stmg::GameInfoCtx Class Reference

Inheritance diagram for stmg::GameInfoCtx:

Public Member Functions
	GameInfoCtx (const shared_ptr< AppConfig > &refAppConfig, const File &oGameFile)
	GameInfoCtx (const shared_ptr< AppPreferences > &refAppPreferences, Named &oNamed, const File &oGameFile)
const GameConstraints &	getGameConstraints () const
const shared_ptr< HighscoresDefinition > &	getHighscoresDefinition () const
const NamedObjIndex< Variable::VariableType > &	getGameVariableTypes () const
const NamedObjIndex< Variable::VariableType > &	getTeamVariableTypes () const
const NamedObjIndex< Variable::VariableType > &	getMateVariableTypes () const
const NamedObjIndex< Variable::VariableType > &	getVariableTypes (OwnerType eOwnerType) const
std::pair< int32_t, OwnerType >	getVariableIdAndOwnerType (const std::string &sVarName) const
double	getMinGameInterval () const
	Get minimum game interval. More...
double	getInitialGameInterval () const
	Get initial game interval. More...
int32_t	getMaxViewTicks () const
	Get the maximum number of view ticks in a game interval. More...
int32_t	getAdditionalHighscoresWait () const
	Get additional time in milliseconds for highscores to appear when game ended. More...
std::tuple< double, double, double >	getSoundScales () const
	The sound scales from tiles to sound coordinates. More...
int32_t	getBoardPainterIdx () const
int32_t	getBlockPainterIdx () const
Public Member Functions inherited from stmg::ConditionalCtx
	ConditionalCtx (const shared_ptr< AppPreferences > &refAppPreferences, Named &oNamed)
	ConditionalCtx (const shared_ptr< AppConfig > &refAppConfig, Named &oNamed)
virtual int32_t	getContextTeam () const
	The context team. More...
virtual int32_t	getContextMate () const
	The context mate. More...
void	addChecker (const xmlpp::Element *p0Element) override
	Adds a checker for the element. More...
void	removeChecker (const xmlpp::Element *p0Element, bool bCheckChildElements, bool bCheckAttrs) override
	Removes a checker for the element. More...
Public Member Functions inherited from stmg::ParserCtx
	ParserCtx (const shared_ptr< AppConfig > &refAppConfig, Named &oNamed)
	Constructor. More...
	ParserCtx (const shared_ptr< AppPreferences > &refAppPreferences, Named &oNamed)
	Constructor. More...
virtual	~ParserCtx ()
const shared_ptr< AppConfig > &	appConfig ()
	The app config. More...
const shared_ptr< AppPreferences > &	appPreferences ()
	The app preferences. More...
Named &	named ()
	The named assets. More...
void	pushCtx (const std::string &sStr)
	Push a context. More...
void	popCtx ()
	Pop a context. More...
void	addValidChildElementName (const xmlpp::Element *p0Element, const std::string &sChildElementName)
	Declares a child element name as valid. More...
void	addValidChildElementNames (const xmlpp::Element *p0Element, const std::string &sChildElementName)
	Declares a child element name as valid. More...
template<typename ... Names>
void	addValidChildElementNames (const xmlpp::Element *p0Element, const std::string &sChildElementName, const Names &... oNames)
	Declares multiple child element names as valid. More...
void	addValidAttrName (const xmlpp::Element *p0Element, const std::string &sAttrName)
	Declares an attribute name as valid. More...
void	addValidAttrNames (const xmlpp::Element *p0Element, const std::string &sAttrName)
	Declares an attribute name as valid. More...
template<typename ... Names>
void	addValidAttrNames (const xmlpp::Element *p0Element, const std::string &sAttrName, const Names &... oNames)
	Declares attribute names as valid. More...
void	removeChecker (const xmlpp::Element *p0Element, bool bCheck)
	Removes a checker for the element. More...
std::runtime_error	error (const std::string &sErr)
	Creates an exception for the current context. More...
void	dump () const

Protected Member Functions
std::string	err (const std::string &sErr) override
	Builds complete error string from context. More...
Protected Member Functions inherited from stmg::ParserCtx
std::vector< Checker >::iterator	getChecker (const xmlpp::Element *p0Element)

Additional Inherited Members
Static Public Member Functions inherited from stmg::ParserCtx
static int32_t	getLine (const xmlpp::Element *p0Element, const std::string &sAttr)
	The line number within a document of an element or attribute. More...
Protected Attributes inherited from stmg::ParserCtx
const shared_ptr< AppConfig >	m_refAppConfig
shared_ptr< AppPreferences >	m_refAppPreferences
Named &	m_oNamed
std::vector< std::string >	m_oStack
std::vector< Checker >	m_aCheckers

Constructor & Destructor Documentation

GameInfoCtx() [1/2]

stmg::GameInfoCtx::GameInfoCtx	(	const shared_ptr< AppConfig > &	refAppConfig,
		const File &	oGameFile
	)

GameInfoCtx() [2/2]

stmg::GameInfoCtx::GameInfoCtx	(	const shared_ptr< AppPreferences > &	refAppPreferences,
		Named &	oNamed,
		const File &	oGameFile
	)

Member Function Documentation

err()

std::string stmg::GameInfoCtx::err ( const std::string &  s )

overrideprotectedvirtual

Builds complete error string from context.

The base implementation concatenates strings passed to pushCtx().

Parameters

s	The error without context.

Returns

The error string with context.

Reimplemented from stmg::ParserCtx.

getAdditionalHighscoresWait()

int32_t stmg::GameInfoCtx::getAdditionalHighscoresWait ( ) const

inline

Get additional time in milliseconds for highscores to appear when game ended.

Returns

The additional time in milliseconds.

getBlockPainterIdx()

int32_t stmg::GameInfoCtx::getBlockPainterIdx ( ) const

inline

getBoardPainterIdx()

int32_t stmg::GameInfoCtx::getBoardPainterIdx ( ) const

inline

getGameConstraints()

const GameConstraints& stmg::GameInfoCtx::getGameConstraints ( ) const

inline

getGameVariableTypes()

const NamedObjIndex<Variable::VariableType>& stmg::GameInfoCtx::getGameVariableTypes ( ) const

inline

getHighscoresDefinition()

const shared_ptr<HighscoresDefinition>& stmg::GameInfoCtx::getHighscoresDefinition ( ) const

inline

getInitialGameInterval()

double stmg::GameInfoCtx::getInitialGameInterval ( ) const

inline

Get initial game interval.

Returns

The interval in milliseconds or -1.0 if not defined.

getMateVariableTypes()

const NamedObjIndex<Variable::VariableType>& stmg::GameInfoCtx::getMateVariableTypes ( ) const

inline

getMaxViewTicks()

int32_t stmg::GameInfoCtx::getMaxViewTicks ( ) const

inline

Get the maximum number of view ticks in a game interval.

Returns

The maximum or -1 if not defined.

getMinGameInterval()

double stmg::GameInfoCtx::getMinGameInterval ( ) const

inline

Get minimum game interval.

Returns

The interval in milliseconds or -1.0 if not defined.

getSoundScales()

std::tuple<double,double, double> stmg::GameInfoCtx::getSoundScales

(

)

const

The sound scales from tiles to sound coordinates.

Returns

The scales.

getTeamVariableTypes()

const NamedObjIndex<Variable::VariableType>& stmg::GameInfoCtx::getTeamVariableTypes ( ) const

inline

getVariableIdAndOwnerType()

std::pair<int32_t, OwnerType> stmg::GameInfoCtx::getVariableIdAndOwnerType

(

const std::string &

sVarName

)

const

getVariableTypes()

const NamedObjIndex<Variable::VariableType>& stmg::GameInfoCtx::getVariableTypes

(

OwnerType

eOwnerType

)

const