SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft:

Public Member Functions
void	OnCompartmentEnteredOrLeft (IEntity vehicle, BaseCompartmentManagerComponent mgr, IEntity occupant, int managerId, int slotID)
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 Member Functions inherited from BaseContainerObject
proto external string	GetStoreName ()
	Retrieve the store name, usually just a GUID.

Public Attributes
bool	m_bEnteredOrLeft
ref SCR_ScenarioFrameworkGet	m_Getter
ref SCR_ScenarioFrameworkGet	m_OccupantGetter
ref array< int >	m_aSlotIDs
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActions
IEntity	m_OccupantEntity
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_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.GetSubActions

(

)

Parameters

[out]

subActions

Implements SCR_ScenarioFrameworkActionBase.

OnActivate()

override void SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implements SCR_ScenarioFrameworkActionBase.

OnCompartmentEnteredOrLeft()

void SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.OnCompartmentEnteredOrLeft	(	IEntity	vehicle,
		BaseCompartmentManagerComponent	mgr,
		IEntity	occupant,
		int	managerId,
		int	slotID )

Parameters

[in]	vehicle
[in]	mgr
[in]	occupant
[in]	managerId
[in]	slotID

Member Data Documentation

m_aActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.m_aActions

m_aSlotIDs

ref array<int> SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.m_aSlotIDs

m_bEnteredOrLeft

bool SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.m_bEnteredOrLeft

m_Getter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.m_Getter

m_OccupantEntity

IEntity SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.m_OccupantEntity

m_OccupantGetter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.m_OccupantGetter

---

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

• Game/ScenarioFramework/Actions/SCR_ScenarioFrameworkActionOnCompartmentEnteredOrLeft.c