Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_Task Interface Reference
Inheritance diagram for SCR_Task:
SCR_AttackTaskEntity SCR_BaseRequestedTaskEntity SCR_CampaignMilitaryBaseTaskEntity SCR_EstablishBaseTaskEntity SCR_ExtendedTask SCR_ReconTaskEntity SCR_TransportUnitHelpTaskEntity SCR_EstablishBaseRequestedTaskEntity SCR_FireSupportRequestedTaskEntity SCR_PickupRequestedTaskEntity SCR_RearmRequestedTaskEntity SCR_ReinforceRequestedTaskEntity SCR_RepairRequestedTaskEntity SCR_BuildingCampaignMilitaryBaseTaskEntity SCR_DismantleCampaignMilitaryBaseTaskEntity SCR_HoldCampaignMilitaryBaseTaskEntity SCR_ResupplyCampaignMilitaryBaseTaskEntity SCR_SeizeCampaignMilitaryBaseTaskEntity SCR_EditorTask SCR_ScenarioFrameworkTask

Public Member Functions

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 Member Functions

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 ()
 

Protected Member Functions

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)
 
override bool RplSave (ScriptBitWriter writer)
 
void WriteUIInfo (ScriptBitWriter writer, SCR_TaskUIInfo info)
 
void WriteExecutor (ScriptBitWriter writer, SCR_TaskExecutor executor)
 
override bool RplLoad (ScriptBitReader reader)
 
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 InitializeData ()
 
void ConnectToTaskSystem ()
 
void DisconnectFromTaskSystem ()
 

Protected Attributes

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
 

Static Protected Attributes

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
 

Constructor & Destructor Documentation

◆ SCR_Task()

void SCR_Task.SCR_Task ( IEntitySource src,
IEntity parent )
Parameters
[in]src
[in]parent

◆ ~SCR_Task()

void SCR_Task.~SCR_Task ( )

Member Function Documentation

◆ _WB_AfterWorldUpdate()

override void SCR_Task._WB_AfterWorldUpdate ( float timeSlice)

Implemented in SCR_ExtendedTask.

◆ AddOwnerExecutor()

bool SCR_Task.AddOwnerExecutor ( SCR_TaskExecutor executor)

Tries to add an owner executor to this task.

Parameters
[in]executor
Returns

Implemented in SCR_ExtendedTask.

◆ AddOwnerExecutor_Proxy()

void SCR_Task.AddOwnerExecutor_Proxy ( SCR_TaskExecutor executor)
protected

◆ AddOwnerFactionKey()

void SCR_Task.AddOwnerFactionKey ( FactionKey factionKey)
Parameters
[in]factionKey

Implemented in SCR_TriggerTask.

◆ AddOwnerGroupID()

void SCR_Task.AddOwnerGroupID ( int groupID)
Parameters
[in]groupID

◆ AddTaskAssignee()

bool SCR_Task.AddTaskAssignee ( SCR_TaskExecutor executor,
bool listenToInvokers = true,
int requesterID = 0 )

Tries to add a new assignee to this task.

Parameters
[in]executor
[in]listenToInvokers
[in]requesterID
Returns

Implemented in SCR_ExtendedTask.

◆ AddTaskAssignee_Proxy()

void SCR_Task.AddTaskAssignee_Proxy ( SCR_TaskExecutor executor,
int requesterID )
protected

◆ ConnectToTaskSystem()

void SCR_Task.ConnectToTaskSystem ( )
protected

◆ DisconnectFromTaskSystem()

void SCR_Task.DisconnectFromTaskSystem ( )
protected

◆ EOnInit()

override void SCR_Task.EOnInit ( IEntity owner)

Implemented in SCR_AttackTaskEntity, SCR_BuildingCampaignMilitaryBaseTaskEntity, SCR_DismantleCampaignMilitaryBaseTaskEntity, SCR_EditorTask, SCR_EstablishBaseRequestedTaskEntity, SCR_EstablishBaseTaskEntity, SCR_ExtendedTask, SCR_HoldCampaignMilitaryBaseTaskEntity, SCR_MoveTask, SCR_RearmRequestedTaskEntity, SCR_ReconTaskEntity, SCR_ReinforceRequestedTaskEntity, SCR_RepairRequestedTaskEntity, and SCR_TriggerTask.

◆ GetAuthorID()

int SCR_Task.GetAuthorID ( )

Returns task author ID.

Returns

◆ GetOnDisplayDataChanged()

ScriptInvokerVoid SCR_Task.GetOnDisplayDataChanged ( )
Returns

◆ GetOnOwnerExecutorAdded()

static SCR_TaskExecutorInvoker SCR_Task.GetOnOwnerExecutorAdded ( )
static
Returns

◆ GetOnOwnerExecutorRemoved()

static SCR_TaskExecutorInvoker SCR_Task.GetOnOwnerExecutorRemoved ( )
static
Returns

◆ GetOnOwnerFactionAdded()

static SCR_TaskFactionInvoker SCR_Task.GetOnOwnerFactionAdded ( )
static
Returns

◆ GetOnOwnerFactionRemoved()

static SCR_TaskFactionInvoker SCR_Task.GetOnOwnerFactionRemoved ( )
static
Returns

◆ GetOnOwnerGroupAdded()

static SCR_TaskGroupInvoker SCR_Task.GetOnOwnerGroupAdded ( )
static
Returns

◆ GetOnOwnerGroupRemoved()

static SCR_TaskGroupInvoker SCR_Task.GetOnOwnerGroupRemoved ( )
static
Returns

◆ GetOnTaskAssigneeAdded()

static SCR_TaskExecutorRequesterInvoker SCR_Task.GetOnTaskAssigneeAdded ( )
static
Returns

◆ GetOnTaskAssigneeRemoved()

static SCR_TaskExecutorRequesterInvoker SCR_Task.GetOnTaskAssigneeRemoved ( )
static
Returns

◆ GetOnTaskOwnershipChanged()

static SCR_TaskOwnershipInvoker SCR_Task.GetOnTaskOwnershipChanged ( )
static
Returns

◆ GetOnTaskStateChanged()

static SCR_TaskStateInvoker SCR_Task.GetOnTaskStateChanged ( )
static
Returns

◆ GetOnTaskUIVisibilityChanged()

static SCR_TaskUIVisibilityInvoker SCR_Task.GetOnTaskUIVisibilityChanged ( )
static
Returns

◆ GetOnTaskVisibilityChanged()

static SCR_TaskVisibilityInvoker SCR_Task.GetOnTaskVisibilityChanged ( )
static
Returns

◆ GetOwnerExecutorCount()

int SCR_Task.GetOwnerExecutorCount ( )
Returns

◆ GetOwnerExecutors()

array< ref SCR_TaskExecutor > SCR_Task.GetOwnerExecutors ( )
Returns

◆ GetOwnerFactionCount()

int SCR_Task.GetOwnerFactionCount ( )
Returns

◆ GetOwnerFactionKeys()

array< string > SCR_Task.GetOwnerFactionKeys ( )
Returns

◆ GetOwnerGroupCount()

int SCR_Task.GetOwnerGroupCount ( )
Returns

◆ GetOwnerGroupIDs()

array< int > SCR_Task.GetOwnerGroupIDs ( )
Returns

◆ GetTaskAssigneeCount()

int SCR_Task.GetTaskAssigneeCount ( )

Returns number of assignees for this task.

Returns

◆ GetTaskAssigneePlayerCount()

int SCR_Task.GetTaskAssigneePlayerCount ( bool recursive = true)

Returns number of assigned players for this task; If recursive is true, it will check assigned groups as well.

Parameters
[in]recursive
Returns

◆ GetTaskAssigneePlayerIDs()

array< int > SCR_Task.GetTaskAssigneePlayerIDs ( )

Returns array of player assignees for this task.

Returns

◆ GetTaskAssignees()

array< ref SCR_TaskExecutor > SCR_Task.GetTaskAssignees ( )

Returns array of assignees for this task.

Returns

◆ GetTaskData()

SCR_TaskData SCR_Task.GetTaskData ( )

Returns task data instance.

Returns

◆ GetTaskDescription()

LocalizedString SCR_Task.GetTaskDescription ( out array< LocalizedString > params = null)

Returns description of task.

Parameters
[out]params
Returns

◆ GetTaskIconPath()

