Cytopia  0.3
A city building simulation game
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SettingsData Struct Reference

#include <Settings.hxx>

+ Inheritance diagram for SettingsData:
+ Collaboration diagram for SettingsData:

Public Attributes

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...
 

Detailed Description

Todo:

This and Settings must be refactored into a TransitiveModel class

This TransitiveModel must be subscribed to by the Settings iView

We must create a ServiceController class with setters and Events for each field

Definition at line 23 of file Settings.hxx.

Member Data Documentation

◆ audio3DStatus

bool SettingsData::audio3DStatus

whether to play 3D sound or not

Definition at line 103 of file Settings.hxx.

◆ audioChannels

int SettingsData::audioChannels

the number of channels used for sound playback 1=Mono,2=Stereo

Definition at line 100 of file Settings.hxx.

◆ audioConfig3DJSONFile

FilePath SettingsData::audioConfig3DJSONFile

the file path to Audio Configuration 3D

Definition at line 142 of file Settings.hxx.

◆ audioConfigJSONFile

FilePath SettingsData::audioConfigJSONFile

file path to Audio Configuration

Definition at line 139 of file Settings.hxx.

◆ biome

std::string SettingsData::biome

this is used for biomedata

Todo:

Remove this later when terraingen is using biomes

replace by enum when BetterEnums is implemented

Definition at line 118 of file Settings.hxx.

◆ buildMenuPosition

std::string SettingsData::buildMenuPosition

location of the build menu

Acceptable values are "LEFT", "RIGHT", "TOP", and "BOTTOM"

Todo:

add a typename

replace by enum when BetterEnums is implemented

Definition at line 111 of file Settings.hxx.

◆ currentScreenHeight

ScreenDimension SettingsData::currentScreenHeight

the actual screen height (can differ from the one that's set in borderless fullscreen)

Definition at line 52 of file Settings.hxx.

◆ currentScreenWidth

ScreenDimension SettingsData::currentScreenWidth

the actual screen width (can differ from the one that's set in borderless fullscreen)

Definition at line 49 of file Settings.hxx.

◆ defaultFontSize

uint32_t SettingsData::defaultFontSize

Definition at line 162 of file Settings.hxx.

◆ fontFileName

FilePath SettingsData::fontFileName

FilePath of the Font that should be used.

Definition at line 148 of file Settings.hxx.

◆ fullScreen

bool SettingsData::fullScreen
Todo:

document what this field is

add a typename

Definition at line 76 of file Settings.hxx.

◆ fullScreenMode

int SettingsData::fullScreenMode
Todo:

document what this field is

add a typename

Definition at line 82 of file Settings.hxx.

◆ gameLanguage

std::string SettingsData::gameLanguage

the code for the current game language

Definition at line 145 of file Settings.hxx.

◆ mapSize

int SettingsData::mapSize

the size of the map

Todo:
add a typename

Definition at line 34 of file Settings.hxx.

◆ maxElevationHeight

int SettingsData::maxElevationHeight

the maximum elevation height

Todo:
add a typename

Definition at line 58 of file Settings.hxx.

◆ musicVolume

float SettingsData::musicVolume

the volume of music as float between [0, 1]

Definition at line 85 of file Settings.hxx.

◆ playMusic

bool SettingsData::playMusic

true if music should be played

Definition at line 91 of file Settings.hxx.

◆ playSoundEffects

bool SettingsData::playSoundEffects

true if sound effects should be played

Definition at line 94 of file Settings.hxx.

◆ screenHeight

ScreenDimension SettingsData::screenHeight

the screen height

Precondition
only apply for windowed or fullscreen mode

Definition at line 46 of file Settings.hxx.

◆ screenWidth

ScreenDimension SettingsData::screenWidth

the screen width

Precondition
only apply for windowed or fullscreen mode

Definition at line 40 of file Settings.hxx.

◆ settingsVersion

int SettingsData::settingsVersion

the version of the Settings file. Overwrite cache settings if a newer version exists

Definition at line 28 of file Settings.hxx.

◆ showBuildingsInBlueprint

bool SettingsData::showBuildingsInBlueprint

indicates whether we want to see buildings inside Blueprint layer or not

Definition at line 165 of file Settings.hxx.

◆ soundEffectsVolume

float SettingsData::soundEffectsVolume

the volume of sound effects as float between [0, 1]

Definition at line 88 of file Settings.hxx.

◆ subMenuButtonHeight

int SettingsData::subMenuButtonHeight

The height in pixels of the buttons used in the build sub menues on the UI.

Definition at line 160 of file Settings.hxx.

◆ subMenuButtonWidth

int SettingsData::subMenuButtonWidth

The width in pixels of the buttons used in the build sub menues on the UI.

Definition at line 154 of file Settings.hxx.

◆ tileDataJSONFile

FilePath SettingsData::tileDataJSONFile

JSONFile that contains tileData.

Todo:
add a typename

Definition at line 130 of file Settings.hxx.

◆ uiDataJSONFile

FilePath SettingsData::uiDataJSONFile

JSONFile that contains uiData.

Todo:
add a typename

Definition at line 124 of file Settings.hxx.

◆ uiLayoutJSONFile

FilePath SettingsData::uiLayoutJSONFile

The file path to the UI layout file.

Todo:
add a typename

Definition at line 136 of file Settings.hxx.

◆ vSync

bool SettingsData::vSync

if vSync is enabled or not

Todo:
add a typename

Definition at line 70 of file Settings.hxx.

◆ writeErrorLogFile

bool SettingsData::writeErrorLogFile

Write errors to a log file.

Definition at line 168 of file Settings.hxx.

◆ zoneLayerTransparency

float SettingsData::zoneLayerTransparency

the value of the zone layer transparency, (0 - 1.0). where 0 is full opaque and 1 for full transparency.

Definition at line 64 of file Settings.hxx.


The documentation for this struct was generated from the following file: