Inheritance diagram for SCR_ScenarioFrameworkTask:

[legend]

Public Member Functions
void	SetTaskState (SCR_TaskState state)

void	SetLayerTask (SCR_ScenarioFrameworkLayerTask layer)

SCR_ScenarioFrameworkLayerTask	GetLayerTask ()

override void	OnStateChanged (SCR_TaskState previousState, SCR_TaskState newState)
	An event called when the state of this task has been changed.

override void	Finish (bool showMsg=true)
	Finishes mission based on player's faction, shows message if player's faction matches target faction.

void	SetTaskAsset (IEntity object)

void	RehookTaskAsset (IEntity object)
	Updates linked entity for this task.

IEntity	GetAsset ()

void	SetSlotTask (SCR_ScenarioFrameworkSlotTask slotTask)

SCR_ScenarioFrameworkSlotTask	GetSlotTask ()

SCR_ScenarioFrameworkTaskSupportEntity	GetSupportEntity ()

void	SetTaskExecutionBriefing (string text)

string	GetTaskExecutionBriefing ()

void	SetSpawnedEntityName (string name)

string	GetSpawnedEntityName ()

override string	GetTaskListTaskText ()

override void	Serialize (ScriptBitWriter writer)
	Serializes task execution briefing and spawned entity name.

override void	Deserialize (ScriptBitReader reader)
	Deserializes task execution briefing and spawned entity name from ScriptBitReader.

void	Init ()
	Initializes support entity, sets task entity, updates blacklist if necessary.

override void	EOnInit (IEntity owner)
	Initializes task manager if it exists, otherwise returns without action.

Public Member Functions inherited from SCR_BaseTask
void	OnDelete ()

bool	NotifyAssignment ()

bool	NotifyUnassign ()

void	DoNotifyAssignment (int assigneeID)

void	DoNotifyUnassign (int assigneeID)

SCR_ERadioMsg	GetAssignMessage ()

SCR_ERadioMsg	GetUnassignMessage ()

ResourceName	GetMapUIElementResourceName ()

string	GetMapDescriptorText ()

void	OnMapOpen (MapConfiguration config)

void	OnHoverItem (MapItem item)

string	GetFullTaskIconName ()

string	GetTaskMapIconName ()

string	GetTaskListIconNamePrefix ()

string	GetTaskListIconName ()

string	GetTaskListTaskTitle ()

string	GetMajorModifier ()

string	GetTaskListTaskText ()

Widget	GetParentWidget (notnull Widget rootWidget)

ResourceName	GetIconImageset ()

void	SetHUDIcon ()

void	SetWidgetIcon (ImageWidget image)

void	ClearWidgetIcon ()
	Remove icon assigned to this task.

void	UpdateMapTaskIcon ()

void	UpdatePriorityMapTaskIcon ()

bool	AssignTaskToAI (AIAgent agent)

string	GetIconName ()

ResourceName	GetImageSetName ()

string	GetIconSuffix ()

string	GetTitleIconString ()

void	SetTitleWidgetText (notnull TextWidget textWidget, string taskText)

string	GetTitleText ()

void	SetDescriptionWidgetText (notnull TextWidget textWidget, string taskText)

Widget	GenerateTaskDescriptionUI (notnull Widget rootWidget, array< Widget > widgets)

void	UpdateTaskListAssignee ()

void	OnAssigneeKilled ()

void	CreateMapUIIcon ()

Faction	GetTargetFaction ()
	Returns the faction that should complete this task.

void	SetTargetFaction (Faction targetFaction)
	Sets the faction that should complete this task.

string	GetFinishText ()
	Returns a text informing about the task being finished.

bool	IsAssigned ()
	Returns whether the task is assigned to someone or not.

string	GetAllAssigneeNamesString ()
	Returns a string with all the assignees on this task in following format: "PlayerA, PlayerB, ..., PlayerN".

void	CheckAssigneeTimeout ()
	Checks all the assignees for timeout, if their time is up, they get unassigned.

void	SetLastAssigneeAddedTimestamp (float timestamp)

