Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_ExtendedTask Class Reference
Inheritance diagram for SCR_ExtendedTask:
SCR_ScenarioFrameworkTask SCR_ScenarioFrameworkTaskArea SCR_TaskDefend SCR_TaskDestroyObject SCR_TaskKill SCR_ScenarioFrameworkTaskClearArea SCR_ScenarioFrameworkTaskExtract

Protected Member Functions

LocalizedString GetCustomSubtaskDescription ()
void SetCustomSubtaskDescription (LocalizedString subTaskDescription)
void Rpc_SetCustomSubtaskDescription (LocalizedString subTaskDescription)
bool IsChildTask ()
bool HasChildTasks ()
int GetChildTaskCount ()
bool CanBeAssigned ()
int GetNodeDepth ()
SCR_Task GetParentTask ()
void SetParentTask (SCR_ExtendedTask parentTask)
void Rpc_SetParentTask (RplId parentTaskRplID)
array< SCR_Task > GetChildTasks ()
bool AddChildTask (SCR_Task task)
void Rpc_AddChildTask (RplId taskRplID)
bool RemoveChildTask (SCR_Task task)
void Rpc_RemoveChildTask (RplId taskRplID)
float GetTaskProgress ()
void SetTaskProgress (float percentage, bool changeState=true)
void Rpc_SetTaskProgress (float percentage, float previousProgress)
void AddTaskProgress (float percentage, bool changeState=true)
void Rpc_AddTaskProgress (float percentage)
void RemoveTaskProgress (float percentage, bool changeState=true)
void Rpc_RemoveTaskProgress (float percentage)
bool CanTaskProgressBeShown ()
void ShowTaskProgress (bool enable)
void Rpc_ShowTaskProgress (bool enable)
override bool AddTaskAssignee (SCR_TaskExecutor executor, bool listenToInvokers=true, int requesterID=0)
override bool RemoveTaskAssignee (SCR_TaskExecutor executor, bool listenToInvokers=true, int requesterID=0)
void Rpc_AddOwnerFactionKey (FactionKey factionKey)
void Rpc_RemoveOwnerFactionKey (FactionKey factionKey)
void Rpc_AddOwnerGroupID (int groupID)
void Rpc_RemoveOwnerGroupID (int groupID)
override bool AddOwnerExecutor (SCR_TaskExecutor executor)
override bool RemoveOwnerExecutor (SCR_TaskExecutor executor)
override void SetTaskState (SCR_ETaskState state)
void Rpc_SetTaskOwnership (SCR_ETaskOwnership ownership)
void Rpc_SetTaskVisibility (SCR_ETaskVisibility visibility)
SCR_ChildTaskInvoker GetOnChildTaskAdded ()
SCR_ChildTaskInvoker GetOnChildTaskRemoved ()
ScriptInvokerFloat2 GetOnProgressChanged ()
bool RplSave (ScriptBitWriter writer)
bool RplLoad (ScriptBitReader reader)
void InitializeData ()
void InitializeChildTasks ()
override void EOnInit (IEntity owner)

Protected Attributes

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
const float MIN_TASK_PROGRESSION_PERCENTAGE = 0.0
const float MAX_TASK_PROGRESSION_PERCENTAGE = 100.0

Detailed Description

Definition at line 9 of file SCR_ExtendedTask.c.

Member Function Documentation

◆ AddChildTask()

bool SCR_ExtendedTask::AddChildTask ( SCR_Task task)
inlineprotected

Tries to parent task to this one

Parameters
[in]task
Returns

Definition at line 206 of file SCR_ExtendedTask.c.

◆ AddOwnerExecutor()

override bool SCR_ExtendedTask::AddOwnerExecutor ( SCR_TaskExecutor executor)
inlineprotected

Adds given executor to task as an owner/viewer depending on task ownership and visibility

Parameters
[in]executor
Returns

Definition at line 735 of file SCR_ExtendedTask.c.

◆ AddTaskAssignee()

