SCR_ScenarioFrameworkActionOnResourceConsumerChange Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkActionOnResourceConsumerChange:

Public Member Functions
override void	OnActivate (IEntity object)
void	OnResourceChanged (SCR_ResourceInteractor interactor, float previousValue)
SCR_ResourceConsumer	GetContainer (notnull IEntity entity, out SCR_ResourceComponent component)
	Get the resource consumer at given entity.
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_aActions
int	m_iActivationAmount
SCR_EScenarioFrameworkComparisonOperator	m_eComparisonOperator
IEntity	m_SupplyHolderEntity
ref SCR_ResourceSystemSubscriptionHandleBase	m_Handle
Public Attributes inherited from SCR_ScenarioFrameworkActionBase
bool	m_bDebug
int	m_iMaxNumberOfActivations
IEntity	m_Entity
int	m_iNumberOfActivations

Member Function Documentation

GetContainer()

SCR_ResourceConsumer SCR_ScenarioFrameworkActionOnResourceConsumerChange.GetContainer	(	notnull IEntity	entity,
		out SCR_ResourceComponent	component )

Get the resource consumer at given entity.

Parameters

[in]	entity
[out]	resource	component

Returns

GetSubActions()

override array< ref SCR_ScenarioFrameworkActionBase > SCR_ScenarioFrameworkActionOnResourceConsumerChange.GetSubActions

(

)

Parameters

[out]

subActions

Implements SCR_ScenarioFrameworkActionBase.

OnActivate()

override void SCR_ScenarioFrameworkActionOnResourceConsumerChange.OnActivate

(

IEntity

object

)

Parameters

[in]

object

Implements SCR_ScenarioFrameworkActionBase.

OnResourceChanged()

void SCR_ScenarioFrameworkActionOnResourceConsumerChange.OnResourceChanged	(	SCR_ResourceInteractor	interactor,
		float	previousValue )

Member Data Documentation

m_aActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkActionOnResourceConsumerChange.m_aActions

m_eComparisonOperator

SCR_EScenarioFrameworkComparisonOperator SCR_ScenarioFrameworkActionOnResourceConsumerChange.m_eComparisonOperator

m_Getter

ref SCR_ScenarioFrameworkGet SCR_ScenarioFrameworkActionOnResourceConsumerChange.m_Getter

m_Handle

ref SCR_ResourceSystemSubscriptionHandleBase SCR_ScenarioFrameworkActionOnResourceConsumerChange.m_Handle

m_iActivationAmount

int SCR_ScenarioFrameworkActionOnResourceConsumerChange.m_iActivationAmount

m_SupplyHolderEntity

IEntity SCR_ScenarioFrameworkActionOnResourceConsumerChange.m_SupplyHolderEntity

---

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

• Game/ScenarioFramework/Actions/ResourceComponentActions/SCR_ScenarioFrameworkActionOnResourceConsumerChange.c