Inheritance diagram for SCR_ScenarioFrameworkLayerBase:

Public Member Functions
string	GetName ()

void	SetEntity (IEntity entity)

bool	GetIsTerminated ()

void	SetIsTerminated (bool state)

void	SetRandomlySpawnedChildren (array< string > randomlySpawnedChildren)

void	AddRandomlySpawnedChild (SCR_ScenarioFrameworkLayerBase child)
	Adds child to list if not already present, ensuring uniqueness.

array< SCR_ScenarioFrameworkLayerBase >	GetRandomlySpawnedChildren ()

int	GetPlayersCount (FactionKey factionName="")
	Counts players in specified faction.

int	GetMaxPlayersForGameMode (FactionKey factionName="")
	Determines maximum players for a mission based on its mode, returns 4 if mission header is invalid.

SCR_ScenarioFrameworkArea	GetParentArea ()

void	GetAllLayers (out notnull array< SCR_ScenarioFrameworkLayerBase > layers)
	Gathers all layers from child entities and their siblings, adding them to the provided array.

void	GetAllLayers (out notnull array< SCR_ScenarioFrameworkLayerBase > layers, SCR_ScenarioFrameworkEActivationType activationType)
	Gathers all layers from child entities and their siblings, adding them to the provided array, filtered by activation type.

void	GetAllLayerTasks (out notnull array< SCR_ScenarioFrameworkLayerTask > layerTasks)
	Gathers all layer tasks from child entities and their siblings, adding them to the provided array.

void	GetAllSlotTasks (out notnull array< SCR_ScenarioFrameworkSlotTask > slotTasks)
	Gets all slot tasks from all layers in the hierarchy of the owner entity, including sibling layers' tasks.

SCR_ScenarioFrameworkLayerTask	GetLayerTask ()

SCR_ScenarioFrameworkSlotTask	GetSlotTask (array< SCR_ScenarioFrameworkLayerBase > aLayers)
	Retrieves slot task from layer child entities.

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	GetDynamicDespawnEnabled ()

void	SetDynamicDespawnEnabled (bool enabled)

bool	GetDynamicDespawnExcluded ()

int	GetDynamicDespawnRange ()

void	SetDynamicDespawnRange (int range)

void	SetDynamicDespawnExcluded (bool excluded)

array< IEntity >	GetSpawnedEntities ()

array< SCR_ScenarioFrameworkLayerBase >	GetChildrenEntities ()

SCR_ScenarioFrameworkLayerBase	GetRandomChildren ()

void	GetChildren (out array< SCR_ScenarioFrameworkLayerBase > children)
	Reverses and inserts children layers into an array.

void	GetChildren (out array< SCR_ScenarioFrameworkLayerBase > children, SCR_ScenarioFrameworkEActivationType activationType)
	Reverses and inserts children layers into an array, filtered by activation type.

void	GetLogics (out array< SCR_ScenarioFrameworkLogic > logics)
	Retrieves all child scenario framework logic entities from owner entity and adds them to logics array if not already present.

array< SCR_ScenarioFrameworkLogic >	GetSpawnedLogics ()

array< ref SCR_ScenarioFrameworkPlugin >	GetSpawnedPlugins ()

int	GetRepeatedSpawnNumber ()

void	SetRepeatedSpawnNumber (int number)

ScriptInvokerScenarioFrameworkLayer	GetOnAllChildrenSpawned ()

void	InvokeAllChildrenSpawned ()
	Spawns all children and triggers invoker on completion.

void	CalculateSupposedSpawnedChildren (bool previouslyRandomized=false)
	Calculates supposed spawned children based on activation type, termination, initiation, and conditions.

void	CheckAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer=null)
	Checks if all children layers have spawned or spawns one randomly if specified.

void	SpawnChildren (bool previouslyRandomized=false)
	Spawns children based on scenario settings, either all at once or randomly.

void	SpawnPreviouslyRandomizedChildren ()
	Spawns children with delay based on their index.

void	SpawnRandomOneChild (bool previouslyRandomized=false)
	Spawns random child object if not previously randomized, else spawns previously randomized children.

void	SpawnRandomMultipleChildren (bool previouslyRandomized=false)
	Spawns random children based on player count, if previously randomized, uses previous children, otherwise selects from available children.

void	InitChild (SCR_ScenarioFrameworkLayerBase child)
	Initializes child layer, sets parent layer, and initializes child with parent area and action type.

IEntity	GetSpawnedEntity ()

void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false, bool affectRandomization=true)
	Restores default settings, clears children, removes spawned entities, optionally reinitializes after restoration.

void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
	Dynamically despawns this layer.

void	DynamicReinit ()
	Reinitializes this layer.

bool	InitAlreadyHappened ()
	Initialization check if already happened.

bool	InitParentLayer ()
	Initializes parent layer.

bool	InitNotTerminated ()
	Checks if layer is not terminated, spawns children if parent exists, returns false if terminated or children not spawnned.

bool	InitDynDespawnAndActivation (SCR_ScenarioFrameworkEActivationType activation)
	Checks if object is not dynamically despawned, then verifies if activation type matches, spawns all children if.

bool	InitActivationConditions (bool calledFromInit=false)
	Checks activation conditions for scenario layer, sets condition status based on logic operator, checks parent layer if needed.

bool	InitArea (SCR_ScenarioFrameworkArea area)
	Initializes area for scenario framework layer.

bool	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 ()
	Initializes children, retrieves them, and spawns them.

void	Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)
	Initializes scenario framework layer.

void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
	Initializes logic, plugins and actions.

override void	EOnFrame (IEntity owner, float timeSlice)
	Draws debug shapes during runtime if enabled.

override void	OnPostInit (IEntity owner)

void	SetDebugShapeSize (float fSize)

array< ref SCR_ScenarioFrameworkActionBase >	GetActivationActions ()

override int	_WB_GetAfterWorldUpdateSpecs (IEntity owner, IEntitySource src)

override void	_WB_AfterWorldUpdate (IEntity owner, float timeSlice)
	Draws debug shape based on m_bShowDebugShapesInWorkbench setting in Workbench after world update.

override void	_WB_OnCreate (IEntity owner, IEntitySource src)
	Renames all entities in the owner's children hierarchy.

override bool	_WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
	Controls debug shape visibility in Workbench based on user input.

void	RenameOwnerEntity (IEntity owner)
	Rename entity owner with default name if not restoring undo/redo.

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

void	~SCR_ScenarioFrameworkLayerBase ()
	Removes object in edit mode or despawns it if not in edit mode.

Public Attributes
SCR_EScenarioFrameworkSpawnChildrenType	m_SpawnChildren

FactionKey	m_sFactionKey

int	m_iRandomPercent

bool	m_bEnableRepeatedSpawn

int	m_iRepeatedSpawnNumber

float	m_fRepeatedSpawnTimer

bool	m_bShowDebugShapesDuringRuntime

bool	m_bShowDebugShapesInWorkbench

SCR_ScenarioFrameworkEActivationType	m_eActivationType

ref array< ref SCR_ScenarioFrameworkActivationConditionBase >	m_aActivationConditions

SCR_EScenarioFrameworkLogicOperators	m_eActivationConditionLogic

ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActivationActions

bool	m_bDynamicDespawn

int	m_iDynamicDespawnRange

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, 255, 255, 255)

int	m_iCurrentlySpawnedChildren

int	m_iSupposedSpawnedChildren

bool	m_bInitiated

bool	m_bDynamicallyDespawned

bool	m_bIsTerminated

int	m_iRepeatedSpawnNumberDefault = m_iRepeatedSpawnNumber

SCR_ScenarioFrameworkEActivationType	m_eActivationTypeDefault = m_eActivationType

Static Public Attributes
static const int	SPAWN_DELAY = 200

Protected Member Functions
void	SetFactionKey (FactionKey factionKey)

FactionKey	GetFactionKey ()

FactionKey	GetParentFactionKeyRecursive ()
	Climbs the hierarchy tree to find a defined FactionKey.

void	RepeatedSpawn ()
	Repetitive spawning with timer.

void	RepeatedSpawnCalled ()
	Repetitive spawning logic with countdown and condition checks.

void	ActivateLogic ()
	Initializes all logic components.

void	DrawDebugShape (bool draw)
	Draws debug shape if draw flag is true, creates sphere shape with specified color, flags, position, and radius.

void	InitActivationActions ()

void	RestoreActionsToDefault ()

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkLayerBase()

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

Parameters

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

◆ ~SCR_ScenarioFrameworkLayerBase()

void SCR_ScenarioFrameworkLayerBase.~SCR_ScenarioFrameworkLayerBase ( )

Removes object in edit mode or despawns it if not in edit mode.

Member Function Documentation

◆ _WB_AfterWorldUpdate()

override void SCR_ScenarioFrameworkLayerBase._WB_AfterWorldUpdate	(	IEntity	owner,
		float	timeSlice )

Draws debug shape based on m_bShowDebugShapesInWorkbench setting in Workbench after world update.

Parameters

[in]	owner	The owner represents the entity (object) calling the method.
[in]	timeSlice	TimeSlice represents the time interval for which the method is called during each frame update.

◆ _WB_GetAfterWorldUpdateSpecs()

override int SCR_ScenarioFrameworkLayerBase._WB_GetAfterWorldUpdateSpecs	(	IEntity	owner,
		IEntitySource	src )

◆ _WB_OnCreate()

override void SCR_ScenarioFrameworkLayerBase._WB_OnCreate	(	IEntity	owner,
		IEntitySource	src )

Renames all entities in the owner's children hierarchy.

Parameters

[in]	owner	Renames owner entity and its children in hierarchy.
[in]	src	Source entity representing the parent object creating this scripted object.

◆ _WB_OnKeyChanged()

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

Controls debug shape visibility in Workbench based on user input.

Parameters

[in]	owner	The owner represents the entity (object) in the game world that triggers the method when its key value changes.
[in]	src	BaseContainer src represents input parameter containing key-value pairs related to the key changes in the Workbench.
[in]	key	Controls whether debug shapes are drawn in Workbench.
[in]	ownerContainers	Represents a list of containers related to the owner entity in the method.
[in]	parent	Parent represents the entity that owns the key change event, used for context in the method.

Returns: : Controls whether debug shapes are drawn in Workbench.

Implemented in SCR_ScenarioFrameworkSlotBase, and SCR_ScenarioFrameworkSlotWaypoint.

◆ ActivateLogic()

void SCR_ScenarioFrameworkLayerBase.ActivateLogic ( )

protected

Initializes all logic components.

◆ AddRandomlySpawnedChild()

void SCR_ScenarioFrameworkLayerBase.AddRandomlySpawnedChild ( SCR_ScenarioFrameworkLayerBase child )

Adds child to list if not already present, ensuring uniqueness.

Parameters

[in] child Adds child object to list of randomly spawned children if it's not already in the list.

◆ AfterAllChildrenSpawned()

void SCR_ScenarioFrameworkLayerBase.AfterAllChildrenSpawned ( SCR_ScenarioFrameworkLayerBase layer )

Initializes logic, plugins and actions.

Parameters

[in] layer for which this method is called.

Implemented in SCR_ScenarioFrameworkArea, SCR_ScenarioFrameworkLayerTaskDefend, SCR_ScenarioFrameworkSlotAI, SCR_ScenarioFrameworkSlotBase, SCR_ScenarioFrameworkSlotClearArea, SCR_ScenarioFrameworkSlotMarker, SCR_ScenarioFrameworkSlotPick, SCR_ScenarioFrameworkSlotTaskAI, and SCR_ScenarioFrameworkSlotTrigger.

◆ CalculateSupposedSpawnedChildren()

void SCR_ScenarioFrameworkLayerBase.CalculateSupposedSpawnedChildren ( bool previouslyRandomized = false )

Calculates supposed spawned children based on activation type, termination, initiation, and conditions.

Parameters

[in] previouslyRandomized indicates whether children layers were spawned randomly previously.

◆ CheckAllChildrenSpawned()

void SCR_ScenarioFrameworkLayerBase.CheckAllChildrenSpawned ( SCR_ScenarioFrameworkLayerBase layer = null )

Checks if all children layers have spawned or spawns one randomly if specified.

Parameters

[in] layer for which this check is invoked.

◆ DrawDebugShape()

void SCR_ScenarioFrameworkLayerBase.DrawDebugShape ( bool draw )

protected

Draws debug shape if draw flag is true, creates sphere shape with specified color, flags, position, and radius.

Parameters

[in] draw debug shape if draw is true, otherwise does nothing.

Implemented in SCR_ScenarioFrameworkArea, and SCR_ScenarioFrameworkSlotWaypoint.

◆ DynamicDespawn()

void SCR_ScenarioFrameworkLayerBase.DynamicDespawn ( SCR_ScenarioFrameworkLayerBase layer )

Dynamically despawns this layer.

Parameters

[in] layer for which this is called.

Implemented in SCR_ScenarioFrameworkArea, SCR_ScenarioFrameworkLayerTask, SCR_ScenarioFrameworkLayerTaskDefend, SCR_ScenarioFrameworkSlotAI, SCR_ScenarioFrameworkSlotBase, SCR_ScenarioFrameworkSlotDefend, SCR_ScenarioFrameworkSlotPick, SCR_ScenarioFrameworkSlotTask, and SCR_ScenarioFrameworkSlotTaskAI.

◆ DynamicReinit()

void SCR_ScenarioFrameworkLayerBase.DynamicReinit ( )

Reinitializes this layer.

Implemented in SCR_ScenarioFrameworkArea, SCR_ScenarioFrameworkLayerTask, and SCR_ScenarioFrameworkSlotTask.

◆ EOnFrame()

override void SCR_ScenarioFrameworkLayerBase.EOnFrame	(	IEntity	owner,
		float	timeSlice )

Draws debug shapes during runtime if enabled.

Parameters

[in]	owner	represents the owner entity of this layer.
[in]	timeSlice	represents the time interval for which the method is called during each frame.

Implemented in SCR_ScenarioFrameworkLayerTaskDefend.

◆ FinishInit()

void SCR_ScenarioFrameworkLayerBase.FinishInit ( )

Initializes children, retrieves them, and spawns them.

Implemented in SCR_ScenarioFrameworkLayerTask, SCR_ScenarioFrameworkSlotBase, SCR_ScenarioFrameworkSlotClearArea, SCR_ScenarioFrameworkSlotExtraction, SCR_ScenarioFrameworkSlotTask, and SCR_ScenarioFrameworkSlotTrigger.

◆ FinishInitChildrenInsert()

void SCR_ScenarioFrameworkLayerBase.FinishInitChildrenInsert ( )

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

Implemented in SCR_ScenarioFrameworkSlotDelivery.

◆ GetActivationActions()

array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkLayerBase.GetActivationActions ( )

◆ GetActivationType()

SCR_ScenarioFrameworkEActivationType SCR_ScenarioFrameworkLayerBase.GetActivationType ( )

Returns: Represents the activation type.

◆ GetAllLayers() [1/2]

void SCR_ScenarioFrameworkLayerBase.GetAllLayers ( out notnull array< SCR_ScenarioFrameworkLayerBase > layers )

Gathers all layers from child entities and their siblings, adding them to the provided array.

Parameters

[out] layers Represents all layers in this layer hierarchy.

◆ GetAllLayers() [2/2]

void SCR_ScenarioFrameworkLayerBase.GetAllLayers	(	out notnull array< SCR_ScenarioFrameworkLayerBase >	layers,
		SCR_ScenarioFrameworkEActivationType	activationType )

Gathers all layers from child entities and their siblings, adding them to the provided array, filtered by activation type.

Parameters

[out]	layers	Represents all layers in this layer hierarchy.
[in]	activationType	that will filter output layers.

◆ GetAllLayerTasks()

void SCR_ScenarioFrameworkLayerBase.GetAllLayerTasks ( out notnull array< SCR_ScenarioFrameworkLayerTask > layerTasks )

Gathers all layer tasks from child entities and their siblings, adding them to the provided array.

Parameters

[out] layerTasks Represents all tasks associated with layers in the scenario hierarchy.

◆ GetAllSlotTasks()

void SCR_ScenarioFrameworkLayerBase.GetAllSlotTasks ( out notnull array< SCR_ScenarioFrameworkSlotTask > slotTasks )

Gets all slot tasks from all layers in the hierarchy of the owner entity, including sibling layers' tasks.

Parameters

[out] slotTasks Represents all slot tasks from the current entity and its siblings in the hierarchy.

◆ GetChildren() [1/2]

void SCR_ScenarioFrameworkLayerBase.GetChildren ( out array< SCR_ScenarioFrameworkLayerBase > children )

Reverses and inserts children layers into an array.

Parameters

[out] children Returns an array of child entities with SCR_ScenarioFrameworkLayerBase component, reversed and then inserted into the main

◆ GetChildren() [2/2]

void SCR_ScenarioFrameworkLayerBase.GetChildren	(	out array< SCR_ScenarioFrameworkLayerBase >	children,
		SCR_ScenarioFrameworkEActivationType	activationType )

Reverses and inserts children layers into an array, filtered by activation type.

Parameters

[out] children Returns an array of child entities with SCR_ScenarioFrameworkLayerBase component, reversed and then inserted into the main

◆ GetChildrenEntities()

array< SCR_ScenarioFrameworkLayerBase > SCR_ScenarioFrameworkLayerBase.GetChildrenEntities ( )

Returns: an array of child entities in the scenario framework layer.

◆ GetDynamicDespawnEnabled()

bool SCR_ScenarioFrameworkLayerBase.GetDynamicDespawnEnabled ( )

Returns: Indicates whether dynamic despawn is enabled or not.

◆ GetDynamicDespawnExcluded()

bool SCR_ScenarioFrameworkLayerBase.GetDynamicDespawnExcluded ( )

Returns: Represents whether the layer is excluded from dynamic despawning.

◆ GetDynamicDespawnRange()

int SCR_ScenarioFrameworkLayerBase.GetDynamicDespawnRange ( )

Returns: Represents dynamic despawn range.

◆ GetEnableRepeatedSpawn()

bool SCR_ScenarioFrameworkLayerBase.GetEnableRepeatedSpawn ( )

Returns: Represents whether repeated spawning is enabled or not.

◆ GetFactionKey()

FactionKey SCR_ScenarioFrameworkLayerBase.GetFactionKey ( )

protected

Returns: Faction key representing the faction this layer has assigned.

◆ GetIsInitiated()

bool SCR_ScenarioFrameworkLayerBase.GetIsInitiated ( )

Returns: Indicates if the layer has been initiated.

◆ GetIsTerminated()

bool SCR_ScenarioFrameworkLayerBase.GetIsTerminated ( )

Returns: whether the layer is terminated or not.

◆ GetLayerTask()

SCR_ScenarioFrameworkLayerTask SCR_ScenarioFrameworkLayerBase.GetLayerTask ( )

Returns: the ScenarioFrameworkLayerTask that this layer is nested into

Implemented in SCR_ScenarioFrameworkArea.

◆ GetLogics()

void SCR_ScenarioFrameworkLayerBase.GetLogics ( out array< SCR_ScenarioFrameworkLogic > logics )

Retrieves all child scenario framework logic entities from owner entity and adds them to logics array if not already present.

Parameters

[out] logics Retrieves all child scenario framework logic entities from owner entity and adds them to logics array if not already present.

◆ GetMaxPlayersForGameMode()

int SCR_ScenarioFrameworkLayerBase.GetMaxPlayersForGameMode ( FactionKey factionName = "" )

Determines maximum players for a mission based on its mode, returns 4 if mission header is invalid.

Parameters

[in] factionName Faction name is the identifier for the faction in the game mode, used to determine the maximum number of players allowed in

Returns: Maximum players allowed for the current game mode based on the specified faction.

◆ GetName()

string SCR_ScenarioFrameworkLayerBase.GetName ( )

Returns: the name of the owner entity.

◆ GetOnAllChildrenSpawned()

ScriptInvokerScenarioFrameworkLayer SCR_ScenarioFrameworkLayerBase.GetOnAllChildrenSpawned ( )

Returns: a ScriptInvokerBase object representing the invoker triggered when all children have spawned in ScenarioFrameworkLayer.

◆ GetParentArea()

SCR_ScenarioFrameworkArea SCR_ScenarioFrameworkLayerBase.GetParentArea ( )

Returns: parent area of the entity or null if not found.

◆ GetParentFactionKeyRecursive()

FactionKey SCR_ScenarioFrameworkLayerBase.GetParentFactionKeyRecursive ( )

protected

Climbs the hierarchy tree to find a defined FactionKey.

Only reccomended to use in Workbench for object preview. When the Game is running, directly reference m_sFactionKey or GetFactionKey().

◆ GetParentLayer()

SCR_ScenarioFrameworkLayerBase SCR_ScenarioFrameworkLayerBase.GetParentLayer ( )

Returns: parent layer entity or null if no parent layer exists.

◆ GetPlayersCount()

int SCR_ScenarioFrameworkLayerBase.GetPlayersCount ( FactionKey factionName = "" )

Counts players in specified faction.

Parameters

[in] factionName FactionName is the key identifier for a faction in the game, used to determine player count within that faction.

Returns: count of players in specified faction.

◆ GetRandomChildren()

SCR_ScenarioFrameworkLayerBase SCR_ScenarioFrameworkLayerBase.GetRandomChildren ( )

Returns: Randomly selected child object from the list of children.

◆ GetRandomlySpawnedChildren()

array< SCR_ScenarioFrameworkLayerBase > SCR_ScenarioFrameworkLayerBase.GetRandomlySpawnedChildren ( )

Returns: Randomly spawned children layers

◆ GetRepeatedSpawnNumber()

int SCR_ScenarioFrameworkLayerBase.GetRepeatedSpawnNumber ( )

Returns: Repetition count for spawning an object.

◆ GetSlotTask()

SCR_ScenarioFrameworkSlotTask SCR_ScenarioFrameworkLayerBase.GetSlotTask ( array< SCR_ScenarioFrameworkLayerBase > aLayers )

Retrieves slot task from layer child entities.

Parameters

[in] aLayers is an array of ScenarioFrameworkLayerBase objects representing layers in the scenario.

Returns: the first SCR_ScenarioFrameworkSlotTask component found in the given layers or their children.

◆ GetSpawnChildrenType()

SCR_EScenarioFrameworkSpawnChildrenType SCR_ScenarioFrameworkLayerBase.GetSpawnChildrenType ( )

Returns: Spawn children type for scenario spawning.

◆ GetSpawnedEntities()

array< IEntity > SCR_ScenarioFrameworkLayerBase.GetSpawnedEntities ( )

Returns: Array of spawned entities.

◆ GetSpawnedEntity()

IEntity SCR_ScenarioFrameworkLayerBase.GetSpawnedEntity ( )

Returns: Spawned entity.

◆ GetSpawnedLogics()

array< SCR_ScenarioFrameworkLogic > SCR_ScenarioFrameworkLayerBase.GetSpawnedLogics ( )

Returns: Array of spawned logic.

◆ GetSpawnedPlugins()

array< ref SCR_ScenarioFrameworkPlugin > SCR_ScenarioFrameworkLayerBase.GetSpawnedPlugins ( )

Returns: Array of plugins.

◆ Init()

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

Initializes scenario framework layer.

Parameters

[in]	area	that this layer is nested into
[in]	activation	Activation type for scenario framework activation.

Implemented in SCR_ScenarioFrameworkArea, and SCR_ScenarioFrameworkSlotBase.

◆ InitActivationActions()

void SCR_ScenarioFrameworkLayerBase.InitActivationActions ( )

protected

◆ InitActivationConditions()

bool SCR_ScenarioFrameworkLayerBase.InitActivationConditions ( bool calledFromInit = false )

Checks activation conditions for scenario layer, sets condition status based on logic operator, checks parent layer if needed.

Returns: whether all activation conditions for this scenario layer have been initialized successfully.

◆ InitAlreadyHappened()

bool SCR_ScenarioFrameworkLayerBase.InitAlreadyHappened ( )

Initialization check if already happened.

Returns: whether initialization has already happened.

Implemented in SCR_ScenarioFrameworkSlotBase.

◆ InitArea()

bool SCR_ScenarioFrameworkLayerBase.InitArea ( SCR_ScenarioFrameworkArea area )

Initializes area for scenario framework layer.

Parameters

[in] area sets parent area if provided or gets parent area if not provided

Returns: true if area is successfully initialized, false otherwise.

◆ InitChild()

void SCR_ScenarioFrameworkLayerBase.InitChild ( SCR_ScenarioFrameworkLayerBase child )

Initializes child layer, sets parent layer, and initializes child with parent area and action type.

Parameters

[in] child that is to be initialized.

◆ InitDynDespawnAndActivation()

bool SCR_ScenarioFrameworkLayerBase.InitDynDespawnAndActivation ( SCR_ScenarioFrameworkEActivationType activation )

Checks if object is not dynamically despawned, then verifies if activation type matches, spawns all children if.

Parameters

[in] activation Activation type determines if scenario object should spawn or despawn based on conditions.

Returns: true if the object can be despawned and activated with given type, false otherwise.

◆ InitFactionSettings()

bool SCR_ScenarioFrameworkLayerBase.InitFactionSettings ( )

Handles inheritance of faction settings from parents.

◆ InitNotTerminated()

bool SCR_ScenarioFrameworkLayerBase.InitNotTerminated ( )

Checks if layer is not terminated, spawns children if parent exists, returns false if terminated or children not spawnned.

Returns: true if not terminated, otherwise false.

Implemented in SCR_ScenarioFrameworkSlotTask.

◆ InitOtherThings()

bool SCR_ScenarioFrameworkLayerBase.InitOtherThings ( )

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

Implemented in SCR_ScenarioFrameworkQRFSlotAI, SCR_ScenarioFrameworkSlotAI, SCR_ScenarioFrameworkSlotBase, and SCR_ScenarioFrameworkSlotTaskAI.

◆ InitParentLayer()

bool SCR_ScenarioFrameworkLayerBase.InitParentLayer ( )

Initializes parent layer.

Returns: true if parent layer is already initialized, otherwise initializes it and returns true if successful.

Implemented in SCR_ScenarioFrameworkArea.

◆ InvokeAllChildrenSpawned()

void SCR_ScenarioFrameworkLayerBase.InvokeAllChildrenSpawned ( )

Spawns all children and triggers invoker on completion.

◆ OnPostInit()

override void SCR_ScenarioFrameworkLayerBase.OnPostInit ( IEntity owner )

Parameters

[in] owner represents the entity being processed by the method, which is used for managing debug shapes during runtime based on certain conditions.

Implemented in SCR_ScenarioFrameworkArea, and SCR_ScenarioFrameworkLayerTaskDefend.

◆ RenameOwnerEntity()

void SCR_ScenarioFrameworkLayerBase.RenameOwnerEntity ( IEntity owner )

Rename entity owner with default name if not restoring undo/redo.

Parameters

[in] owner Represents the entity whose name is being changed by the method.

◆ RepeatedSpawn()

void SCR_ScenarioFrameworkLayerBase.RepeatedSpawn ( )

protected

Repetitive spawning with timer.

◆ RepeatedSpawnCalled()

void SCR_ScenarioFrameworkLayerBase.RepeatedSpawnCalled ( )

protected

Repetitive spawning logic with countdown and condition checks.

◆ RestoreActionsToDefault()

void SCR_ScenarioFrameworkLayerBase.RestoreActionsToDefault ( )

protected

◆ RestoreToDefault()

void SCR_ScenarioFrameworkLayerBase.RestoreToDefault	(	bool	includeChildren = false,
		bool	reinitAfterRestoration = false,
		bool	affectRandomization = true )

Restores default settings, clears children, removes spawned entities, optionally reinitializes after restoration.

Parameters

[in]	includeChildren	Restores default settings for this entity and its children if includeChildren is true.
[in]	reinitAfterRestoration	Restores entity to default state, optionally reinitializes after restoration.
[in]	affectRandomization	determines whether to clear all randomly spawned children entities after restoring default settings.

Implemented in SCR_ScenarioFrameworkArea, SCR_ScenarioFrameworkLayerTask, SCR_ScenarioFrameworkLayerTaskDefend, SCR_ScenarioFrameworkLayerTaskDeliver, SCR_ScenarioFrameworkSlotAI, SCR_ScenarioFrameworkSlotBase, SCR_ScenarioFrameworkSlotMarker, SCR_ScenarioFrameworkSlotTask, SCR_ScenarioFrameworkSlotTaskAI, and SCR_ScenarioFrameworkSlotTrigger.

◆ SetActivationType()

void SCR_ScenarioFrameworkLayerBase.SetActivationType ( SCR_ScenarioFrameworkEActivationType activationType )

Parameters

[in] activationType Sets the activation type

◆ SetDebugShapeSize()

void SCR_ScenarioFrameworkLayerBase.SetDebugShapeSize ( float fSize )

Parameters

[in] fSize is the radius for debug shape visualization.

◆ SetDynamicDespawnEnabled()

void SCR_ScenarioFrameworkLayerBase.SetDynamicDespawnEnabled ( bool enabled )

Parameters

[in] enabled Enables or disables dynamic despawning.

◆ SetDynamicDespawnExcluded()

void SCR_ScenarioFrameworkLayerBase.SetDynamicDespawnExcluded ( bool excluded )

Parameters

[in] excluded Excludes layer from dynamic despawning.

◆ SetDynamicDespawnRange()

void SCR_ScenarioFrameworkLayerBase.SetDynamicDespawnRange ( int range )

Parameters

[in] range Represents distance in meters for dynamic despawning.

◆ SetEnableRepeatedSpawn()

void SCR_ScenarioFrameworkLayerBase.SetEnableRepeatedSpawn ( bool value )

Parameters

[in] value Enables or disables repeated spawning of units for this layer.

◆ SetEntity()

void SCR_ScenarioFrameworkLayerBase.SetEntity ( IEntity entity )

Parameters

[in] entity Sets the entity reference for further manipulation.

◆ SetFactionKey()

void SCR_ScenarioFrameworkLayerBase.SetFactionKey ( FactionKey factionKey )

protected

Parameters

[in] factionKey Sets the faction key for the layer.

◆ SetIsTerminated()

