Inheritance diagram for SCR_ScenarioFrameworkSlotWaypoint:

[legend]

Public Member Functions
override IEntity	SpawnAsset ()

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

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

Public Member Functions inherited from SCR_ScenarioFrameworkSlotBase
void	OnObjectDamage (EDamageState state)

void	OnInventoryParentChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)

void	OnCompartmentEntered (IEntity vehicle, BaseCompartmentManagerComponent mgr, IEntity occupant, int managerId, int slotID)

string	GetOverridenObjectDisplayName ()

void	SetOverridenObjectDisplayName (string name)

string	GetSpawnedEntityDisplayName ()

SCR_ScenarioFrameworkArea	GetAreaWB ()
	Get the Layer Task which is parent of this Slot.

string	GetSpawnedObjectName ()

ResourceName	GetObjectToSpawn ()

ResourceName	GetRandomlySpawnedObject ()

void	SetRandomlySpawnedObject (ResourceName name)

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

override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)

override bool	InitAlreadyHappened ()

bool	InitRepeatableSpawn ()

bool	InitEntitySpawnCheck ()

bool	InitEntitySpawn ()

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

override void	FinishInit ()

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

override void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)

ScriptInvoker	GetOnAllAreasInitiatedInvoker ()

override void	SpawnChildren (bool previouslyRandomized=false)

ResourceName	GetRandomAsset (out ResourceName prefab)

IEntity	SpawnAsset ()

override void	_WB_AfterWorldUpdate (IEntity owner, float timeSlice)

override void	_WB_SetTransform (IEntity owner, inout vector mat[4], IEntitySource src)

void	SpawnEntityPreview (IEntity owner, Resource resource)

override void	_WB_OnInit (IEntity owner, inout vector mat[4], IEntitySource src)

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

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

void	~SCR_ScenarioFrameworkSlotBase ()

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

Public Attributes
ref SCR_ScenarioFrameworkWaypoint	m_Waypoint

Public Attributes inherited from SCR_ScenarioFrameworkSlotBase
ResourceName	m_sObjectToSpawn

string	m_sID

bool	m_bUseExistingWorldAsset

string	m_sOverrideObjectDisplayName

bool	m_bCanBeGarbageCollected

bool	m_bRandomizePerFaction

EEntityCatalogType	m_eEntityCatalogType

ref array< EEditableEntityLabel >	m_aIncludedEditableEntityLabels

ref array< EEditableEntityLabel >	m_aExcludedEditableEntityLabels

bool	m_bIncludeOnlySelectedLabels

bool	m_bIgnoreOrientChildrenToTerrain

bool	m_bSelected = false

ref EntitySpawnParams	m_SpawnParams = new EntitySpawnParams()

vector	m_Size

ResourceName	m_sRandomlySpawnedObject

vector	m_vPosition

bool	m_bShowDebugShapesInWorkbench

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

Protected Member Functions
override void	DrawDebugShape (bool draw)

Protected Member Functions inherited from SCR_ScenarioFrameworkSlotBase
void	QueryObjectsInRange (float fRange=2.5)
	Get objects of type defined in m_sObjectToSpawn in the range.

bool	GetEntity (notnull IEntity entity)
	Get object of type defined in m_sObjectToSpawn.

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

FactionKey	GetFactionKey ()

void	RepeatedSpawn ()

void	RepeatedSpawnCalled ()

void	ActivateLogic ()

void	DrawDebugShape (bool draw)

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

Protected Attributes inherited from SCR_ScenarioFrameworkSlotBase
IEntity	m_PreviewEntity

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkSlotWaypoint()

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

Parameters

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

Member Function Documentation

◆ _WB_OnKeyChanged()

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

Implements SCR_ScenarioFrameworkSlotBase.

◆ DrawDebugShape()

override void SCR_ScenarioFrameworkSlotWaypoint.DrawDebugShape ( bool draw )

protected

Implements SCR_ScenarioFrameworkLayerBase.

◆ SpawnAsset()

override IEntity SCR_ScenarioFrameworkSlotWaypoint.SpawnAsset ( )

Returns

Implements SCR_ScenarioFrameworkSlotBase.

Member Data Documentation

◆ m_Waypoint

ref SCR_ScenarioFrameworkWaypoint SCR_ScenarioFrameworkSlotWaypoint.m_Waypoint

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

Game/ScenarioFramework/Components/SCR_ScenarioFrameworkSlotWaypoint.c

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members