Settings Class Reference

the settings of the client More...

#include <Settings.hxx>

Inheritance diagram for Settings:

Collaboration diagram for Settings:

Public Member Functions
void	readFile ()
	Load settings from file. More...
void	writeFile ()
	Save settings to file. More...
void	resetSettingsToDefaults ()
	Reset settings to defaults from local settings file. More...

Public Attributes
friend	Singleton< Settings >
Public Attributes inherited from SettingsData
int	settingsVersion
	the version of the Settings file. Overwrite cache settings if a newer version exists More...
int	mapSize
	the size of the map More...
ScreenDimension	screenWidth
	the screen width More...
ScreenDimension	screenHeight
	the screen height More...
ScreenDimension	currentScreenWidth
	the actual screen width (can differ from the one that's set in borderless fullscreen) More...
ScreenDimension	currentScreenHeight
	the actual screen height (can differ from the one that's set in borderless fullscreen) More...
int	maxElevationHeight
	the maximum elevation height More...
float	zoneLayerTransparency
	the value of the zone layer transparency, (0 - 1.0). where 0 is full opaque and 1 for full transparency. More...
bool	vSync
	if vSync is enabled or not More...
bool	fullScreen
int	fullScreenMode
float	musicVolume
	the volume of music as float between [0, 1] More...
float	soundEffectsVolume
	the volume of sound effects as float between [0, 1] More...
bool	playMusic
	true if music should be played More...
bool	playSoundEffects
	true if sound effects should be played More...
int	audioChannels
	the number of channels used for sound playback 1=Mono,2=Stereo More...
bool	audio3DStatus
	whether to play 3D sound or not More...
std::string	buildMenuPosition
	location of the build menu More...
std::string	biome
	this is used for biomedata More...
FilePath	uiDataJSONFile
	JSONFile that contains uiData. More...
FilePath	tileDataJSONFile
	JSONFile that contains tileData. More...
FilePath	uiLayoutJSONFile
	The file path to the UI layout file. More...
FilePath	audioConfigJSONFile
	file path to Audio Configuration More...
FilePath	audioConfig3DJSONFile
	the file path to Audio Configuration 3D More...
std::string	gameLanguage
	the code for the current game language More...
FilePath	fontFileName
	FilePath of the Font that should be used. More...
int	subMenuButtonWidth
	The width in pixels of the buttons used in the build sub menues on the UI. More...
int	subMenuButtonHeight
	The height in pixels of the buttons used in the build sub menues on the UI. More...
uint32_t	defaultFontSize
bool	showBuildingsInBlueprint
	indicates whether we want to see buildings inside Blueprint layer or not More...
bool	writeErrorLogFile
	Write errors to a log file. More...

Private Member Functions
	Settings ()
	~Settings ()=default
json	parseSettingsFile (const std::string &fileName) const

Additional Inherited Members
Static Public Member Functions inherited from Singleton< Settings >
static Settings &	instance (void)
	Get an instance of the singleton. More...
Protected Member Functions inherited from Singleton< Settings >
	Singleton () noexcept=default
	~Singleton () noexcept=default

Detailed Description

the settings of the client

Definition at line 175 of file Settings.hxx.

Constructor & Destructor Documentation

Settings()

Settings::Settings ( )

private

Definition at line 12 of file Settings.cxx.

{ readFile(); }

Here is the call graph for this function:

~Settings()

Settings::~Settings ( )

privatedefault

Member Function Documentation

parseSettingsFile()

json Settings::parseSettingsFile ( const std::string &  fileName ) const

private

Definition at line 75 of file Settings.cxx.

{
  json settingsJSONObject;
 
  if (fs::fileExists(fileName))
  {
    std::string jsonFile = fs::readFileAsString(fileName);
    settingsJSONObject = json::parse(jsonFile, nullptr, false);
  }
 
  return settingsJSONObject;
}

Here is the call graph for this function:

Here is the caller graph for this function:

readFile()

void Settings::readFile

(

)

Load settings from file.

Exceptions

ConfigurationError

when loading configuration results in an error

Definition at line 14 of file Settings.cxx.

{
  const std::string pathToCachedSettingsFile = CYTOPIA_DATA_DIR + SETTINGS_FILENAME;
  const std::string pathToLocalSettingsFile = fs::getBasePath() + CYTOPIA_RESOURCES_DIR + SETTINGS_FILENAME;
 
  const json localJsonObject = parseSettingsFile(pathToLocalSettingsFile);
  const json cachedJsonObject = parseSettingsFile(pathToCachedSettingsFile);
 
  if (localJsonObject.empty() || localJsonObject.is_discarded())
    throw ConfigurationError(TRACE_INFO "Error parsing local JSON File " + string{pathToLocalSettingsFile});
 
  SettingsData settingsData;
 
  if (cachedJsonObject.empty() || cachedJsonObject.is_discarded())
  {
    settingsData = localJsonObject;
  }
  else
  {
    int cacheVersion = cachedJsonObject.value("SettingsVersion", -1);
    int localVersion = localJsonObject.value("SettingsVersion", -1);
    if (localVersion <= cacheVersion)
    {
      settingsData = cachedJsonObject;
    }
    else
    {
      LOG(LOG_INFO) << "The settings file version has changed. Overwriting local cached settings file with default settings.";
    }
  }
 
  *this = settingsData;
 
  // init the actual resolution with the desired resolution
  currentScreenWidth = screenWidth;
  currentScreenHeight = screenHeight;
 
#ifdef __ANDROID__
  subMenuButtonHeight *= 2;
  subMenuButtonWidth *= 2;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

resetSettingsToDefaults()

void Settings::resetSettingsToDefaults

(

)

Reset settings to defaults from local settings file.

Exceptions

ConfigurationError

when loading configuration results in an error

Definition at line 88 of file Settings.cxx.

{
  const std::string pathToLocalSettingsFile = fs::getBasePath() + CYTOPIA_RESOURCES_DIR + SETTINGS_FILENAME;
  const json localJsonObject = parseSettingsFile(pathToLocalSettingsFile);
 
  if (localJsonObject.empty() || localJsonObject.is_discarded())
    throw ConfigurationError(TRACE_INFO "Error parsing local JSON File " + string{pathToLocalSettingsFile});
 
  SettingsData settingsData;
  settingsData = localJsonObject;
  *this = settingsData;
}

Here is the call graph for this function:

Here is the caller graph for this function:

writeFile()

void Settings::writeFile

(

)

Save settings to file.

Definition at line 57 of file Settings.cxx.

{
  const json settingsJsonObject = *this;
  std::string pathToDataDir;
  if (CYTOPIA_DATA_DIR_BASE.empty())
  {
    LOG(LOG_ERROR) << "CYTOPIA_DATA_DIR_BASE is not set! Please report this issue on github. Falling back to cytopia base dir.";
    pathToDataDir = fs::getBasePath() + CYTOPIA_RESOURCES_DIR;
  }
  else
  {
    pathToDataDir = CYTOPIA_DATA_DIR;
  }
  std::string pathToSettingsFile = pathToDataDir + SETTINGS_FILENAME;
  fs::createDirectory(pathToDataDir);
  fs::writeStringToFile(pathToSettingsFile, settingsJsonObject.dump());
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Singleton< Settings >

friend Settings::Singleton< Settings >

Definition at line 178 of file Settings.hxx.

---

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

• src/engine/basics/Settings.hxx
• src/engine/basics/Settings.cxx