void SCR_ScenarioFrameworkLayerBase.SetIsTerminated ( bool state )

Parameters

[in] state termination of this layer.

Implemented in SCR_ScenarioFrameworkSlotMarker.

◆ SetParentLayer()

void SCR_ScenarioFrameworkLayerBase.SetParentLayer ( SCR_ScenarioFrameworkLayerBase parentLayer )

Parameters

[in] layer base that will be set as parentLayer.

◆ SetRandomlySpawnedChildren()

void SCR_ScenarioFrameworkLayerBase.SetRandomlySpawnedChildren ( array< string > randomlySpawnedChildren )

Parameters

[in] randomlySpawnedChildren A list of child entities to randomly spawn

◆ SetRepeatedSpawnNumber()

void SCR_ScenarioFrameworkLayerBase.SetRepeatedSpawnNumber ( int number )

Parameters

[in] number Represents the number of repeated spawns for an entity in the game.

◆ SpawnChildren()

void SCR_ScenarioFrameworkLayerBase.SpawnChildren ( bool previouslyRandomized = false )

Spawns children based on scenario settings, either all at once or randomly.

Parameters

[in] previouslyRandomized bool indicates whether children were spawned randomly before.

Implemented in SCR_ScenarioFrameworkSlotBase.

◆ SpawnPreviouslyRandomizedChildren()

void SCR_ScenarioFrameworkLayerBase.SpawnPreviouslyRandomizedChildren ( )

Spawns children with delay based on their index.

◆ SpawnRandomMultipleChildren()

void SCR_ScenarioFrameworkLayerBase.SpawnRandomMultipleChildren ( bool previouslyRandomized = false )

Spawns random children based on player count, if previously randomized, uses previous children, otherwise selects from available children.

Parameters

[in] previouslyRandomized state is stored, used for spawning them again in the same positions.

◆ SpawnRandomOneChild()

void SCR_ScenarioFrameworkLayerBase.SpawnRandomOneChild ( bool previouslyRandomized = false )

Spawns random child object if not previously randomized, else spawns previously randomized children.

Parameters

[in] previouslyRandomized indicates if children were spawned randomly before.

Member Data Documentation

◆ m_aActivationActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkLayerBase.m_aActivationActions

◆ m_aActivationConditions

ref array<ref SCR_ScenarioFrameworkActivationConditionBase> SCR_ScenarioFrameworkLayerBase.m_aActivationConditions

◆ m_aChildren

ref array<SCR_ScenarioFrameworkLayerBase> SCR_ScenarioFrameworkLayerBase.m_aChildren = {}

◆ m_aLogic

ref array<SCR_ScenarioFrameworkLogic> SCR_ScenarioFrameworkLayerBase.m_aLogic = {}

◆ m_aPlugins

ref array<ref SCR_ScenarioFrameworkPlugin> SCR_ScenarioFrameworkLayerBase.m_aPlugins

◆ m_aRandomlySpawnedChildren

ref array<SCR_ScenarioFrameworkLayerBase> SCR_ScenarioFrameworkLayerBase.m_aRandomlySpawnedChildren = {}

◆ m_Area

SCR_ScenarioFrameworkArea SCR_ScenarioFrameworkLayerBase.m_Area

◆ m_aSpawnedEntities

ref array<IEntity> SCR_ScenarioFrameworkLayerBase.m_aSpawnedEntities = {}

◆ m_bDynamicallyDespawned

bool SCR_ScenarioFrameworkLayerBase.m_bDynamicallyDespawned

◆ m_bDynamicDespawn

bool SCR_ScenarioFrameworkLayerBase.m_bDynamicDespawn

◆ m_bEnableRepeatedSpawn

bool SCR_ScenarioFrameworkLayerBase.m_bEnableRepeatedSpawn

◆ m_bExcludeFromDynamicDespawn

bool SCR_ScenarioFrameworkLayerBase.m_bExcludeFromDynamicDespawn

◆ m_bInitiated

bool SCR_ScenarioFrameworkLayerBase.m_bInitiated

◆ m_bIsTerminated

bool SCR_ScenarioFrameworkLayerBase.m_bIsTerminated

◆ m_bShowDebugShapesDuringRuntime

bool SCR_ScenarioFrameworkLayerBase.m_bShowDebugShapesDuringRuntime

◆ m_bShowDebugShapesInWorkbench

bool SCR_ScenarioFrameworkLayerBase.m_bShowDebugShapesInWorkbench

◆ m_eActivationConditionLogic

SCR_EScenarioFrameworkLogicOperators SCR_ScenarioFrameworkLayerBase.m_eActivationConditionLogic

◆ m_eActivationType

SCR_ScenarioFrameworkEActivationType SCR_ScenarioFrameworkLayerBase.m_eActivationType

◆ m_eActivationTypeDefault

SCR_ScenarioFrameworkEActivationType SCR_ScenarioFrameworkLayerBase.m_eActivationTypeDefault = m_eActivationType

◆ m_Entity

IEntity SCR_ScenarioFrameworkLayerBase.m_Entity

◆ m_fDebugShapeRadius

float SCR_ScenarioFrameworkLayerBase.m_fDebugShapeRadius = 0.25

