SCR_ScenarioFrameworkPluginOnInventoryChange Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkPluginOnInventoryChange:

Public Member Functions
override void	Init (SCR_ScenarioFrameworkLayerBase object)
	Initializes inventory storage managers for an entity, subscribes to item added and removed events.
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_aActionsOnItemAdded
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActionsOnItemRemoved
IEntity	m_Asset
Public Attributes inherited from SCR_ScenarioFrameworkPlugin
bool	m_bDebug
SCR_ScenarioFrameworkLayerBase	m_Object

Protected Member Functions
void	OnItemAdded (IEntity item, BaseInventoryStorageComponent storageOwner)
	Handles inventory item addition, debugs, and triggers actions on item addition.
void	OnItemRemoved (IEntity item, BaseInventoryStorageComponent storageOwner)
	Handles inventory item removal, debugs, and triggers actions on item removal.

Member Function Documentation

GetActions()

override array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkPluginOnInventoryChange.GetActions

(

)

Returns

[out] Actions

Implements SCR_ScenarioFrameworkPlugin.

Init()

override void SCR_ScenarioFrameworkPluginOnInventoryChange.Init

(

SCR_ScenarioFrameworkLayerBase

object

)

Initializes inventory storage managers for an entity, subscribes to item added and removed events.

Parameters

[in]

object

of layer base from which entity is further retrieved

Implements SCR_ScenarioFrameworkPlugin.

OnItemAdded()

void SCR_ScenarioFrameworkPluginOnInventoryChange.OnItemAdded ( IEntity item, BaseInventoryStorageComponent storageOwner )

protected

Handles inventory item addition, debugs, and triggers actions on item addition.

Parameters

[in]	item	Adds an item to inventory, triggers actions on item addition.
[in]	storageOwner	Represents the entity owning the inventory where an item is added.

OnItemRemoved()

void SCR_ScenarioFrameworkPluginOnInventoryChange.OnItemRemoved ( IEntity item, BaseInventoryStorageComponent storageOwner )

protected

Handles inventory item removal, debugs, and triggers actions on item removal.

Parameters

[in]	item	Removes an item from inventory, triggers actions on item removal.
[in]	storageOwner	Represents the entity owning the inventory where item is removed from.

Member Data Documentation

m_aActionsOnItemAdded

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkPluginOnInventoryChange.m_aActionsOnItemAdded

m_aActionsOnItemRemoved

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkPluginOnInventoryChange.m_aActionsOnItemRemoved

m_Asset

IEntity SCR_ScenarioFrameworkPluginOnInventoryChange.m_Asset

---

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

• Game/ScenarioFramework/Plugins/SCR_ScenarioFrameworkPluginOnInventoryChange.c