SCR_ScenarioFrameworkActionOnAnimationEvent Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionOnAnimationEvent:

Public Member Functions
override void	OnActivate (IEntity object)
void	OnAnimationEvent (AnimationEventID animEventType, AnimationEventID animUserString, int intParam, float timeFromStart, float timeToEnd)
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 Member Functions inherited from BaseContainerObject
proto external string	GetStoreName ()
	Retrieve the store name, usually just a GUID.

Public Attributes
ref SCR_ScenarioFrameworkGet	m_Getter
string	m_sAnimationEventString
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActions
SCR_CharacterControllerComponent	m_CharController
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_ScenarioFrameworkActionOnAnimationEvent.GetSubActions

(

)

Parameters

[out]

subActions

Implements SCR_ScenarioFrameworkActionBase.

OnActivate()

override void SCR_ScenarioFrameworkActionOnAnimationEvent.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implements SCR_ScenarioFrameworkActionBase.

OnAnimationEvent()

void SCR_ScenarioFrameworkActionOnAnimationEvent.OnAnimationEvent	(	AnimationEventID	animEventType,
		AnimationEventID	animUserString,
		int	intParam,
		float	timeFromStart,
		float	timeToEnd )

Parameters

[in]

state

Member Data Documentation

m_aActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkActionOnAnimationEvent.m_aActions

m_CharController

SCR_CharacterControllerComponent SCR_ScenarioFrameworkActionOnAnimationEvent.m_CharController

m_Getter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionOnAnimationEvent.m_Getter

m_sAnimationEventString

string SCR_ScenarioFrameworkActionOnAnimationEvent.m_sAnimationEventString

---

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

• Game/ScenarioFramework/Actions/SCR_ScenarioFrameworkOnAnimationEvent.c