string SCR_Task.GetTaskIconPath ( )

Returns task icon path.

Returns

◆ GetTaskIconSetName()

string SCR_Task.GetTaskIconSetName ( )

Returns name of task icon set.

Returns

◆ GetTaskID()

string SCR_Task.GetTaskID ( )

Returns task ID.

Returns

◆ GetTaskName()

LocalizedString SCR_Task.GetTaskName ( out array< LocalizedString > params = null)

Returns name of task.

Parameters
[out]params
Returns

◆ GetTaskOwnership()

SCR_ETaskOwnership SCR_Task.GetTaskOwnership ( )
Returns

◆ GetTaskPosition()

vector SCR_Task.GetTaskPosition ( )

Returns position of task.

Returns

◆ GetTaskState()

SCR_ETaskState SCR_Task.GetTaskState ( )
Returns

◆ GetTaskUIInfo()

SCR_TaskUIInfo SCR_Task.GetTaskUIInfo ( )

Returns task UI info.

Returns

◆ GetTaskUIVisibility()

SCR_ETaskUIVisibility SCR_Task.GetTaskUIVisibility ( )
Returns

◆ GetTaskVisibility()

SCR_ETaskVisibility SCR_Task.GetTaskVisibility ( )
Returns

◆ GetUIComponent()

SCR_TaskUIComponent SCR_Task.GetUIComponent ( )
Returns

◆ InitializeData()

void SCR_Task.InitializeData ( )
protected

Implemented in SCR_BaseRequestedTaskEntity, SCR_CampaignMilitaryBaseTaskEntity, SCR_ExtendedTask, and SCR_ScenarioFrameworkTask.

◆ IsTaskAssignedTo()

bool SCR_Task.IsTaskAssignedTo ( SCR_TaskExecutor executor,
out SCR_TaskExecutor match = null )

Returns true if specified executor is assigned to this task and provides matching executor.

Parameters
[in]executor
[out]match
Returns

◆ OnFactionChanged()

void SCR_Task.OnFactionChanged ( FactionAffiliationComponent owner,
Faction previousFaction,
Faction newFaction )
protected

If faction changed for an assignee, go through assignee list and remove assignees who are no longer allowed to be assigned to this task.

◆ OnGroupChanged()

void SCR_Task.OnGroupChanged ( int groupID)
protected

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

◆ OnGroupRemoved()

void SCR_Task.OnGroupRemoved ( SCR_AIGroup group)
protected

When group is deleted, check if group matches group in task data and reset values.

◆ OnPlayerAddedToGroup()

void SCR_Task.OnPlayerAddedToGroup ( SCR_AIGroup group,
int playerID )
protected

Invoke m_OnDisplayDataChanged to update UI when player joins group.

◆ OnPlayerFactionChanged()

void SCR_Task.OnPlayerFactionChanged ( int playerId,
SCR_PlayerFactionAffiliationComponent playerFactionAffiliationComponent,
Faction faction )
protected

◆ OnPlayerRemovedFromGroup()

void SCR_Task.OnPlayerRemovedFromGroup ( SCR_AIGroup group,
int playerID )
protected

Invoke m_OnDisplayDataChanged to update UI when player leaves group.

◆ ReadExecutor()

void SCR_Task.ReadExecutor ( ScriptBitReader reader,
out SCR_TaskExecutor executor )
protected

◆ ReadUIInfo()

void SCR_Task.ReadUIInfo ( ScriptBitReader reader,
out SCR_TaskUIInfo info )
protected

Implemented in SCR_BaseRequestedTaskEntity.

◆ RemoveOwnerExecutor()

bool SCR_Task.RemoveOwnerExecutor ( SCR_TaskExecutor executor)

Tries to remove an owner executor from this task.

Parameters
[in]executor
Returns

Implemented in SCR_ExtendedTask.

◆ RemoveOwnerExecutor_Proxy()

void SCR_Task.RemoveOwnerExecutor_Proxy ( SCR_TaskExecutor executor)
protected

◆ RemoveOwnerFactionKey()

void SCR_Task.RemoveOwnerFactionKey ( FactionKey factionKey)
Parameters
[in]factionKey

◆ RemoveOwnerGroupID()

void SCR_Task.RemoveOwnerGroupID ( int groupID)
Parameters
[in]groupID

◆ RemoveTaskAssignee()

bool SCR_Task.RemoveTaskAssignee ( SCR_TaskExecutor executor,
bool listenToInvokers = true,
int requesterID = 0 )

Tries to remove an assignee from this task.

Parameters
[in]executor
[in]listenToInvokers
[in]requesterID
Returns

Implemented in SCR_ExtendedTask.

◆ RemoveTaskAssignee_Proxy()

void SCR_Task.RemoveTaskAssignee_Proxy ( SCR_TaskExecutor executor,
int requesterID )
protected

◆ RemoveUnauthorizedAssignees()

void SCR_Task.RemoveUnauthorizedAssignees ( )
protected

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

◆ Rpc_AddOwnerExecutorEntity()

void SCR_Task.Rpc_AddOwnerExecutorEntity ( SCR_TaskExecutorEntity executor)
protected

◆ Rpc_AddOwnerExecutorGroup()

void SCR_Task.Rpc_AddOwnerExecutorGroup ( SCR_TaskExecutorGroup executor)
protected

◆ Rpc_AddOwnerExecutorPlayer()

void SCR_Task.Rpc_AddOwnerExecutorPlayer ( SCR_TaskExecutorPlayer executor)
protected

◆ Rpc_AddOwnerFactionKey()

void SCR_Task.Rpc_AddOwnerFactionKey ( FactionKey factionKey)
protected

Implemented in SCR_ExtendedTask.

◆ Rpc_AddOwnerGroupID()

void SCR_Task.Rpc_AddOwnerGroupID ( int groupID)
protected

Implemented in SCR_ExtendedTask.

◆ Rpc_AddTaskAssigneeEntity()

void SCR_Task.Rpc_AddTaskAssigneeEntity ( SCR_TaskExecutorEntity executor,
int requesterID )
protected

◆ Rpc_AddTaskAssigneeGroup()

void SCR_Task.Rpc_AddTaskAssigneeGroup ( SCR_TaskExecutorGroup executor,
int requesterID )
protected

◆ Rpc_AddTaskAssigneePlayer()

void SCR_Task.Rpc_AddTaskAssigneePlayer ( SCR_TaskExecutorPlayer executor,
int requesterID )
protected

◆ Rpc_RemoveOwnerExecutorEntity()

void SCR_Task.Rpc_RemoveOwnerExecutorEntity ( SCR_TaskExecutorEntity executor)
protected

◆ Rpc_RemoveOwnerExecutorGroup()

void SCR_Task.Rpc_RemoveOwnerExecutorGroup ( SCR_TaskExecutorGroup executor)
protected

◆ Rpc_RemoveOwnerExecutorPlayer()

void SCR_Task.Rpc_RemoveOwnerExecutorPlayer ( SCR_TaskExecutorPlayer executor)
protected

◆ Rpc_RemoveOwnerFactionKey()

void SCR_Task.Rpc_RemoveOwnerFactionKey ( FactionKey factionKey)
protected

Implemented in SCR_ExtendedTask.

◆ Rpc_RemoveOwnerGroupID()

void SCR_Task.Rpc_RemoveOwnerGroupID ( int groupID)
protected

Implemented in SCR_ExtendedTask.

◆ Rpc_RemoveTaskAssigneeEntity()

void SCR_Task.Rpc_RemoveTaskAssigneeEntity ( SCR_TaskExecutorEntity executor,
int requesterID )
protected

◆ Rpc_RemoveTaskAssigneeGroup()

void SCR_Task.Rpc_RemoveTaskAssigneeGroup ( SCR_TaskExecutorGroup executor,
int requesterID )
protected

◆ Rpc_RemoveTaskAssigneePlayer()

void SCR_Task.Rpc_RemoveTaskAssigneePlayer ( SCR_TaskExecutorPlayer executor,
int requesterID )
protected

◆ Rpc_SetAuthorID()

void SCR_Task.Rpc_SetAuthorID ( int authorId)
protected

◆ Rpc_SetTaskDescription()

void SCR_Task.Rpc_SetTaskDescription ( LocalizedString taskDesc,
array< LocalizedString > taskDescParams )
protected

◆ Rpc_SetTaskIconPath()

void SCR_Task.Rpc_SetTaskIconPath ( ResourceName iconPath)
protected

◆ Rpc_SetTaskIconSetName()

void SCR_Task.Rpc_SetTaskIconSetName ( string iconSetName)
protected

◆ Rpc_SetTaskID()

void SCR_Task.Rpc_SetTaskID ( string taskID)
protected

◆ Rpc_SetTaskName()

void SCR_Task.Rpc_SetTaskName ( LocalizedString taskName,
array< LocalizedString > taskNameParams )
protected

◆ Rpc_SetTaskOwnership()

void SCR_Task.Rpc_SetTaskOwnership ( SCR_ETaskOwnership ownership)
protected

Implemented in SCR_ExtendedTask.

◆ Rpc_SetTaskPosition()

void SCR_Task.Rpc_SetTaskPosition ( vector position)
protected

◆ Rpc_SetTaskState()

void SCR_Task.Rpc_SetTaskState ( SCR_ETaskState state)
protected

◆ Rpc_SetTaskUIVisibility()

void SCR_Task.Rpc_SetTaskUIVisibility ( SCR_ETaskUIVisibility visibility)
protected

◆ Rpc_SetTaskVisibility()

void SCR_Task.Rpc_SetTaskVisibility ( SCR_ETaskVisibility visibility)
protected

Implemented in SCR_ExtendedTask.

◆ RplLoad()

override bool SCR_Task.RplLoad ( ScriptBitReader reader)
protected

Implemented in SCR_BaseRequestedTaskEntity, SCR_CampaignMilitaryBaseTaskEntity, SCR_EstablishBaseTaskEntity, SCR_ExtendedTask, SCR_ReinforceRequestedTaskEntity, SCR_RepairRequestedTaskEntity, and SCR_ScenarioFrameworkTask.

◆ RplSave()

override bool SCR_Task.RplSave ( ScriptBitWriter writer)
protected

Implemented in SCR_BaseRequestedTaskEntity, SCR_CampaignMilitaryBaseTaskEntity, SCR_ExtendedTask, and SCR_ScenarioFrameworkTask.

◆ SetAuthorID()

void SCR_Task.SetAuthorID ( int authorId)

Sets author id of task.

Parameters
[in]taskID

◆ SetTaskDescription()

void SCR_Task.SetTaskDescription ( LocalizedString taskDesc,
array< LocalizedString > taskDescParams = null )

Sets description of task.

Parameters
[in]taskDesc
[in]taskDescParams

◆ SetTaskIconPath()

void SCR_Task.SetTaskIconPath ( ResourceName iconPath)

Sets task icon path.

Parameters
[in]iconPath

◆ SetTaskIconSetName()

void SCR_Task.SetTaskIconSetName ( string iconSetName)

Sets name of task icon set.

Parameters
[in]iconSetName

◆ SetTaskID()

void SCR_Task.SetTaskID ( string taskID)

Sets ID of task.

Parameters
[in]taskID

◆ SetTaskName()

void SCR_Task.SetTaskName ( LocalizedString taskName,
array< LocalizedString > taskNameParams = null )

Sets name of task.

Parameters
[in]taskName
[in]taskNameParams

◆ SetTaskOwnership()

void SCR_Task.SetTaskOwnership ( SCR_ETaskOwnership ownership)
Parameters
[in]ownership

◆ SetTaskPosition()

void SCR_Task.SetTaskPosition ( vector position)

Sets position of task.

Parameters
[in]position

◆ SetTaskState()

void SCR_Task.SetTaskState ( SCR_ETaskState state)
Parameters
[in]state

Implemented in SCR_AttackTaskEntity, SCR_CampaignMilitaryBaseTaskEntity, SCR_EditorTask, SCR_ExtendedTask, SCR_HoldCampaignMilitaryBaseTaskEntity, SCR_ReconTaskEntity, SCR_ReinforceRequestedTaskEntity, and SCR_RepairRequestedTaskEntity.

◆ SetTaskUIVisibility()

void SCR_Task.SetTaskUIVisibility ( SCR_ETaskUIVisibility visibility)
Parameters
[in]visibility

◆ SetTaskVisibility()

