Hymn to Beauty
C++ 3D Engine
GameSettings Class Reference

Settings for the game. More...

#include <GameSettings.hpp>

Inheritance diagram for GameSettings:
Settings

Public Member Functions

void Save () final
 Save the settings to an INI file. More...
 
void Load ()
 Load the settings from INI file. More...
 
- Public Member Functions inherited from Settings
bool GetBool (const std::string &settingName)
 Get a bool setting. More...
 
void SetBool (const std::string &settingName, bool value)
 Set a bool setting. More...
 
long GetLong (const std::string &settingName)
 Get a long setting. More...
 
void SetLong (const std::string &settingName, long value)
 Set a long setting. More...
 
double GetDouble (const std::string &settingName)
 Get a double setting. More...
 
void SetDouble (const std::string &settingName, double value)
 Set a double setting. More...
 
std::string GetString (const std::string &settingName)
 Get a string setting. More...
 
void SetString (const std::string &settingName, const std::string &value)
 Set a string setting. More...
 

Static Public Member Functions

static GameSettingsGetInstance ()
 Get the instance of the class. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Settings
void AddBoolSetting (const std::string &settingName, const std::string &section, const std::string &key, bool defaultValue)
 Add a bool setting. More...
 
void AddLongSetting (const std::string &settingName, const std::string &section, const std::string &key, long defaultValue)
 Add a long setting. More...
 
void AddDoubleSetting (const std::string &settingName, const std::string &section, const std::string &key, double defaultValue)
 Add a double setting. More...
 
void AddStringSetting (const std::string &settingName, const std::string &section, const std::string &key, const std::string &defaultValue)
 Add a string setting. More...
 
- Protected Attributes inherited from Settings
CSimpleIni ini
 Ini file. More...
 

Detailed Description

Settings for the game.

Available settings: Name | Description | Type | Default Value -------------------— | -----------------------------— | ---— | ----------—

Member Function Documentation

◆ GetInstance()

GameSettings & GameSettings::GetInstance ( )
static

Get the instance of the class.

Returns
The GameSettings instance

◆ Load()

void GameSettings::Load ( )

Load the settings from INI file.

◆ Save()

void GameSettings::Save ( )
finalvirtual

Save the settings to an INI file.

Implements Settings.


The documentation for this class was generated from the following files: