SCR_ScenarioFrameworkLogicCounter Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkLogicCounter:

Public Member Functions
override void	OnInput (bool pSignal=true, IEntity entity=null)
	Increases entity or self based on input signal.
int	GetCounterValue ()
void	SetCounterValue (int value)
void	Increase (IEntity entity)
	Increases the counter value by 1.
void	Decrease (IEntity entity)
	Decreases the counter value by 1.
void	Reset ()
	Resets counter to 0.
override void	RestoreToDefault ()
Public Member Functions inherited from SCR_ScenarioFrameworkLogic
void	Init ()
	Initializes scenario framework logic and inputs.
void	SetIsTerminated (bool state)
bool	GetIsTerminated ()
void	OnInput (bool pSignal=true, IEntity entity=null)
void	OnActivate (IEntity entity)
void	RestoreToDefault ()
override void	_WB_OnCreate (IEntitySource src)
	Rename entity with default name on creation in World Editor.

Public Attributes
int	m_iCountTo
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aOnIncreaseActions
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aOnDecreaseActions
int	m_iCnt = 0
Public Attributes inherited from SCR_ScenarioFrameworkLogic
bool	m_bDebug
ref array< ref SCR_ScenarioFrameworkLogicInput >	m_aInputs
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActions
bool	m_bIsTerminated

Member Function Documentation

Decrease()

void SCR_ScenarioFrameworkLogicCounter.Decrease

(

IEntity

entity

)

Decreases the counter value by 1.

Parameters

[in]

entity

GetCounterValue()

int SCR_ScenarioFrameworkLogicCounter.GetCounterValue

(

)

Returns

Counter value.

Increase()

void SCR_ScenarioFrameworkLogicCounter.Increase

(

IEntity

entity

)

Increases the counter value by 1.

Parameters

[in]

entity

OnInput()

override void SCR_ScenarioFrameworkLogicCounter.OnInput	(	bool	pSignal = true,
		IEntity	entity = null
	)

Increases entity or self based on input signal.

Parameters

[in]	pSignal	Boolean flag indicating whether input signal is active or not.
[in]	entity	Increases entity's value if entity is provided, else increases this entity's value.

Implements SCR_ScenarioFrameworkLogic.

Reset()

void SCR_ScenarioFrameworkLogicCounter.Reset

(

)

Resets counter to 0.

RestoreToDefault()

override void SCR_ScenarioFrameworkLogicCounter.RestoreToDefault

(

)

Implements SCR_ScenarioFrameworkLogic.

SetCounterValue()

void SCR_ScenarioFrameworkLogicCounter.SetCounterValue

(

int

value

)

Parameters

[in]

value

Sets counter value.

Member Data Documentation

m_aOnDecreaseActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkLogicCounter.m_aOnDecreaseActions

m_aOnIncreaseActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkLogicCounter.m_aOnIncreaseActions

m_iCnt

int SCR_ScenarioFrameworkLogicCounter.m_iCnt = 0

m_iCountTo

int SCR_ScenarioFrameworkLogicCounter.m_iCountTo

---

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

• Game/ScenarioFramework/Components/SCR_ScenarioFrameworkLogic.c