Inheritance diagram for SCR_ScenarioFrameworkLayerTaskClearArea:

[legend]

Public Member Functions
override bool	SetSupportEntity ()

void	SCR_ScenarioFrameworkLayerTaskClearArea (IEntityComponentSource src, IEntity ent, IEntity parent)

Public Member Functions inherited from SCR_ScenarioFrameworkLayerTask
SCR_TaskState	GetLayerTaskState ()

bool	GetLayerTaskResolvedBeforeLoad ()

void	SetLayerTaskState (SCR_TaskState state)

SCR_ScenarioFrameworkTask	GetTask ()

ResourceName	GetTaskPrefab ()

string	GetOverridenObjectDisplayName ()

void	SetOverridenObjectDisplayName (string name)

string	GetTaskTitle ()

string	GetOriginalTaskDescription ()

string	GetTaskDescription ()

SCR_ESFTaskType	GetTaskType ()

override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)

override void	DynamicReinit ()

override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)

override void	FinishInit ()

void	OnTaskStateChanged (SCR_TaskState previousState, SCR_TaskState newState)

void	SetSlotTask (SCR_ScenarioFrameworkSlotTask slotTask)

SCR_ScenarioFrameworkSlotTask	GetSlotTask ()

void	InitTask (SCR_ScenarioFrameworkLayerBase layer)

override void	_WB_AfterWorldUpdate (IEntity owner, float timeSlice)

override bool	_WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)

void	~SCR_ScenarioFrameworkLayerTask ()

Public Member Functions inherited from SCR_ScenarioFrameworkLayerBase
string	GetName ()

void	SetEntity (IEntity entity)

bool	GetIsTerminated ()

void	SetIsTerminated (bool state)

void	SetRandomlySpawnedChildren (array< string > randomlySpawnedChildren)

array< SCR_ScenarioFrameworkLayerBase >	GetRandomlySpawnedChildren ()

int	GetPlayersCount (FactionKey factionName="")

int	GetMaxPlayersForGameMode (FactionKey factionName="")

SCR_ScenarioFrameworkArea	GetParentArea ()
	Get parent area the object is nested into.

SCR_ScenarioFrameworkLayerTask	GetLayerTask ()
	Get layer task the object is nested into if there is some.

SCR_ScenarioFrameworkSlotTask	GetSlotTask (array< SCR_ScenarioFrameworkLayerBase > aLayers)
	Get SlotTask from array of LayerBases if there is any.

void	SetParentLayer (SCR_ScenarioFrameworkLayerBase parentLayer)

SCR_ScenarioFrameworkLayerBase	GetParentLayer ()

SCR_EScenarioFrameworkSpawnChildrenType	GetSpawnChildrenType ()

bool	GetEnableRepeatedSpawn ()

void	SetEnableRepeatedSpawn (bool value)

SCR_ScenarioFrameworkEActivationType	GetActivationType ()

void	SetActivationType (SCR_ScenarioFrameworkEActivationType activationType)

bool	GetIsInitiated ()

bool	GetDynamicDespawnExcluded ()

void	SetDynamicDespawnExcluded (bool excluded)

array< IEntity >	GetSpawnedEntities ()

array< SCR_ScenarioFrameworkLayerBase >	GetChildrenEntities ()

SCR_ScenarioFrameworkLayerBase	GetRandomChildren ()
	Returns the random Slot.

void	GetChildren (out array< SCR_ScenarioFrameworkLayerBase > children)
	Goes through the hierarchy and returns all the child entities of LayerBase type.

void	GetLogics (out array< SCR_ScenarioFrameworkLogic > logics)

array< SCR_ScenarioFrameworkLogic >	GetSpawnedLogics ()

array< ref SCR_ScenarioFrameworkPlugin >	GetSpawnedPlugins ()

int	GetRepeatedSpawnNumber ()

void	SetRepeatedSpawnNumber (int number)

ScriptInvokerScenarioFrameworkLayer	GetOnAllChildrenSpawned ()

void	InvokeAllChildrenSpawned ()

void	CheckAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer=null)

void	SpawnChildren (bool previouslyRandomized=false)

void	SpawnPreviouslyRandomizedChildren ()

void	SpawnRandomOneChild (bool previouslyRandomized=false)

void	SpawnRandomMultipleChildren (bool previouslyRandomized=false)

void	InitChild (SCR_ScenarioFrameworkLayerBase child)

IEntity	GetSpawnedEntity ()

void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)

void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)

void	DynamicReinit ()

bool	InitAlreadyHappened ()

bool	InitParentLayer ()

bool	InitNotTerminated ()

bool	InitDynDespawnAndActivation (SCR_ScenarioFrameworkEActivationType activation)

bool	InitActivationConditions ()

bool	InitArea (SCR_ScenarioFrameworkArea area)

void	InitFactionSettings ()
	Handles inheritance of faction settings from parents.

bool	InitOtherThings ()
	For situations where some other logic is to be appended in these checks and is to be performed before FinishInit.