◆ m_fRepeatedSpawnTimer

float SCR_ScenarioFrameworkLayerBase.m_fRepeatedSpawnTimer

◆ m_fRepeatSpawnTimeEnd

WorldTimestamp SCR_ScenarioFrameworkLayerBase.m_fRepeatSpawnTimeEnd

◆ m_fRepeatSpawnTimeStart

WorldTimestamp SCR_ScenarioFrameworkLayerBase.m_fRepeatSpawnTimeStart

◆ m_iCurrentlySpawnedChildren

int SCR_ScenarioFrameworkLayerBase.m_iCurrentlySpawnedChildren

◆ m_iDebugShapeColor

int SCR_ScenarioFrameworkLayerBase.m_iDebugShapeColor = ARGB(32, 255, 255, 255)

◆ m_iDynamicDespawnRange

int SCR_ScenarioFrameworkLayerBase.m_iDynamicDespawnRange

◆ m_iRandomPercent

int SCR_ScenarioFrameworkLayerBase.m_iRandomPercent

◆ m_iRepeatedSpawnNumber

int SCR_ScenarioFrameworkLayerBase.m_iRepeatedSpawnNumber

◆ m_iRepeatedSpawnNumberDefault

int SCR_ScenarioFrameworkLayerBase.m_iRepeatedSpawnNumberDefault = m_iRepeatedSpawnNumber

◆ m_iSupposedSpawnedChildren

int SCR_ScenarioFrameworkLayerBase.m_iSupposedSpawnedChildren

◆ m_OnAllChildrenSpawned

ref ScriptInvokerBase<ScriptInvokerScenarioFrameworkLayerMethod> SCR_ScenarioFrameworkLayerBase.m_OnAllChildrenSpawned

◆ m_ParentLayer

SCR_ScenarioFrameworkLayerBase SCR_ScenarioFrameworkLayerBase.m_ParentLayer

◆ m_sFactionKey

FactionKey SCR_ScenarioFrameworkLayerBase.m_sFactionKey

◆ m_SpawnChildren

SCR_EScenarioFrameworkSpawnChildrenType SCR_ScenarioFrameworkLayerBase.m_SpawnChildren

◆ SPAWN_DELAY

const int SCR_ScenarioFrameworkLayerBase.SPAWN_DELAY = 200

static

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

Game/ScenarioFramework/Components/SCR_ScenarioFrameworkLayerBase.c

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkLayerBase()

◆ ~SCR_ScenarioFrameworkLayerBase()

Member Function Documentation

◆ _WB_AfterWorldUpdate()

◆ _WB_GetAfterWorldUpdateSpecs()

◆ _WB_OnCreate()

◆ _WB_OnKeyChanged()

◆ ActivateLogic()

◆ AddRandomlySpawnedChild()

◆ AfterAllChildrenSpawned()

◆ CalculateSupposedSpawnedChildren()

◆ CheckAllChildrenSpawned()

◆ DrawDebugShape()

◆ DynamicDespawn()

◆ DynamicReinit()

◆ EOnFrame()

◆ FinishInit()

◆ FinishInitChildrenInsert()

◆ GetActivationActions()

◆ GetActivationType()

◆ GetAllLayers() [1/2]

◆ GetAllLayers() [2/2]

◆ GetAllLayerTasks()

◆ GetAllSlotTasks()

◆ GetChildren() [1/2]

◆ GetChildren() [2/2]

◆ GetChildrenEntities()

◆ GetDynamicDespawnEnabled()

◆ GetDynamicDespawnExcluded()

◆ GetDynamicDespawnRange()

◆ GetEnableRepeatedSpawn()

◆ GetFactionKey()

◆ GetIsInitiated()

◆ GetIsTerminated()

◆ GetLayerTask()

◆ GetLogics()

◆ GetMaxPlayersForGameMode()

◆ GetName()

◆ GetOnAllChildrenSpawned()

◆ GetParentArea()

◆ GetParentFactionKeyRecursive()

◆ GetParentLayer()

◆ GetPlayersCount()

◆ GetRandomChildren()

◆ GetRandomlySpawnedChildren()

◆ GetRepeatedSpawnNumber()

◆ GetSlotTask()

◆ GetSpawnChildrenType()

◆ GetSpawnedEntities()

◆ GetSpawnedEntity()

◆ GetSpawnedLogics()

◆ GetSpawnedPlugins()

◆ Init()

◆ InitActivationActions()

◆ InitActivationConditions()

◆ InitAlreadyHappened()

◆ InitArea()

◆ InitChild()

◆ InitDynDespawnAndActivation()

◆ InitFactionSettings()

◆ InitNotTerminated()

◆ InitOtherThings()

◆ InitParentLayer()

◆ InvokeAllChildrenSpawned()

◆ OnPostInit()

◆ RenameOwnerEntity()

◆ RepeatedSpawn()

◆ RepeatedSpawnCalled()

◆ RestoreActionsToDefault()

◆ RestoreToDefault()

◆ SetActivationType()

◆ SetDebugShapeSize()

◆ SetDynamicDespawnEnabled()

◆ SetDynamicDespawnExcluded()

◆ SetDynamicDespawnRange()