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

Public Attributes

std::string m_sName
 The name of the game. More...
 
GameOwnerm_p0GameOwner
 The game owner. More...
 
AssignableNamed m_oNamed
 The named indexes from the theme. More...
 
AssignableNamedObjIndex< Variable::VariableTypem_oGameVariableTypes
 The global named variable types. More...
 
AssignableNamedObjIndex< Variable::VariableTypem_oTeamVariableTypes
 The named variable types for each team. More...
 
AssignableNamedObjIndex< Variable::VariableTypem_oPlayerVariableTypes
 The named variable types for each player. More...
 
shared_ptr< Layoutm_refLayout
 The layout. More...
 
unique_ptr< RandomSourcem_refRandomSource
 The random number source. More...
 
shared_ptr< HighscoresDefinitionm_refHighscoresDefinition
 The highscores definition. More...
 
shared_ptr< Highscorem_refHighscore
 The current highscores. More...
 
double m_fMinGameInterval = 1.0
 The minimal tick interval in milliseconds. More...
 
double m_fInitialGameInterval = 100.0
 The initial tick interval in milliseconds. More...
 
int32_t m_nMaxViewTicks = 8
 Maximum number of view ticks in a game interval. More...
 
int32_t m_nAdditionalHighscoresWait = 0
 Additional milliseconds before highscores dialog appears at end of game. More...
 
double m_fSoundScaleX = 1.0
 The x axis scale from tiles to sound coordinates. More...
 
double m_fSoundScaleY = 1.0
 The y axis scale from tiles to sound coordinates. More...
 
double m_fSoundScaleZ = 1.0
 The z axis scale from tiles to sound coordinates. More...
 
int32_t m_nBoardPainterIdx = -1
 The painter the view should use for drawing board tiles. More...
 
int32_t m_nBlockPainterIdx = -1
 The painter the view should use for drawing block tiles. More...
 

Member Data Documentation

◆ m_fInitialGameInterval

double stmg::Game::Init::m_fInitialGameInterval = 100.0

The initial tick interval in milliseconds.

Default: 100.

◆ m_fMinGameInterval

double stmg::Game::Init::m_fMinGameInterval = 1.0

The minimal tick interval in milliseconds.

Default: 1.

◆ m_fSoundScaleX

double stmg::Game::Init::m_fSoundScaleX = 1.0

The x axis scale from tiles to sound coordinates.

Default: 1.

◆ m_fSoundScaleY

double stmg::Game::Init::m_fSoundScaleY = 1.0

The y axis scale from tiles to sound coordinates.

Default: 1.

◆ m_fSoundScaleZ

double stmg::Game::Init::m_fSoundScaleZ = 1.0

The z axis scale from tiles to sound coordinates.

Default: 1.

◆ m_nAdditionalHighscoresWait

int32_t stmg::Game::Init::m_nAdditionalHighscoresWait = 0

Additional milliseconds before highscores dialog appears at end of game.

Must be > 0. Default: 0.

◆ m_nBlockPainterIdx

int32_t stmg::Game::Init::m_nBlockPainterIdx = -1

The painter the view should use for drawing block tiles.

Either a valid m_oNamed.painters() index or -1 if theme should use its default. Default: -1.

◆ m_nBoardPainterIdx

int32_t stmg::Game::Init::m_nBoardPainterIdx = -1

The painter the view should use for drawing board tiles.

Either a valid m_oNamed.painters() index or -1 if theme should use its default. Default: -1.

◆ m_nMaxViewTicks

int32_t stmg::Game::Init::m_nMaxViewTicks = 8

Maximum number of view ticks in a game interval.

Must be > 0. Default: 8.

◆ m_oGameVariableTypes

AssignableNamedObjIndex<Variable::VariableType> stmg::Game::Init::m_oGameVariableTypes

The global named variable types.

◆ m_oNamed

AssignableNamed stmg::Game::Init::m_oNamed

The named indexes from the theme.

◆ m_oPlayerVariableTypes

AssignableNamedObjIndex<Variable::VariableType> stmg::Game::Init::m_oPlayerVariableTypes

The named variable types for each player.

◆ m_oTeamVariableTypes

AssignableNamedObjIndex<Variable::VariableType> stmg::Game::Init::m_oTeamVariableTypes

The named variable types for each team.

◆ m_p0GameOwner

GameOwner* stmg::Game::Init::m_p0GameOwner

The game owner.

Cannot be null.

◆ m_refHighscore

shared_ptr<Highscore> stmg::Game::Init::m_refHighscore

The current highscores.

Can be null.

◆ m_refHighscoresDefinition

shared_ptr<HighscoresDefinition> stmg::Game::Init::m_refHighscoresDefinition

The highscores definition.

Can be null.

◆ m_refLayout

shared_ptr<Layout> stmg::Game::Init::m_refLayout

The layout.

Cannot be null.

◆ m_refRandomSource

unique_ptr<RandomSource> stmg::Game::Init::m_refRandomSource

The random number source.

Can be null.

◆ m_sName

std::string stmg::Game::Init::m_sName

The name of the game.

Cannot be empty.