SCR_TaskNetworkComponent Interface Reference

Takes care of tasks-specific server <> client communication and requests. More...

Inheritance diagram for SCR_TaskNetworkComponent:

Public Member Functions
void	CancelTask (int taskID)
	Allows the requester to cancel a task requested by them.
void	AbandonTask (int taskID)
	Allows the local player to abandon a task assigned to them.
void	RequestAssignment (int taskID)
	Allows the local player to request assignment to a task.
void	AssignTaskToPlayer (int gmID, int taskID, int playerID)
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
void	SCR_TaskNetworkComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Protected Member Functions
void	RPC_AssignTaskToPlayer (int gmID, int taskID, int playerID)
void	RPC_CancelTask (int taskID)
	An RPC executed on the server, tells task manager to cancel given task by given player.
void	RPC_AbandonTask (int taskID, int playerID)
	An RPC executed on the server, tells task manager to abandon given task by given player.
void	RPC_RequestAssignment (int taskID, int playerID)
	An RPC executed on the server, tells task manager to assign given task to given player.

Protected Attributes
SCR_PlayerController	m_PlayerController
RplComponent	m_RplComponent

Static Protected Attributes
static const int	INVALID_PLAYER_ID = -1

Detailed Description

Takes care of tasks-specific server <> client communication and requests.

Constructor & Destructor Documentation

SCR_TaskNetworkComponent()

void SCR_TaskNetworkComponent.SCR_TaskNetworkComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Member Function Documentation

AbandonTask()

void SCR_TaskNetworkComponent.AbandonTask

(

int

taskID

)

Allows the local player to abandon a task assigned to them.

Parameters

[in]

taskID

AssignTaskToPlayer()

void SCR_TaskNetworkComponent.AssignTaskToPlayer	(	int	gmID,
		int	taskID,
		int	playerID
	)

Parameters

[in]	gmID
[in]	taskID
[in]	playerID

CancelTask()

void SCR_TaskNetworkComponent.CancelTask

(

int

taskID

)

Allows the requester to cancel a task requested by them.

Parameters

[in]

taskID

EOnInit()

override void SCR_TaskNetworkComponent.EOnInit

(

IEntity

owner

)

OnPostInit()

override void SCR_TaskNetworkComponent.OnPostInit

(

IEntity

owner

)

RequestAssignment()

void SCR_TaskNetworkComponent.RequestAssignment

(

int

taskID

)

Allows the local player to request assignment to a task.

Parameters

[in]

taskID

RPC_AbandonTask()

void SCR_TaskNetworkComponent.RPC_AbandonTask ( int  taskID, int  playerID  )

protected

An RPC executed on the server, tells task manager to abandon given task by given player.

Parameters

[in]	taskID
[in]	playerID

RPC_AssignTaskToPlayer()

void SCR_TaskNetworkComponent.RPC_AssignTaskToPlayer ( int  gmID, int  taskID, int  playerID  )

protected

RPC_CancelTask()

void SCR_TaskNetworkComponent.RPC_CancelTask ( int  taskID )

protected

An RPC executed on the server, tells task manager to cancel given task by given player.

Parameters

[in]

taskID

RPC_RequestAssignment()

void SCR_TaskNetworkComponent.RPC_RequestAssignment ( int  taskID, int  playerID  )

protected

An RPC executed on the server, tells task manager to assign given task to given player.

Parameters

[in]	taskID
[in]	playerID

Member Data Documentation

INVALID_PLAYER_ID

const int SCR_TaskNetworkComponent.INVALID_PLAYER_ID = -1

staticprotected

m_PlayerController

SCR_PlayerController SCR_TaskNetworkComponent.m_PlayerController

protected

m_RplComponent

RplComponent SCR_TaskNetworkComponent.m_RplComponent

protected

---

The documentation for this interface was generated from the following file:

• Game/Campaign/SCR_TaskNetworkComponent.c