SCR_ScenarioFrameworkActionItemSafeguard Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionItemSafeguard:

Public Member Functions
void	OnItemPossessed (IEntity item, BaseInventoryStorageComponent pStorageOwner)
void	OnItemDropped (IEntity item, BaseInventoryStorageComponent pStorageOwner)
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
ref SCR_ScenarioFrameworkGet	m_Getter
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActionsOnItemDropped
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActionsOnItemPossessed
SCR_EScenarioFrameworkItemGCState	m_eGarbageCollectionStatus = SCR_EScenarioFrameworkItemGCState.UNDEFINED
Public Attributes inherited from SCR_ScenarioFrameworkActionBase
bool	m_bDebug
int	m_iMaxNumberOfActivations
IEntity	m_Entity
int	m_iNumberOfActivations

Protected Member Functions
void	OnItemCarrierChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)
void	HandleNewSlotGC (IEntity entity)
	Handles the cases where GarbageSystem might delete new slot entity.
void	HandleOldSlotGC (IEntity entity)
	Handles possible revert of case prevention where GarbageSystem might delete root entity.
void	OnDestroyed (IEntity destroyedEntity)
	Used to remove task item from destroyed entity inventory and drop it to the ground.
void	OnDisconnected (int playerID)
void	RegisterPlayer (int playerID, IEntity playerEntity)

Protected Attributes
IEntity	m_ItemEntity

Member Function Documentation

GetSubActions()

override array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkActionItemSafeguard.GetSubActions

(

)

Parameters

[out]

subActions

Implements SCR_ScenarioFrameworkActionBase.

HandleNewSlotGC()

void SCR_ScenarioFrameworkActionItemSafeguard.HandleNewSlotGC ( IEntity entity )

protected

Handles the cases where GarbageSystem might delete new slot entity.

HandleOldSlotGC()

void SCR_ScenarioFrameworkActionItemSafeguard.HandleOldSlotGC ( IEntity entity )

protected

Handles possible revert of case prevention where GarbageSystem might delete root entity.

OnActivate()

override void SCR_ScenarioFrameworkActionItemSafeguard.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implements SCR_ScenarioFrameworkActionBase.

OnDestroyed()

void SCR_ScenarioFrameworkActionItemSafeguard.OnDestroyed ( IEntity destroyedEntity )

protected

Used to remove task item from destroyed entity inventory and drop it to the ground.

OnDisconnected()

void SCR_ScenarioFrameworkActionItemSafeguard.OnDisconnected ( int playerID )

protected

OnItemCarrierChanged()

void SCR_ScenarioFrameworkActionItemSafeguard.OnItemCarrierChanged ( InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot )

protected

OnItemDropped()

void SCR_ScenarioFrameworkActionItemSafeguard.OnItemDropped	(	IEntity	item,
		BaseInventoryStorageComponent	pStorageOwner )

OnItemPossessed()

void SCR_ScenarioFrameworkActionItemSafeguard.OnItemPossessed	(	IEntity	item,
		BaseInventoryStorageComponent	pStorageOwner )

RegisterPlayer()

void SCR_ScenarioFrameworkActionItemSafeguard.RegisterPlayer ( int playerID, IEntity playerEntity )

protected

Member Data Documentation

m_aActionsOnItemDropped

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkActionItemSafeguard.m_aActionsOnItemDropped

m_aActionsOnItemPossessed

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkActionItemSafeguard.m_aActionsOnItemPossessed

m_eGarbageCollectionStatus

SCR_EScenarioFrameworkItemGCState SCR_ScenarioFrameworkActionItemSafeguard.m_eGarbageCollectionStatus = SCR_EScenarioFrameworkItemGCState.UNDEFINED

m_Getter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionItemSafeguard.m_Getter

m_ItemEntity

IEntity SCR_ScenarioFrameworkActionItemSafeguard.m_ItemEntity

protected

---

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

• Game/ScenarioFramework/Actions/SCR_ScenarioFrameworkActionItemSafeguard.c