(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / settings_func.h
blob3b3387b5fd486ed5ebff3fabc72bec97f7620eee
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file settings_func.h Functions related to setting/changing the settings. */
12 #ifndef SETTINGS_FUNC_H
13 #define SETTINGS_FUNC_H
15 #include "core/smallvec_type.hpp"
16 #include "company_type.h"
18 struct IniFile;
20 void IConsoleSetSetting(const char *name, const char *value, bool force_newgame = false);
21 void IConsoleSetSetting(const char *name, int32 value);
22 void IConsoleGetSetting(const char *name, bool force_newgame = false);
23 void IConsoleListSettings(const char *prefilter);
25 void LoadFromConfig(bool minimal = false);
26 void SaveToConfig();
27 void CheckConfig();
29 void IniLoadWindowSettings(IniFile *ini, const char *grpname, void *desc);
30 void IniSaveWindowSettings(IniFile *ini, const char *grpname, void *desc);
32 /* Functions to load and save NewGRF settings to a separate
33 * configuration file, used for presets. */
34 typedef AutoFreeSmallVector<char *, 4> GRFPresetList;
36 void GetGRFPresetList(GRFPresetList *list);
37 struct GRFConfig *LoadGRFPresetFromConfig(const char *config_name);
38 void SaveGRFPresetToConfig(const char *config_name, struct GRFConfig *config);
39 void DeleteGRFPresetFromConfig(const char *config_name);
41 uint GetCompanySettingIndex(const char *name);
42 void SetDefaultCompanySettings(CompanyID cid);
44 #if defined(ENABLE_NETWORK)
45 void SyncCompanySettings();
46 #else /* ENABLE_NETWORK */
47 static inline void SyncCompanySettings() {}
48 #endif /* ENABLE_NETWORK */
50 #endif /* SETTINGS_FUNC_H */