SCR_ScenarioFrameworkTask Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkTask:

Public Member Functions
SCR_ETaskNotificationSettings	GetTaskNotificationSettings ()
void	SetLayerTask (SCR_ScenarioFrameworkLayerTask layer)
SCR_ScenarioFrameworkLayerTask	GetLayerTask ()
void	HookTaskAsset (IEntity object)
	Updates linked entity for this task.
IEntity	GetAsset ()
void	SetSlotTask (SCR_ScenarioFrameworkSlotTask slotTask)
SCR_ScenarioFrameworkSlotTask	GetSlotTask ()
void	SetTaskExecutionBriefing (string text)
string	GetTaskExecutionBriefing ()
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
Public Member Functions inherited from SCR_ExtendedTask
LocalizedString	GetCustomSubtaskDescription ()
	Returns custom description string for subtasks.
void	SetCustomSubtaskDescription (LocalizedString subTaskDescription)
	Sets custom description string for subtasks.
bool	IsChildTask ()
	Returns true if this task is parented to another.
bool	HasChildTasks ()
	Returns true if other tasks are parented to this one.
int	GetChildTaskCount ()
	Returns exact number of tasks parented to this one.
bool	CanBeAssigned ()
	Returns true if this task is assignable to entities; Will always return false if it is a parent task.
int	GetNodeDepth ()
	Returns depth within the task hierarchy; Parent task is always 0, while child tasks are 1.
SCR_Task	GetParentTask ()
	Returns parent task or null if there is none.
array< SCR_Task >	GetChildTasks ()
	Returns array of tasks parented to this one.
bool	AddChildTask (SCR_Task task)
	Tries to parent task to this one.
bool	RemoveChildTask (SCR_Task task)
	Tries to unparent task from this one.
float	GetTaskProgress ()
	Returns progress of task as float; Value ranges from 0-100.
void	SetTaskProgress (float percentage, bool changeState=true)
	Sets progress of task in percentage.
void	AddTaskProgress (float percentage, bool changeState=true)
	Adds progress to task in percentage.
void	RemoveTaskProgress (float percentage, bool changeState=true)
	Removes progress from task in percentage.
bool	CanTaskProgressBeShown ()
	Returns true if task progress can be shown.
void	ShowTaskProgress (bool enable)
override bool	AddTaskAssignee (SCR_TaskExecutor executor, bool listenToInvokers=true, int requesterID=0)
	Tries to assign this task to the given entity If linking data to other tasks is enabled and this task is parented to another, the parent task will be assigned to the entity as well.
override bool	RemoveTaskAssignee (SCR_TaskExecutor executor, bool listenToInvokers=true, int requesterID=0)
	Tries to unassign this task from the given entity If linking data to other tasks is enabled and this task is parented to another, the parent task will be unassigned from the entity as well.
override bool	AddOwnerExecutor (SCR_TaskExecutor executor)
	Adds given executor to task as an owner/viewer depending on task ownership and visibility.
override bool	RemoveOwnerExecutor (SCR_TaskExecutor executor)
	Removes given executor from task as an owner/viewer depending on task ownership and visibility.
override void	SetTaskState (SCR_ETaskState state)
SCR_ChildTaskInvoker	GetOnChildTaskAdded ()
SCR_ChildTaskInvoker	GetOnChildTaskRemoved ()
ScriptInvokerFloat2	GetOnProgressChanged ()
override void	_WB_AfterWorldUpdate (float timeSlice)
override void	EOnInit (IEntity owner)
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.
SCR_ETaskState	GetTaskState ()
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 ()
vector	GetTaskPosition ()
	Returns position of task.
void	SetTaskPosition (vector position)
	Sets position of task.
SCR_TaskUIComponent	GetUIComponent ()
ScriptInvokerVoid	GetOnDisplayDataChanged ()
void	SCR_Task (IEntitySource src, IEntity parent)
void	~SCR_Task ()

