12 #ifndef SETTINGS_INTERNAL_H 13 #define SETTINGS_INTERNAL_H 115 bool IsEditable(
bool do_command =
false)
const;
129 bool SetSettingValue(uint index, int32 value,
bool force_newgame =
false);
130 bool SetSettingValue(uint index,
const char *value,
bool force_newgame =
false);
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
this setting can be changed in the scenario editor (only makes sense when SGF_NEWGAME_ONLY is set) ...
const void * def
default value given when none is present
bitmasked number where MULTIPLE bits may be set
this setting can be different for each company (saved in company struct)
this setting cannot be changed in a game
SettingGuiFlag flags
handles how a setting would show up in the GUI (text/currency, etc.)
the number represents money, so when reading value multiply by exchange rate
list of integers separated by a comma ','
Properties of config file settings.
Settings displayed in the list of basic settings.
Settings displayed in the list of advanced settings.
Advanced settings are part of advanced and expert list.
the value represents a limited number of string-options (internally integer)
this setting only applies to network games
const char * name
name of the setting. Used in configuration file and for console
OnChange * proc
callback procedure for when the value is changed
Expert settings can only be seen in the expert list.
SaveLoad save
Internal structure (going to savegame, parts to config)
const SettingDesc * GetSettingFromName(const char *name, uint *i)
Given a name of setting, return a setting description of it.
size_t OnConvert(const char *value)
callback prototype for conversion error
Functions/types related to saving and loading games.
Used in setting filter to match all types.
display absolute value of the setting
SettingCategory
A SettingCategory defines a grouping of the settings.
StringID str_help
(Translated) string with help text; gui only.
OnConvert * proc_cnvt
callback procedure when loading value mechanism fails
this setting does not apply to network games; it may not be changed during the game ...
bool SetSettingValue(uint index, int32 value, bool force_newgame=false)
Top function to save the new value of an element of the Settings struct.
bool OnChange(int32 var)
callback prototype on data modification
SettingCategory cat
assigned categories of the setting
uint32 StringID
Numeric value that represents a string, independent of the selected language.
string with a pre-allocated buffer
StringID str_val
(Translated) first string describing the value.
a value of zero means the feature is disabled
bitmasked number where only ONE bit may be set
SettingDescType cmd
various flags for the variable
const char * many
ONE/MANY_OF_MANY: string of possible values for this type.
StringID str
(translated) string with descriptive text; gui and console
SettingDescTypeLong
Convention/Type of settings.
SettingType
Type of settings for filtering.
void SetCompanySetting(uint index, int32 value)
Top function to save the new value of an element of the Settings struct.
int32 interval
the interval to use between settings in the 'settings' window. If interval is '0' the interval is dyn...
SettingDescBase desc
Settings structure (going to configuration file)
Settings displayed in the list of expert settings.
Basic settings are part of all lists.