SCR_ScenarioFrameworkLogic Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkLogic:

Public Member Functions
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
bool	m_bDebug
ref array< ref SCR_ScenarioFrameworkLogicInput >	m_aInputs
ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActions
bool	m_bIsTerminated

Member Function Documentation

_WB_OnCreate()

override void SCR_ScenarioFrameworkLogic._WB_OnCreate

(

IEntitySource

src

)

Rename entity with default name on creation in World Editor.

Parameters

[in]

src

Source entity representing the object being created in the world editor.

GetIsTerminated()

bool SCR_ScenarioFrameworkLogic.GetIsTerminated

(

)

Returns

whether the object is terminated or not.

Init()

void SCR_ScenarioFrameworkLogic.Init

(

)

Initializes scenario framework logic and inputs.

OnActivate()

void SCR_ScenarioFrameworkLogic.OnActivate

(

IEntity

entity

)

Parameters

[in]

entity

which activates this action

OnInput()

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

Implemented in SCR_ScenarioFrameworkLogicCounter, and SCR_ScenarioFrameworkLogicOR.

RestoreToDefault()

void SCR_ScenarioFrameworkLogic.RestoreToDefault

(

)

Implemented in SCR_ScenarioFrameworkLogicCounter.

SetIsTerminated()

void SCR_ScenarioFrameworkLogic.SetIsTerminated

(

bool

state

)

Parameters

[in]

state

of termination.

Member Data Documentation

m_aActions

ref array<ref SCR_ScenarioFrameworkActionBase> SCR_ScenarioFrameworkLogic.m_aActions

m_aInputs

ref array<ref SCR_ScenarioFrameworkLogicInput> SCR_ScenarioFrameworkLogic.m_aInputs

m_bDebug

bool SCR_ScenarioFrameworkLogic.m_bDebug

m_bIsTerminated

bool SCR_ScenarioFrameworkLogic.m_bIsTerminated

---

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

• Game/ScenarioFramework/Components/SCR_ScenarioFrameworkLogic.c