void	FinishInitChildrenInsert ()
	For situations where some other logic is needed to be performed before or after this Insert.

void	FinishInit ()

void	Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)

void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)

override void	EOnFrame (IEntity owner, float timeSlice)

override void	OnPostInit (IEntity owner)

void	SetDebugShapeSize (float fSize)

override void	_WB_OnCreate (IEntity owner, IEntitySource src)

void	RenameOwnerEntity (IEntity owner)

void	SCR_ScenarioFrameworkLayerBase (IEntityComponentSource src, IEntity ent, IEntity parent)

void	~SCR_ScenarioFrameworkLayerBase ()

Additional Inherited Members
Public Attributes inherited from SCR_ScenarioFrameworkLayerTask
string	m_sTaskTitle

string	m_sTaskDescription

SCR_ESFTaskType	m_eTypeOfTask = SCR_ESFTaskType.DEFAULT

ResourceName	m_sTaskPrefab

bool	m_bPlaceMarkerOnSubjectSlot

string	m_sOverrideObjectDisplayName

ref array< ref SCR_ScenarioFrameworkActionBase >	m_aTriggerActionsOnFinish

SCR_ScenarioFrameworkSlotTask	m_SlotTask

SCR_ScenarioFrameworkTask	m_Task

SCR_ScenarioFrameworkTaskSupportEntity	m_SupportEntity

SCR_TaskState	m_eLayerTaskState

bool	m_bTaskResolvedBeforeLoad

Public Attributes inherited from SCR_ScenarioFrameworkLayerBase
SCR_EScenarioFrameworkSpawnChildrenType	m_SpawnChildren

FactionKey	m_sFactionKey

int	m_iRandomPercent

bool	m_bEnableRepeatedSpawn

int	m_iRepeatedSpawnNumber

float	m_fRepeatedSpawnTimer

bool	m_bShowDebugShapesDuringRuntime

SCR_ScenarioFrameworkEActivationType	m_eActivationType

ref array< ref SCR_ScenarioFrameworkActivationConditionBase >	m_aActivationConditions

ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActivationActions

bool	m_bExcludeFromDynamicDespawn

ref array< ref SCR_ScenarioFrameworkPlugin >	m_aPlugins

ref array< SCR_ScenarioFrameworkLayerBase >	m_aChildren = {}

ref array< SCR_ScenarioFrameworkLayerBase >	m_aRandomlySpawnedChildren = {}

ref array< SCR_ScenarioFrameworkLogic >	m_aLogic = {}

ref ScriptInvokerBase< ScriptInvokerScenarioFrameworkLayerMethod >	m_OnAllChildrenSpawned

ref array< IEntity >	m_aSpawnedEntities = {}

IEntity	m_Entity

SCR_ScenarioFrameworkArea	m_Area

SCR_ScenarioFrameworkLayerBase	m_ParentLayer

float	m_fDebugShapeRadius = 0.25

WorldTimestamp	m_fRepeatSpawnTimeStart

WorldTimestamp	m_fRepeatSpawnTimeEnd

int	m_iDebugShapeColor = ARGB(32, 0xFF, 0x00, 0x12)

int	m_iCurrentlySpawnedChildren

int	m_iSupposedSpawnedChildren

bool	m_bInitiated

bool	m_bIsRegistered

bool	m_bDynamicallyDespawned

bool	m_bIsTerminated

int	m_iRepeatedSpawnNumberDefault = m_iRepeatedSpawnNumber

SCR_ScenarioFrameworkEActivationType	m_eActivationTypeDefault = m_eActivationType

Static Public Attributes inherited from SCR_ScenarioFrameworkLayerTask
static const ref ScriptInvoker	s_OnTaskSetup = new ScriptInvoker()

Static Public Attributes inherited from SCR_ScenarioFrameworkLayerBase
static const int	SPAWN_DELAY = 200

Protected Member Functions inherited from SCR_ScenarioFrameworkLayerTask
bool	SetTaskPrefab ()

bool	SetSupportEntity ()

bool	CreateTask ()

void	SetupTask ()

Protected Member Functions inherited from SCR_ScenarioFrameworkLayerBase
void	SetFactionKey (FactionKey factionKey)

FactionKey	GetFactionKey ()

void	RepeatedSpawn ()

void	RepeatedSpawnCalled ()

void	ActivateLogic ()

void	DrawDebugShape (bool draw)

Protected Attributes inherited from SCR_ScenarioFrameworkLayerTask
bool	m_bShowDebugShapesInWorkbench

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkLayerTaskClearArea()

void SCR_ScenarioFrameworkLayerTaskClearArea.SCR_ScenarioFrameworkLayerTaskClearArea	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

◆ SetSupportEntity()

override bool SCR_ScenarioFrameworkLayerTaskClearArea.SetSupportEntity ( )

Implements SCR_ScenarioFrameworkLayerTask.

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

Game/ScenarioFramework/Components/SCR_ScenarioFrameworkLayerTaskClearArea.c

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkLayerTaskClearArea()

Member Function Documentation

◆ SetSupportEntity()