56#include "table/strings.h"
84 static const SettingTable _generic_setting_tables[] = {
93 _news_display_settings,
94 _pathfinding_settings,
98 return _generic_setting_tables;
107 static const SettingTable _private_setting_tables[] = {
108 _network_private_settings,
110 return _private_setting_tables;
119 static const SettingTable _secrets_setting_tables[] = {
120 _network_secrets_settings,
122 return _secrets_setting_tables;
125using SettingDescProc = void(
IniFile &ini,
const SettingTable &desc, std::string_view grpname,
void *
object,
bool only_startup);
126using SettingDescProcList = void(
IniFile &ini, std::string_view grpname,
StringList &list);
128static bool IsSignedVarMemType(VarType vt)
145 static inline const IniGroupNameList list_group_names = {
149 "server_bind_addresses",
150 "server_authorized_keys",
151 "rcon_authorized_keys",
152 "admin_authorized_keys"
156 ConfigIniFile(
const std::string &filename) :
IniFile(list_group_names)
196 if (digit.has_value())
return digit;
198 auto it = std::ranges::find(
many,
str);
199 if (it ==
many.end())
return std::nullopt;
200 return static_cast<uint32_t
>(it -
many.begin());
211 if (
str ==
"true" ||
str ==
"on" ||
str ==
"1")
return true;
212 if (
str ==
"false" ||
str ==
"off" ||
str ==
"0")
return false;
224static std::optional<uint32_t>
LookupManyOfMany(std::span<const std::string_view> many, std::string_view str)
226 static const std::string_view separators{
" \t|"};
235 if (value.empty())
break;
238 if (!r.has_value())
return r;
250static std::optional<std::vector<uint32_t>>
ParseIntList(std::string_view str)
253 std::vector<uint32_t> result;
259 if (comma && consumer.
ReadIf(
",")) {
265 if (!v.has_value())
return std::nullopt;
266 result.push_back(*v);
272 if (!result.empty() && !comma)
return std::nullopt;
285static bool LoadIntList(std::optional<std::string_view> str,
void *array,
int nelems, VarType type)
288 std::byte *p =
static_cast<std::byte *
>(array);
289 if (!str.has_value()) {
290 std::fill_n(p, nelems * elem_size,
static_cast<std::byte
>(0));
295 if (!opt_items.has_value() || opt_items->size() != (
size_t)nelems)
return false;
297 for (
auto item : *opt_items) {
315 for (
size_t i = 0; i != this->
save.length; i++) {
319 case SLE_VAR_I8: v = *(
const int8_t *)p; p += 1;
break;
320 case SLE_VAR_U8: v = *(
const uint8_t *)p; p += 1;
break;
321 case SLE_VAR_I16: v = *(
const int16_t *)p; p += 2;
break;
322 case SLE_VAR_U16: v = *(
const uint16_t *)p; p += 2;
break;
323 case SLE_VAR_I32: v = *(
const int32_t *)p; p += 4;
break;
324 case SLE_VAR_U32: v = *(
const uint32_t *)p; p += 4;
break;
325 default: NOT_REACHED();
327 if (i != 0) result +=
',';
328 format_append(result,
"{}", v);
333std::string OneOfManySettingDesc::FormatSingleValue(uint
id)
const
335 if (
id >= this->
many.size()) {
336 return fmt::format(
"{}",
id);
338 return std::string{this->
many[id]};
343 uint
id = (uint)this->
Read(
object);
344 return this->FormatSingleValue(
id);
349 uint bitmask = (uint)this->
Read(
object);
356 if (!result.empty()) result +=
'|';
357 result += this->FormatSingleValue(
id);
372 if (!value.has_value()) {
383 return static_cast<int32_t
>(*value);
391 if (!r.has_value() && this->many_cnvt !=
nullptr) r = this->
many_cnvt(str);
392 if (r.has_value())
return *r;
403 if (r.has_value())
return *r;
414 if (r.has_value())
return *r;
429 return this->get_title_cb !=
nullptr ? this->get_title_cb(*
this) : this->
str;
438 return this->get_help_cb !=
nullptr ? this->get_help_cb(*
this) : this->
str_help;
448 if (this->get_value_params_cb !=
nullptr) {
449 return this->get_value_params_cb(*
this, value);
453 return {value != 0 ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF, {}};
457 auto [min_val, _] = this->
GetRange();
458 return {this->
str_val - min_val + value, value};
479 return this->get_range_cb !=
nullptr ? this->get_range_cb(*
this) : std::tuple(this->
min, this->
max);
491 this->
Write(
object, val);
505 auto [min_val, max_val] = this->
GetRange();
523 val =
Clamp(val, min_val, max_val);
524 }
else if (val < min_val || val >
static_cast<int32_t
>(max_val)) {
533 uint32_t uval =
static_cast<uint32_t
>(val);
537 uval =
ClampU(uval, min_val, max_val);
538 }
else if (uval <
static_cast<uint32_t
>(min_val) || uval > max_val) {
543 val =
static_cast<int32_t
>(uval);
548 default: NOT_REACHED();
583 if (this->
max_length == 0 || str.size() < this->max_length)
return;
588 str.erase(this->
max_length - 1, std::string::npos);
621static void IniLoadSettings(
IniFile &ini,
const SettingTable &settings_table, std::string_view grpname,
void *
object,
bool only_startup)
626 for (
auto &desc : settings_table) {
629 if (sd->
startup != only_startup)
continue;
632 std::string s{ sd->
GetName() };
633 auto sc = s.find(
'.');
634 if (sc != std::string::npos) {
635 group = ini.
GetGroup(s.substr(0, sc));
636 if (group ==
nullptr) group = group_def;
637 s = s.substr(sc + 1);
643 if (group !=
nullptr) item = group->
GetItem(s);
644 if (item ==
nullptr && group != group_def && group_def !=
nullptr) {
649 if (item ==
nullptr) {
653 if (sc != std::string::npos) {
654 if (group = ini.
GetGroup(s.substr(0, sc)); group !=
nullptr) item = group->
GetItem(s.substr(sc + 1));
670 std::string str{(item ==
nullptr) ? this->
def : item->
value.value_or(
"")};
672 this->
Write(
object, str);
677 std::optional<std::string_view> str;
678 if (item !=
nullptr) {
680 }
else if (!this->
def.empty()) {
706static void IniSaveSettings(
IniFile &ini,
const SettingTable &settings_table, std::string_view grpname,
void *
object,
bool)
708 IniGroup *group_def =
nullptr, *group;
710 for (
auto &desc : settings_table) {
718 std::string s{ sd->
GetName() };
719 auto sc = s.find(
'.');
720 if (sc != std::string::npos) {
722 s = s.substr(sc + 1);
728 IniItem &item = group->GetOrCreateItem(s);
740 if (IsSignedVarMemType(this->
save.conv)) {
741 i = this->
Read(
object);
743 i = (uint32_t)this->
Read(
object);
745 return fmt::format(
"{}", i);
750 bool val = this->
Read(
object) != 0;
751 return val ?
"true" :
"false";
756 int32_t item_value =
static_cast<int32_t
>(this->
ParseValue(*item->
value));
757 int32_t object_value = this->
Read(
object);
758 return item_value == object_value;
763 int32_t object_value = this->
Read(
object);
774 const std::string &str = this->
Read(
object);
782 return fmt::format(
"\"{}\"", str);
784 default: NOT_REACHED();
794 const std::string &str = this->
Read(
object);
795 return item->
value->compare(str) == 0;
800 const std::string &str = this->
Read(
object);
801 return this->
def == str;
840 if (group ==
nullptr)
return;
845 if (!item.
name.empty()) list.push_back(item.
name);
863 for (
const auto &iter : list) {
902 (_game_mode == GM_NORMAL ||
952static void AILoadConfig(
const IniFile &ini, std::string_view grpname)
957 for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
962 if (group ==
nullptr)
return;
964 CompanyID c = CompanyID::Begin();
970 if (item.
name !=
"none") {
971 Debug(script, 0,
"The AI by the name '{}' was no longer found, and removed from the list.", item.
name);
977 if (c >= MAX_COMPANIES)
break;
981static void GameLoadConfig(
const IniFile &ini, std::string_view grpname)
989 if (group ==
nullptr || group->
items.empty())
return;
997 if (item.
name !=
"none") {
998 Debug(script, 0,
"The GameScript by the name '{}' was no longer found, and removed from the list.", item.
name);
1013 if (
const IniItem *item = group->
GetItem(
"graphicsset"); item !=
nullptr && item->
value) BaseGraphics::ini_data.name = *item->
value;
1016 if (
const IniGroup *group = ini.
GetGroup(
"graphicsset"); group !=
nullptr) {
1018 if (
const IniItem *item = group->
GetItem(
"name"); item !=
nullptr && item->
value) BaseGraphics::ini_data.name = *item->
value;
1020 if (
const IniItem *item = group->
GetItem(
"shortname"); item !=
nullptr && item->
value && item->
value->size() == 8) {
1022 if (val.has_value()) {
1031 if (
const IniItem *item = group->
GetItem(
"extra_version"); item !=
nullptr && item->
value) {
1033 if (val.has_value()) {
1034 BaseGraphics::ini_data.extra_version = *val;
1042 if (
const IniItem *item = group->
GetItem(
"extra_params"); item !=
nullptr && item->
value) {
1044 if (params.has_value()) {
1045 BaseGraphics::ini_data.extra_params = params.value();
1067 if (group ==
nullptr)
return list;
1071 std::unique_ptr<GRFConfig> c{};
1073 std::array<uint8_t, 4> grfid_buf;
1075 std::string_view item_name = item.
name;
1076 bool has_md5sum =
false;
1079 auto grfid_pos = item_name.find(
"|");
1080 if (grfid_pos != std::string_view::npos) {
1081 std::string_view grfid_str = item_name.substr(0, grfid_pos);
1084 item_name = item_name.substr(grfid_pos + 1);
1086 auto md5sum_pos = item_name.find(
"|");
1087 if (md5sum_pos != std::string_view::npos) {
1088 std::string_view md5sum_str = item_name.substr(0, md5sum_pos);
1091 if (has_md5sum) item_name = item_name.substr(md5sum_pos + 1);
1094 uint32_t grfid = grfid_buf[0] | (grfid_buf[1] << 8) | (grfid_buf[2] << 16) | (grfid_buf[3] << 24);
1097 if (s !=
nullptr) c = std::make_unique<GRFConfig>(*s);
1101 if (s !=
nullptr) c = std::make_unique<GRFConfig>(*s);
1105 std::string filename = std::string(item_name);
1107 if (c ==
nullptr) c = std::make_unique<GRFConfig>(filename);
1110 if (item.
value.has_value() && !item.
value->empty()) {
1112 if (params.has_value()) {
1113 c->SetParams(params.value());
1125 reason = STR_CONFIG_ERROR_INVALID_GRF_NOT_FOUND;
1127 reason = STR_CONFIG_ERROR_INVALID_GRF_UNSAFE;
1129 reason = STR_CONFIG_ERROR_INVALID_GRF_SYSTEM;
1131 reason = STR_CONFIG_ERROR_INVALID_GRF_INCOMPATIBLE;
1133 reason = STR_CONFIG_ERROR_INVALID_GRF_UNKNOWN;
1137 GetEncodedString(STR_CONFIG_ERROR_INVALID_GRF, filename.empty() ? item.
name : filename, reason),
1143 auto found = std::ranges::find_if(list, [&c](
const auto &gc) {
return gc->ident.grfid == c->ident.grfid; });
1144 if (found != std::end(list)) {
1146 GetEncodedString(STR_CONFIG_ERROR_DUPLICATE_GRFID, c->filename, (*found)->filename),
1162 list.push_back(std::move(c));
1171 if (group ==
nullptr)
return IFV_0;
1173 auto version_number = group->
GetItem(
"ini_version");
1175 if (version_number ==
nullptr || !version_number->value.has_value())
return IFV_0;
1177 uint32_t version = 0;
1178 std::from_chars(version_number->value->data(), version_number->value->data() + version_number->value->size(), version);
1183static void AISaveConfig(
IniFile &ini, std::string_view grpname)
1188 for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
1203static void GameSaveConfig(
IniFile &ini, std::string_view grpname)
1240 if (used_set ==
nullptr)
return;
1248 const GRFConfig *extra_cfg = used_set->GetExtraConfig();
1249 if (extra_cfg !=
nullptr && !extra_cfg->
param.empty()) {
1256static void GRFSaveConfig(
IniFile &ini, std::string_view grpname,
const GRFConfigList &list)
1261 for (
const auto &c : list) {
1262 std::string key = fmt::format(
"{:08X}|{}|{}",
std::byteswap(c->ident.grfid),
1269static void HandleSettingDescs(
IniFile &generic_ini,
IniFile &private_ini,
IniFile &secrets_ini, SettingDescProc *proc, SettingDescProcList *proc_list,
bool only_startup =
false)
1271 proc(generic_ini, _misc_settings,
"misc",
nullptr, only_startup);
1272#if defined(_WIN32) && !defined(DEDICATED)
1273 proc(generic_ini, _win32_settings,
"win32",
nullptr, only_startup);
1288 proc(generic_ini, _currency_settings,
"currency", &
GetCustomCurrency(), only_startup);
1289 proc(generic_ini, _company_settings,
"company", &
_settings_client.company, only_startup);
1291 if (!only_startup) {
1295 proc_list(private_ini,
"server_authorized_keys",
_settings_client.network.server_authorized_keys);
1296 proc_list(private_ini,
"rcon_authorized_keys",
_settings_client.network.rcon_authorized_keys);
1297 proc_list(private_ini,
"admin_authorized_keys",
_settings_client.network.admin_authorized_keys);
1312 for (
auto &desc : table) {
1316 std::string s{ sd->
GetName() };
1317 auto sc = s.find(
'.');
1318 if (sc == std::string::npos)
continue;
1321 if (group ==
nullptr)
continue;
1322 s = s.substr(sc + 1);
1353 *old_item =
nullptr;
1357 if (igroup ==
nullptr)
return false;
1363 if (tmp_old_item ==
nullptr)
return false;
1369 if (new_item !=
nullptr)
return false;
1371 *old_item = tmp_old_item;
1388 IniFileVersion generic_version = LoadVersionFromConfig(generic_ini);
1411 if (network !=
nullptr) {
1412 const IniItem *use_relay_service = network->
GetItem(
"use_relay_service");
1413 if (use_relay_service !=
nullptr) {
1414 if (use_relay_service->
value ==
"never") {
1416 }
else if (use_relay_service->
value ==
"ask") {
1418 }
else if (use_relay_service->
value ==
"allow") {
1433 static constexpr std::initializer_list<std::string_view> _old_autosave_interval{
"off"sv,
"monthly"sv,
"quarterly"sv,
"half year"sv,
"yearly"sv};
1436 switch (old_value) {
1449 _settings_client.gui.right_click_wnd_close = old_value.value_or(
false) ? RightClickClose::Yes : RightClickClose::No;
1454 AILoadConfig(generic_ini,
"ai_players");
1455 GameLoadConfig(generic_ini,
"game_scripts");
1480 IniFileVersion generic_version = LoadVersionFromConfig(generic_ini);
1486 if (
IniGroup *group = private_ini.
GetGroup(
"private"); group !=
nullptr) group->
comment =
"; This file possibly contains private information which can identify you as person.\n";
1487 if (
IniGroup *group = secrets_ini.
GetGroup(
"secrets"); group !=
nullptr) group->
comment =
"; Do not share this file with others, not even if they claim to be technical support.\n; This file contains saved passwords and other secrets that should remain private to you!\n";
1489 if (generic_version ==
IFV_0) {
1511 if (game_creation !=
nullptr) {
1512 game_creation->
RemoveItem(
"generation_seed");
1519 if (network !=
nullptr) {
1528 AISaveConfig(generic_ini,
"ai_players");
1529 GameSaveConfig(generic_ini,
"game_scripts");
1554 if (group.
name.starts_with(
"preset-")) {
1555 list.push_back(group.
name.substr(7));
1570 std::string section(
"preset-");
1571 section += config_name;
1587 std::string section(
"preset-");
1588 section += config_name;
1591 GRFSaveConfig(ini, section, config);
1601 std::string section(
"preset-");
1602 section += config_name;
1617 int32_t oldval = this->
Read(
object);
1620 if (oldval == newval)
return;
1622 this->
Write(
object, newval);
1650 if (sd->
GetName() == name)
return sd;
1654 std::string short_name_suffix = std::string{
"." }.append(name);
1658 if (sd->
GetName().ends_with(short_name_suffix))
return sd;
1674 saveloads.push_back(sd->
save);
1685 static const SettingTable saveload_settings_tables[] = {
1686 _difficulty_settings,
1689 _linkgraph_settings,
1691 _pathfinding_settings,
1695 static std::vector<SettingVariant> settings_table;
1697 if (settings_table.empty()) {
1698 for (
auto &saveload_settings_table : saveload_settings_tables) {
1699 for (
auto &saveload_setting : saveload_settings_table) {
1700 settings_table.push_back(saveload_setting);
1705 return settings_table;
1716 static const std::string_view company_prefix =
"company.";
1717 if (name.starts_with(company_prefix)) name.remove_prefix(company_prefix.size());
1731 if (sd !=
nullptr)
return sd;
1735 if (sd !=
nullptr)
return sd;
1739 if (sd !=
nullptr)
return sd;
1752 std::vector<const SettingDesc *> collection;
1755 for (
const auto &desc : table) {
1757 if (!func(*sd))
continue;
1759 collection.push_back(sd);
1828 return Command<Commands::ChangeCompanySetting>::Post(setting->
GetName(), value);
1840 if (_game_mode != GM_MENU) {
1847 if (force_newgame) {
1854 return Command<Commands::ChangeSetting>::Post(setting->
GetName(), value);
1867 for (
auto &desc : _company_settings) {
1880 for (
auto &desc : _company_settings) {
1889 if (old_value != new_value) Command<Commands::ChangeCompanySetting>::SendNet(STR_NULL,
_local_company, sd->
GetName(), new_value);
1925 this->
Write(
object, newval);
1933void IConsoleSetSetting(std::string_view name, std::string_view value,
bool force_newgame)
1942 bool success =
true;
1965void IConsoleSetSetting(std::string_view name,
int value)
1968 assert(sd !=
nullptr);
1993 auto [min_val, max_val] = int_setting->
GetRange();
2000static void IConsoleListSettingsTable(
const SettingTable &table, std::string_view prefilter)
2002 for (
auto &desc : table) {
2005 if (!prefilter.empty() && sd->
GetName().find(prefilter) == std::string::npos)
continue;
2020 IConsoleListSettingsTable(table, prefilter);
2023 IConsoleListSettingsTable(table, prefilter);
2026 IConsoleListSettingsTable(table, prefilter);
2032ScriptConfigSettings::ScriptConfigSettings()
2050 for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
2051 if (other.
ai[c] !=
nullptr) {
2052 this->
ai[c] = std::make_unique<AIConfig>(*other.
ai[c]);
2055 if (other.
game !=
nullptr) {
2056 this->
game = std::make_unique<GameConfig>(*other.
game);
AIConfig stores the configuration settings of every AI.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr enable_if_t< is_integral_v< T >, T > byteswap(T x) noexcept
Custom implementation of std::byteswap; remove once we build with C++23.
AI instantion of script configuration.
static AIConfig * GetConfig(CompanyID company, ScriptSettingSource source=ScriptSettingSource::Default)
Get the AI configuration of specific company.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
Common return value for all commands.
IniFile to store a configuration.
Game script instantion of script configuration.
static GameConfig * GetConfig(ScriptSettingSource source=ScriptSettingSource::Default)
Get the script configuration.
@ ForceNewGame
Get the newgame Script config.
bool HasScript() const
Is this config attached to an Script?
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.
const std::string & GetName() const
Get the name of the Script.
std::string SettingsToString() const
Convert the custom settings to a string that can be stored in the config file or savegames.
Parse data from a string / buffer.
std::optional< T > TryReadIntegerBase(int base, bool clamp=false)
Try to read and parse an integer in number 'base', and then advance the reader.
bool AnyBytesLeft() const noexcept
Check whether any bytes left to read.
static const std::string_view WHITESPACE_NO_NEWLINE
ASCII whitespace characters, excluding new-line.
bool ReadIf(std::string_view str)
Check whether the next data matches 'str', and skip it.
void SkipUntilCharNotIn(std::string_view chars)
Skip 8-bit chars, while they are in 'chars', until they are not.
std::string_view ReadUntilCharIn(std::string_view chars)
Read 8-bit chars, while they are not in 'chars', until they are; and advance reader.
static constexpr int SECONDS_PER_DAY
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Execute
execute the given command
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
Configuration options of the network stuff.
static const uint NETWORK_MAX_GRF_COUNT
Maximum number of GRFs that can be sent.
void IConsolePrint(TextColour colour_code, const std::string &string)
Handle the printing of text entered into the console or redirected there by any other means.
Console functions used outside of the console code.
static const TextColour CC_HELP
Colour for help lines.
static const TextColour CC_INFO
Colour for information lines.
static const TextColour CC_DEFAULT
Default colour of the console.
static const TextColour CC_ERROR
Colour for error lines.
void ResetCurrencies(bool preserve_custom)
Will fill _currency_specs array with default values from origin_currency_specs Called only from newgr...
Functions to handle different currencies.
CurrencySpec & GetCustomCurrency()
Get the custom currency.
void DebugReconsiderSendRemoteMessages()
Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.
Functions related to debugging.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Functions related to errors.
std::list< ErrorMessageData > ErrorList
Define a queue with errors.
void ScheduleErrorMessage(ErrorList &datas)
Schedule a list of errors.
@ WL_CRITICAL
Critical errors, the MessageBox is shown in all cases.
void ShowErrorMessage(EncodedString &&summary_msg, int x, int y, CommandCost &cc)
Display an error message in a window.
void ShowFirstError()
Show the first error of the queue.
bool FioCheckFileExists(std::string_view filename, Subdirectory subdir)
Check whether the given file exists.
std::string _config_file
Configuration file of OpenTTD.
Functions for standard in/out file operations.
@ NO_DIRECTORY
A path without any base directory.
@ NEWGRF_DIR
Subdirectory for all NewGRFs.
Declarations for savegames operations.
fluid_settings_t * settings
FluidSynth settings handle.
GameConfig stores the configuration settings of every Game.
Gamelog _gamelog
Gamelog instance.
Functions to be called to log fundamental changes to the game.
@ GLAT_SETTING
Setting changed.
Functions related to world/map generation.
@ LG_ORIGINAL
The original landscape generator.
static const uint CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY
Value for custom sea level in difficulty settings.
static const uint CUSTOM_SEA_LEVEL_MIN_PERCENTAGE
Minimum percentage a user can specify for custom sea level.
Types related to reading/writing '*.ini' files.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
constexpr uint ClampU(const uint a, const uint min, const uint max)
Clamp an unsigned integer between an interval.
StringList _network_host_list
The servers we know.
bool _networking
are we in networking mode?
StringList _network_ban_list
The banned clients.
bool _network_server
network-server is active
StringList _network_bind_list
The addresses to bind on.
Basic functions/variables used all over the place.
Network functions used by other parts of OpenTTD.
@ Public
The game is publicly accessible.
@ Local
Do not communicate with the game coordinator.
void BadgeClassSaveConfig(IniFile &ini)
Save badge column preferences.
void BadgeClassLoadConfig(const IniFile &ini)
Load badge column preferences.
Functions related to NewGRF badge configuration.
GRFConfigList _grfconfig_static
First item in list of static GRF set up.
std::string GRFBuildParamList(const GRFConfig &c)
Build a string containing space separated parameter values.
const GRFConfig * FindGRFConfig(uint32_t grfid, FindGRFConfigMode mode, const MD5Hash *md5sum, uint32_t desired_version)
Find a NewGRF in the scanned list.
GRFConfigList _grfconfig_newgame
First item in list of default GRF set up.
bool FillGRFDetails(GRFConfig &config, bool is_static, Subdirectory subdir)
Find the GRFID of a given grf, and calculate its md5sum.
Functions to find and configure NewGRFs.
@ GCS_NOT_FOUND
GRF file was not found in the local cache.
@ Invalid
GRF is unusable with this version of OpenTTD.
@ Static
GRF file is used statically (can be used in any MP game).
@ System
GRF file is an openttd-internal system grf.
@ Unsafe
GRF file is unsafe for static usage.
@ FGCM_NEWEST_VALID
Find newest Grf, ignoring Grfs with GRFConfigFlag::Invalid set.
@ FGCM_EXACT
Only find Grfs matching md5sum.
void PickerSaveConfig(IniFile &ini)
Save favourites of all registered Pickers to config.
void PickerLoadConfig(const IniFile &ini)
Load favourites of all registered Pickers from config.
Declaration of OTTD revision dependent variables.
A number of safeguards to prevent using unsafe methods.
void WriteValue(void *ptr, VarType conv, int64_t val)
Write the value of a setting.
int64_t ReadValue(const void *ptr, VarType conv)
Return a signed-long version of the value of a setting.
@ SLE_VAR_NULL
useful to write zeros in savegame.
@ SLE_VAR_STR
string pointer
@ SLE_VAR_STRQ
string pointer enclosed in quotes
constexpr size_t SlVarSize(VarType type)
Return expect size in bytes of a VarType.
void * GetVariableAddress(const void *object, const SaveLoad &sld)
Get the address of the variable.
bool SlIsObjectCurrentlyValid(SaveLoadVersion version_from, SaveLoadVersion version_to)
Checks if some version from/to combination falls within the range of the active savegame version.
constexpr VarType GetVarMemType(VarType type)
Get the NumberType of a setting.
static void GraphicsSetLoadConfig(IniFile &ini)
Load BaseGraphics set selection and configuration.
void HandleOldDiffCustom(bool savegame)
Reading of the old diff_custom array and transforming it to the new format.
void SyncCompanySettings()
Sync all company settings in a multiplayer game.
void IniLoadWindowSettings(IniFile &ini, std::string_view grpname, WindowDesc *desc)
Load a WindowDesc from config.
static void RemoveEntriesFromIni(IniFile &ini, const SettingTable &table)
Remove all entries from a settings table from an ini-file.
void SaveGRFPresetToConfig(std::string_view config_name, GRFConfigList &config)
Save a NewGRF configuration with a preset name.
StringList GetGRFPresetList()
Get the list of known NewGrf presets.
static void ValidateSettings()
Checks if any settings are set to incorrect values, and sets them to correct values in that case.
bool IsConversionNeeded(const ConfigIniFile &ini, const std::string &group, const std::string &old_var, const std::string &new_var, const IniItem **old_item)
Check whether a conversion should be done, and based on what old setting information.
void IConsoleGetSetting(std::string_view name, bool force_newgame)
Output value of a specific setting to the console.
std::string _secrets_file
Secrets configuration file of OpenTTD.
static GRFConfigList GRFLoadConfig(const IniFile &ini, std::string_view grpname, bool is_static)
Load a GRF configuration.
std::string _favs_file
Picker favourites configuration file of OpenTTD.
static ErrorList _settings_error_list
Errors while loading minimal settings.
void DeleteGRFPresetFromConfig(std::string_view config_name)
Delete a NewGRF configuration by preset name.
void SetDefaultCompanySettings(CompanyID cid)
Set the company settings for a new company to their default values.
static void IniLoadSettingList(IniFile &ini, std::string_view grpname, StringList &list)
Loads all items from a 'grpname' section into a list The list parameter can be a nullptr pointer,...
std::vector< const SettingDesc * > GetFilteredSettingCollection(std::function< bool(const SettingDesc &desc)> func)
Get a collection of settings matching a custom filter.
void LoadFromConfig(bool startup)
Load the values from the configuration files.
GRFConfigList LoadGRFPresetFromConfig(std::string_view config_name)
Load a NewGRF configuration by preset-name.
bool SetSettingValue(const IntSettingDesc *sd, int32_t value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
void SaveToConfig()
Save the values to the configuration file.
VehicleDefaultSettings _old_vds
Used for loading default vehicles settings from old savegames.
void PrepareOldDiffCustom()
Prepare for reading and old diff_custom by zero-ing the memory.
static void IniLoadSettings(IniFile &ini, const SettingTable &settings_table, std::string_view grpname, void *object, bool only_startup)
Load values from a group of an IniFile structure into the internal representation.
void GetSaveLoadFromSettingTable(SettingTable settings, std::vector< SaveLoad > &saveloads)
Get the SaveLoad for all settings in the settings table.
static void GraphicsSetSaveConfig(IniFile &ini)
Save BaseGraphics set selection and configuration.
static bool LoadIntList(std::optional< std::string_view > str, void *array, int nelems, VarType type)
Load parsed string-values into an integer-array (intlist).
static std::optional< std::vector< uint32_t > > ParseIntList(std::string_view str)
Parse a string into a vector of uint32s.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
CommandCost CmdChangeCompanySetting(DoCommandFlags flags, const std::string &name, int32_t value)
Change one of the per-company settings.
IniFileVersion
Ini-file versions.
@ IFV_0
0 All versions prior to introduction.
@ IFV_AUTOSAVE_RENAME
5 PR#11143 Renamed values of autosave to be in minutes.
@ IFV_LINKGRAPH_SECONDS
3 PR#10610 Store linkgraph update intervals in seconds instead of days.
@ IFV_REMOVE_GENERATION_SEED
7 PR#11927 Remove "generation_seed" from configuration.
@ IFV_MAX_VERSION
Highest possible ini-file version.
@ IFV_NETWORK_PRIVATE_SETTINGS
4 PR#10762 Move use_relay_service to private settings.
@ IFV_GAME_TYPE
2 PR#9515 Convert server_advertise to server_game_type.
@ IFV_RIGHT_CLICK_CLOSE
6 PR#10204 Add alternative right click to close windows setting.
@ IFV_PRIVATE_SECRETS
1 PR#9298 Moving of settings from openttd.cfg to private.cfg / secrets.cfg.
SettingTable GetSaveLoadSettingTable()
Create a single table with all settings that should be stored/loaded in the savegame.
void IConsoleListSettings(std::string_view prefilter)
List all settings and their value to the console.
static void IniSaveSettingList(IniFile &ini, std::string_view grpname, StringList &list)
Saves all items from a list into the 'grpname' section The list parameter can be a nullptr pointer,...
const uint16_t INIFILE_VERSION
Current ini-file version of OpenTTD.
static void IniSaveSettings(IniFile &ini, const SettingTable &settings_table, std::string_view grpname, void *object, bool)
Save the values of settings to the inifile.
static auto & SecretSettingTables()
List of all the secrets setting tables.
std::string _private_file
Private configuration file of OpenTTD.
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
static auto & PrivateSettingTables()
List of all the private setting tables.
static void SaveVersionInConfig(IniFile &ini)
Save the version of OpenTTD to the ini file.
static std::optional< uint32_t > LookupManyOfMany(std::span< const std::string_view > many, std::string_view str)
Find the set-integer value MANYofMANY type in a string.
static const SettingDesc * GetSettingFromName(std::string_view name, const SettingTable &settings)
Given a name of setting, return a setting description from the table.
static auto & GenericSettingTables()
List of all the generic setting tables.
void IniSaveWindowSettings(IniFile &ini, std::string_view grpname, WindowDesc *desc)
Save a WindowDesc to config.
static const SettingDesc * GetCompanySettingFromName(std::string_view name)
Given a name of setting, return a company setting description of it.
CommandCost CmdChangeSetting(DoCommandFlags flags, const std::string &name, int32_t value)
Network-safe changing of settings (server-only).
ClientSettings _settings_client
The current settings for this game.
Command definitions related to settings.
Functions related to setting/changing the settings.
@ NotInSave
Do not save with savegame, basically client-based.
@ Sandbox
This setting is a sandbox setting.
@ SceneditOnly
This setting can only be changed in the scenario editor.
@ PerCompany
This setting can be different for each company (saved in company struct).
@ NewgameOnly
This setting cannot be changed in a game.
@ GuiZeroIsSpecial
A value of zero is possible and has a custom string (the one after "strval").
@ NoNetwork
This setting does not apply to network games; it may not be changed during the game.
@ NotInConfig
Do not save to config file.
@ GuiDropdown
The value represents a limited number of string-options (internally integer) presented as dropdown.
@ SceneditToo
This setting can be changed in the scenario editor (only makes sense when SettingFlag::NewgameOnly is...
@ NoNetworkSync
Do not synchronize over network (but it is saved if SettingFlag::NotInSave is not set).
@ NetworkOnly
This setting only applies to network games.
SettingType
Type of settings for filtering.
@ ST_CLIENT
Client setting.
@ ST_COMPANY
Company setting.
static constexpr const SettingDesc * GetSettingDesc(const SettingVariant &desc)
Helper to convert the type of the iterated settings description to a pointer to it.
Definition of the configuration tables of the settings.
GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
Definition of base types and functions in a cross-platform compatible way.
bool ConvertHexToBytes(std::string_view hex, std::span< uint8_t > bytes)
Convert a hex-string to a byte-array, while validating it was actually hex.
void StrMakeValidInPlace(char *str, StringValidationSettings settings)
Scans the string for invalid characters and replaces them with a question mark '?
std::string FormatArrayAsHex(std::span< const uint8_t > data)
Format a byte array into a continuous hex string.
static std::optional< T > ParseInteger(std::string_view arg, int base=10, bool clamp=false)
Change a string into its number representation.
Functions related to low-level strings.
std::vector< std::string > StringList
Type for a list of strings.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
std::string name
The name of the base set.
uint32_t shortname
Four letter short variant of the name.
std::string FormatValue(const void *object) const override
Format the value of the setting associated with this object.
static std::optional< bool > ParseSingleValue(std::string_view str)
Find whether a string was a boolean true or a boolean false.
int32_t ParseValue(std::string_view str) const override
Convert a string representation (external) of an integer-like setting to an integer.
All settings that are only important for the local client.
CompanySettings settings
settings specific for each company
Information about GRF, used in the game and (part of it) in savegames.
uint32_t version
NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown.
std::vector< uint32_t > param
GRF parameters.
All settings together for the game.
All data of a graphics set.
Ini file that supports both loading and saving.
bool SaveToDisk(const std::string &filename)
Save the Ini file's data to the disk.
IniFile(const IniGroupNameList &list_group_names={})
Create a new ini file with given group names.
A group within an ini file.
const IniItem * GetItem(std::string_view name) const
Get the item with the given name.
std::string comment
comment for group
void Clear()
Clear all items in the group.
void RemoveItem(std::string_view name)
Remove the item with the given name.
std::string name
name of group
IniItem & CreateItem(std::string_view name)
Create an item with the given name.
IniItem & GetOrCreateItem(std::string_view name)
Get the item with the given name, and if it doesn't exist create a new item.
std::list< IniItem > items
all items in the group
A single "line" in an ini file.
std::optional< std::string > value
The value of this item.
std::string name
The name of this item.
void SetValue(std::string_view value)
Replace the current value with another value.
std::list< IniGroup > groups
all groups in the ini
void RemoveGroup(std::string_view name)
Remove the group with the given name.
const IniGroup * GetGroup(std::string_view name) const
Get the group with the given name.
void LoadFromDisk(std::string_view filename, Subdirectory subdir)
Load the Ini file's data from the disk.
IniGroup & GetOrCreateGroup(std::string_view name)
Get the group with the given name, and if it doesn't exist create a new group.
Base integer type, including boolean, settings.
StringID str_help
(Translated) string with help text; gui only.
StringID str_val
(Translated) first string describing the value.
void MakeValueValid(int32_t &value) const
Make the value valid given the limitations of this setting.
void ResetToDefault(void *object) const override
Reset the setting to its default value.
std::string FormatValue(const void *object) const override
Format the value of the setting associated with this object.
int32_t def
default value given when none is present
std::tuple< int32_t, uint32_t > GetRange() const
Get the min/max range for the setting.
StringID GetTitle() const
Get the title of the setting.
void ChangeValue(const void *object, int32_t newvalue) const
Handle changing a value.
uint32_t max
maximum values
GetDefaultValueCallback * get_def_cb
Callback to set the correct default value.
bool IsSameValue(const IniItem *item, void *object) const override
Check whether the value in the Ini item is the same as is saved in this setting in the object.
int32_t min
minimum values
PreChangeCheck * pre_check
Callback to check for the validity of the setting.
int32_t GetDefaultValue() const
Get the default value of the setting.
void Write(const void *object, int32_t value) const
Set the value of a setting.
StringID GetHelp() const
Get the help text of the setting.
virtual bool IsBoolSetting() const
Check whether this setting is a boolean type setting.
PostChangeCallback * post_callback
Callback when the setting has been changed.
StringID str
(translated) string with descriptive text; gui and console
void MakeValueValidAndWrite(const void *object, int32_t value) const
Make the value valid and then write it to the setting.
std::pair< StringParameter, StringParameter > GetValueParams(int32_t value) const
Get parameters for drawing the value of the setting.
int32_t Read(const void *object) const
Read the integer from the the actual setting.
virtual int32_t ParseValue(std::string_view str) const
Convert a string representation (external) of an integer-like setting to an integer.
bool IsDefaultValue(void *object) const override
Check whether the value is the same as the default value.
void ParseValue(const IniItem *item, void *object) const override
Parse/read the value from the Ini item into the setting associated with this object.
void ResetToDefault(void *object) const override
Reset the setting to its default value.
bool IsSameValue(const IniItem *item, void *object) const override
Check whether the value in the Ini item is the same as is saved in this setting in the object.
std::string_view def
default value given when none is present
std::string FormatValue(const void *object) const override
Convert a list to a string representation.
bool IsDefaultValue(void *object) const override
Check whether the value is the same as the default value.
int32_t ParseValue(std::string_view str) const override
Convert a string representation (external) of an integer-like setting to an integer.
std::string FormatValue(const void *object) const override
Format the value of the setting associated with this object.
OnConvert * many_cnvt
callback procedure when loading value mechanism fails
std::string FormatValue(const void *object) const override
Format the value of the setting associated with this object.
static std::optional< uint32_t > ParseSingleValue(std::string_view str, std::span< const std::string_view > many)
Find the index value of a ONEofMANY type in a string.
std::vector< std::string_view > many
possible values for this type
int32_t ParseValue(std::string_view str) const override
Convert a string representation (external) of an integer-like setting to an integer.
static Company * Get(auto index)
static bool IsValidID(auto index)
SaveLoadVersion version_to
Save/load the variable before this savegame version.
VarType conv
Type of the variable to be saved; this field combines both FileVarType and MemVarType.
SaveLoadVersion version_from
Save/load the variable starting from this savegame version.
Container for AI and Game script configuration.
std::unique_ptr< class GameConfig > game
settings for gamescript
TypedIndexContainer< std::array< std::unique_ptr< class AIConfig >, MAX_COMPANIES >, CompanyID > ai
settings per company
~ScriptConfigSettings()
Needs to be manually defined due to incomplete definition of types in the header.
Iterable ensemble of each set bit in a value.
Properties of config file settings.
virtual void ParseValue(const IniItem *item, void *object) const =0
Parse/read the value from the Ini item into the setting associated with this object.
bool IsEditable(bool do_command=false) const
Check whether the setting is editable in the current gamemode.
SettingFlags flags
Handles how a setting would show up in the GUI (text/currency, etc.).
virtual bool IsStringSetting() const
Check whether this setting is an string type setting.
SettingType GetType() const
Return the type of the setting.
constexpr const std::string & GetName() const
Get the name of this setting.
bool startup
Setting has to be loaded directly at startup?.
virtual std::string FormatValue(const void *object) const =0
Format the value of the setting associated with this object.
const struct StringSettingDesc * AsStringSetting() const
Get the setting description of this setting as a string setting.
virtual bool IsSameValue(const IniItem *item, void *object) const =0
Check whether the value in the Ini item is the same as is saved in this setting in the object.
SaveLoad save
Internal structure (going to savegame, parts to config).
virtual bool IsIntSetting() const
Check whether this setting is an integer type setting.
const struct IntSettingDesc * AsIntSetting() const
Get the setting description of this setting as an integer setting.
const std::string & Read(const void *object) const
Read the string from the the actual setting.
std::string_view def
Default value given when none is present.
void Write(const void *object, std::string_view str) const
Write a string to the actual setting.
uint32_t max_length
Maximum length of the string, 0 means no maximum length.
PreChangeCheck * pre_check
Callback to check for the validity of the setting.
void ChangeValue(const void *object, std::string &&newval) const
Handle changing a string value.
void MakeValueValid(std::string &str) const
Make the value valid given the limitations of this setting.
bool IsSameValue(const IniItem *item, void *object) const override
Check whether the value in the Ini item is the same as is saved in this setting in the object.
bool IsDefaultValue(void *object) const override
Check whether the value is the same as the default value.
PostChangeCallback * post_callback
Callback when the setting has been changed.
void ResetToDefault(void *object) const override
Reset the setting to its default value.
std::string FormatValue(const void *object) const override
Format the value of the setting associated with this object.
void ParseValue(const IniItem *item, void *object) const override
Parse/read the value from the Ini item into the setting associated with this object.
Default settings for vehicles.
High level window description.
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting).
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Window functions not directly related to making/drawing windows.
@ WC_ERRMSG
Error message; Window numbers:
@ WC_CHEATS
Cheat window; Window numbers:
@ WC_GAME_OPTIONS
Game options window; Window numbers: