stmm-games-doc  0.32.0
Public Member Functions | List of all members
stmg::Theme::RuntimeVariablesEnv Class Referenceabstract

Public Member Functions

virtual ~RuntimeVariablesEnv () noexcept=default
 
virtual int32_t getVariableIdFromName (const std::string &sVarName) noexcept=0
 Get variable id from name callback. More...
 
virtual int32_t getVariableValue (int32_t nVarId) noexcept=0
 Get variable value callback. More...
 

Constructor & Destructor Documentation

◆ ~RuntimeVariablesEnv()

virtual stmg::Theme::RuntimeVariablesEnv::~RuntimeVariablesEnv ( )
virtualdefaultnoexcept

Member Function Documentation

◆ getVariableIdFromName()

virtual int32_t stmg::Theme::RuntimeVariablesEnv::getVariableIdFromName ( const std::string &  sVarName)
pure virtualnoexcept

Get variable id from name callback.

Parameters
sVarNameThe variable name. Cannot be empty.
Returns
The variable id or -1 if not defined.

◆ getVariableValue()

virtual int32_t stmg::Theme::RuntimeVariablesEnv::getVariableValue ( int32_t  nVarId)
pure virtualnoexcept

Get variable value callback.

Parameters
nVarIdThe variable id as returned from getVariableIdFromName().
Returns
The current value.