SCR_ScenarioFrameworkPluginOnDestroyEvent Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkPluginOnDestroyEvent:

Public Member Functions
override void	Init (SCR_ScenarioFrameworkLayerBase object)
	Initializes scenario framework layer, registers damage state change event, checks for vehicle engine stop event, and schedules engine drowning action.
void	OnActivate ()
void	OnObjectDamage (EDamageState state)
void	CheckEngineDrowned ()
	Checks if engine is downed, removes related event handlers, and activates actions on destroy if engine is drown.
void	OnGroupEmpty (AIGroup group)
override array< ref SCR_ScenarioFrameworkActionBase >	GetActions ()
Public Member Functions inherited from SCR_ScenarioFrameworkPlugin
SCR_ScenarioFrameworkLayerBase	GetObject ()
void	OnWBKeyChanged (SCR_ScenarioFrameworkLayerBase object)
Public Member Functions inherited from BaseContainerObject
proto external string	GetStoreName ()
	Retrieve the store name, usually just a GUID.

Public Attributes
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActionsOnDestroy
IEntity	m_Asset
Public Attributes inherited from SCR_ScenarioFrameworkPlugin
bool	m_bDebug
SCR_ScenarioFrameworkLayerBase	m_Object

Member Function Documentation

CheckEngineDrowned()

void SCR_ScenarioFrameworkPluginOnDestroyEvent.CheckEngineDrowned

(

)

Checks if engine is downed, removes related event handlers, and activates actions on destroy if engine is drown.

GetActions()

override array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkPluginOnDestroyEvent.GetActions

(

)

Returns

[out] Actions

Implements SCR_ScenarioFrameworkPlugin.

Init()

override void SCR_ScenarioFrameworkPluginOnDestroyEvent.Init

(

SCR_ScenarioFrameworkLayerBase

object

)

Initializes scenario framework layer, registers damage state change event, checks for vehicle engine stop event, and schedules engine drowning action.

Parameters

[in]

object

of layer base from which entity is further retrieved

Implements SCR_ScenarioFrameworkPlugin.

OnActivate()

void SCR_ScenarioFrameworkPluginOnDestroyEvent.OnActivate

(

)

OnGroupEmpty()

void SCR_ScenarioFrameworkPluginOnDestroyEvent.OnGroupEmpty

(

AIGroup

group

)

OnObjectDamage()

void SCR_ScenarioFrameworkPluginOnDestroyEvent.OnObjectDamage

(

EDamageState

state

)

Parameters

[in]

state

OnObjectDamage state represents the current damage state of an object in the game, used to determine if an object has been

Member Data Documentation

m_aActionsOnDestroy

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkPluginOnDestroyEvent.m_aActionsOnDestroy

m_Asset

IEntity SCR_ScenarioFrameworkPluginOnDestroyEvent.m_Asset

---

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

• Game/ScenarioFramework/Plugins/SCR_ScenarioFrameworkPluginOnDestroyEvent.c