OpenTTD Source: src/script/script_config.hpp Source File

OpenTTD Source 14.0-RC3

script_config.hpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #ifndef SCRIPT_CONFIG_HPP
11 #define SCRIPT_CONFIG_HPP
12
13 #include "../company_type.h"
14 #include "../textfile_gui.h"
15 #include "script_instance.hpp"
16
18 static const int INT32_DIGITS_WITH_SIGN_AND_TERMINATION = 10 + 1 + 1;
19
21 enum ScriptConfigFlags {
22 SCRIPTCONFIG_NONE = 0x0,
23 // Unused flag 0x1.
24 SCRIPTCONFIG_BOOLEAN = 0x2,
25 SCRIPTCONFIG_INGAME = 0x4,
26 SCRIPTCONFIG_DEVELOPER = 0x8,
27 };
28
29 typedef std::map<int, std::string> LabelMapping;
30
32 struct ScriptConfigItem {
33 std::string name;
34 std::string description;
35 int min_value = 0;
36 int max_value = 1;
37 int default_value = 0;
38 int step_size = 1;
39 ScriptConfigFlags flags = SCRIPTCONFIG_NONE;
40 LabelMapping labels;
41 bool complete_labels = false;
42 };
43
44 typedef std::vector<ScriptConfigItem> ScriptConfigItemList;
45
49 class ScriptConfig {
50 protected:
52 typedef std::map<std::string, int> SettingValueList;
53
54 public:
55 ScriptConfig() :
56 version(-1),
57 info(nullptr),
58 to_load_data(nullptr)
59 {}
60
65 ScriptConfig(const ScriptConfig *config);
66
68 virtual ~ScriptConfig();
69
78 void Change(std::optional<const std::string> name, int version = -1, bool force_exact_match = false);
79
83 class ScriptInfo *GetInfo() const;
84
88 const ScriptConfigItemList *GetConfigList();
89
94 enum ScriptSettingSource {
95 SSS_DEFAULT,
96 SSS_FORCE_NEWGAME,
97 SSS_FORCE_GAME,
98 };
99
108 void AnchorUnchangeableSettings();
109
117 int GetSetting(const std::string &name) const;
118
122 void SetSetting(const std::string_view name, int value);
123
127 void ResetSettings();
128
132 void ResetEditableSettings(bool yet_to_start);
133
138 bool HasScript() const;
139
143 const std::string &GetName() const;
144
148 int GetVersion() const;
149
154 void StringToSettings(const std::string &value);
155
160 std::string SettingsToString() const;
161
168 std::optional<std::string> GetTextfile(TextfileType type, CompanyID slot) const;
169
170 void SetToLoadData(ScriptInstance::ScriptData *data);
171 ScriptInstance::ScriptData *GetToLoadData();
172
173 protected:
174 std::string name;
175 int version;
176 class ScriptInfo *info;
177 SettingValueList settings;
178 std::unique_ptr<ScriptConfigItemList> config_list;
179 std::unique_ptr<ScriptInstance::ScriptData> to_load_data;
180
184 void ClearConfigList();
185
190 virtual ScriptInfo *FindInfo(const std::string &name, int version, bool force_exact_match) = 0;
191 };
192
193 #endif /* SCRIPT_CONFIG_HPP */
ScriptConfig::config_list
std::unique_ptr< ScriptConfigItemList > config_list
List with all settings defined by this Script.
Definition: script_config.hpp:178
INT32_DIGITS_WITH_SIGN_AND_TERMINATION
static const int INT32_DIGITS_WITH_SIGN_AND_TERMINATION
Maximum of 10 digits for MIN / MAX_INT32, 1 for the sign and 1 for '\0'.
Definition: script_config.hpp:18
ScriptConfigItem::step_size
int step_size
The step size in the gui.
Definition: script_config.hpp:38
ScriptConfigFlags
ScriptConfigFlags
Bitmask of flags for Script settings.
Definition: script_config.hpp:21
ScriptConfigItem::name
std::string name
The name of the configuration setting.
Definition: script_config.hpp:33
ScriptConfigItemList
std::vector< ScriptConfigItem > ScriptConfigItemList
List of ScriptConfig items.
Definition: script_config.hpp:44
ScriptConfig::~ScriptConfig
virtual ~ScriptConfig()
Delete an Script configuration.
Definition: script_config.cpp:48
ScriptConfig::SettingValueList
std::map< std::string, int > SettingValueList
List with name=>value pairs of all script-specific settings.
Definition: script_config.hpp:52
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
ScriptConfig::ResetEditableSettings
void ResetEditableSettings(bool yet_to_start)
Reset only editable and visible settings to their default value.
Definition: script_config.cpp:107
SCRIPTCONFIG_BOOLEAN
@ SCRIPTCONFIG_BOOLEAN
This value is a boolean (either 0 (false) or 1 (true) ).
Definition: script_config.hpp:24
ScriptConfigItem::min_value
int min_value
The minimal value this configuration setting can have.
Definition: script_config.hpp:35
ScriptConfig::Change
void Change(std::optional< const std::string > name, int version=-1, bool force_exact_match=false)
Set another Script to be loaded in this slot.
Definition: script_config.cpp:21
ScriptConfigItem::complete_labels
bool complete_labels
True if all values have a label.
Definition: script_config.hpp:41
ScriptConfigItem::max_value
int max_value
The maximal value this configuration setting can have.
Definition: script_config.hpp:36
ScriptConfig::SSS_DEFAULT
@ SSS_DEFAULT
Get the Script config from the current game mode.
Definition: script_config.hpp:95
ScriptConfig::GetInfo
class ScriptInfo * GetInfo() const
Get the ScriptInfo linked to this ScriptConfig.
Definition: script_config.cpp:54
SCRIPTCONFIG_NONE
@ SCRIPTCONFIG_NONE
No flags set.
Definition: script_config.hpp:22
SCRIPTCONFIG_INGAME
@ SCRIPTCONFIG_INGAME
This setting can be changed while the Script is running.
Definition: script_config.hpp:25
SCRIPTCONFIG_DEVELOPER
@ SCRIPTCONFIG_DEVELOPER
This setting will only be visible when the Script development tools are active.
Definition: script_config.hpp:26
ScriptConfig::version
int version
Version of the Script.
Definition: script_config.hpp:175
ScriptConfig::StringToSettings
void StringToSettings(const std::string &value)
Convert a string which is stored in the config file or savegames to custom settings of this Script.
Definition: script_config.cpp:141
ScriptConfig::GetVersion
int GetVersion() const
Get the version of the Script.
Definition: script_config.cpp:136
ScriptConfig::ResetSettings
void ResetSettings()
Reset all settings to their default value.
Definition: script_config.cpp:102
ScriptConfig::to_load_data
std::unique_ptr< ScriptInstance::ScriptData > to_load_data
Data to load after the Script start.
Definition: script_config.hpp:179
ScriptConfig::info
class ScriptInfo * info
ScriptInfo object for related to this Script version.
Definition: script_config.hpp:176
ScriptConfig::AnchorUnchangeableSettings
void AnchorUnchangeableSettings()
As long as the default of a setting has not been changed, the value of the setting is not stored.
Definition: script_config.cpp:73
ScriptConfig::SettingsToString
std::string SettingsToString() const
Convert the custom settings to a string that can be stored in the config file or savegames.
Definition: script_config.cpp:163
ScriptConfig
Script settings.
Definition: script_config.hpp:49
ScriptConfig::SSS_FORCE_NEWGAME
@ SSS_FORCE_NEWGAME
Get the newgame Script config.
Definition: script_config.hpp:96
ScriptConfig::GetSetting
int GetSetting(const std::string &name) const
Get the value of a setting for this config.
Definition: script_config.cpp:82
script_instance.hpp
ScriptConfig::name
std::string name
Name of the Script.
Definition: script_config.hpp:174
ScriptConfigItem::default_value
int default_value
The default value of this configuration setting.
Definition: script_config.hpp:37
ScriptConfig::GetTextfile
std::optional< std::string > GetTextfile(TextfileType type, CompanyID slot) const
Search a textfile file next to this script.
Definition: script_config.cpp:177
ScriptConfigItem::description
std::string description
The description of the configuration setting.
Definition: script_config.hpp:34
ScriptConfigItem::flags
ScriptConfigFlags flags
Flags for the configuration setting.
Definition: script_config.hpp:39
ScriptConfig::ClearConfigList
void ClearConfigList()
Routine that clears the config list.
Definition: script_config.cpp:68
ScriptConfig::GetConfigList
const ScriptConfigItemList * GetConfigList()
Get the config list for this ScriptConfig.
Definition: script_config.cpp:59
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:14
ScriptConfigItem::labels
LabelMapping labels
Text labels for the integer values.
Definition: script_config.hpp:40
ScriptInfo
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30
ScriptConfigItem
Info about a single Script setting.
Definition: script_config.hpp:32
LabelMapping
std::map< int, std::string > LabelMapping
Map-type used to map the setting numbers to labels.
Definition: script_config.hpp:29
ScriptConfig::SSS_FORCE_GAME
@ SSS_FORCE_GAME
Get the Script config from the current game.
Definition: script_config.hpp:97
ScriptConfig::SetSetting
void SetSetting(const std::string_view name, int value)
Set the value of a setting for this config.
Definition: script_config.cpp:89
ScriptConfig::FindInfo
virtual ScriptInfo * FindInfo(const std::string &name, int version, bool force_exact_match)=0
This function should call back to the Scanner in charge of this Config, to find the ScriptInfo belong...
ScriptConfig::HasScript
bool HasScript() const
Is this config attached to an Script? In other words, is there a Script that is assigned to this slot...
Definition: script_config.cpp:126
ScriptConfig::settings
SettingValueList settings
List with all setting=>value pairs that are configure for this Script.
Definition: script_config.hpp:177
ScriptConfig::ScriptSettingSource
ScriptSettingSource
Where to get the config from, either default (depends on current game mode) or force either newgame o...
Definition: script_config.hpp:94
ScriptConfig::GetName
const std::string & GetName() const
Get the name of the Script.
Definition: script_config.cpp:131