SCR_ScenarioFrameworkTaskSupportEntity Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkTaskSupportEntity:

Public Member Functions
override void	FinishTask (notnull SCR_BaseTask task)
	Finishes scenario task, checks conditions, and calls superclass method.
IEntity	GetTaskEntity ()
void	SetTaskEntity (IEntity entity)
SCR_BaseTask	CreateTask (SCR_ScenarioFrameworkLayerTask layer)
	Spawns entity for scenario layer task and creates base task.
void	SetTaskPrefab (ResourceName sTaskPrefab)
void	SetSpawnedEntityName (notnull SCR_ScenarioFrameworkTask task, string name)
	Sets spawned entity name for a task in scenario framework.
void	RPC_SpawnedEntityName (int taskID, string name)
	Sets spawned entity name for a scenario task.
void	SetTaskExecutionBriefing (notnull SCR_ScenarioFrameworkTask task, string description)
	Sets task execution briefing for given task with description.
void	RPC_TaskExecutionBriefing (int taskID, string description)
	Sets task execution briefing description for specified task ID.
Public Member Functions inherited from SCR_BaseTaskSupportEntity
void	SetTargetFaction (notnull SCR_BaseTask task, notnull Faction faction)
void	RPC_SetTargetFaction (int taskID, int factionIndex)
SCR_BaseTask	CreateTask ()
void	Initialize ()
void	OnTaskListOpen (notnull SCR_UITaskManagerComponent uiTaskManagerComponent)
ResourceName	GetTaskDescriptionWidgetResource ()
ResourceName	GetResourceName ()
Resource	GetTaskPrefab ()
void	MoveTask (vector newPosition, int taskID)
void	RPC_MoveTask (int taskID, vector newPosition)
void	AssignTask (notnull SCR_BaseTask task, notnull SCR_BaseTaskExecutor assignee, bool forced=false)
void	RPC_AssignTask (int playerID, int taskID, float timestamp, bool forced)
	Assigns a task on clients.
void	CancelTask (int taskID)
void	FinishTask (notnull SCR_BaseTask task)
void	FailTask (notnull SCR_BaseTask task)
void	UnassignTask (notnull SCR_BaseTask task, notnull SCR_BaseTaskExecutor assignee, SCR_EUnassignReason reason)
void	RPC_UnassignTask (int taskID, int playerID, SCR_EUnassignReason reason)
	Assigns a task on clients.
void	SetTaskState (notnull SCR_BaseTask task, SCR_TaskState state)
void	RPC_SetTaskState (int taskID, SCR_TaskState state)
void	SetTaskDescription (notnull SCR_BaseTask task, string description)
void	RPC_SetTaskDescription (int taskID, string description)
void	SetTaskTitle (notnull SCR_BaseTask task, string title)
void	RPC_SetTaskTitle (int taskID, string title)
void	OnMapOpen (MapConfiguration config)
override void	EOnInit (IEntity owner)
void	SCR_BaseTaskSupportEntity (IEntitySource src, IEntity parent)
void	~SCR_BaseTaskSupportEntity ()

Protected Member Functions
SCR_Faction	GetCharacterFaction (IEntity unit)
	Returns the facton of the character if it exists, otherwise null.
Protected Member Functions inherited from SCR_BaseTaskSupportEntity
void	RPC_CancelTask (int taskID)
void	RPC_FinishTask (int taskID)
void	RPC_FailTask (int taskID)
void	RegisterContextualMenuCallbacks ()

Protected Attributes
IEntity	m_Entity
Protected Attributes inherited from SCR_BaseTaskSupportEntity
ResourceName	m_sTaskDescriptionWidgetResource
ResourceName	m_sTaskPrefab

Member Function Documentation

CreateTask()

SCR_BaseTask SCR_ScenarioFrameworkTaskSupportEntity.CreateTask

(

SCR_ScenarioFrameworkLayerTask

layer

)

Spawns entity for scenario layer task and creates base task.

Parameters

[in]

layer

Spawned entity layer for task creation.

Returns

the spawned entity for the layer task.

Implemented in SCR_ScenarioFrameworkTaskClearAreaSupportEntity.

FinishTask()

override void SCR_ScenarioFrameworkTaskSupportEntity.FinishTask

(

notnull SCR_BaseTask

task

)

Finishes scenario task, checks conditions, and calls superclass method.

Parameters

[in]

task

Finishes scenario framework task, checks conditions for completion.

Implements SCR_BaseTaskSupportEntity.

GetCharacterFaction()

SCR_Faction SCR_ScenarioFrameworkTaskSupportEntity.GetCharacterFaction ( IEntity  unit )

protected

Returns the facton of the character if it exists, otherwise null.

Parameters

[in]

unit

Represents an in-game unit entity, used to determine its faction in the method.

Returns

the character's faction.

GetTaskEntity()

IEntity SCR_ScenarioFrameworkTaskSupportEntity.GetTaskEntity

(

)

Returns

The return value represents the entity associated with this task.

RPC_SpawnedEntityName()

void SCR_ScenarioFrameworkTaskSupportEntity.RPC_SpawnedEntityName	(	int	taskID,
		string	name
	)

Sets spawned entity name for a scenario task.

Parameters

[in]	taskID	TaskID represents the unique identifier for the scenario task in the task manager.
[in]	name	Represents the name of an entity spawned in-game, used for identification purposes.

RPC_TaskExecutionBriefing()

void SCR_ScenarioFrameworkTaskSupportEntity.RPC_TaskExecutionBriefing	(	int	taskID,
		string	description
	)

Sets task execution briefing description for specified task ID.

Parameters

[in]	taskID	Task ID is an identifier for a specific task in the scenario, used to reference it in the method for setting its execution brief
[in]	description	Sets briefing description for a specific task.

SetSpawnedEntityName()

void SCR_ScenarioFrameworkTaskSupportEntity.SetSpawnedEntityName	(	notnull SCR_ScenarioFrameworkTask	task,
		string	name
	)

Sets spawned entity name for a task in scenario framework.

Parameters

[in]	task	Sets spawned entity name for a scenario task.
[in]	name	Sets the name for spawned entity in scenario task.

SetTaskEntity()

void SCR_ScenarioFrameworkTaskSupportEntity.SetTaskEntity

(

IEntity

entity

)

Parameters

[in]

entity

Represents an object or entity in the game world assigned to this task.

SetTaskExecutionBriefing()

void SCR_ScenarioFrameworkTaskSupportEntity.SetTaskExecutionBriefing	(	notnull SCR_ScenarioFrameworkTask	task,
		string	description
	)

Sets task execution briefing for given task with description.

Parameters

[in]	task	Sets briefing for a specific task with given description.
[in]	description	Sets the briefing description for a specific task in the scenario.

SetTaskPrefab()

void SCR_ScenarioFrameworkTaskSupportEntity.SetTaskPrefab

(

ResourceName

sTaskPrefab

)

Parameters

[in]

sTaskPrefab

The method sets the prefab for a task.

Member Data Documentation

m_Entity

IEntity SCR_ScenarioFrameworkTaskSupportEntity.m_Entity

protected

---

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

• Game/ScenarioFramework/Tasks/SCR_ScenarioFrameworkTaskSupportEntity.c