override bool SCR_ExtendedTask::AddTaskAssignee ( SCR_TaskExecutor executor,
bool listenToInvokers = true,
int requesterID = 0 )
inlineprotected

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

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

Definition at line 560 of file SCR_ExtendedTask.c.

◆ AddTaskProgress()

void SCR_ExtendedTask::AddTaskProgress ( float percentage,
bool changeState = true )
inlineprotected

Adds progress to task in percentage

Parameters
[in]percentage
Returns

Definition at line 415 of file SCR_ExtendedTask.c.

◆ CanBeAssigned()

bool SCR_ExtendedTask::CanBeAssigned ( )
inlineprotected

Returns true if this task is assignable to entities; Will always return false if it is a parent task

Returns

Definition at line 97 of file SCR_ExtendedTask.c.

◆ CanTaskProgressBeShown()

bool SCR_ExtendedTask::CanTaskProgressBeShown ( )
inlineprotected

Returns true if task progress can be shown

Returns

Definition at line 518 of file SCR_ExtendedTask.c.

◆ EOnInit()

override void SCR_ExtendedTask::EOnInit ( IEntity owner)
inlineprotected

Definition at line 1075 of file SCR_ExtendedTask.c.

◆ GetChildTaskCount()

int SCR_ExtendedTask::GetChildTaskCount ( )
inlineprotected

Returns exact number of tasks parented to this one

Returns

Definition at line 85 of file SCR_ExtendedTask.c.

◆ GetChildTasks()

array< SCR_Task > SCR_ExtendedTask::GetChildTasks ( )
inlineprotected

Returns array of tasks parented to this one

Returns

Definition at line 176 of file SCR_ExtendedTask.c.

◆ GetCustomSubtaskDescription()

LocalizedString SCR_ExtendedTask::GetCustomSubtaskDescription ( )
inlineprotected

Returns custom description string for subtasks

Returns

Definition at line 36 of file SCR_ExtendedTask.c.

◆ GetNodeDepth()

int SCR_ExtendedTask::GetNodeDepth ( )
inlineprotected

Returns depth within the task hierarchy; Parent task is always 0, while child tasks are 1

Returns

Definition at line 105 of file SCR_ExtendedTask.c.

◆ GetOnChildTaskAdded()

SCR_ChildTaskInvoker SCR_ExtendedTask::GetOnChildTaskAdded ( )
inlineprotected
Returns

Definition at line 888 of file SCR_ExtendedTask.c.

◆ GetOnChildTaskRemoved()

SCR_ChildTaskInvoker SCR_ExtendedTask::GetOnChildTaskRemoved ( )
inlineprotected
Returns

Definition at line 899 of file SCR_ExtendedTask.c.

◆ GetOnProgressChanged()

ScriptInvokerFloat2 SCR_ExtendedTask::GetOnProgressChanged ( )
inlineprotected
Returns

Definition at line 910 of file SCR_ExtendedTask.c.

◆ GetParentTask()

SCR_Task SCR_ExtendedTask::GetParentTask ( )
inlineprotected

Returns parent task or null if there is none

Returns

Definition at line 117 of file SCR_ExtendedTask.c.

◆ GetTaskProgress()

float SCR_ExtendedTask::GetTaskProgress ( )
inlineprotected

Returns progress of task as float; Value ranges from 0-100

Returns

Definition at line 323 of file SCR_ExtendedTask.c.

◆ HasChildTasks()

bool SCR_ExtendedTask::HasChildTasks ( )
inlineprotected

Returns true if other tasks are parented to this one

Returns

Definition at line 76 of file SCR_ExtendedTask.c.

◆ InitializeChildTasks()

void SCR_ExtendedTask::InitializeChildTasks ( )
inlineprotected

Definition at line 1043 of file SCR_ExtendedTask.c.

◆ InitializeData()

void SCR_ExtendedTask::InitializeData ( )
inlineprotected

Definition at line 1018 of file SCR_ExtendedTask.c.

◆ IsChildTask()

bool SCR_ExtendedTask::IsChildTask ( )
inlineprotected

Returns true if this task is parented to another

Returns

