SCR_ScenarioFrameworkTaskClearAreaSupportEntity Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkTaskClearAreaSupportEntity:

Public Member Functions
override SCR_BaseTask	CreateTask (SCR_ScenarioFrameworkLayerTask layer)
	Spawns entity for scenario layer task.
Public Member Functions inherited from SCR_ScenarioFrameworkTaskSupportEntity
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 ()

Additional Inherited Members
Protected Member Functions inherited from SCR_ScenarioFrameworkTaskSupportEntity
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 inherited from SCR_ScenarioFrameworkTaskSupportEntity
IEntity	m_Entity
Protected Attributes inherited from SCR_BaseTaskSupportEntity
ResourceName	m_sTaskDescriptionWidgetResource
ResourceName	m_sTaskPrefab

Member Function Documentation

CreateTask()

override SCR_BaseTask SCR_ScenarioFrameworkTaskClearAreaSupportEntity.CreateTask

(

SCR_ScenarioFrameworkLayerTask

layer

)

Spawns entity for scenario layer task.

Parameters

[in]

layer

Spawned entity layer for task creation.

Returns

the spawned entity for the task layer.

Implements SCR_ScenarioFrameworkTaskSupportEntity.

---

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

• Game/ScenarioFramework/Tasks/SCR_ScenarioFrameworkTaskClearAreaSupportEntity.c