16#include "table/strings.h"
22 if (
name.has_value()) {
23 this->name =
name.value();
28 this->version = (this->
info ==
nullptr) ? -1 : this->
info->GetVersion();
42 for (
const auto &item : config.
settings) {
43 this->
settings[item.first] = item.second;
54 if (this->
info !=
nullptr)
return this->
info->GetConfigList();
56 this->
config_list = std::make_unique<ScriptConfigItemList>();
70 this->
SetSetting(item.name, this->GetSetting(item.name));
78 if (it == this->
settings.end())
return this->
info->GetSettingDefaultValue(
name);
85 if (this->
info ==
nullptr)
return;
88 if (config_item ==
nullptr)
return;
104 for (SettingValueList::iterator it = this->
settings.begin(); it != this->settings.end();) {
106 assert(config_item !=
nullptr);
111 if (editable && visible) {
121 return this->
info !=
nullptr;
136 std::string_view to_process = value;
139 size_t pos = to_process.find_first_of(
'=');
140 if (pos == std::string_view::npos)
return;
142 std::string_view item_name = to_process.substr(0, pos);
144 to_process.remove_prefix(pos + 1);
145 pos = to_process.find_first_of(
',');
147 std::from_chars(to_process.data(), to_process.data() + std::min(pos, to_process.size()), item_value);
151 if (pos == std::string_view::npos)
return;
152 to_process.remove_prefix(pos + 1);
158 if (this->
settings.empty())
return {};
161 for (
const auto &item : this->
settings) {
162 format_append(result,
"{}={},", item.first, item.second);
166 result.resize(result.size() - 1);
172 if (slot == CompanyID::Invalid() || this->
GetInfo() ==
nullptr)
return std::nullopt;
177void ScriptConfig::SetToLoadData(ScriptInstance::ScriptData *data)
182ScriptInstance::ScriptData *ScriptConfig::GetToLoadData()
187static std::pair<StringParameter, StringParameter> GetValueParams(
const ScriptConfigItem &config_item,
int value)
191 auto it = config_item.
labels.find(value);
192 if (it != std::end(config_item.
labels))
return {STR_JUST_RAW_STRING, it->second};
194 return {STR_JUST_INT, value};
204 auto [param1, param2] = GetValueParams(*
this, value);
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
SettingValueList settings
List with all setting=>value pairs that are configure for this Script.
std::optional< std::string > GetTextfile(TextfileType type, CompanyID slot) const
Search a textfile file next to this script.
void AnchorUnchangeableSettings()
As long as the default of a setting has not been changed, the value of the setting is not stored.
bool HasScript() const
Is this config attached to an Script?
ScriptConfig()=default
Default constructor.
void SetSetting(std::string_view name, int value)
Set the value of a setting for this config.
void Change(std::optional< std::string_view > name, int version=-1, bool force_exact_match=false)
Set another Script to be loaded in this slot.
void StringToSettings(std::string_view value)
Convert a string which is stored in the config file or savegames to custom settings of this Script.
int version
Version of the Script.
virtual ScriptInfo * FindInfo(const std::string &name, int version, bool force_exact_match)=0
Finds the appropriate ScriptInfo for a given script name and version.
const std::string & GetName() const
Get the name of the Script.
class ScriptInfo * info
ScriptInfo object for related to this Script version.
std::unique_ptr< ScriptConfigItemList > config_list
List with all settings defined by this Script.
int GetVersion() const
Get the version of the Script.
void ClearConfigList()
Routine that clears the config list.
std::unique_ptr< ScriptInstance::ScriptData > to_load_data
Data to load after the Script start.
class ScriptInfo * GetInfo() const
Get the ScriptInfo linked to this ScriptConfig.
void ResetSettings()
Reset all settings to their default value.
std::string name
Name of the Script.
const ScriptConfigItemList * GetConfigList()
Get the config list for this ScriptConfig.
int GetSetting(const std::string &name) const
Get the value of a setting for this config.
std::string SettingsToString() const
Convert the custom settings to a string that can be stored in the config file or savegames.
void ResetEditableSettings(bool yet_to_start)
Reset only editable and visible settings to their default value.
All static information from an Script like name, version, etc.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
@ Ai
Subdirectory for all AI files.
@ Gs
Subdirectory for all game scripts.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
@ LightBlue
Light blue colour.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
A number of safeguards to prevent using unsafe methods.
std::vector< ScriptConfigItem > ScriptConfigItemList
List of ScriptConfig items.
@ Boolean
This value is a boolean (either 0 (false) or 1 (true) ).
@ Developer
This setting will only be visible when the Script development tools are active.
@ InGame
This setting can be changed while the Script is running.
ScriptInfo keeps track of all information of a script, like Author, Description, ....
ClientSettings _settings_client
The current settings for this game.
Types related to global configuration settings.
Definition of base types and functions in a cross-platform compatible way.
Info about a single Script setting.
ScriptConfigFlags flags
Flags for the configuration setting.
std::string GetString(int value) const
Get string to display this setting in the configuration interface.
LabelMapping labels
Text labels for the integer values.
int min_value
The minimal value this configuration setting can have.
int max_value
The maximal value this configuration setting can have.
std::string description
The description of the configuration setting.
TextColour GetColour() const
Get text colour to display this setting in the configuration interface.
GUI functions related to textfiles.
TextfileType
Additional text files accompanying Tar archives.