SCR_ScenarioFrameworkLogicStruct Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkLogicStruct:

Public Member Functions
void	IncreaseStructVarCount ()
	Increases struct variable count by 1.
int	GetStructVarCount ()
bool	GetIsTerminated ()
string	GetName ()
int	GetCounterValue ()
void	SetIsTerminated (bool state)
void	SetName (string name)
void	SetCounterValue (int value)
void	SCR_ScenarioFrameworkLogicStruct ()
	Registers scenario framework variables: name, termination status, counter value.
Public Member Functions inherited from SCR_JsonApiStruct
bool	Serialize ()
	Write world data into the struct.
bool	Deserialize ()
	Read data from the struct and apply them in the world.
void	ClearCache ()
	Clear struct's data.
void	Log ()
	Log struct's data.

Protected Attributes
string	m_sName
int	m_iCounterValue
bool	m_bIsTerminated
int	m_iStructVarCount

Constructor & Destructor Documentation

SCR_ScenarioFrameworkLogicStruct()

void SCR_ScenarioFrameworkLogicStruct.SCR_ScenarioFrameworkLogicStruct

(

)

Registers scenario framework variables: name, termination status, counter value.

Member Function Documentation

GetCounterValue()

int SCR_ScenarioFrameworkLogicStruct.GetCounterValue

(

)

Returns

The return value represents the current count value stored in m_iCounterValue variable.

GetIsTerminated()

bool SCR_ScenarioFrameworkLogicStruct.GetIsTerminated

(

)

Returns

whether the object is terminated or not.

GetName()

string SCR_ScenarioFrameworkLogicStruct.GetName

(

)

Returns

the name stored in the variable m_sName.

GetStructVarCount()

int SCR_ScenarioFrameworkLogicStruct.GetStructVarCount

(

)

Returns

The number of structure variables in the class.

IncreaseStructVarCount()

void SCR_ScenarioFrameworkLogicStruct.IncreaseStructVarCount

(

)

Increases struct variable count by 1.

SetCounterValue()

void SCR_ScenarioFrameworkLogicStruct.SetCounterValue

(

int

value

)

Parameters

[in]

value

Sets the counter value for further use in the script.

SetIsTerminated()

void SCR_ScenarioFrameworkLogicStruct.SetIsTerminated

(

bool

state

)

Parameters

[in]

state

indicating termination status.

SetName()

void SCR_ScenarioFrameworkLogicStruct.SetName

(

string

name

)

Parameters

[in]

name

Sets layer name.

Member Data Documentation

m_bIsTerminated

bool SCR_ScenarioFrameworkLogicStruct.m_bIsTerminated

protected

m_iCounterValue

int SCR_ScenarioFrameworkLogicStruct.m_iCounterValue

protected

m_iStructVarCount

int SCR_ScenarioFrameworkLogicStruct.m_iStructVarCount

protected

m_sName

string SCR_ScenarioFrameworkLogicStruct.m_sName

protected

---

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

• Game/ScenarioFramework/SCR_ScenarioFrameworkStruct.c