void SCR_Task.SetTaskVisibility ( SCR_ETaskVisibility visibility)
Parameters
[in]visibility

◆ WriteExecutor()

void SCR_Task.WriteExecutor ( ScriptBitWriter writer,
SCR_TaskExecutor executor )
protected

◆ WriteUIInfo()

void SCR_Task.WriteUIInfo ( ScriptBitWriter writer,
SCR_TaskUIInfo info )
protected

Member Data Documentation

◆ m_aAssignees

ref array<ref SCR_TaskExecutor> SCR_Task.m_aAssignees
protected

◆ m_aOwnerExecutors

ref array<ref SCR_TaskExecutor> SCR_Task.m_aOwnerExecutors
protected

◆ m_aOwnerFactionKeys

ref array<string> SCR_Task.m_aOwnerFactionKeys
protected

◆ m_aOwnerGroupIDs

ref array<int> SCR_Task.m_aOwnerGroupIDs
protected

◆ m_DebugText

ref DebugTextWorldSpace SCR_Task.m_DebugText
protected

◆ m_EditableEntityComponent

SCR_EditableEntityComponent SCR_Task.m_EditableEntityComponent
protected

◆ m_eTaskOwnership

SCR_ETaskOwnership SCR_Task.m_eTaskOwnership
protected

◆ m_eTaskState

SCR_ETaskState SCR_Task.m_eTaskState
protected

◆ m_eTaskUIVisibility

SCR_ETaskUIVisibility SCR_Task.m_eTaskUIVisibility
protected

◆ m_eTaskVisibility

SCR_ETaskVisibility SCR_Task.m_eTaskVisibility
protected

◆ m_OnDisplayDataChanged

ref ScriptInvokerVoid SCR_Task.m_OnDisplayDataChanged
protected

◆ m_sTaskID

string SCR_Task.m_sTaskID
protected

◆ m_TaskData

ref SCR_TaskData SCR_Task.m_TaskData
protected

◆ m_TaskSystem

SCR_TaskSystem SCR_Task.m_TaskSystem
protected

◆ m_TaskUIInfo

ref SCR_TaskUIInfo SCR_Task.m_TaskUIInfo
protected

◆ m_UIComponent

SCR_TaskUIComponent SCR_Task.m_UIComponent
protected

◆ s_OnOwnerExecutorAdded

ref SCR_TaskExecutorInvoker SCR_Task.s_OnOwnerExecutorAdded
staticprotected

◆ s_OnOwnerExecutorRemoved

ref SCR_TaskExecutorInvoker SCR_Task.s_OnOwnerExecutorRemoved
staticprotected

◆ s_OnOwnerFactionAdded

ref SCR_TaskFactionInvoker SCR_Task.s_OnOwnerFactionAdded
staticprotected

◆ s_OnOwnerFactionRemoved

ref SCR_TaskFactionInvoker SCR_Task.s_OnOwnerFactionRemoved
staticprotected

◆ s_OnOwnerGroupAdded

ref SCR_TaskGroupInvoker SCR_Task.s_OnOwnerGroupAdded
staticprotected

◆ s_OnOwnerGroupRemoved

ref SCR_TaskGroupInvoker SCR_Task.s_OnOwnerGroupRemoved
staticprotected

◆ s_OnTaskAssigneeAdded

ref SCR_TaskExecutorRequesterInvoker SCR_Task.s_OnTaskAssigneeAdded
staticprotected

◆ s_OnTaskAssigneeRemoved

ref SCR_TaskExecutorRequesterInvoker SCR_Task.s_OnTaskAssigneeRemoved
staticprotected

◆ s_OnTaskOwnershipChanged

ref SCR_TaskOwnershipInvoker SCR_Task.s_OnTaskOwnershipChanged
staticprotected

◆ s_OnTaskStateChanged

ref SCR_TaskStateInvoker SCR_Task.s_OnTaskStateChanged
staticprotected

◆ s_OnTaskUIVisibilityChanged

ref SCR_TaskUIVisibilityInvoker SCR_Task.s_OnTaskUIVisibilityChanged
staticprotected

◆ s_OnTaskVisibilityChanged

ref SCR_TaskVisibilityInvoker SCR_Task.s_OnTaskVisibilityChanged
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.13.2