SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance:

Public Member Functions
void	SpawnRandomObject (notnull array< string > aObjectsNames)
void	SpawnRandomMultipleObjects (notnull array< string > aObjectsNames)
override void	OnActivate (IEntity object)
Public Member Functions inherited from SCR_ScenarioFrameworkActionBase
void	Init (IEntity entity)
	Initializes entity, sets OnActivate and OnDeactivate event handlers for SCR_BaseTriggerEntity.
bool	CanActivate ()
	Checks if action can be activated, handles maximum activation limit, increments activation count if possible.
bool	ValidateInputEntity (IEntity object, SCR_ScenarioFrameworkGet getter, out IEntity entity)
	Validates input entity for ScenarioFramework Action, checks if it's from layer or getter, returns true if valid.
void	OnActivate (IEntity object)
array< ref SCR_ScenarioFrameworkActionBase >	GetSubActions ()
void	RestoreToDefault ()
	Restores default settings for action and resets number of activations.
void	SpawnObjects (notnull array< string > aObjectsNames, SCR_ScenarioFrameworkEActivationType eActivationType)
	Spawns objects from an array, checks for existence, activation type, and initializes them with specified activation type.

Public Attributes
ref SCR_ScenarioFrameworkGet	m_Getter
int	m_iMinDistance
int	m_iMaxDistance
ref array< string >	m_aListOfObjects
SCR_ScenarioFrameworkEActivationType	m_eActivationType
SCR_EScenarioFrameworkSpawnChildrenType	m_SpawnObjects
int	m_iRandomPercent
Public Attributes inherited from SCR_ScenarioFrameworkActionBase
bool	m_bDebug
int	m_iMaxNumberOfActivations
IEntity	m_Entity
int	m_iNumberOfActivations

Member Function Documentation

OnActivate()

override void SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implements SCR_ScenarioFrameworkActionBase.

SpawnRandomMultipleObjects()

void SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.SpawnRandomMultipleObjects

(

notnull array< string >

aObjectsNames

)

SpawnRandomObject()

void SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.SpawnRandomObject

(

notnull array< string >

aObjectsNames

)

Member Data Documentation

m_aListOfObjects

ref array<string> SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.m_aListOfObjects

m_eActivationType

SCR_ScenarioFrameworkEActivationType SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.m_eActivationType

m_Getter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.m_Getter

m_iMaxDistance

int SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.m_iMaxDistance

m_iMinDistance

int SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.m_iMinDistance

m_iRandomPercent

int SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.m_iRandomPercent

m_SpawnObjects

SCR_EScenarioFrameworkSpawnChildrenType SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.m_SpawnObjects

---

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

• Game/ScenarioFramework/Actions/SCR_ScenarioFrameworkActionSpawnObjectBasedOnDistance.c