Inheritance diagram for SCR_BaseRequestedTaskEntity:

Public Member Functions
SCR_TaskRequesterIdInvoker	GetOnRequesterIdChanged ()

void	SetTaskRequesterId (int groupId)

bool	CanBeCanceledByLocalPlayer ()

bool	IsPlayerFromRequesterGroup (int playerId)

bool	RequestedByLocalPlayerGroup ()

int	GetRequesterId ()

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

Public Member Functions inherited from SCR_Task
SCR_TaskData	GetTaskData ()
	Returns task data instance.

SCR_TaskUIInfo	GetTaskUIInfo ()
	Returns task UI info.

string	GetTaskID ()
	Returns task ID.

void	SetTaskID (string taskID)
	Sets ID of task.

int	GetAuthorID ()
	Returns task author ID.

void	SetAuthorID (int authorId)
	Sets author id of task.

LocalizedString	GetTaskName (out array< LocalizedString > params=null)
	Returns name of task.

void	SetTaskName (LocalizedString taskName, array< LocalizedString > taskNameParams=null)
	Sets name of task.

LocalizedString	GetTaskDescription (out array< LocalizedString > params=null)
	Returns description of task.

void	SetTaskDescription (LocalizedString taskDesc, array< LocalizedString > taskDescParams=null)
	Sets description of task.

string	GetTaskIconPath ()
	Returns task icon path.

void	SetTaskIconPath (ResourceName iconPath)
	Sets task icon path.

string	GetTaskIconSetName ()
	Returns name of task icon set.

void	SetTaskIconSetName (string iconSetName)
	Sets name of task icon set.

int	GetTaskAssigneeCount ()
	Returns number of assignees for this task.

int	GetTaskAssigneePlayerCount (bool recursive=true)
	Returns number of assigned players for this task; If recursive is true, it will check assigned groups as well.

array< ref SCR_TaskExecutor >	GetTaskAssignees ()
	Returns array of assignees for this task.

array< int >	GetTaskAssigneePlayerIDs ()
	Returns array of player assignees for this task.

bool	IsTaskAssignedTo (SCR_TaskExecutor executor, out SCR_TaskExecutor match=null)
	Returns true if specified executor is assigned to this task and provides matching executor.

bool	AddTaskAssignee (SCR_TaskExecutor executor, bool listenToInvokers=true, int requesterID=0)
	Tries to add a new assignee to this task.

bool	RemoveTaskAssignee (SCR_TaskExecutor executor, bool listenToInvokers=true, int requesterID=0)
	Tries to remove an assignee from this task.

SCR_ETaskState	GetTaskState ()

void	SetTaskState (SCR_ETaskState state)

SCR_ETaskOwnership	GetTaskOwnership ()

void	SetTaskOwnership (SCR_ETaskOwnership ownership)

SCR_ETaskVisibility	GetTaskVisibility ()

void	SetTaskVisibility (SCR_ETaskVisibility visibility)

SCR_ETaskUIVisibility	GetTaskUIVisibility ()

void	SetTaskUIVisibility (SCR_ETaskUIVisibility visibility)

int	GetOwnerFactionCount ()

array< string >	GetOwnerFactionKeys ()

void	AddOwnerFactionKey (FactionKey factionKey)

void	RemoveOwnerFactionKey (FactionKey factionKey)

int	GetOwnerGroupCount ()

array< int >	GetOwnerGroupIDs ()

void	AddOwnerGroupID (int groupID)

void	RemoveOwnerGroupID (int groupID)

int	GetOwnerExecutorCount ()

array< ref SCR_TaskExecutor >	GetOwnerExecutors ()

bool	AddOwnerExecutor (SCR_TaskExecutor executor)
	Tries to add an owner executor to this task.

bool	RemoveOwnerExecutor (SCR_TaskExecutor executor)
	Tries to remove an owner executor from this task.

vector	GetTaskPosition ()
	Returns position of task.

void	SetTaskPosition (vector position)
	Sets position of task.

SCR_TaskUIComponent	GetUIComponent ()