void	SetIndividual (bool individual)
	Set this task as task for an individual.

bool	IsIndividual ()
	Returns whether this task is for an individual or not.

void	SetIsPriority (bool isPrio)

bool	IsPriority ()

bool	IsAssignable ()

bool	CanBeAssigned (out SCR_ECannotAssignReasons reason, int playerID=-1)
	Returns whether this task can be assigned to the player with the given player ID If playerID == -1, the local player is used as the target.

float	GetLastAssigneeAddedTimestamp ()
	Returns the timestamp of last add assignee event.

float	GetAssigneeTimeLeft ()
	Returns time left the assignee of this task has to finish it, after that they get automatically unassigned.

void	SetTaskID (int taskID)
	Sets an ID of this task.

int	GetTaskID ()
	Returns an ID of this task.

SCR_TaskState	GetTaskState ()
	Returns the state of this task.

void	SetTitle (string title)

string	GetTitle ()
	Return the title of this task.

void	SetDescription (string description)

string	GetDescription ()
	Return the description of this task.

SCR_BaseTaskExecutor	GetAssignee ()
	Returns the first assignee of this task.

int	GetAssignees (out array< SCR_BaseTaskExecutor > assignees)
	Returns assignees of this task.

int	GetAssigneeCount ()

void	Cancel (bool showMsg=true)

void	Remove ()
	Marks the task as removed.

void	Create (bool showMsg=true)
	When the task is created.

void	Finish (bool showMsg=true)
	Marks the task as finished.

void	Fail (bool showMsg=true)
	Fails the task.

void	RemoveAllAssignees ()
	Removes every assignee from this task.

void	RemoveAssignee (SCR_BaseTaskExecutor assignee, SCR_EUnassignReason reason)
	Removes an assignee, specified as a parameter, from this task.

void	AddAssignee (SCR_BaseTaskExecutor assignee, float timestamp)
	Adds a new assignee, specified as a parameter, to this task.

void	InitOnSpawn (int pid, IEntity ent)

void	ToggleHUDIcon (bool show, bool fade=true)

void	UpdateHUDIcon ()

Widget	GetTaskIconkWidget ()

void	SetTaskIconWidget (Widget w)

void	SetState (SCR_TaskState state)
	Changes the state of this task to the parameter.

void	RegisterTaskUpdate (SCR_ETaskEventMask TaskEventMask)
	Registers task event mask for OnTaskUpdate.

void	Serialize (ScriptBitWriter writer)

void	Deserialize (ScriptBitReader reader)

override void	EOnInit (IEntity owner)

void	SCR_BaseTask (IEntitySource src, IEntity parent)

void	~SCR_BaseTask ()

Public Attributes
string	m_sTaskIntroVoiceline

Protected Member Functions
bool	SetSupportEntity ()
	Sets support entity for task.

Protected Member Functions inherited from SCR_BaseTask
void	ShowPopUpNotification (string subtitle)

void	UpdateMapInfo ()

bool	DoneByAssignee ()

void	ShowTaskProgress (bool showMsg=true)

void	ShowAvailableTask (bool afterAssigneeRemoved=false)
	Shows a message informing about this task being available.

bool	IsAssignedToLocalPlayer ()
	Returns whether this task is assigned to the local player.

void	OnAssigneeRemoved (SCR_BaseTaskExecutor oldAssignee)
	An event called when an assignee has been removed from this task.

void	OnAssigneeAdded (SCR_BaseTaskExecutor newAssignee)
	An event called when a new assignee has been added to this task.

void	OnStateChanged (SCR_TaskState previousState, SCR_TaskState newState)
	An event called when the state of this task has been changed.

Protected Attributes
IEntity	m_Asset

SCR_ScenarioFrameworkTaskSupportEntity	m_SupportEntity

SCR_ScenarioFrameworkLayerTask	m_LayerTask

SCR_ScenarioFrameworkSlotTask	m_SlotTask

string	m_sTaskExecutionBriefing

string	m_sSpawnedEntityName

Protected Attributes inherited from SCR_BaseTask
string	m_sName

string	m_sDescription