Definition at line 68 of file SCR_ExtendedTask.c.

◆ RemoveChildTask()

bool SCR_ExtendedTask::RemoveChildTask ( SCR_Task task)
inlineprotected

Tries to unparent task from this one

Parameters
[in]task
Returns

Definition at line 263 of file SCR_ExtendedTask.c.

◆ RemoveOwnerExecutor()

override bool SCR_ExtendedTask::RemoveOwnerExecutor ( SCR_TaskExecutor executor)
inlineprotected

Removes given executor from task as an owner/viewer depending on task ownership and visibility

Parameters
[in]executor
Returns

Definition at line 768 of file SCR_ExtendedTask.c.

◆ RemoveTaskAssignee()

override bool SCR_ExtendedTask::RemoveTaskAssignee ( SCR_TaskExecutor executor,
bool listenToInvokers = true,
int requesterID = 0 )
inlineprotected

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

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

Definition at line 584 of file SCR_ExtendedTask.c.

◆ RemoveTaskProgress()

void SCR_ExtendedTask::RemoveTaskProgress ( float percentage,
bool changeState = true )
inlineprotected

Removes progress from task in percentage

Parameters
[in]percentage
Returns

Definition at line 470 of file SCR_ExtendedTask.c.

◆ Rpc_AddChildTask()

void SCR_ExtendedTask::Rpc_AddChildTask ( RplId taskRplID)
inlineprotected

Definition at line 233 of file SCR_ExtendedTask.c.

◆ Rpc_AddOwnerFactionKey()

void SCR_ExtendedTask::Rpc_AddOwnerFactionKey ( FactionKey factionKey)
inlineprotected

Definition at line 621 of file SCR_ExtendedTask.c.

◆ Rpc_AddOwnerGroupID()

void SCR_ExtendedTask::Rpc_AddOwnerGroupID ( int groupID)
inlineprotected

Definition at line 677 of file SCR_ExtendedTask.c.

◆ Rpc_AddTaskProgress()

void SCR_ExtendedTask::Rpc_AddTaskProgress ( float percentage)
inlineprotected

Definition at line 454 of file SCR_ExtendedTask.c.

◆ Rpc_RemoveChildTask()

void SCR_ExtendedTask::Rpc_RemoveChildTask ( RplId taskRplID)
inlineprotected

Definition at line 297 of file SCR_ExtendedTask.c.

◆ Rpc_RemoveOwnerFactionKey()

void SCR_ExtendedTask::Rpc_RemoveOwnerFactionKey ( FactionKey factionKey)
inlineprotected

Definition at line 649 of file SCR_ExtendedTask.c.

◆ Rpc_RemoveOwnerGroupID()

void SCR_ExtendedTask::Rpc_RemoveOwnerGroupID ( int groupID)
inlineprotected

Definition at line 705 of file SCR_ExtendedTask.c.

◆ Rpc_RemoveTaskProgress()

void SCR_ExtendedTask::Rpc_RemoveTaskProgress ( float percentage)
inlineprotected

Definition at line 503 of file SCR_ExtendedTask.c.

◆ Rpc_SetCustomSubtaskDescription()

void SCR_ExtendedTask::Rpc_SetCustomSubtaskDescription ( LocalizedString subTaskDescription)
inlineprotected

Definition at line 56 of file SCR_ExtendedTask.c.

◆ Rpc_SetParentTask()

void SCR_ExtendedTask::Rpc_SetParentTask ( RplId parentTaskRplID)
inlineprotected

Definition at line 147 of file SCR_ExtendedTask.c.

◆ Rpc_SetTaskOwnership()

void SCR_ExtendedTask::Rpc_SetTaskOwnership ( SCR_ETaskOwnership ownership)
inlineprotected

Definition at line 829 of file SCR_ExtendedTask.c.

◆ Rpc_SetTaskProgress()

void SCR_ExtendedTask::Rpc_SetTaskProgress ( float percentage,
float previousProgress )
inlineprotected

Definition at line 399 of file SCR_ExtendedTask.c.

◆ Rpc_SetTaskVisibility()