ScriptInvokerVoid	GetOnDisplayDataChanged ()

override void	_WB_AfterWorldUpdate (float timeSlice)

override void	EOnInit (IEntity owner)

void	SCR_Task (IEntitySource src, IEntity parent)

void	~SCR_Task ()

Static Public Attributes
static const int	REQUEST_MAX_COUNT = 2

static const int	INVALID_REQUESTER_ID = -1

Protected Member Functions
void	RpcDo_SetTaskRequesterId (int groupId)

void	OnSetRequesterId (int requesterId)

override void	ReadUIInfo (ScriptBitReader reader, out SCR_TaskUIInfo info)

void	DeleteTask ()

override void	InitializeData ()

Protected Member Functions inherited from SCR_Task
void	Rpc_SetTaskID (string taskID)

void	Rpc_SetAuthorID (int authorId)

void	Rpc_SetTaskName (LocalizedString taskName, array< LocalizedString > taskNameParams)

void	Rpc_SetTaskDescription (LocalizedString taskDesc, array< LocalizedString > taskDescParams)

void	Rpc_SetTaskIconPath (ResourceName iconPath)

void	Rpc_SetTaskIconSetName (string iconSetName)

void	AddTaskAssignee_Proxy (SCR_TaskExecutor executor, int requesterID)

void	Rpc_AddTaskAssigneePlayer (SCR_TaskExecutorPlayer executor, int requesterID)

void	Rpc_AddTaskAssigneeEntity (SCR_TaskExecutorEntity executor, int requesterID)

void	Rpc_AddTaskAssigneeGroup (SCR_TaskExecutorGroup executor, int requesterID)

void	RemoveTaskAssignee_Proxy (SCR_TaskExecutor executor, int requesterID)

void	Rpc_RemoveTaskAssigneePlayer (SCR_TaskExecutorPlayer executor, int requesterID)

void	Rpc_RemoveTaskAssigneeEntity (SCR_TaskExecutorEntity executor, int requesterID)

void	Rpc_RemoveTaskAssigneeGroup (SCR_TaskExecutorGroup executor, int requesterID)

void	Rpc_SetTaskState (SCR_ETaskState state)

void	Rpc_SetTaskOwnership (SCR_ETaskOwnership ownership)

void	Rpc_SetTaskVisibility (SCR_ETaskVisibility visibility)

void	Rpc_SetTaskUIVisibility (SCR_ETaskUIVisibility visibility)

void	Rpc_AddOwnerFactionKey (FactionKey factionKey)

void	Rpc_RemoveOwnerFactionKey (FactionKey factionKey)

void	Rpc_AddOwnerGroupID (int groupID)

void	Rpc_RemoveOwnerGroupID (int groupID)

void	AddOwnerExecutor_Proxy (SCR_TaskExecutor executor)

void	Rpc_AddOwnerExecutorPlayer (SCR_TaskExecutorPlayer executor)

void	Rpc_AddOwnerExecutorEntity (SCR_TaskExecutorEntity executor)

void	Rpc_AddOwnerExecutorGroup (SCR_TaskExecutorGroup executor)

void	RemoveOwnerExecutor_Proxy (SCR_TaskExecutor executor)

void	Rpc_RemoveOwnerExecutorPlayer (SCR_TaskExecutorPlayer executor)

void	Rpc_RemoveOwnerExecutorEntity (SCR_TaskExecutorEntity executor)

void	Rpc_RemoveOwnerExecutorGroup (SCR_TaskExecutorGroup executor)

void	Rpc_SetTaskPosition (vector position)

void	WriteUIInfo (ScriptBitWriter writer, SCR_TaskUIInfo info)

void	WriteExecutor (ScriptBitWriter writer, SCR_TaskExecutor executor)

void	ReadExecutor (ScriptBitReader reader, out SCR_TaskExecutor executor)

void	RemoveUnauthorizedAssignees ()
	Go through assignee list and remove assignees who are not allowed to be assigned to this task.