bool	m_bAssignable

bool	m_bIndividualTask

string	m_sMapIconName

string	m_sTaskListIconNamePrefix

string	m_sTaskListIconName

string	m_sMajorModifier

ResourceName	m_sMapUIElementResourceName

ResourceName	m_sIconImageset

SCR_ERadioMsg	m_eAssignMessage

bool	m_bNotifyAssignment

SCR_ERadioMsg	m_eUnassignMessage

bool	m_bNotifyUnassign

ResourceName	m_sHUDIcon

Faction	m_TargetFaction = null

int	m_iTaskID = INVALID_TASK_ID

float	m_fAssigneeTimeLimit = DEFAULT_ASSIGNEE_TIME_LIMIT

float	m_fLastAssigneeAddedTimestamp = INVALID_TIMESTAMP

ref array< SCR_BaseTaskExecutor >	m_aAssignees = new array<SCR_BaseTaskExecutor>()

SCR_TaskState	m_eState

SCR_BaseTaskExecutor	m_TimedOutAssignee = null

float	m_fAssigneeTimeoutTimestamp = INVALID_TIMESTAMP

SCR_MapDescriptorComponent	m_MapDescriptor

ImageWidget	m_wHUDIcon

Widget	m_wMapTaskIcon

Widget	m_wTaskListDescription

bool	m_bIsPriority

SCR_PlayerFactionAffiliationComponent	m_sPlyFactionAffilComp

float	m_fMajorSize = 80

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseTask
static const string	TASK_AMOUNT_COMPLETED_TEXT = "#AR-Tasks_AmountCompleted"

static const string	TASK_PROGRESS_TEXT = "#AR-Tasks_StatusProgress-UC"

static const string	TASK_FINISHED_TEXT = "#AR-Tasks_StatusFinished-UC"

static const string	TASK_AVAILABLE_TEXT = "#AR-Tasks_StatusNew-UC"

static const string	TASK_HINT_TEXT = "#AR-Tasks_Hint"

static const string	TASK_CANCELLED_TEXT = "#AR-Tasks_StatusCancelled-UC"

static const string	TASK_COMPLETED_TEXT = "#AR-Tasks_StatusCompleted-UC"

static const string	TASK_FAILED_TEXT = "#AR-Tasks_StatusFailed-UC"

static const float	DEFAULT_ASSIGNEE_TIME_LIMIT = 1800

static const float	DEFAULT_ASSIGNEE_TIMEOUT_TIME = 60

static const int	INVALID_TIMESTAMP = -1

static const int	INVALID_TASK_ID = -1

static int	s_iCurrentTaskID = 0

const string	TASK_BG_M = "Icon_M_Task_BG"

const string	TASK_O_M = "Icon_M_Task_Outline"

const string	TASK_BG = "Icon_Task_BG"

const string	TASK_O = "Icon_Task_Outline"

const string	TASK_H = "Icon_M_Task_Hover"

const string	Task_S = "TaskIconSymbol"

Static Protected Attributes inherited from SCR_BaseTask
static const float	PLATFORM_ICON_SIZE = 2

Member Function Documentation

◆ Deserialize()

override void SCR_ScenarioFrameworkTask.Deserialize ( ScriptBitReader reader )

Deserializes task execution briefing and spawned entity name from ScriptBitReader.

Parameters

[in] reader Reads serialized data from the provided ScriptBitReader object, deserializing it into the object's fields.

Implements SCR_BaseTask.

◆ EOnInit()

override void SCR_ScenarioFrameworkTask.EOnInit ( IEntity owner )

Initializes task manager if it exists, otherwise returns without action.

Parameters

[in] owner The owner represents the entity that initializes this method, typically an object in the game world.

Implements SCR_BaseTask.

◆ Finish()

override void SCR_ScenarioFrameworkTask.Finish ( bool showMsg = true )

Finishes mission based on player's faction, shows message if player's faction matches target faction.

Parameters

[in] showMsg Determines if local player's faction matches target faction for message display.

Implements SCR_BaseTask.

◆ 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.

◆ GetSpawnedEntityName()

