Inheritance diagram for SCR_ScenarioFrameworkArea:

Protected Member Functions
void	SetupTrigger ()
	Spawns a trigger entity with specified resource, sets its radius, and attaches an activation event.
void	MoveTaskIconToArea (notnull SCR_Task task)
bool	GetIsTaskSuitableForArea (SCR_ESFTaskType eTaskType)
void	GetAvailableTaskTypes (out array< SCR_ESFTaskType > aTaskTypes)
void	GetSuitableLayersForTaskType (out notnull array< SCR_ScenarioFrameworkLayerBase > aSlotsOut, SCR_ESFTaskType eTaskType)
void	SetAreaSelected (bool bSet)
bool	GetIsAreaSelected ()
void	OnAreaTriggerActivated (IEntity entity)
ScriptInvoker	GetOnAreaTriggerActivated ()
ScriptInvoker	GetOnAreaInit ()
override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false, bool affectRandomization=true, bool deleteSpawnedEntities=true)
override void	DynamicReinit ()
	Initializes dynamic reinitialization by calling Init() method.
override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
override bool	InitParentLayer ()
override void	Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)
override void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
void	PrepareLayerSpecificDynamicDespawn (SCR_ScenarioFrameworkLayerBase layer, bool staySpawned=false, int despawnRange=0)
void	RemoveLayerSpecificDynamicDespawn (SCR_ScenarioFrameworkLayerBase layer, bool staySpawned=false)
void	PrepareDynamicDespawn ()
	Prepares dynamic spawn/despawn for layers.
void	RemoveDynamicDespawn ()
	Removes dynamic spawn/despawn for layers.
void	ExecuteDynamicDespawn (SCR_ScenarioFrameworkSystem scenarioFrameworkSystem)
	Executes dynamic spawn/despawn for layers.
void	DynamicSpawnLayer (array< vector > observers)
	Goes over despawned layers and checks whether or not said area should spawn.
void	DynamicDespawnLayer (array< vector > observers)
	Goes over spawned layers and checks whether or not said area should despawn.
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
void	DrawDebugShape (bool draw)
void	SCR_ScenarioFrameworkArea (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_ScenarioFrameworkArea ()

Detailed Description

Class is managing the area including the Slots (prefab Slot.et). The Slots should be placed in its hierarchy. GameModePatrolManager will select one instance of this type and will start to populate it based on the selected task

Definition at line 24 of file SCR_ScenarioFrameworkArea.c.

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkArea()

void SCR_ScenarioFrameworkArea::SCR_ScenarioFrameworkArea	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

inlineprotected

Parameters

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

Definition at line 630 of file SCR_ScenarioFrameworkArea.c.

◆ ~SCR_ScenarioFrameworkArea()

void SCR_ScenarioFrameworkArea::~SCR_ScenarioFrameworkArea ( )

inlineprotected

Definition at line 639 of file SCR_ScenarioFrameworkArea.c.

Member Function Documentation

◆ AfterAllChildrenSpawned()

override void SCR_ScenarioFrameworkArea::AfterAllChildrenSpawned ( SCR_ScenarioFrameworkLayerBase layer )

inlineprotected

Initializes Trigger

Parameters

[in] layer for which this method is called.

Definition at line 395 of file SCR_ScenarioFrameworkArea.c.

◆ DrawDebugShape()

void SCR_ScenarioFrameworkArea::DrawDebugShape ( bool draw )

inlineprotected

Draws debug shapes for debugging

Parameters

[in] draw debug shape for the object if draw parameter is true, otherwise does not draw anything.

Definition at line 601 of file SCR_ScenarioFrameworkArea.c.

◆ DynamicDespawn()

override void SCR_ScenarioFrameworkArea::DynamicDespawn ( SCR_ScenarioFrameworkLayerBase layer )

inlineprotected

Removes all children layers from the scenario framework layer and despawns itself if not excluded from dynamic despawning.

Parameters

[in] layer Removes layer from dynamic despawning, clears children layers.

Definition at line 352 of file SCR_ScenarioFrameworkArea.c.

◆ DynamicDespawnLayer()

void SCR_ScenarioFrameworkArea::DynamicDespawnLayer ( array< vector > observers )

inlineprotected

Goes over spawned layers and checks whether or not said area should despawn.

Definition at line 524 of file SCR_ScenarioFrameworkArea.c.

◆ DynamicReinit()

override void SCR_ScenarioFrameworkArea::DynamicReinit ( )

inlineprotected

Initializes dynamic reinitialization by calling Init() method.

Definition at line 344 of file SCR_ScenarioFrameworkArea.c.

◆ DynamicSpawnLayer()

void SCR_ScenarioFrameworkArea::DynamicSpawnLayer ( array< vector > observers )

inlineprotected

Goes over despawned layers and checks whether or not said area should spawn.

Definition at line 498 of file SCR_ScenarioFrameworkArea.c.

◆ EOnInit()

override void SCR_ScenarioFrameworkArea::EOnInit ( IEntity owner )

inlineprotected

Initializes area registration with ScenarioFrameworkSystem when game mode is valid.

Parameters

[in] owner The owner represents the entity that initializes this script on its EOnInit event.

Definition at line 555 of file SCR_ScenarioFrameworkArea.c.

◆ ExecuteDynamicDespawn()

void SCR_ScenarioFrameworkArea::ExecuteDynamicDespawn ( SCR_ScenarioFrameworkSystem scenarioFrameworkSystem )

inlineprotected

Executes dynamic spawn/despawn for layers.

Definition at line 487 of file SCR_ScenarioFrameworkArea.c.

◆ GetAvailableTaskTypes()

void SCR_ScenarioFrameworkArea::GetAvailableTaskTypes ( out array< SCR_ESFTaskType > aTaskTypes )

inlineprotected

Gets available task types from scenario layers and adds them to an array.

Parameters

[out] aTaskTypes The array of available task types for the scenario framework layer.

Definition at line 240 of file SCR_ScenarioFrameworkArea.c.

◆ GetIsAreaSelected()

bool SCR_ScenarioFrameworkArea::GetIsAreaSelected ( )

inlineprotected

Returns: whether an area is selected or not.

Definition at line 289 of file SCR_ScenarioFrameworkArea.c.

◆ GetIsTaskSuitableForArea()

bool SCR_ScenarioFrameworkArea::GetIsTaskSuitableForArea ( SCR_ESFTaskType eTaskType )

inlineprotected

Checks if given task type is suitable for current area by checking if it's in available task types list.

Parameters

[in] eTaskType Task type enum representing possible tasks in the area.

Returns: true if the given task type is suitable for the current area, false otherwise.

Definition at line 227 of file SCR_ScenarioFrameworkArea.c.

◆ GetOnAreaInit()

ScriptInvoker SCR_ScenarioFrameworkArea::GetOnAreaInit ( )

inlineprotected

Returns: the event handler for area initialization.

Definition at line 321 of file SCR_ScenarioFrameworkArea.c.

◆ GetOnAreaTriggerActivated()

ScriptInvoker SCR_ScenarioFrameworkArea::GetOnAreaTriggerActivated ( )

inlineprotected

Returns: a ScriptInvoker object for handling area trigger activation events.

Definition at line 311 of file SCR_ScenarioFrameworkArea.c.

◆ GetSuitableLayersForTaskType()

void SCR_ScenarioFrameworkArea::GetSuitableLayersForTaskType	(	out notnull array< SCR_ScenarioFrameworkLayerBase >	aSlotsOut,
		SCR_ESFTaskType	eTaskType )

inlineprotected

Filters suitable layers for given task type, populates output array with matching layers.

Parameters

[out]	aSlotsOut	Array of suitable layers for given task type.
[in]	eTaskType	eTaskType is the task type parameter used to filter suitable layers for the given task type in the scenario framework.

Definition at line 262 of file SCR_ScenarioFrameworkArea.c.

◆ Init()

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

inlineprotected

Initializes area, spawns trigger if not already spawned, initializes trigger actions if trigger is present, and sets activation type

Parameters

[in]	area	parent
[in]	activation	Activation type determines how scenario area is initiated, either on init or based on specific conditions.

Definition at line 383 of file SCR_ScenarioFrameworkArea.c.

◆ InitParentLayer()

override bool SCR_ScenarioFrameworkArea::InitParentLayer ( )

inlineprotected

Initializes parent layer with true value.

Returns: true if parent layer initialization is successful.

Definition at line 373 of file SCR_ScenarioFrameworkArea.c.

◆ MoveTaskIconToArea()

void SCR_ScenarioFrameworkArea::MoveTaskIconToArea ( notnull SCR_Task task )

inlineprotected

Moves task icon to area position.

Parameters

[in] task

Definition at line 217 of file SCR_ScenarioFrameworkArea.c.

◆ OnAreaTriggerActivated()

void SCR_ScenarioFrameworkArea::OnAreaTriggerActivated ( IEntity entity )

inlineprotected

Parameters

[in] entity Triggers area activation event for scenario framework, enabling periodic queries if not already done once.

Definition at line 296 of file SCR_ScenarioFrameworkArea.c.

◆ OnPostInit()

override void SCR_ScenarioFrameworkArea::OnPostInit ( IEntity owner )

inlineprotected

Parameters

[in] owner The owner represents the entity being initialized in the method.

Definition at line 591 of file SCR_ScenarioFrameworkArea.c.

◆ PrepareDynamicDespawn()

void SCR_ScenarioFrameworkArea::PrepareDynamicDespawn ( )

inlineprotected

Prepares dynamic spawn/despawn for layers.

Definition at line 458 of file SCR_ScenarioFrameworkArea.c.

◆ PrepareLayerSpecificDynamicDespawn()

void SCR_ScenarioFrameworkArea::PrepareLayerSpecificDynamicDespawn	(	SCR_ScenarioFrameworkLayerBase	layer,
		bool	staySpawned = false,
		int	despawnRange = 0 )

inlineprotected

Prepares dynamic spawn/despawn for specific layer (Intended for runtime usage)

Parameters

[in]	layer
[in]	staySpawned

Definition at line 406 of file SCR_ScenarioFrameworkArea.c.

◆ RemoveDynamicDespawn()

void SCR_ScenarioFrameworkArea::RemoveDynamicDespawn ( )

inlineprotected

Removes dynamic spawn/despawn for layers.

Definition at line 473 of file SCR_ScenarioFrameworkArea.c.

◆ RemoveLayerSpecificDynamicDespawn()

void SCR_ScenarioFrameworkArea::RemoveLayerSpecificDynamicDespawn	(	SCR_ScenarioFrameworkLayerBase	layer,
		bool	staySpawned = false )

inlineprotected

Removes dynamic spawn/despawn for specific layer (Intended for runtime usage)

Parameters

[in]	layer
[in]	staySpawned

Definition at line 430 of file SCR_ScenarioFrameworkArea.c.

◆ RestoreToDefault()

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

inlineprotected

Restores default settings, deselects area, nullifies triggers, resets item delivery point, and calls base class

Parameters

[in]	includeChildren	Restores default settings, optionally including children objects.
[in]	reinitAfterRestoration	Restores object state, optionally reinitializes after restoration.
[in]	affectRandomization	Affects randomization settings during restoration.

Definition at line 331 of file SCR_ScenarioFrameworkArea.c.

◆ SetAreaSelected()

void SCR_ScenarioFrameworkArea::SetAreaSelected ( bool bSet )

inlineprotected

Parameters

[in] bSet is a boolean parameter indicating whether to set or unset the area selection.

Definition at line 282 of file SCR_ScenarioFrameworkArea.c.

◆ SetupTrigger()

void SCR_ScenarioFrameworkArea::SetupTrigger ( )

inlineprotected

Spawns a trigger entity with specified resource, sets its radius, and attaches an activation event.

Definition at line 185 of file SCR_ScenarioFrameworkArea.c.

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

scripts/Game/ScenarioFramework/Components/SCR_ScenarioFrameworkArea.c

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkArea()

◆ ~SCR_ScenarioFrameworkArea()

Member Function Documentation

◆ AfterAllChildrenSpawned()

◆ DrawDebugShape()

◆ DynamicDespawn()

◆ DynamicDespawnLayer()

◆ DynamicReinit()

◆ DynamicSpawnLayer()

◆ EOnInit()

◆ ExecuteDynamicDespawn()

◆ GetAvailableTaskTypes()

◆ GetIsAreaSelected()

◆ GetIsTaskSuitableForArea()

◆ GetOnAreaInit()

◆ GetOnAreaTriggerActivated()

◆ GetSuitableLayersForTaskType()

◆ Init()

◆ InitParentLayer()

◆ MoveTaskIconToArea()

◆ OnAreaTriggerActivated()

◆ OnPostInit()

◆ PrepareDynamicDespawn()

◆ PrepareLayerSpecificDynamicDespawn()

◆ RemoveDynamicDespawn()

◆ RemoveLayerSpecificDynamicDespawn()

◆ RestoreToDefault()

◆ SetAreaSelected()

◆ SetupTrigger()