void	OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)
	If faction changed for an assignee, go through assignee list and remove assignees who are no longer allowed to be assigned to this task.

void	OnPlayerFactionChanged (int playerId, SCR_PlayerFactionAffiliationComponent playerFactionAffiliationComponent, Faction faction)

void	OnGroupChanged (int groupID)
	If group changed for an assignee, go through assignee list and remove assignees who are no longer allowed to be assigned to this task.

void	OnGroupRemoved (SCR_AIGroup group)
	When group is deleted, check if group matches group in task data and reset values.

void	OnPlayerAddedToGroup (SCR_AIGroup group, int playerID)
	Invoke m_OnDisplayDataChanged to update UI when player joins group.

void	OnPlayerRemovedFromGroup (SCR_AIGroup group, int playerID)
	Invoke m_OnDisplayDataChanged to update UI when player leaves group.

void	ConnectToTaskSystem ()

void	DisconnectFromTaskSystem ()

Protected Attributes
SCR_BaseRequestedTaskData	m_BaseRequestedTaskData

ref SCR_TaskRequesterIdInvoker	m_OnRequesterIdChanged

Protected Attributes inherited from SCR_Task
string	m_sTaskID

ref SCR_TaskUIInfo	m_TaskUIInfo

SCR_ETaskState	m_eTaskState

SCR_ETaskOwnership	m_eTaskOwnership

SCR_ETaskVisibility	m_eTaskVisibility

SCR_ETaskUIVisibility	m_eTaskUIVisibility

ref array< string >	m_aOwnerFactionKeys

ref array< int >	m_aOwnerGroupIDs

ref array< ref SCR_TaskExecutor >	m_aOwnerExecutors

ref array< ref SCR_TaskExecutor >	m_aAssignees

ref SCR_TaskData	m_TaskData

SCR_TaskSystem	m_TaskSystem

SCR_TaskUIComponent	m_UIComponent

SCR_EditableEntityComponent	m_EditableEntityComponent

ref ScriptInvokerVoid	m_OnDisplayDataChanged

ref DebugTextWorldSpace	m_DebugText

Additional Inherited Members
Static Public Member Functions inherited from SCR_Task
static SCR_TaskStateInvoker	GetOnTaskStateChanged ()

static SCR_TaskOwnershipInvoker	GetOnTaskOwnershipChanged ()

static SCR_TaskVisibilityInvoker	GetOnTaskVisibilityChanged ()

static SCR_TaskUIVisibilityInvoker	GetOnTaskUIVisibilityChanged ()

static SCR_TaskExecutorRequesterInvoker	GetOnTaskAssigneeAdded ()

static SCR_TaskExecutorRequesterInvoker	GetOnTaskAssigneeRemoved ()

static SCR_TaskFactionInvoker	GetOnOwnerFactionAdded ()

static SCR_TaskFactionInvoker	GetOnOwnerFactionRemoved ()

static SCR_TaskGroupInvoker	GetOnOwnerGroupAdded ()

static SCR_TaskGroupInvoker	GetOnOwnerGroupRemoved ()

static SCR_TaskExecutorInvoker	GetOnOwnerExecutorAdded ()

static SCR_TaskExecutorInvoker	GetOnOwnerExecutorRemoved ()

Static Protected Attributes inherited from SCR_Task
static ref SCR_TaskStateInvoker	s_OnTaskStateChanged

static ref SCR_TaskOwnershipInvoker	s_OnTaskOwnershipChanged

static ref SCR_TaskVisibilityInvoker	s_OnTaskVisibilityChanged

static ref SCR_TaskUIVisibilityInvoker	s_OnTaskUIVisibilityChanged

static ref SCR_TaskExecutorRequesterInvoker	s_OnTaskAssigneeAdded

static ref SCR_TaskExecutorRequesterInvoker	s_OnTaskAssigneeRemoved

static ref SCR_TaskFactionInvoker	s_OnOwnerFactionAdded

static ref SCR_TaskFactionInvoker	s_OnOwnerFactionRemoved

static ref SCR_TaskGroupInvoker	s_OnOwnerGroupAdded