string SCR_ScenarioFrameworkTask.GetSpawnedEntityName ( )

Returns: The name of the entity spawned by the method.

◆ GetSupportEntity()

SCR_ScenarioFrameworkTaskSupportEntity SCR_ScenarioFrameworkTask.GetSupportEntity ( )

Returns: Support entity.

◆ GetTaskExecutionBriefing()

string SCR_ScenarioFrameworkTask.GetTaskExecutionBriefing ( )

Returns: Task execution briefing string.

◆ GetTaskListTaskText()

override string SCR_ScenarioFrameworkTask.GetTaskListTaskText ( )

Returns: formatted string with translated description and spawned entity name.

Implements SCR_BaseTask.

◆ Init()

void SCR_ScenarioFrameworkTask.Init ( )

Initializes support entity, sets task entity, updates blacklist if necessary.

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

◆ OnStateChanged()

override void SCR_ScenarioFrameworkTask.OnStateChanged	(	SCR_TaskState	previousState,
		SCR_TaskState	newState
	)

An event called when the state of this task has been changed.

Implements SCR_BaseTask.

◆ RehookTaskAsset()

void SCR_ScenarioFrameworkTask.RehookTaskAsset ( 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_TaskDestroyObject, and SCR_TaskKill.

◆ Serialize()

override void SCR_ScenarioFrameworkTask.Serialize ( ScriptBitWriter writer )

Serializes task execution briefing and spawned entity name.

Parameters

[in] writer Writer is used for serializing object data into a stream.

Implements SCR_BaseTask.

◆ 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.

◆ SetSpawnedEntityName()

void SCR_ScenarioFrameworkTask.SetSpawnedEntityName ( string name )

Parameters

[in] name Represents the name for the spawned entity in the game world.

◆ SetSupportEntity()

bool SCR_ScenarioFrameworkTask.SetSupportEntity ( )

protected

Sets support entity for task.

Returns: true if a support entity is found, false otherwise.

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

◆ SetTaskAsset()

void SCR_ScenarioFrameworkTask.SetTaskAsset ( IEntity object )

Parameters

[in] object Sets the asset for the task, represented by an entity object.

◆ SetTaskExecutionBriefing()

void SCR_ScenarioFrameworkTask.SetTaskExecutionBriefing ( string text )

Parameters

[in] text Sets the briefing for task execution.

◆ SetTaskState()

void SCR_ScenarioFrameworkTask.SetTaskState ( SCR_TaskState state )

Parameters

[in] state sets state of the task.

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

◆ m_sSpawnedEntityName

string SCR_ScenarioFrameworkTask.m_sSpawnedEntityName

protected

◆ m_sTaskExecutionBriefing

string SCR_ScenarioFrameworkTask.m_sTaskExecutionBriefing

protected

◆ m_sTaskIntroVoiceline

string SCR_ScenarioFrameworkTask.m_sTaskIntroVoiceline

◆ m_SupportEntity

SCR_ScenarioFrameworkTaskSupportEntity SCR_ScenarioFrameworkTask.m_SupportEntity

protected

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

Game/ScenarioFramework/Tasks/SCR_ScenarioFrameworkTask.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ Deserialize()

◆ EOnInit()

◆ Finish()

◆ GetAsset()

◆ GetLayerTask()

◆ GetSlotTask()

◆ GetSpawnedEntityName()

◆ GetSupportEntity()

◆ GetTaskExecutionBriefing()

◆ GetTaskListTaskText()

◆ Init()

◆ OnStateChanged()

◆ RehookTaskAsset()

◆ Serialize()

◆ SetLayerTask()

◆ SetSlotTask()

◆ SetSpawnedEntityName()

◆ SetSupportEntity()

◆ SetTaskAsset()

◆ SetTaskExecutionBriefing()

◆ SetTaskState()

Member Data Documentation

◆ m_Asset

◆ m_LayerTask

◆ m_SlotTask

◆ m_sSpawnedEntityName

◆ m_sTaskExecutionBriefing

◆ m_sTaskIntroVoiceline

◆ m_SupportEntity