SCR_ScenarioFrameworkActionOnUserActionEvent Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionOnUserActionEvent:

Public Member Functions
void	OnInvoked (IEntity user, ScriptedUserAction action, EUserActionEvent e)
override void	OnActivate (IEntity object)
override array< ref SCR_ScenarioFrameworkActionBase >	GetSubActions ()
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	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_iActionID
ref SCR_ScenarioFrameworkGet	m_GetterUser
EUserActionEvent	m_eUserActionEvent
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActions
ref array< IEntity >	m_aUserEntities
Public Attributes inherited from SCR_ScenarioFrameworkActionBase
bool	m_bDebug
int	m_iMaxNumberOfActivations
IEntity	m_Entity
int	m_iNumberOfActivations

Member Function Documentation

GetSubActions()

override array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkActionOnUserActionEvent.GetSubActions

(

)

Parameters

[out]

subActions

Implements SCR_ScenarioFrameworkActionBase.

OnActivate()

override void SCR_ScenarioFrameworkActionOnUserActionEvent.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implements SCR_ScenarioFrameworkActionBase.

OnInvoked()

void SCR_ScenarioFrameworkActionOnUserActionEvent.OnInvoked	(	IEntity	user,
		ScriptedUserAction	action,
		EUserActionEvent	e )

Member Data Documentation

m_aActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkActionOnUserActionEvent.m_aActions

m_aUserEntities

ref array<IEntity> SCR_ScenarioFrameworkActionOnUserActionEvent.m_aUserEntities

m_eUserActionEvent

EUserActionEvent SCR_ScenarioFrameworkActionOnUserActionEvent.m_eUserActionEvent

m_Getter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionOnUserActionEvent.m_Getter

m_GetterUser

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionOnUserActionEvent.m_GetterUser

m_iActionID

int SCR_ScenarioFrameworkActionOnUserActionEvent.m_iActionID

---

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

• Game/ScenarioFramework/Actions/SCR_ScenarioFrameworkActionOnUserActionEvent.c