static ref SCR_TaskGroupInvoker	s_OnOwnerGroupRemoved

static ref SCR_TaskExecutorInvoker	s_OnOwnerExecutorAdded

static ref SCR_TaskExecutorInvoker	s_OnOwnerExecutorRemoved

Member Function Documentation

◆ CanBeCanceledByLocalPlayer()

bool SCR_BaseRequestedTaskEntity.CanBeCanceledByLocalPlayer ( )

Returns: if the local player can cancel the request

◆ DeleteTask()

void SCR_BaseRequestedTaskEntity.DeleteTask ( )

protected

◆ GetOnRequesterIdChanged()

SCR_TaskRequesterIdInvoker SCR_BaseRequestedTaskEntity.GetOnRequesterIdChanged ( )

◆ GetRequesterId()

int SCR_BaseRequestedTaskEntity.GetRequesterId ( )

Returns: requester Id

◆ InitializeData()

override void SCR_BaseRequestedTaskEntity.InitializeData ( )

protected

Implements SCR_Task.

◆ IsPlayerFromRequesterGroup()

bool SCR_BaseRequestedTaskEntity.IsPlayerFromRequesterGroup ( int playerId )

Parameters

[in] playerId

Returns: true if the player is from requester group

◆ OnSetRequesterId()

void SCR_BaseRequestedTaskEntity.OnSetRequesterId ( int requesterId )

protected

Implemented in SCR_PickupRequestedTaskEntity.

◆ ReadUIInfo()

override void SCR_BaseRequestedTaskEntity.ReadUIInfo	(	ScriptBitReader	reader,
		out SCR_TaskUIInfo	info )

protected

Implements SCR_Task.

◆ RequestedByLocalPlayerGroup()

bool SCR_BaseRequestedTaskEntity.RequestedByLocalPlayerGroup ( )

Returns: true if the local player is from requester group

◆ RpcDo_SetTaskRequesterId()

void SCR_BaseRequestedTaskEntity.RpcDo_SetTaskRequesterId ( int groupId )

protected

◆ RplLoad()

override bool SCR_BaseRequestedTaskEntity.RplLoad ( ScriptBitReader reader )

Implements SCR_Task.

Implemented in SCR_ReinforceRequestedTaskEntity, and SCR_RepairRequestedTaskEntity.

◆ RplSave()

override bool SCR_BaseRequestedTaskEntity.RplSave ( ScriptBitWriter writer )

Implements SCR_Task.

◆ SetTaskRequesterId()

void SCR_BaseRequestedTaskEntity.SetTaskRequesterId ( int groupId )

Member Data Documentation

◆ INVALID_REQUESTER_ID

const int SCR_BaseRequestedTaskEntity.INVALID_REQUESTER_ID = -1

static

◆ m_BaseRequestedTaskData

SCR_BaseRequestedTaskData SCR_BaseRequestedTaskEntity.m_BaseRequestedTaskData

protected

◆ m_OnRequesterIdChanged

ref SCR_TaskRequesterIdInvoker SCR_BaseRequestedTaskEntity.m_OnRequesterIdChanged

protected

◆ REQUEST_MAX_COUNT

const int SCR_BaseRequestedTaskEntity.REQUEST_MAX_COUNT = 2

static

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

Game/Tasks/Campaign/SCR_BaseRequestedTaskEntity.c

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CanBeCanceledByLocalPlayer()

◆ DeleteTask()

◆ GetOnRequesterIdChanged()

◆ GetRequesterId()

◆ InitializeData()

◆ IsPlayerFromRequesterGroup()

◆ OnSetRequesterId()

◆ ReadUIInfo()

◆ RequestedByLocalPlayerGroup()

◆ RpcDo_SetTaskRequesterId()

◆ RplLoad()

◆ RplSave()

◆ SetTaskRequesterId()

Member Data Documentation

◆ INVALID_REQUESTER_ID

◆ m_BaseRequestedTaskData

◆ m_OnRequesterIdChanged

◆ REQUEST_MAX_COUNT