stmm-games-doc  0.32.0
Public Attributes | List of all members
stmg::Variable::VariableType Struct Reference

The variable type. More...

Public Attributes

int32_t m_nInitialValue = 0
 The initial value. More...
 
bool m_bReadOnly = false
 Whether the variable with this type is read-only. More...
 
bool m_bTimeRelative = false
 Whether the variable is time relative (time passed from the start of the game). More...
 
bool m_bAddTime = true
 Whether the passed time should be added to the variable (or subtracted. More...
 
VARIABLE_TIME_BASE m_eTimeBase = VARIABLE_TIME_BASE_SEC
 What is the time base to be added (or subtracted). More...
 
VARIABLE_FORMAT m_eFormat = VARIABLE_FORMAT_NUMBER
 The format the variable should appear when converted to a string. More...
 

Detailed Description

The variable type.

Each variable is associated with a type. Usually more variables share the same type (for example the Points variable for each team have the same type).

Member Data Documentation

◆ m_bAddTime

bool stmg::Variable::VariableType::m_bAddTime = true

Whether the passed time should be added to the variable (or subtracted.

Default is true.

◆ m_bReadOnly

bool stmg::Variable::VariableType::m_bReadOnly = false

Whether the variable with this type is read-only.

Default is false.

◆ m_bTimeRelative

bool stmg::Variable::VariableType::m_bTimeRelative = false

Whether the variable is time relative (time passed from the start of the game).

Default is false.

◆ m_eFormat

VARIABLE_FORMAT stmg::Variable::VariableType::m_eFormat = VARIABLE_FORMAT_NUMBER

The format the variable should appear when converted to a string.

◆ m_eTimeBase

VARIABLE_TIME_BASE stmg::Variable::VariableType::m_eTimeBase = VARIABLE_TIME_BASE_SEC

What is the time base to be added (or subtracted).

◆ m_nInitialValue

int32_t stmg::Variable::VariableType::m_nInitialValue = 0

The initial value.

Default is 0.