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

Public Attributes

std::string m_sAppName
 The application name. More...
 
std::string m_sAppVersion
 The application version. More...
 
shared_ptr< stmi::DeviceManagerm_refDeviceManager
 The device manager, source of input events and playback capability provider. More...
 
AppConstraints m_oAppConstraints
 Constraints. More...
 
CapabilityAssignment m_oCapabilityAssignment
 How capabilities are assigned to players. More...
 
std::vector< KeyActionm_aKeyActions
 The key actions. More...
 
std::vector< shared_ptr< Option > > m_aOptions
 The (possibly interrelated) options. More...
 
int32_t m_nMaxGamePlayedHistory = 10
 The maximum number of latest game names played. More...
 
bool m_bSoundEnabled = true
 Whether game plays sounds. More...
 
bool m_bSoundPerPlayerAllowed = false
 Whether the game allows per player sound output. More...
 
bool m_bTestMode = false
 Whether test mode. More...
 

Member Data Documentation

◆ m_aKeyActions

std::vector<KeyAction> stmg::StdConfig::Init::m_aKeyActions

The key actions.

Names must be unique.

◆ m_aOptions

std::vector< shared_ptr<Option> > stmg::StdConfig::Init::m_aOptions

The (possibly interrelated) options.

Option names starting with an underscore are reserved (not allowed here).

◆ m_bSoundEnabled

bool stmg::StdConfig::Init::m_bSoundEnabled = true

Whether game plays sounds.

Default is true.

◆ m_bSoundPerPlayerAllowed

bool stmg::StdConfig::Init::m_bSoundPerPlayerAllowed = false

Whether the game allows per player sound output.

Must be false if m_bSoundEnabled is false. Default is false.

◆ m_bTestMode

bool stmg::StdConfig::Init::m_bTestMode = false

Whether test mode.

Default is false.

◆ m_nMaxGamePlayedHistory

int32_t stmg::StdConfig::Init::m_nMaxGamePlayedHistory = 10

The maximum number of latest game names played.

Can be 0. Default is 10.

◆ m_oAppConstraints

AppConstraints stmg::StdConfig::Init::m_oAppConstraints

Constraints.

◆ m_oCapabilityAssignment

CapabilityAssignment stmg::StdConfig::Init::m_oCapabilityAssignment

How capabilities are assigned to players.

◆ m_refDeviceManager

shared_ptr<stmi::DeviceManager> stmg::StdConfig::Init::m_refDeviceManager

The device manager, source of input events and playback capability provider.

Cannot be null.

◆ m_sAppName

std::string stmg::StdConfig::Init::m_sAppName

The application name.

Cannot be empty and only contain alphanum and '-' and '_'.

◆ m_sAppVersion

std::string stmg::StdConfig::Init::m_sAppVersion

The application version.

Cannot be empty.