Classes
class	SCR_ScenarioFrameworkLayerTaskClass

Functions
SCR_ScenarioFrameworkLayerTaskClass SCR_ScenarioFrameworkLayerBaseClass	Attribute (desc:"Name of the task in list of tasks", category:"Task")
bool	GetLayerTaskResolvedBeforeLoad ()
void	SetLayerTaskState (SCR_ETaskState state)
SCR_ScenarioFrameworkTask	GetTask ()
ResourceName	GetTaskPrefab ()
string	GetOverridenObjectDisplayName ()
void	SetOverridenObjectDisplayName (string name)
string	GetTaskTitle ()
string	GetOriginalTaskDescription ()
string	GetTaskDescription ()
SCR_ESFTaskType	GetTaskType ()
SCR_ScenarioFrameworkLayerTask	GetTopMostParentTaskLayer ()
override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false, bool affectRandomization=true, bool deleteSpawnedEntities=true)
override void	DynamicReinit ()
	Initializes layer with same activation type as parent.
override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
override void	FinishInit ()
	Initializes tasks after all children spawned.
void	OnTaskStateChanged (SCR_ETaskState previousState, SCR_ETaskState newState)
void	SetSlotTask (SCR_ScenarioFrameworkSlotTask slotTask)
SCR_ScenarioFrameworkSlotTask	GetSlotTask ()
void	ProcessLayerTaskState (SCR_ETaskState state, bool forced=false, bool calledFromSubtask=false)
void	ProcessSubTasks ()
	This method processes subtasks of a main task, calculates progress bar based on completed subtasks, and updates the layer.
void	InitTask (SCR_ScenarioFrameworkLayerBase layer)
void	SetMarkerUpdateInterval (float newInterval)
void	UpdateMarkerPosition ()
	Updates marker position on map, if it changed from previous one.
vector	GetMarkerPosition ()
bool	CreateTask (vector position)
string	PrepareName ()
string	PrepareDescription ()
void	InitIcon ()
	Initializes task icon based on provided task or slot task. If task icon set name or path is empty, error.
SCR_ScenarioFrameworkLayerTask	GetLayerTaskByName (string name)
void	SetupTask ()
void	SetupSubtask ()
	Sets up a subtask, disables linking data to related tasks, and registers the task as a subtask of a parent task.
void	OnTopParentLayerTaskInitialized (SCR_ScenarioFrameworkLayerBase layer)
void	~SCR_ScenarioFrameworkLayerTask ()
	Removes task from support entity and despawns if in edit mode or task is cancelled.

Function Documentation

◆ Attribute()

SCR_ScenarioFrameworkLayerTaskClass SCR_ScenarioFrameworkLayerBaseClass Attribute	(	desc:"Name of the task in list of tasks"	,
		category:"Task"	)

Returns: Layer task state in current task layer.

Definition at line 1 of file SCR_ScenarioFrameworkLayerTask.c.

◆ CreateTask()

bool CreateTask ( vector position )

protected

Creates a task for the support entity, sets its target faction, and moves it to the specified location.

Returns: true if the task creation is successful, false otherwise.

Definition at line 704 of file SCR_ScenarioFrameworkLayerTask.c.

◆ DynamicDespawn()

override void DynamicDespawn ( SCR_ScenarioFrameworkLayerBase layer )

Dynamically despawns this layer.

Parameters

[in] layer for which this is called.

Definition at line 265 of file SCR_ScenarioFrameworkLayerTask.c.

◆ DynamicReinit()

override void DynamicReinit ( )

Initializes layer with same activation type as parent.

Definition at line 257 of file SCR_ScenarioFrameworkLayerTask.c.

◆ FinishInit()

override void FinishInit ( )

Initializes tasks after all children spawned.

Definition at line 310 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetLayerTaskByName()

SCR_ScenarioFrameworkLayerTask GetLayerTaskByName ( string name )

protected

Retrieves layer task by name.

Parameters

[in] name of target layer task

Definition at line 848 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetLayerTaskResolvedBeforeLoad()

bool GetLayerTaskResolvedBeforeLoad ( )

Returns: Indicates if task was resolved before loading.

Definition at line 117 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetMarkerPosition()

vector GetMarkerPosition ( )

Definition at line 679 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetOriginalTaskDescription()

string GetOriginalTaskDescription ( )

Returns: Original task description string returned by the method.

Definition at line 166 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetOverridenObjectDisplayName()

string GetOverridenObjectDisplayName ( )

Returns: the display name for an overridden object.

Definition at line 145 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetSlotTask()

SCR_ScenarioFrameworkSlotTask GetSlotTask ( )

Returns: related to this layer task.

Definition at line 378 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetTask()

SCR_ScenarioFrameworkTask GetTask ( )

Returns: the current task.

Definition at line 131 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetTaskDescription()

string GetTaskDescription ( )

Returns: the task description, or sets it if an override object display name is provided.

Definition at line 173 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetTaskPrefab()

ResourceName GetTaskPrefab ( )

Returns: The return value represents the prefab for the task in the method.

Definition at line 138 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetTaskTitle()

string GetTaskTitle ( )

Returns: The return value represents the title of the task.

Definition at line 159 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetTaskType()

SCR_ESFTaskType GetTaskType ( )

Returns: Task type enum representing the type of task in the mission.

Definition at line 183 of file SCR_ScenarioFrameworkLayerTask.c.

◆ GetTopMostParentTaskLayer()

SCR_ScenarioFrameworkLayerTask GetTopMostParentTaskLayer ( )

Returns: topmost parent ScenarioFrameworkLayerTask.

Definition at line 190 of file SCR_ScenarioFrameworkLayerTask.c.

◆ InitIcon()

void InitIcon ( )

protected

Initializes task icon based on provided task or slot task. If task icon set name or path is empty, error.

Definition at line 809 of file SCR_ScenarioFrameworkLayerTask.c.

◆ InitTask()

void InitTask ( SCR_ScenarioFrameworkLayerBase layer )

Initializes task, sets up support entity, and handles task state changes based on scenario framework layer.

Parameters

[in] layer for which this task is to be initialized

Definition at line 568 of file SCR_ScenarioFrameworkLayerTask.c.

◆ OnTaskStateChanged()

void OnTaskStateChanged	(	SCR_ETaskState	previousState,
		SCR_ETaskState	newState )

Triggers actions on task finish if not resolved before load.

Parameters

[in]	previousState	represents the current state of the task before it transitions to new state.
[in]	newState	Triggers actions on task finish state change.

Definition at line 321 of file SCR_ScenarioFrameworkLayerTask.c.

◆ OnTopParentLayerTaskInitialized()

void OnTopParentLayerTaskInitialized ( SCR_ScenarioFrameworkLayerBase layer )

protected

Parameters

[in] layer Initializes the task for the top parent layer, adding it as a child task to the parent task.

Definition at line 931 of file SCR_ScenarioFrameworkLayerTask.c.

◆ PrepareDescription()

string PrepareDescription ( )

protected

Prepares task description based on slot task or default task description.

Returns: the task description or briefing for the current task.

Definition at line 791 of file SCR_ScenarioFrameworkLayerTask.c.

◆ PrepareName()

string PrepareName ( )

protected

Prepares task name based on slot task or default task title.

Returns: the task title for the method.

Definition at line 772 of file SCR_ScenarioFrameworkLayerTask.c.

◆ ProcessLayerTaskState()

void ProcessLayerTaskState	(	SCR_ETaskState	state,
		bool	forced = false,
		bool	calledFromSubtask = false )

Processes the state of a task and its subtasks, updating the task's state and progress bar if necessary

Parameters

[in]	state	Processes the state of a task and its subtasks, updating the task's state and progress bar if necessary
[in]	forced	parameter represents a boolean value that determines whether to process the task state even if the conditions for task completion are not met
[in]	calledFromSubtask	parameter represents whether the method is being called from a subtask or not. If true, it

Definition at line 388 of file SCR_ScenarioFrameworkLayerTask.c.