Protected Member Functions
void	Rpc_SetTaskExecutionBriefing (string text)
override void	InitializeData ()
Protected Member Functions inherited from SCR_ExtendedTask
void	Rpc_SetCustomSubtaskDescription (LocalizedString subTaskDescription)
void	SetParentTask (SCR_ExtendedTask parentTask)
void	Rpc_SetParentTask (RplId parentTaskRplID)
void	Rpc_AddChildTask (RplId taskRplID)
void	Rpc_RemoveChildTask (RplId taskRplID)
void	Rpc_SetTaskProgress (float percentage, float previousProgress)
void	Rpc_AddTaskProgress (float percentage)
void	Rpc_RemoveTaskProgress (float percentage)
void	Rpc_ShowTaskProgress (bool enable)
override void	Rpc_AddOwnerFactionKey (FactionKey factionKey)
override void	Rpc_RemoveOwnerFactionKey (FactionKey factionKey)
override void	Rpc_AddOwnerGroupID (int groupID)
override void	Rpc_RemoveOwnerGroupID (int groupID)
override void	Rpc_SetTaskOwnership (SCR_ETaskOwnership ownership)
override void	Rpc_SetTaskVisibility (SCR_ETaskVisibility visibility)
void	InitializeChildTasks ()
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_SetTaskUIVisibility (SCR_ETaskUIVisibility visibility)
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	ReadUIInfo (ScriptBitReader reader, out SCR_TaskUIInfo info)
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
IEntity	m_Asset
SCR_ScenarioFrameworkLayerTask	m_LayerTask
SCR_ScenarioFrameworkSlotTask	m_SlotTask
Protected Attributes inherited from SCR_ExtendedTask
bool	m_bLinkDataToRelatedTasks
bool	m_bEnableProgress
float	m_fProgress
LocalizedString	m_sCustomSubtaskDescription
SCR_ETaskState	m_eCachedTaskState
ref SCR_ChildTaskInvoker	m_OnChildTaskAdded
ref SCR_ChildTaskInvoker	m_OnChildTaskRemoved
ref ScriptInvokerFloat2	m_OnProgressChanged
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_ExtendedTask
const float	MIN_TASK_PROGRESSION_PERCENTAGE = 0.0
const float	MAX_TASK_PROGRESSION_PERCENTAGE = 100.0
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

GetAsset()

IEntity SCR_ScenarioFrameworkTask.GetAsset

(

)

Returns

Asset entity.

GetLayerTask()

SCR_ScenarioFrameworkLayerTask SCR_ScenarioFrameworkTask.GetLayerTask

(

)

Returns

Layer task linked to this task.

GetSlotTask()

SCR_ScenarioFrameworkSlotTask SCR_ScenarioFrameworkTask.GetSlotTask

(

)

Returns

linked slot task.

GetTaskExecutionBriefing()

string SCR_ScenarioFrameworkTask.GetTaskExecutionBriefing

(

)

Returns

Task execution briefing string.

GetTaskNotificationSettings()

SCR_ETaskNotificationSettings SCR_ScenarioFrameworkTask.GetTaskNotificationSettings

(

)

HookTaskAsset()

void SCR_ScenarioFrameworkTask.HookTaskAsset

(

IEntity

object

)

Updates linked entity for this task.

Parameters

[in]

object

Updates blacklist for garbage system, sets task entity for support entity.

Implemented in SCR_ScenarioFrameworkTaskArea, SCR_TaskDefend, SCR_TaskDeliver, SCR_TaskDestroyObject, and SCR_TaskKill.

InitializeData()

override void SCR_ScenarioFrameworkTask.InitializeData ( )

protected

Implements SCR_ExtendedTask.

Rpc_SetTaskExecutionBriefing()

void SCR_ScenarioFrameworkTask.Rpc_SetTaskExecutionBriefing ( string text )

protected

RplLoad()

override bool SCR_ScenarioFrameworkTask.RplLoad

(

ScriptBitReader

reader

)

Implements SCR_ExtendedTask.

RplSave()

override bool SCR_ScenarioFrameworkTask.RplSave

(

ScriptBitWriter

writer

)

Implements SCR_ExtendedTask.

SetLayerTask()

void SCR_ScenarioFrameworkTask.SetLayerTask

(

SCR_ScenarioFrameworkLayerTask

layer

)

Parameters

[in]

layer

Sets the layer task for this task.

SetSlotTask()

void SCR_ScenarioFrameworkTask.SetSlotTask

(

SCR_ScenarioFrameworkSlotTask

slotTask

)

Parameters

[in]

slotTask

that will be linked to this task.

SetTaskExecutionBriefing()

void SCR_ScenarioFrameworkTask.SetTaskExecutionBriefing

(

string

text

)

Parameters

[in]

text

Sets the briefing for task execution.

Member Data Documentation

m_Asset

IEntity SCR_ScenarioFrameworkTask.m_Asset

protected

m_LayerTask

SCR_ScenarioFrameworkLayerTask SCR_ScenarioFrameworkTask.m_LayerTask

protected

m_SlotTask

SCR_ScenarioFrameworkSlotTask SCR_ScenarioFrameworkTask.m_SlotTask

protected

---

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

• Game/ScenarioFramework/Tasks/SCR_ScenarioFrameworkTask.c