OpenTTD Source  12.0-beta2
settings_func.h File Reference
#include "core/smallvec_type.hpp"
#include "company_type.h"
#include "string_type.h"

Go to the source code of this file.

Functions

void IConsoleSetSetting (const char *name, const char *value, bool force_newgame=false)
 
void IConsoleSetSetting (const char *name, int32 value)
 
void IConsoleGetSetting (const char *name, bool force_newgame=false)
 Output value of a specific setting to the console. More...
 
void IConsoleListSettings (const char *prefilter)
 List all settings and their value to the console. More...
 
void LoadFromConfig (bool minimal=false)
 Load the values from the configuration files. More...
 
void SaveToConfig ()
 Save the values to the configuration file.
 
void IniLoadWindowSettings (IniFile &ini, const char *grpname, void *desc)
 Load a WindowDesc from config. More...
 
void IniSaveWindowSettings (IniFile &ini, const char *grpname, void *desc)
 Save a WindowDesc to config. More...
 
StringList GetGRFPresetList ()
 Get the list of known NewGrf presets. More...
 
struct GRFConfigLoadGRFPresetFromConfig (const char *config_name)
 Load a NewGRF configuration by preset-name. More...
 
void SaveGRFPresetToConfig (const char *config_name, struct GRFConfig *config)
 Save a NewGRF configuration with a preset name. More...
 
void DeleteGRFPresetFromConfig (const char *config_name)
 Delete a NewGRF configuration by preset name. More...
 
void SetDefaultCompanySettings (CompanyID cid)
 Set the company settings for a new company to their default values.
 
void SyncCompanySettings ()
 Sync all company settings in a multiplayer game.
 

Detailed Description

Functions related to setting/changing the settings.

Definition in file settings_func.h.

Function Documentation

◆ DeleteGRFPresetFromConfig()

void DeleteGRFPresetFromConfig ( const char *  config_name)

Delete a NewGRF configuration by preset name.

Parameters
config_nameName of the preset.

Definition at line 1347 of file settings.cpp.

References _config_file, IniLoadFile::RemoveGroup(), IniFile::SaveToDisk(), and seprintf().

◆ GetGRFPresetList()

StringList GetGRFPresetList ( )

Get the list of known NewGrf presets.

Returns
List of preset names.

Definition at line 1294 of file settings.cpp.

References _config_file, IniLoadFile::group, IniGroup::name, and IniGroup::next.

Referenced by NewGRFWindow::OnQueryTextFinished(), and SavePresetWindow::SavePresetWindow().

◆ IConsoleGetSetting()

void IConsoleGetSetting ( const char *  name,
bool  force_newgame 
)

Output value of a specific setting to the console.

Parameters
nameName of the setting to output its value
force_newgameforce the newgame settings

Definition at line 1669 of file settings.cpp.

References CC_ERROR, GetSettingFromName(), and IConsolePrint().

◆ IConsoleListSettings()

void IConsoleListSettings ( const char *  prefilter)

List all settings and their value to the console.

Parameters
prefilterIf not nullptr, only list settings with names that begin with prefilter prefix

Definition at line 1707 of file settings.cpp.

References CC_HELP, GenericSettingTables(), and IConsolePrint().

◆ IniLoadWindowSettings()

void IniLoadWindowSettings ( IniFile ini,
const char *  grpname,
void *  desc 
)

Load a WindowDesc from config.

Parameters
iniIniFile handle to the ini file with the source data
grpnamecharacter string identifying the section-header of the ini file that will be parsed
descDestination WindowDesc

Definition at line 780 of file settings.cpp.

References IniLoadSettings().

Referenced by WindowDesc::LoadFromConfig().

◆ IniSaveWindowSettings()

void IniSaveWindowSettings ( IniFile ini,
const char *  grpname,
void *  desc 
)

Save a WindowDesc to config.

Parameters
iniIniFile handle to the ini file where the destination data is saved
grpnamecharacter string identifying the section-header of the ini file
descSource WindowDesc

Definition at line 791 of file settings.cpp.

References IniSaveSettings().

Referenced by WindowDesc::SaveToConfig().

◆ LoadFromConfig()

void LoadFromConfig ( bool  startup)

Load the values from the configuration files.

Parameters
startupLoad the minimal amount of the configuration to "bootstrap" the blitter and such.

Definition at line 1202 of file settings.cpp.

References _config_file, _private_file, _secrets_file, and ResetCurrencies().

Referenced by AfterNewGRFScan::OnNewGRFsScanned().

◆ LoadGRFPresetFromConfig()

struct GRFConfig* LoadGRFPresetFromConfig ( const char *  config_name)

Load a NewGRF configuration by preset-name.

Parameters
config_nameName of the preset.
Returns
NewGRF configuration.
See also
GetGRFPresetList

Definition at line 1314 of file settings.cpp.

References _config_file, GRFLoadConfig(), and seprintf().

Referenced by NewGRFWindow::OnDropdownSelect().

◆ SaveGRFPresetToConfig()

void SaveGRFPresetToConfig ( const char *  config_name,
GRFConfig config 
)

Save a NewGRF configuration with a preset name.

Parameters
config_nameName of the preset.
configNewGRF configuration to save.
See also
GetGRFPresetList

Definition at line 1332 of file settings.cpp.

References _config_file, and seprintf().

Referenced by NewGRFWindow::OnQueryTextFinished().