◆ ProcessSubTasks()

void ProcessSubTasks ( )

This method processes subtasks of a main task, calculates progress bar based on completed subtasks, and updates the layer.

Definition at line 523 of file SCR_ScenarioFrameworkLayerTask.c.

◆ RestoreToDefault()

override void RestoreToDefault	(	bool	includeChildren = false,
		bool	reinitAfterRestoration = false,
		bool	affectRandomization = true,
		bool	deleteSpawnedEntities = true )

Restores default settings, clears children, removes spawned entities, optionally reinitializes after restoration.

Parameters

[in]	includeChildren	Restores default settings for this entity and its children if includeChildren is true.
[in]	reinitAfterRestoration	Restores entity to default state, optionally reinitializes after restoration.
[in]	affectRandomization	determines whether to clear all randomly spawned children entities after restoring default settings.

Definition at line 211 of file SCR_ScenarioFrameworkLayerTask.c.

◆ SetLayerTaskState()

void SetLayerTaskState ( SCR_ETaskState state )

Parameters

[in] state Sets layer task state

Definition at line 124 of file SCR_ScenarioFrameworkLayerTask.c.

◆ SetMarkerUpdateInterval()

void SetMarkerUpdateInterval ( float newInterval )

Set interval for updating marker position

Parameters

[in] newInterval for new interval in ms. If set to 0, updates will be disabled

Definition at line 655 of file SCR_ScenarioFrameworkLayerTask.c.

◆ SetOverridenObjectDisplayName()

void SetOverridenObjectDisplayName ( string name )

Parameters

[in] name Sets object display name override.

Definition at line 152 of file SCR_ScenarioFrameworkLayerTask.c.

◆ SetSlotTask()

void SetSlotTask ( SCR_ScenarioFrameworkSlotTask slotTask )

Parameters

[in] slotTask related to this layer task.

Definition at line 369 of file SCR_ScenarioFrameworkLayerTask.c.

◆ SetupSubtask()

void SetupSubtask ( )

protected

Sets up a subtask, disables linking data to related tasks, and registers the task as a subtask of a parent task.

Definition at line 898 of file SCR_ScenarioFrameworkLayerTask.c.

◆ SetupTask()

void SetupTask ( )

protected

Definition at line 858 of file SCR_ScenarioFrameworkLayerTask.c.

◆ UpdateMarkerPosition()

void UpdateMarkerPosition ( )

Updates marker position on map, if it changed from previous one.

Definition at line 665 of file SCR_ScenarioFrameworkLayerTask.c.

◆ ~SCR_ScenarioFrameworkLayerTask()

void ~SCR_ScenarioFrameworkLayerTask ( )

protected

Removes task from support entity and despawns if in edit mode or task is cancelled.

Definition at line 947 of file SCR_ScenarioFrameworkLayerTask.c.

Classes

Functions

Function Documentation

◆ Attribute()

◆ CreateTask()

◆ DynamicDespawn()

◆ DynamicReinit()

◆ FinishInit()

◆ GetLayerTaskByName()

◆ GetLayerTaskResolvedBeforeLoad()

◆ GetMarkerPosition()

◆ GetOriginalTaskDescription()

◆ GetOverridenObjectDisplayName()

◆ GetSlotTask()

◆ GetTask()

◆ GetTaskDescription()

◆ GetTaskPrefab()

◆ GetTaskTitle()

◆ GetTaskType()

◆ GetTopMostParentTaskLayer()

◆ InitIcon()

◆ InitTask()

◆ OnTaskStateChanged()

◆ OnTopParentLayerTaskInitialized()

◆ PrepareDescription()

◆ PrepareName()

◆ ProcessLayerTaskState()

◆ ProcessSubTasks()

◆ RestoreToDefault()

◆ SetLayerTaskState()

◆ SetMarkerUpdateInterval()

◆ SetOverridenObjectDisplayName()

◆ SetSlotTask()

◆ SetupSubtask()

◆ SetupTask()

◆ UpdateMarkerPosition()

◆ ~SCR_ScenarioFrameworkLayerTask()