stmg::HighscoresLoader Class Reference

Inheritance diagram for stmg::HighscoresLoader:

Public Member Functions
virtual	~HighscoresLoader () noexcept=default
virtual std::vector< shared_ptr< Highscore > >	getHighscores (const std::string &sGameName, const shared_ptr< HighscoresDefinition > &refHighscoresDefinition) const noexcept=0
	Get all the currently available highscores for a game. More...
virtual shared_ptr< Highscore >	getHighscore (const std::string &sGameName, const AppPreferences &oPreferences, const shared_ptr< HighscoresDefinition > &refHighscoresDefinition) const noexcept=0
	Get the highscore for the game (prefs) and the highscores definition. More...
virtual bool	updateHighscore (const std::string &sGameName, const AppPreferences &oPreferences, const Highscore &oHighscore) noexcept=0
	Persist the highscores for a game. More...

Constructor & Destructor Documentation

~HighscoresLoader()

virtual stmg::HighscoresLoader::~HighscoresLoader ( )

virtualdefaultnoexcept

Member Function Documentation

getHighscore()

virtual shared_ptr<Highscore> stmg::HighscoresLoader::getHighscore ( const std::string &  sGameName, const AppPreferences &  oPreferences, const shared_ptr< HighscoresDefinition > &  refHighscoresDefinition  ) const

pure virtualnoexcept

Get the highscore for the game (prefs) and the highscores definition.

Parameters

sGameName	The game name. Cannot be empty.
oPreferences	The preferences.
refHighscoresDefinition	The highscores definition. Cannot be null.

Returns

The highscores or null if there's no highscore for the game (type).

Implemented in stmg::XmlHighscoresLoader.

getHighscores()

virtual std::vector<shared_ptr<Highscore> > stmg::HighscoresLoader::getHighscores ( const std::string &  sGameName, const shared_ptr< HighscoresDefinition > &  refHighscoresDefinition  ) const

pure virtualnoexcept

Get all the currently available highscores for a game.

Parameters

sGameName	The game name. Cannot be empty.
refHighscoresDefinition	The highscores definition. Cannot be null.

Returns

The highscores for the game.

Implemented in stmg::XmlHighscoresLoader.

updateHighscore()

virtual bool stmg::HighscoresLoader::updateHighscore ( const std::string &  sGameName, const AppPreferences &  oPreferences, const Highscore &  oHighscore  )

pure virtualnoexcept

Persist the highscores for a game.

Parameters

sGameName	The game name. Cannot be empty.
oPreferences	The preferences.
oHighscore	The highscore.

Returns

Whether the update was successful.

Implemented in stmg::XmlHighscoresLoader.