void SCR_ExtendedTask::Rpc_SetTaskVisibility ( SCR_ETaskVisibility visibility)
inlineprotected

Definition at line 858 of file SCR_ExtendedTask.c.

◆ Rpc_ShowTaskProgress()

void SCR_ExtendedTask::Rpc_ShowTaskProgress ( bool enable)
inlineprotected

Definition at line 543 of file SCR_ExtendedTask.c.

◆ RplLoad()

bool SCR_ExtendedTask::RplLoad ( ScriptBitReader reader)
inlineprotected

Definition at line 968 of file SCR_ExtendedTask.c.

◆ RplSave()

bool SCR_ExtendedTask::RplSave ( ScriptBitWriter writer)
inlineprotected

Definition at line 928 of file SCR_ExtendedTask.c.

◆ SetCustomSubtaskDescription()

void SCR_ExtendedTask::SetCustomSubtaskDescription ( LocalizedString subTaskDescription)
inlineprotected

Sets custom description string for subtasks

Returns

Definition at line 48 of file SCR_ExtendedTask.c.

◆ SetParentTask()

void SCR_ExtendedTask::SetParentTask ( SCR_ExtendedTask parentTask)
inlineprotected

Definition at line 131 of file SCR_ExtendedTask.c.

◆ SetTaskProgress()

void SCR_ExtendedTask::SetTaskProgress ( float percentage,
bool changeState = true )
inlineprotected

Sets progress of task in percentage

Parameters
[in]percentage
Returns

Definition at line 336 of file SCR_ExtendedTask.c.

◆ SetTaskState()

override void SCR_ExtendedTask::SetTaskState ( SCR_ETaskState state)
inlineprotected

Definition at line 798 of file SCR_ExtendedTask.c.

◆ ShowTaskProgress()

void SCR_ExtendedTask::ShowTaskProgress ( bool enable)
inlineprotected
Parameters
[in]enable
Returns

Definition at line 531 of file SCR_ExtendedTask.c.

Member Data Documentation

◆ m_bEnableProgress

bool SCR_ExtendedTask::m_bEnableProgress
protected

Definition at line 15 of file SCR_ExtendedTask.c.

◆ m_bLinkDataToRelatedTasks

bool SCR_ExtendedTask::m_bLinkDataToRelatedTasks
protected

Definition at line 12 of file SCR_ExtendedTask.c.

◆ m_eCachedTaskState

SCR_ETaskState SCR_ExtendedTask::m_eCachedTaskState
protected

Definition at line 23 of file SCR_ExtendedTask.c.

◆ m_fProgress

float SCR_ExtendedTask::m_fProgress
protected

Definition at line 18 of file SCR_ExtendedTask.c.

◆ m_OnChildTaskAdded

ref SCR_ChildTaskInvoker SCR_ExtendedTask::m_OnChildTaskAdded
protected

Definition at line 25 of file SCR_ExtendedTask.c.

◆ m_OnChildTaskRemoved

ref SCR_ChildTaskInvoker SCR_ExtendedTask::m_OnChildTaskRemoved
protected

Definition at line 26 of file SCR_ExtendedTask.c.

◆ m_OnProgressChanged

ref ScriptInvokerFloat2 SCR_ExtendedTask::m_OnProgressChanged
protected

Definition at line 28 of file SCR_ExtendedTask.c.

◆ m_sCustomSubtaskDescription

LocalizedString SCR_ExtendedTask::m_sCustomSubtaskDescription
protected

Definition at line 21 of file SCR_ExtendedTask.c.

◆ MAX_TASK_PROGRESSION_PERCENTAGE

const float SCR_ExtendedTask::MAX_TASK_PROGRESSION_PERCENTAGE = 100.0
protected

Definition at line 31 of file SCR_ExtendedTask.c.

◆ MIN_TASK_PROGRESSION_PERCENTAGE

const float SCR_ExtendedTask::MIN_TASK_PROGRESSION_PERCENTAGE = 0.0
protected

Definition at line 30 of file SCR_ExtendedTask.c.

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