17#include "network/core/network_game_info.h"
45#include "3rdparty/fmt/chrono.h"
49#include "table/strings.h"
81static std::optional<T>
ParseType(std::string_view arg)
84 if (i.has_value())
return static_cast<T
>(*i);
81static std::optional<T>
ParseType(std::string_view arg) {
…}
134 if (echo)
IConsolePrint(
CC_ERROR,
"You cannot use this command because there is no network available.");
229 if (_game_mode == GM_MENU) {
245 IConsolePrint(
CC_HELP,
"Reset status data of all engines. This might solve some issues with 'lost' engines. Usage: 'resetengines'.");
261 IConsolePrint(
CC_HELP,
"Reset NewGRF allocations of engine slots. This will remove invalid engine definitions, and might make default engines available again.");
265 if (_game_mode == GM_MENU) {
284static bool ConResetTile(std::span<std::string_view> argv)
292 if (argv.size() == 2) {
311 switch (argv.size()) {
330 auto level = ParseInteger<std::underlying_type_t<ZoomLevel>>(argv[1]);
331 if (level.has_value()) {
332 auto zoom_lvl =
static_cast<ZoomLevel>(*level);
367 IConsolePrint(
CC_HELP,
"'instant' will immediately move and redraw viewport without smooth scrolling.");
370 if (argv.size() < 2)
return false;
372 uint32_t arg_index = 1;
373 bool instant =
false;
374 if (argv[arg_index] ==
"instant") {
379 switch (argv.size() - arg_index) {
382 if (result.has_value()) {
396 if (x.has_value() && y.has_value()) {
416static bool ConSave(std::span<std::string_view> argv)
423 if (argv.size() == 2) {
424 std::string filename = fmt::format(
"{}.sav", argv[1]);
416static bool ConSave(std::span<std::string_view> argv) {
…}
445 IConsolePrint(
CC_HELP,
"Saves the configuration for new games to the configuration file, typically 'openttd.cfg'.");
446 IConsolePrint(
CC_HELP,
"It does not save the configuration of the current game to the configuration file.");
455static bool ConLoad(std::span<std::string_view> argv)
462 if (argv.size() != 2)
return false;
464 std::string_view file = argv[1];
467 if (item !=
nullptr) {
481static bool ConLoadScenario(std::span<std::string_view> argv)
484 IConsolePrint(
CC_HELP,
"Load a scenario by name or index. Usage: 'load_scenario <file | number>'.");
488 if (argv.size() != 2)
return false;
490 std::string_view file = argv[1];
493 if (item !=
nullptr) {
507static bool ConLoadHeightmap(std::span<std::string_view> argv)
510 IConsolePrint(
CC_HELP,
"Load a heightmap by name or index. Usage: 'load_heightmap <file | number>'.");
514 if (argv.size() != 2)
return false;
516 std::string_view file = argv[1];
519 if (item !=
nullptr) {
533static bool ConRemove(std::span<std::string_view> argv)
540 if (argv.size() != 2)
return false;
542 std::string_view file = argv[1];
545 if (item !=
nullptr) {
563static bool ConListFiles(std::span<std::string_view> argv)
566 IConsolePrint(
CC_HELP,
"List all loadable savegames and directories in the current dir via console. Usage: 'ls | dir'.");
579static bool ConListScenarios(std::span<std::string_view> argv)
595static bool ConListHeightmaps(std::span<std::string_view> argv)
611static bool ConChangeDirectory(std::span<std::string_view> argv)
618 if (argv.size() != 2)
return false;
620 std::string_view file = argv[1];
623 if (item !=
nullptr) {
640static bool ConPrintWorkingDirectory(std::span<std::string_view> argv)
655static bool ConClearBuffer(std::span<std::string_view> argv)
662 IConsoleClearBuffer();
672static bool ConKickOrBan(std::string_view arg,
bool ban, std::string_view reason)
676 if (arg.find_first_of(
".:") == std::string::npos) {
677 auto client_id = ParseType<ClientID>(arg);
678 if (!client_id.has_value()) {
719static bool ConKick(std::span<std::string_view> argv)
722 IConsolePrint(
CC_HELP,
"Kick a client from a network game. Usage: 'kick <ip | client-id> [<kick-reason>]'.");
727 if (argv.size() != 2 && argv.size() != 3)
return false;
730 if (argv.size() == 2)
return ConKickOrBan(argv[1],
false, {});
733 size_t kick_message_length = argv[2].size();
734 if (kick_message_length >= 255) {
735 IConsolePrint(
CC_ERROR,
"Maximum kick message length is 254 characters. You entered {} characters.", kick_message_length);
738 return ConKickOrBan(argv[1],
false, argv[2]);
742static bool ConBan(std::span<std::string_view> argv)
745 IConsolePrint(
CC_HELP,
"Ban a client from a network game. Usage: 'ban <ip | client-id> [<ban-reason>]'.");
751 if (argv.size() != 2 && argv.size() != 3)
return false;
754 if (argv.size() == 2)
return ConKickOrBan(argv[1],
true, {});
757 size_t kick_message_length = argv[2].size();
758 if (kick_message_length >= 255) {
759 IConsolePrint(
CC_ERROR,
"Maximum kick message length is 254 characters. You entered {} characters.", kick_message_length);
762 return ConKickOrBan(argv[1],
true, argv[2]);
766static bool ConUnBan(std::span<std::string_view> argv)
769 IConsolePrint(
CC_HELP,
"Unban a client from a network game. Usage: 'unban <ip | banlist-index>'.");
774 if (argv.size() != 2)
return false;
798static bool ConBanList(std::span<std::string_view> argv)
816static bool ConPauseGame(std::span<std::string_view> argv)
823 if (_game_mode == GM_MENU) {
838static bool ConUnpauseGame(std::span<std::string_view> argv)
845 if (_game_mode == GM_MENU) {
864static bool ConRcon(std::span<std::string_view> argv)
867 IConsolePrint(
CC_HELP,
"Remote control the server from another client. Usage: 'rcon <password> <command>'.");
868 IConsolePrint(
CC_HELP,
"Remember to enclose the command in quotes, otherwise only the first parameter is sent.");
869 IConsolePrint(
CC_HELP,
"When your client's public key is in the 'authorized keys' for 'rcon', the password is not checked and may be '*'.");
873 if (argv.size() < 3)
return false;
883static bool ConStatus(std::span<std::string_view> argv)
886 IConsolePrint(
CC_HELP,
"List the status of all clients connected to the server. Usage 'status'.");
894static bool ConServerInfo(std::span<std::string_view> argv)
898 IConsolePrint(
CC_HELP,
"You can change these values by modifying settings 'network.max_clients' and 'network.max_companies'.");
910static bool ConClientNickChange(std::span<std::string_view> argv)
912 if (argv.size() != 3) {
913 IConsolePrint(
CC_HELP,
"Change the nickname of a connected client. Usage: 'client_name <client-id> <new-name>'.");
918 auto client_id = ParseType<ClientID>(argv[1]);
919 if (!client_id.has_value()) {
947static std::optional<CompanyID> ParseCompanyID(std::string_view arg)
949 auto company_id = ParseType<CompanyID>(arg);
950 if (company_id.has_value() && *company_id <= MAX_COMPANIES)
return static_cast<CompanyID>(*company_id - 1);
954static bool ConJoinCompany(std::span<std::string_view> argv)
956 if (argv.size() < 2) {
962 auto company_id = ParseCompanyID(argv[1]);
963 if (!company_id.has_value()) {
969 if (info ==
nullptr) {
976 IConsolePrint(
CC_ERROR,
"Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
1005static bool ConMoveClient(std::span<std::string_view> argv)
1007 if (argv.size() < 3) {
1008 IConsolePrint(
CC_HELP,
"Move a client to another company. Usage: 'move <client-id> <company-id>'.");
1009 IConsolePrint(
CC_HELP,
"For valid client-id see 'clients', for valid company-id see 'companies', use 255 for moving to spectators.");
1013 auto client_id = ParseType<ClientID>(argv[1]);
1014 if (!client_id.has_value()) {
1020 auto company_id = ParseCompanyID(argv[2]);
1021 if (!company_id.has_value()) {
1027 if (ci ==
nullptr) {
1033 IConsolePrint(
CC_ERROR,
"Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
1058static bool ConResetCompany(std::span<std::string_view> argv)
1061 IConsolePrint(
CC_HELP,
"Remove an idle company from the game. Usage: 'reset_company <company-id>'.");
1062 IConsolePrint(
CC_HELP,
"For company-id's, see the list of companies from the dropdown menu. Company 1 is 1, etc.");
1066 if (argv.size() != 2)
return false;
1068 auto index = ParseCompanyID(argv[1]);
1069 if (!index.has_value()) {
1076 IConsolePrint(
CC_ERROR,
"Company does not exist. company-id must be between 1 and {}.", MAX_COMPANIES);
1090 assert(ci !=
nullptr);
1103static bool ConNetworkClients(std::span<std::string_view> argv)
1106 IConsolePrint(
CC_HELP,
"Get a list of connected clients including their ID, name, company-id, and IP. Usage: 'clients'.");
1115static bool ConNetworkReconnect(std::span<std::string_view> argv)
1118 IConsolePrint(
CC_HELP,
"Reconnect to server to which you were connected last time. Usage: 'reconnect [<company-id>]'.");
1119 IConsolePrint(
CC_HELP,
"Company 255 is spectator (default, if not specified), 254 means creating new company.");
1125 if (argv.size() >= 2) {
1126 auto company_id = ParseCompanyID(argv[1]);
1127 if (!company_id.has_value()) {
1132 playas = *company_id;
1146static bool ConNetworkConnect(std::span<std::string_view> argv)
1149 IConsolePrint(
CC_HELP,
"Connect to a remote OTTD server and join the game. Usage: 'connect <ip>'.");
1150 IConsolePrint(
CC_HELP,
"IP can contain port and company: 'IP[:Port][#Company]', eg: 'server.ottd.org:443#2'.");
1151 IConsolePrint(
CC_HELP,
"Company #255 is spectator all others are a certain company with Company 1 being #1.");
1155 if (argv.size() < 2)
return false;
1164static bool ConExec(std::span<std::string_view> argv)
1168 IConsolePrint(
CC_HELP,
"By passing '0' after the script name, no warning about a missing script file will be shown.");
1172 if (argv.size() < 2)
return false;
1176 if (!script_file.has_value()) {
1177 if (argv.size() == 2 || argv[2] !=
"0")
IConsolePrint(
CC_ERROR,
"Script file '{}' not found.", argv[1]);
1182 IConsolePrint(
CC_ERROR,
"Maximum 'exec' depth reached; script A is calling script B is calling script C ... more than 10 times.");
1190 while (fgets(buffer,
sizeof(buffer), *script_file) !=
nullptr) {
1192 std::string_view cmdline{buffer};
1193 auto last_non_newline = cmdline.find_last_not_of(
"\r\n");
1194 if (last_non_newline != std::string_view::npos) cmdline = cmdline.substr(0, last_non_newline + 1);
1204 if (ferror(*script_file) != 0) {
1212static bool ConSchedule(std::span<std::string_view> argv)
1214 if (argv.size() < 3 || std::string_view(argv[1]) !=
"on-next-calendar-month") {
1215 IConsolePrint(
CC_HELP,
"Schedule a local script to execute later. Usage: 'schedule on-next-calendar-month <script>'.");
1226 std::string_view filename = std::string_view(argv[2]);
1228 IConsolePrint(
CC_INFO,
"Script file '{}' was already scheduled to execute at the start of next calendar month.", filename);
1232 IConsolePrint(
CC_INFO,
"Script file '{}' scheduled to execute at the start of next calendar month.", filename);
1241static bool ConReturn(std::span<std::string_view> argv)
1255extern bool CloseConsoleLogIfActive();
1256extern std::span<const GRFFile> GetAllGRFFiles();
1260static bool ConScript(std::span<std::string_view> argv)
1262 extern std::optional<FileHandle> _iconsole_output_file;
1265 IConsolePrint(
CC_HELP,
"Start or stop logging console output to a file. Usage: 'script <filename>'.");
1270 if (!CloseConsoleLogIfActive()) {
1271 if (argv.size() < 2)
return false;
1274 if (!_iconsole_output_file.has_value()) {
1284static bool ConEcho(std::span<std::string_view> argv)
1291 if (argv.size() < 2)
return false;
1296static bool ConEchoC(std::span<std::string_view> argv)
1299 IConsolePrint(
CC_HELP,
"Print back the first argument to the console in a given colour. Usage: 'echoc <colour> <arg2>'.");
1303 if (argv.size() < 3)
return false;
1306 if (!colour.has_value() || !
IsInsideMM(*colour, TC_BEGIN, TC_END)) {
1315static bool ConNewGame(std::span<std::string_view> argv)
1319 IConsolePrint(
CC_HELP,
"The server can force a new game using 'newgame'; any client joined will rejoin after the server is done generating the new game.");
1324 if (argv.size() >= 2) {
1326 if (!param.has_value()) {
1337static bool ConRestart(std::span<std::string_view> argv)
1339 if (argv.empty() || argv.size() > 2) {
1341 IConsolePrint(
CC_HELP,
"Restarts a game, using either the current or newgame (default) settings.");
1342 IConsolePrint(
CC_HELP,
" * if you started from a new game, and your current/newgame settings haven't changed, the game will be identical to when you started it.");
1343 IConsolePrint(
CC_HELP,
" * if you started from a savegame / scenario / heightmap, the game might be different, because the current/newgame settings might differ.");
1347 if (argv.size() == 1 || std::string_view(argv[1]) ==
"newgame") {
1358static bool ConReload(std::span<std::string_view> argv)
1384 std::istringstream in(full_string);
1386 while (std::getline(in, line)) {
1391template <
typename F,
typename ... Args>
1392bool PrintList(F list_function, Args... args)
1394 std::string output_str;
1395 auto inserter = std::back_inserter(output_str);
1396 list_function(inserter, args...);
1402static bool ConListAILibs(std::span<std::string_view> argv)
1412static bool ConListAI(std::span<std::string_view> argv)
1422static bool ConListGameLibs(std::span<std::string_view> argv)
1432static bool ConListGame(std::span<std::string_view> argv)
1442static bool ConStartAI(std::span<std::string_view> argv)
1444 if (argv.empty() || argv.size() > 3) {
1446 IConsolePrint(
CC_HELP,
"Start a new AI. If <AI> is given, it starts that specific AI (if found).");
1447 IConsolePrint(
CC_HELP,
"If <settings> is given, it is parsed and the AI settings are set to that.");
1451 if (_game_mode != GM_NORMAL) {
1477 if (c->index != n)
break;
1482 if (argv.size() >= 2) {
1483 config->
Change(argv[1], -1,
false);
1491 if (consumer.AnyBytesLeft()) {
1492 auto version = consumer.TryReadIntegerBase<uint32_t>(10);
1493 if (!version.has_value()) {
1497 config->
Change(name, *version,
true);
1505 if (argv.size() == 3) {
1516static bool ConReloadAI(std::span<std::string_view> argv)
1518 if (argv.size() != 2) {
1520 IConsolePrint(
CC_HELP,
"Reload the AI with the given company id. For company-id's, see the list of companies from the dropdown menu. Company 1 is 1, etc.");
1524 if (_game_mode != GM_NORMAL) {
1534 auto company_id = ParseCompanyID(argv[1]);
1535 if (!company_id.has_value()) {
1559static bool ConStopAI(std::span<std::string_view> argv)
1561 if (argv.size() != 2) {
1563 IConsolePrint(
CC_HELP,
"Stop the AI with the given company id. For company-id's, see the list of companies from the dropdown menu. Company 1 is 1, etc.");
1567 if (_game_mode != GM_NORMAL) {
1577 auto company_id = ParseCompanyID(argv[1]);
1578 if (!company_id.has_value()) {
1601static bool ConRescanAI(std::span<std::string_view> argv)
1618static bool ConRescanGame(std::span<std::string_view> argv)
1635static bool ConRescanNewGRF(std::span<std::string_view> argv)
1643 IConsolePrint(
CC_ERROR,
"NewGRF scanning is already running. Please wait until completed to run again.");
1649static bool ConGetSeed(std::span<std::string_view> argv)
1653 IConsolePrint(
CC_HELP,
"The seed can be used to reproduce the exact same map as the game started with.");
1661static bool ConGetDate(std::span<std::string_view> argv)
1664 IConsolePrint(
CC_HELP,
"Returns the current date (year-month-day) of the game. Usage: 'getdate'.");
1673static bool ConGetSysDate(std::span<std::string_view> argv)
1676 IConsolePrint(
CC_HELP,
"Returns the current date (year-month-day) of your system. Usage: 'getsysdate'.");
1684static bool ConAlias(std::span<std::string_view> argv)
1689 IConsolePrint(
CC_HELP,
"Add a new alias, or redefine the behaviour of an existing alias . Usage: 'alias <name> <command>'.");
1693 if (argv.size() < 3)
return false;
1696 if (alias ==
nullptr) {
1704static bool ConScreenShot(std::span<std::string_view> argv)
1707 IConsolePrint(
CC_HELP,
"Create a screenshot of the game. Usage: 'screenshot [viewport | normal | big | giant | heightmap | minimap] [no_con] [size <width> <height>] [<filename>]'.");
1708 IConsolePrint(
CC_HELP,
" 'viewport' (default) makes a screenshot of the current viewport (including menus, windows).");
1712 IConsolePrint(
CC_HELP,
" 'heightmap' makes a heightmap screenshot of the map that can be loaded in as heightmap.");
1713 IConsolePrint(
CC_HELP,
" 'minimap' makes a top-viewed minimap screenshot of the whole world which represents one tile by one pixel.");
1714 IConsolePrint(
CC_HELP,
" 'no_con' hides the console to create the screenshot (only useful in combination with 'viewport').");
1715 IConsolePrint(
CC_HELP,
" 'size' sets the width and height of the viewport to make a screenshot of (only useful in combination with 'normal' or 'big').");
1716 IConsolePrint(
CC_HELP,
" A filename ending in # will prevent overwriting existing files and will number files counting upwards.");
1720 if (argv.size() > 7)
return false;
1724 uint32_t height = 0;
1726 uint32_t arg_index = 1;
1728 if (argv.size() > arg_index) {
1729 if (argv[arg_index] ==
"viewport") {
1732 }
else if (argv[arg_index] ==
"normal") {
1735 }
else if (argv[arg_index] ==
"big") {
1738 }
else if (argv[arg_index] ==
"giant") {
1741 }
else if (argv[arg_index] ==
"heightmap") {
1744 }
else if (argv[arg_index] ==
"minimap") {
1750 if (argv.size() > arg_index && argv[arg_index] ==
"no_con") {
1759 if (argv.size() > arg_index + 2 && argv[arg_index] ==
"size") {
1766 if (!t.has_value()) {
1773 if (!t.has_value()) {
1781 if (argv.size() > arg_index) {
1783 name = argv[arg_index];
1787 if (argv.size() > arg_index) {
1796static bool ConInfoCmd(std::span<std::string_view> argv)
1799 IConsolePrint(
CC_HELP,
"Print out debugging information about a command. Usage: 'info_cmd <cmd>'.");
1803 if (argv.size() < 2)
return false;
1806 if (cmd ==
nullptr) {
1818static bool ConDebugLevel(std::span<std::string_view> argv)
1821 IConsolePrint(
CC_HELP,
"Get/set the default debugging level for the game. Usage: 'debug_level [<level>]'.");
1822 IConsolePrint(
CC_HELP,
"Level can be any combination of names, levels. Eg 'net=5 ms=4'. Remember to enclose it in \"'\"s.");
1826 if (argv.size() > 2)
return false;
1828 if (argv.size() == 1) {
1837static bool ConExit(std::span<std::string_view> argv)
1850static bool ConPart(std::span<std::string_view> argv)
1853 IConsolePrint(
CC_HELP,
"Leave the currently joined/running game (only ingame). Usage: 'part'.");
1857 if (_game_mode != GM_NORMAL)
return false;
1868static bool ConHelp(std::span<std::string_view> argv)
1870 if (argv.size() == 2) {
1875 if (cmd !=
nullptr) {
1881 if (alias !=
nullptr) {
1883 if (cmd !=
nullptr) {
1895 IConsolePrint(TC_LIGHT_BLUE,
" ---- OpenTTD Console Help ---- ");
1907static bool ConListCommands(std::span<std::string_view> argv)
1916 if (argv.size() <= 1|| cmd->
name.find(argv[1]) != std::string::npos) {
1924static bool ConListAliases(std::span<std::string_view> argv)
1931 for (
auto &it :
IConsole::Aliases()) {
1933 if (argv.size() <= 1 || alias->
name.find(argv[1]) != std::string::npos) {
1941static bool ConCompanies(std::span<std::string_view> argv)
1950 std::string company_name =
GetString(STR_COMPANY_NAME, c->index);
1953 IConsolePrint(
CC_INFO,
"#:{}({}) Company Name: '{}' Year Founded: {} Money: {} Loan: {} Value: {} (T:{}, R:{}, P:{}, S:{}) {}",
1954 c->index + 1, colour, company_name,
1955 c->inaugurated_year, (int64_t)c->money, (int64_t)c->current_loan, (int64_t)
CalculateCompanyValue(c),
1957 c->group_all[
VEH_ROAD].num_vehicle,
1959 c->group_all[
VEH_SHIP].num_vehicle,
1960 c->is_ai ?
"AI" :
"");
1966static bool ConSay(std::span<std::string_view> argv)
1969 IConsolePrint(
CC_HELP,
"Chat to your fellow players in a multiplayer game. Usage: 'say \"<msg>\"'.");
1973 if (argv.size() != 2)
return false;
1985static bool ConSayCompany(std::span<std::string_view> argv)
1988 IConsolePrint(
CC_HELP,
"Chat to a certain company in a multiplayer game. Usage: 'say_company <company-no> \"<msg>\"'.");
1989 IConsolePrint(
CC_HELP,
"CompanyNo is the company that plays as company <companyno>, 1 through max_companies.");
1993 if (argv.size() != 3)
return false;
1995 auto company_id = ParseCompanyID(argv[1]);
1996 if (!company_id.has_value()) {
2016static bool ConSayClient(std::span<std::string_view> argv)
2019 IConsolePrint(
CC_HELP,
"Chat to a certain client in a multiplayer game. Usage: 'say_client <client-id> \"<msg>\"'.");
2024 if (argv.size() != 3)
return false;
2026 auto client_id = ParseType<ClientID>(argv[1]);
2027 if (!client_id.has_value()) {
2049enum ConNetworkAuthorizedKeyAction : uint8_t {
2055static void PerformNetworkAuthorizedKeyAction(std::string_view name,
NetworkAuthorizedKeys *authorized_keys, ConNetworkAuthorizedKeyAction action,
const std::string &authorized_key,
CompanyID company = CompanyID::Invalid())
2064 if (authorized_keys->
Contains(authorized_key)) {
2069 if (company == CompanyID::Invalid()) {
2070 authorized_keys->
Add(authorized_key);
2079 if (!authorized_keys->
Contains(authorized_key)) {
2084 if (company == CompanyID::Invalid()) {
2085 authorized_keys->
Remove(authorized_key);
2095static bool ConNetworkAuthorizedKey(std::span<std::string_view> argv)
2097 if (argv.size() <= 2) {
2098 IConsolePrint(
CC_HELP,
"List and update authorized keys. Usage: 'authorized_key list [type]|add [type] [key]|remove [type] [key]'.");
2101 IConsolePrint(
CC_HELP,
" remove: remove the given key from the authorized keys of the given type; use 'all' to remove all authorized keys.");
2102 IConsolePrint(
CC_HELP,
"Instead of a key, use 'client:<id>' to add/remove the key of that given client.");
2110 ConNetworkAuthorizedKeyAction action;
2111 std::string_view action_string = argv[1];
2113 action = CNAKA_LIST;
2117 action = CNAKA_REMOVE;
2123 std::string authorized_key;
2124 if (action != CNAKA_LIST) {
2125 if (argv.size() <= 3) {
2130 authorized_key = argv[3];
2132 auto value = ParseInteger<uint32_t>(authorized_key.substr(7));
2134 if (!value.has_value() || authorized_key.empty()) {
2146 std::string_view type = argv[2];
2148 for (
auto [name, authorized_keys] :
_console_cmd_authorized_keys) PerformNetworkAuthorizedKeyAction(name, authorized_keys, action, authorized_key);
2149 for (
Company *c :
Company::Iterate()) PerformNetworkAuthorizedKeyAction(fmt::format(
"company:{}", c->index + 1), &c->allow_list, action, authorized_key, c->index);
2154 auto value = ParseInteger<uint32_t>(type.substr(8));
2161 PerformNetworkAuthorizedKeyAction(type, &c->
allow_list, action, authorized_key, c->
index);
2168 PerformNetworkAuthorizedKeyAction(name, authorized_keys, action, authorized_key);
2178#if defined(WITH_ZLIB)
2184 static const std::initializer_list<std::pair<std::string_view, ContentType>> content_types = {
2192 for (
const auto &ct : content_types) {
2222 static const std::string_view types[] = {
"Base graphics",
"NewGRF",
"AI",
"AI library",
"Scenario",
"Heightmap",
"Base sound",
"Base music",
"Game script",
"GS library" };
2224 static const std::string_view states[] = {
"Not selected",
"Selected",
"Dep Selected",
"Installed",
"Unknown" };
2227 IConsolePrint(state_to_colour[
to_underlying(ci.
state)],
"{}, {}, {}, {}, {:08X}, {}", ci.
id, types[ci.
type - 1], states[
to_underlying(ci.
state)], ci.
name, ci.
unique_id,
FormatArrayAsHex(ci.
md5sum));
2230static bool ConContent(std::span<std::string_view> argv)
2238 if (argv.size() <= 1) {
2239 IConsolePrint(
CC_HELP,
"Query, select and download content. Usage: 'content update|upgrade|select [id]|unselect [all|id]|state [filter]|download'.");
2242 IConsolePrint(
CC_HELP,
" select: select a specific item given by its id. If no parameter is given, all selected content will be listed.");
2243 IConsolePrint(
CC_HELP,
" unselect: unselect a specific item given by its id or 'all' to unselect all.");
2244 IConsolePrint(
CC_HELP,
" state: show the download/select state of all downloadable content. Optionally give a filter string.");
2260 if (argv.size() <= 2) {
2275 }
else if (
auto content_id = ParseType<ContentID>(argv[2]); content_id.has_value()) {
2284 if (argv.size() <= 2) {
2290 }
else if (
auto content_id = ParseType<ContentID>(argv[2]); content_id.has_value()) {
2319static bool ConFont(std::span<std::string_view> argv)
2325 IConsolePrint(
CC_HELP,
" The \"Currently active\" configuration is the one actually in effect (after interface scaling and replacing unavailable fonts).");
2326 IConsolePrint(
CC_HELP,
" The \"Requested\" configuration is the one requested via console command or config file.");
2330 IConsolePrint(
CC_HELP,
" Set <font name> to \"\" for the default font. Note that <size> has no effect if the default font is in use, and fixed defaults are used instead.");
2331 IConsolePrint(
CC_HELP,
" If the sprite font is enabled in Game Options, it is used instead of the default font.");
2332 IConsolePrint(
CC_HELP,
" The <size> is automatically multiplied by the current interface scaling.");
2337 for (argfs =
FS_BEGIN; argfs < FS_END; argfs++) {
2342 if (argv.size() > 1 && argfs == FS_END)
return false;
2344 if (argv.size() > 2) {
2346 std::string font = setting->
font;
2347 uint size = setting->
size;
2348 uint8_t arg_index = 2;
2352 font = argv[arg_index++];
2355 if (argv.size() > arg_index) {
2358 if (v.has_value()) {
2364 SetFont(argfs, font, size);
2383static bool ConSetting(std::span<std::string_view> argv)
2391 if (argv.size() == 1 || argv.size() > 3)
return false;
2393 if (argv.size() == 2) {
2396 IConsoleSetSetting(argv[1], argv[2]);
2402static bool ConSettingNewgame(std::span<std::string_view> argv)
2405 IConsolePrint(
CC_HELP,
"Change setting for the next game. Usage: 'setting_newgame <name> [<value>]'.");
2410 if (argv.size() == 1 || argv.size() > 3)
return false;
2412 if (argv.size() == 2) {
2415 IConsoleSetSetting(argv[1], argv[2],
true);
2421static bool ConListSettings(std::span<std::string_view> argv)
2428 if (argv.size() > 2)
return false;
2434static bool ConGamelogPrint(std::span<std::string_view> argv)
2437 IConsolePrint(
CC_HELP,
"Print logged fundamental changes to the game since the start. Usage: 'gamelog'.");
2445static bool ConNewGRFReload(std::span<std::string_view> argv)
2448 IConsolePrint(
CC_HELP,
"Reloads all active NewGRFs from disk. Equivalent to reapplying NewGRFs via the settings, but without asking for confirmation. This might crash OpenTTD!");
2458 struct SubdirNameMap {
2460 std::string_view name;
2463 static const SubdirNameMap subdir_name_map[] = {
2480 if (argv.size() != 2) {
2481 IConsolePrint(
CC_HELP,
"List all search paths or default directories for various categories.");
2483 std::string cats{subdir_name_map[0].name};
2485 for (
const SubdirNameMap &sdn : subdir_name_map) {
2496 std::set<std::string> seen_dirs;
2497 for (
const SubdirNameMap &sdn : subdir_name_map) {
2502 std::string path = FioGetDirectory(sp, sdn.subdir);
2504 if (seen_dirs.find(path) != seen_dirs.end())
continue;
2505 seen_dirs.insert(path);
2510 if (!sdn.default_only || exists) {
2512 if (sdn.default_only)
break;
2525static bool ConNewGRFProfile(std::span<std::string_view> argv)
2528 IConsolePrint(
CC_HELP,
"Collect performance data about NewGRF sprite requests and callbacks. Sub-commands can be abbreviated.");
2534 IConsolePrint(
CC_HELP,
" Unselect one or more GRFs from profiling. Use the keyword \"all\" instead of a GRF number to unselect all. Removing an active profiler aborts data collection.");
2536 IConsolePrint(
CC_HELP,
" Begin profiling all selected GRFs. If a number of ticks is provided, profiling stops after that many game ticks. There are 74 ticks in a calendar day.");
2544 std::span<const GRFFile> files = GetAllGRFFiles();
2550 for (
const auto &grf : files) {
2552 bool selected = profiler != _newgrf_profilers.end();
2553 bool active = selected && profiler->active;
2555 std::string_view statustext = active ?
" (active)" : selected ?
" (selected)" :
"";
2556 IConsolePrint(tc,
"{}: [{:08X}] {}{}", i, std::byteswap(grf.grfid), grf.filename, statustext);
2564 for (
size_t argnum = 2; argnum < argv.size(); ++argnum) {
2566 if (!grfnum.has_value() || *grfnum < 1 ||
static_cast<size_t>(*grfnum) > files.size()) {
2570 const GRFFile *grf = &files[*grfnum - 1];
2571 if (std::any_of(_newgrf_profilers.begin(), _newgrf_profilers.end(), [&](
NewGRFProfiler &pr) { return pr.grffile == grf; })) {
2572 IConsolePrint(
CC_WARNING,
"GRF number {} [{:08X}] is already selected for profiling.", *grfnum, std::byteswap(grf->grfid));
2575 _newgrf_profilers.emplace_back(grf);
2582 for (
size_t argnum = 2; argnum < argv.size(); ++argnum) {
2584 _newgrf_profilers.clear();
2588 if (!grfnum.has_value() || *grfnum < 1 ||
static_cast<size_t>(*grfnum) > files.size()) {
2592 const GRFFile *grf = &files[*grfnum - 1];
2607 if (!grfids.empty()) grfids +=
", ";
2608 format_append(grfids,
"[{:08X}]", std::byteswap(pr.
grffile->grfid));
2614 if (argv.size() >= 3) {
2616 if (!ticks.has_value()) {
2617 IConsolePrint(
CC_ERROR,
"No valid amount of ticks was given, profiling will not stop automatically.");
2623 }
else if (_newgrf_profilers.empty()) {
2626 IConsolePrint(
CC_ERROR,
"Did not start profiling for any GRFs, all selected GRFs are already profiling.");
2633 NewGRFProfiler::FinishAll();
2654static void IConsoleDebugLibRegister()
2662static bool ConFramerate(std::span<std::string_view> argv)
2673static bool ConFramerateWindow(std::span<std::string_view> argv)
2698 if (std::isgraph(
GB(label, 24, 8)) && std::isgraph(
GB(label, 16, 8)) && std::isgraph(
GB(label, 8, 8)) && std::isgraph(
GB(label, 0, 8))) {
2699 return fmt::format(
"{:c}{:c}{:c}{:c}",
GB(label, 24, 8),
GB(label, 16, 8),
GB(label, 8, 8),
GB(label, 0, 8));
2702 return fmt::format(
"{:08X}", std::byteswap(label));
2705static void ConDumpRoadTypes()
2714 std::map<uint32_t, const GRFFile *> grfs;
2717 if (rti->
label == 0)
continue;
2720 if (grf !=
nullptr) {
2722 grfs.emplace(grfid, grf);
2726 RoadTypeIsTram(rt) ?
"Tram" :
"Road",
2734 GetStringPtr(rti->strings.name)
2737 for (
const auto &grf : grfs) {
2742static void ConDumpRailTypes()
2752 std::map<uint32_t, const GRFFile *> grfs;
2755 if (rti->
label == 0)
continue;
2758 if (grf !=
nullptr) {
2760 grfs.emplace(grfid, grf);
2772 GetStringPtr(rti->strings.name)
2775 for (
const auto &grf : grfs) {
2780static void ConDumpCargoTypes()
2800 std::map<uint32_t, const GRFFile *> grfs;
2803 const GRFFile *grf = spec->grffile;
2804 if (grf !=
nullptr) {
2806 grfs.emplace(grfid, grf);
2808 IConsolePrint(
CC_DEFAULT,
" {:02d} Bit: {:2d}, Label: {}, Callback mask: 0x{:02X}, Cargo class: {}{}{}{}{}{}{}{}{}{}{}{}{}{}{}{}, GRF: {:08X}, {}",
2812 spec->callback_mask.base(),
2830 GetStringPtr(spec->name)
2833 for (
const auto &grf : grfs) {
2838static bool ConDumpInfo(std::span<std::string_view> argv)
2840 if (argv.size() != 2) {
2858 ConDumpCargoTypes();
2869void IConsoleStdLibRegister()
2945#if defined(WITH_ZLIB)
3001 IConsoleDebugLibRegister();
Base functions for all AIs.
AIConfig stores the configuration settings of every AI.
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.
debug_inline static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
@ NotPourable
Not Pourable (open wagon, but not hopper wagon)
@ Powderized
Powderized, moist protected (powder/silo wagon)
@ Hazardous
Hazardous cargo (Nuclear Fuel, Explosives, etc.)
@ NonPotable
Non-potable / non-food / dirty.
@ Bulk
Bulk cargo (Coal, Grain etc., Ores, Fruit)
@ Liquid
Liquids (Oil, Water, Rubber)
@ Potable
Potable / food / clean.
@ Oversized
Oversized (stake/flatbed wagon)
@ Armoured
Armoured cargo (Valuables, Gold, Diamonds)
@ Refrigerated
Refrigerated cargo (Food, Fruit)
@ Express
Express cargo (Goods, Food, Candy, but also possible for passengers)
@ Special
Special bit used for livery refit tricks instead of normal cargoes.
@ PieceGoods
Piece goods (Livestock, Wood, Steel, Paper)
@ Covered
Covered/Sheltered Freight (Transportation in Box Vans, Silo Wagons, etc.)
static AIConfig * GetConfig(CompanyID company, ScriptSettingSource source=SSS_DEFAULT)
Get the config of a company.
static void GetConsoleLibraryList(std::back_insert_iterator< std::string > &output_iterator)
Wrapper function for AIScanner::GetAIConsoleLibraryList.
static void GetConsoleList(std::back_insert_iterator< std::string > &output_iterator, bool newest_only)
Wrapper function for AIScanner::GetAIConsoleList.
static bool CanStartNew()
Is it possible to start a new AI company?
static void Rescan()
Rescans all searchpaths for available AIs.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
void SelectUpgrade()
Select everything that's an update for something we've got.
void DownloadSelectedContent(uint &files, uint &bytes, bool fallback=false)
Actually begin downloading the content we selected.
void Select(ContentID cid)
Select a specific content id.
void UnselectAll()
Unselect everything that we've not downloaded so far.
void RequestContentList(ContentType type)
Request the content list for the given type.
void AddCallback(ContentCallback *cb)
Add a callback to this class.
void Unselect(ContentID cid)
Unselect a specific content id.
static bool IsConnected()
Check whether the client is actually connected (and in the game).
File list storage for the console, for caching the last 'ls' command.
void ValidateFileList(bool force_reload=false)
(Re-)validate the file storage cache.
bool file_list_valid
If set, the file list is valid.
AbstractFileType abstract_filetype
The abstract file type to list.
void InvalidateFileList()
Declare the file storage cache as being invalid, also clears all stored files.
bool show_dirs
Whether to show directories in the file list.
static std::optional< FileHandle > Open(const std::string &filename, std::string_view mode)
Open an RAII file handle if possible.
List of file information.
void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop, bool show_dirs)
Construct a file list with the given kind of files, for the stated purpose.
const FiosItem * FindItem(std::string_view file)
Find file information of a file by its name from the file list.
Font cache for basic fonts.
virtual std::string GetFontName()=0
Get the name of this font.
bool HasParent()
Check whether the font cache has a parent.
virtual int GetFontSize() const
Get the nominal font size of the font.
static FontCache * Get(FontSize fs)
Get the font cache of a given font size.
static void GetConsoleList(std::back_insert_iterator< std::string > &output_iterator, bool newest_only)
Wrapper function for GameScanner::GetConsoleList.
static void GetConsoleLibraryList(std::back_insert_iterator< std::string > &output_iterator)
Wrapper function for GameScanner::GetConsoleLibraryList.
void PrintConsole()
Print the gamelog data to the console.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Simple helper to (more easily) manage authorized keys.
bool Contains(std::string_view key) const
Check whether the given key is contains in these authorized keys.
bool Add(std::string_view key)
Add the given key to the authorized keys, when it is not already contained.
bool Remove(std::string_view key)
Remove the given key from the authorized keys, when it is exists.
This struct contains all the info that is needed to draw and construct tracks.
RailTypeLabel label
Unique 32 bit rail type identifier.
RailTypeFlags flags
Bit mask of rail type flags.
const GRFFile * grffile[RTSG_END]
NewGRF providing the Action3 for the railtype.
RoadTypeLabel label
Unique 32 bit road type identifier.
const GRFFile * grffile[ROTSG_END]
NewGRF providing the Action3 for the roadtype.
bool HasScript() const
Is this config attached to an Script? In other words, is there a Script that is assigned to this slot...
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.
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.
std::string_view ReadUntilChar(char c, SeparatorUsage sep)
Read data until the first occurrence of 8-bit char 'c', and advance reader.
@ SKIP_ONE_SEPARATOR
Read and discard one separator, do not include it in the result.
static const std::string_view WHITESPACE_NO_NEWLINE
ASCII whitespace characters, excluding new-line.
static YearMonthDay ConvertDateToYMD(Date date)
Converts a Date to a Year, Month & Day.
static Date date
Current date in days (day counter).
Functions related to commands.
Commands
List of commands.
Money CalculateCompanyValue(const Company *c, bool including_loan=true)
Calculate the value of the company.
TypedIndexContainer< std::array< Colours, MAX_COMPANIES >, CompanyID > _company_colours
NOSAVE: can be determined from company structs.
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.
Command definitions related to companies.
Functions related to companies.
@ CCA_NEW_AI
Create a new AI company.
@ CCA_DELETE
Delete a company.
static constexpr CompanyID COMPANY_SPECTATOR
The client is spectating.
@ CALCA_REMOVE
Remove a public key.
@ CALCA_ADD
Create a public key.
static constexpr CompanyID COMPANY_NEW_COMPANY
The client wants a new company.
@ CRR_NONE
Dummy reason for actions that don't need one.
@ CRR_MANUAL
The company is manually removed.
static const uint NETWORK_PUBLIC_KEY_LENGTH
The maximum length of the hexadecimal encoded public keys, in bytes including '\0'.
void IConsoleCmdExec(std::string_view command_string, const uint recurse_count)
Execute a given command passed to us.
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.
static void OutputContentState(const ContentInfo &ci)
Outputs content state information to console.
static const std::initializer_list< std::pair< std::string_view, NetworkAuthorizedKeys * > > _console_cmd_authorized_keys
All the known authorized keys with their name.
static std::string _scheduled_monthly_script
Script scheduled to execute by the 'schedule' console command (empty if no script is scheduled).
static bool ConScrollToTile(std::span< std::string_view > argv)
Scroll to a tile on the map.
static bool ConSaveConfig(std::span< std::string_view > argv)
Explicitly save the configuration.
void ShowFramerateWindow()
Open the general framerate window.
static bool ConResetEngines(std::span< std::string_view > argv)
Reset status of all engines.
static std::optional< T > ParseType(std::string_view arg)
Parse an integer using ParseInteger and convert it to the requested type.
static bool ConListDirs(std::span< std::string_view > argv)
static bool ConResetEnginePool(std::span< std::string_view > argv)
Reset status of the engine pool.
static ConsoleHookResult ConHookServerOrNoNetwork(bool echo)
Check if are either in singleplayer or a server.
static ConsoleFileList _console_file_list_scenario
File storage cache for scenarios.
static ConsoleFileList _console_file_list_heightmap
File storage cache for heightmaps.
static ConsoleHookResult ConHookServerOnly(bool echo)
Check whether we are a server.
static const IntervalTimer< TimerGameCalendar > _scheduled_monthly_timer
Timer that runs every month of game time for the 'schedule' console command.
static std::string FormatLabel(uint32_t label)
Format a label as a string.
static bool ConSave(std::span< std::string_view > argv)
Save the map to a file.
void ConPrintFramerate()
Print performance statistics to game console.
static ConsoleHookResult ConHookNeedNetwork(bool echo)
Check whether we are in a multiplayer game.
static ConsoleHookResult ConHookClientOnly(bool echo)
Check whether we are a client in a network game.
static bool ConZoomToLevel(std::span< std::string_view > argv)
Zoom map to given level.
static ContentType StringToContentType(std::string_view str)
Resolve a string to a content type.
static uint _script_current_depth
Depth of scripts running (used to abort execution when ConReturn is encountered).
static bool NetworkAvailable(bool echo)
Check network availability and inform in console about failure of detection.
static ConsoleHookResult ConHookNeedNonDedicatedNetwork(bool echo)
Check whether we are in a multiplayer game and are playing, i.e.
static ConsoleFileList _console_file_list_savegame
File storage cache for savegames.
static ConsoleHookResult ConHookNoNetwork(bool echo)
Check whether we are in singleplayer mode.
static void PrintLineByLine(const std::string &full_string)
Print a text buffer line by line to the console.
Console functions used outside of the console code.
void IConsoleClose()
Close the in-game console.
Internally used functions for the console.
ConsoleHookResult
Return values of console hooks (IConsoleHook).
@ CHR_HIDE
Hide the existence of the command.
@ CHR_DISALLOW
Disallow command execution.
@ CHR_ALLOW
Allow command execution.
static const uint ICON_CMDLN_SIZE
maximum length of a typed in command
static const TextColour CC_HELP
Colour for help lines.
static const TextColour CC_WHITE
White console lines for various things such as the welcome.
static const TextColour CC_INFO
Colour for information lines.
static const TextColour CC_COMMAND
Colour for the console's commands.
static const TextColour CC_WARNING
Colour for warning lines.
static const TextColour CC_DEBUG
Colour for debug output.
static const TextColour CC_DEFAULT
Default colour of the console.
static const TextColour CC_ERROR
Colour for error lines.
void SetDebugString(std::string_view s, SetDebugStringErrorFunc error_func)
Set debugging levels by parsing the text in s.
std::string GetDebugString()
Print out the current debug-level.
Functions related to debugging.
void StartupEngines()
Start/initialise all our engines.
Functions related to engines.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23)
bool FioRemove(const std::string &filename)
Remove a file.
std::optional< FileHandle > FioFOpenFile(std::string_view filename, std::string_view mode, Subdirectory subdir, size_t *filesize)
Opens a OpenTTD file somewhere in a personal or global directory.
bool FileExists(std::string_view filename)
Test whether the given filename exists.
bool FioCheckFileExists(std::string_view filename, Subdirectory subdir)
Check whether the given file exists.
Functions for Standard In/Out file operations.
@ SLO_SAVE
File is being saved.
@ SLO_LOAD
File is being loaded.
@ DFT_FIOS_DRIVE
A drive (letter) entry.
@ DFT_GAME_FILE
Save game or scenario file.
@ DFT_FIOS_DIR
A directory entry.
@ DFT_FIOS_PARENT
A parent directory entry.
Searchpath
Types of searchpaths OpenTTD might use.
Subdirectory
The different kinds of subdirectories OpenTTD uses.
@ AI_LIBRARY_DIR
Subdirectory for all AI libraries.
@ SCREENSHOT_DIR
Subdirectory for all screenshots.
@ SOCIAL_INTEGRATION_DIR
Subdirectory for all social integration plugins.
@ GAME_LIBRARY_DIR
Subdirectory for all GS libraries.
@ AI_DIR
Subdirectory for all AI files.
@ SCENARIO_DIR
Base directory for all scenarios.
@ BASE_DIR
Base directory for all subdirectories.
@ SAVE_DIR
Base directory for all savegames.
@ HEIGHTMAP_DIR
Subdirectory of scenario for heightmaps.
@ NEWGRF_DIR
Subdirectory for all NewGRFs.
@ AUTOSAVE_DIR
Subdirectory of save for autosaves.
@ BASESET_DIR
Subdirectory for all base data (base sets, intro game)
@ GAME_DIR
Subdirectory for all game scripts.
AbstractFileType
The different abstract types of files that the system knows about.
@ FT_SCENARIO
old or new scenario
@ FT_HEIGHTMAP
heightmap file
@ FT_SAVEGAME
old or new savegame
@ FT_INVALID
Invalid or unknown file type.
std::string FiosGetCurrentPath()
Get the current path/working directory.
bool FiosBrowseTo(const FiosItem *item)
Browse to a new path based on the passed item, starting at _fios_path.
Declarations for savegames operations.
void InitFontCache(bool monospace)
(Re)initialize the font cache related things, i.e.
Functions to read fonts from files and cache them.
FontCacheSubSetting * GetFontCacheSubSetting(FontSize fs)
Get the settings of a given font size.
Base functions for all Games.
Gamelog _gamelog
Gamelog instance.
Functions to be called to log fundamental changes to the game.
Functions related to world/map generation.
static const uint32_t GENERATE_NEW_SEED
Create a new random seed.
void StartNewGameWithoutGUI(uint32_t seed)
Start a normal game without the GUI.
PauseModes _pause_mode
The current pause mode.
SwitchMode _switch_mode
The next mainloop command.
FontSize
Available font sizes.
@ FS_MONO
Index of the monospaced font in the font tables.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Functions related to OTTD's landscape.
bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
Zooms a viewport in a window in or out.
static debug_inline TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Miscellaneous command definitions.
ClientID _redirect_console_to_client
If not invalid, redirect the console output to a client.
bool _network_available
is network mode available?
bool _networking
are we in networking mode?
StringList _network_ban_list
The banned clients.
bool _network_dedicated
are we a dedicated server?
bool _network_server
network-server is active
bool NetworkClientConnectGame(std::string_view connection_string, CompanyID default_company, const std::string &join_server_password)
Join a client to the server at with the given connection string.
ClientID _network_own_client_id
Our client identifier.
Basic functions/variables used all over the place.
AdminID _redirect_console_to_admin
Redirection of the (remote) console to the admin.
Server part of the admin network protocol.
Base core network types and some helper functions to access them.
void NetworkClientSendRcon(std::string_view password, std::string_view command)
Send a remote console command.
void NetworkClientSendChat(NetworkAction action, DestType type, int dest, std::string_view msg, int64_t data)
Send a chat message.
void NetworkClientRequestMove(CompanyID company_id)
Notify the server of this client wanting to be moved to another company.
bool NetworkIsValidClientName(std::string_view client_name)
Check whether the given client name is deemed valid for use in network games.
Client part of the network protocol.
ClientNetworkContentSocketHandler _network_content_client
The client we use to connect to the server.
Part of the network protocol handling content distribution.
std::string _network_server_invite_code
Our invite code as indicated by the Game Coordinator.
Network functions used by other parts of OpenTTD.
bool NetworkServerChangeClientName(ClientID client_id, const std::string &new_name)
Change the client name of the given client.
void NetworkPrintClients()
Print all the clients to the console.
void NetworkServerDoMove(ClientID client_id, CompanyID company_id)
Handle the tid-bits of moving a client from one company to another.
bool NetworkCompanyHasClients(CompanyID company)
Check whether a particular company has clients.
void NetworkServerKickClient(ClientID client_id, std::string_view reason)
Kick a single client.
std::string_view NetworkGetPublicKeyOfClient(ClientID client_id)
Get the public key of the client with the given id.
void NetworkServerSendChat(NetworkAction action, DestType type, int dest, std::string_view msg, ClientID from_id, int64_t data=0, bool from_admin=false)
Send an actual chat message.
void NetworkServerShowStatusToConsole()
Show the status message of all clients on the console.
uint NetworkServerKickOrBanIP(ClientID client_id, bool ban, std::string_view reason)
Ban, or kick, everyone joined from the given client's IP.
@ DESTTYPE_CLIENT
Send message/notice to only a certain client (Private)
@ DESTTYPE_TEAM
Send message/notice to everyone playing the same company (Team)
@ DESTTYPE_BROADCAST
Send message/notice to all clients (All)
ClientID
'Unique' identifier to be given to clients
@ INVALID_CLIENT_ID
Client is not part of anything.
@ CLIENT_ID_SERVER
Servers always have this ID.
Base for the NewGRF implementation.
void ReloadNewGRFData()
Reload all NewGRF files during a running game.
Profiling of NewGRF action 2 handling.
bool RequestNewGRFScan(NewGRFScanCallback *callback)
Request a new NewGRF scan.
@ Error
A game paused because a (critical) error.
@ Normal
A game normally paused.
@ SM_START_HEIGHTMAP
Load a heightmap and start a new game from it.
@ SM_MENU
Switch to game intro menu.
@ SM_RESTARTGAME
Restart --> 'Random game' with current settings.
@ SM_RELOADGAME
Reload the savegame / scenario / heightmap you started the game with.
@ SM_LOAD_GAME
Load game, Play Scenario.
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
RailTypeFlag
Railtype flag bit numbers.
@ Catenary
Bit number for drawing a catenary.
@ Allow90Deg
Bit number for always allowed 90 degree turns, regardless of setting.
@ Disallow90Deg
Bit number for never allowed 90 degree turns, regardless of setting.
@ Hidden
Bit number for hiding from selection.
@ NoSpriteCombine
Bit number for using non-combined junctions.
@ NoLevelCrossing
Bit number for disallowing level crossings.
@ RTSG_GROUND
Main group of ground images.
RailType
Enumeration for all possible railtypes.
@ RAILTYPE_BEGIN
Used for iterations.
@ RAILTYPE_END
Used for iterations.
RoadTypeFlag
Roadtype flag bit numbers.
@ NoHouses
Bit number for setting this roadtype as not house friendly.
@ TownBuild
Bit number for allowing towns to build this roadtype.
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
@ ROTSG_GROUND
Required: Main group of ground images.
RoadType
The different roadtypes we support.
@ ROADTYPE_END
Used for iterations.
@ ROADTYPE_BEGIN
Used for iterations.
A number of safeguards to prevent using unsafe methods.
SaveOrLoadResult SaveOrLoad(std::string_view filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded)
Main Save or Load function where the high-level saveload functions are handled.
FileToSaveLoad _file_to_saveload
File to save or load in the openttd loop.
void DoExitSave()
Do a save when exiting the game (_settings_client.gui.autosave_on_exit)
Functions/types related to saving and loading games.
@ SL_OK
completed successfully
bool MakeScreenshot(ScreenshotType t, const std::string &name, uint32_t width, uint32_t height)
Schedule making a screenshot.
Functions to make screenshots.
ScreenshotType
Type of requested screenshot.
@ SC_VIEWPORT
Screenshot of viewport.
@ SC_ZOOMEDIN
Fully zoomed in screenshot of the visible area.
@ SC_HEIGHTMAP
Heightmap of the world.
@ SC_WORLD
World screenshot.
@ SC_MINIMAP
Minimap screenshot.
@ SC_DEFAULTZOOM
Zoomed to default zoom level screenshot of the visible area.
void IConsoleGetSetting(std::string_view name, bool force_newgame)
Output value of a specific setting to the console.
void SaveToConfig()
Save the values to the configuration file.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
void IConsoleListSettings(std::string_view prefilter)
List all settings and their value to the console.
ClientSettings _settings_client
The current settings for this game.
Functions related to setting/changing the settings.
Definition of base types and functions in a cross-platform compatible way.
#define lengthof(array)
Return the length of an fixed size array.
std::string FormatArrayAsHex(std::span< const uint8_t > data)
Format a byte array into a continuous hex string.
bool StrEqualsIgnoreCase(std::string_view str1, std::string_view str2)
Compares two string( view)s for equality, while ignoring the case of the characters.
bool StrStartsWithIgnoreCase(std::string_view str, std::string_view prefix)
Check whether the given string starts with the given prefix, ignoring case.
bool StrContainsIgnoreCase(std::string_view str, std::string_view value)
Checks if a string is contained in another string, while ignoring the case of the characters.
static std::optional< T > ParseInteger(std::string_view arg, int base=10, bool clamp=false)
Change a string into its number representation.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Functions related to OTTD's strings.
bool ai_in_multiplayer
so we allow AIs in multiplayer
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
Specification of a cargo type.
NetworkSettings network
settings related to the network
GUISettings gui
settings related to the GUI
NetworkAuthorizedKeys allow_list
Public keys of clients that are allowed to join this company.
static bool IsHumanID(auto index)
Is this company a company not controlled by a NoAI program?
void OnConnect(bool success) override
Callback for when the connection has finished.
void OnDownloadComplete(ContentID cid) override
We have finished downloading a file.
void OnDisconnect() override
Callback for when the connection got disconnected.
Callbacks for notifying others about incoming data.
Container for all important information about a piece of content.
uint32_t unique_id
Unique ID; either GRF ID or shortname.
MD5Hash md5sum
The MD5 checksum.
State state
Whether the content info is selected (for download)
std::string name
Name of the content.
ContentID id
Unique (server side) ID for the content.
ContentType type
Type of content.
@ Selected
The content has been manually selected.
@ Autoselected
The content has been selected as dependency.
static bool ResetToCurrentNewGRFConfig()
Tries to reset the engine mapping to match the current NewGRF configuration.
void Set(const FiosItem &item)
Set the title of the file.
Deals with finding savegames.
DetailedFileType detailed
Detailed file type.
AbstractFileType abstract
Abstract file type.
Settings for a single font.
std::string font
The name of the font, or path to the font.
uint size
The (requested) size of the font.
Dynamic data of a loaded NewGRF.
bool autosave_on_exit
save an autosave when you quit the game, but do not ask "Do you really want to quit?...
ZoomLevel zoom_min
minimum zoom out level
bool newgrf_developer_tools
activate NewGRF developer tools and allow modifying NewGRFs in an existing game
ZoomLevel zoom_max
maximum zoom out level
uint8_t map_x
X size of map.
uint8_t map_y
Y size of map.
uint32_t generation_seed
noise seed for world generation
AISettings ai
what may the AI do?
GameCreationSettings game_creation
settings used during the creation of a game (map)
–Aliases– Aliases are like shortcuts for complex functions, variable assignments, etc.
std::string cmdline
command(s) that is/are being aliased
std::string name
name of the alias
IConsoleCmdProc * proc
process executed when command is typed
IConsoleHook * hook
any special trigger action that needs executing
std::string name
name of command
static void AliasRegister(const std::string &name, std::string_view cmd)
Register a an alias for an already existing command in the console.
static IConsoleAlias * AliasGet(const std::string &name)
Find the alias pointed to by its string.
static void CmdRegister(const std::string &name, IConsoleCmdProc *proc, IConsoleHook *hook=nullptr)
Register a new command to be used in the console.
static IConsoleCmd * CmdGet(const std::string &name)
Find the command pointed to by its string.
static uint SizeY()
Get the size of the map along the Y.
static debug_inline uint SizeX()
Get the size of the map along the X.
static debug_inline uint LogX()
Logarithm of the map size along the X side.
static uint LogY()
Logarithm of the map size along the y side.
static debug_inline uint Size()
Get the size of the map.
Container for all information known about a client.
static NetworkClientInfo * GetByClientID(ClientID client_id)
Return the CI given it's client-identifier.
bool CanJoinCompany(CompanyID company_id) const
Returns whether the given company can be joined by this client.
CompanyID client_playas
As which company is this client playing (CompanyID)
ClientID client_id
Client identifier (same as ClientState->client_id)
uint8_t clients_on
Current count of clients on server.
uint8_t max_clients
maximum amount of clients
uint8_t max_companies
maximum amount of companies
NetworkAuthorizedKeys admin_authorized_keys
Public keys of clients that are authorized to use the admin network.
NetworkAuthorizedKeys rcon_authorized_keys
Public keys of clients that are authorized to use the rconsole (server side).
std::string last_joined
Last joined server.
NetworkAuthorizedKeys server_authorized_keys
Public keys of clients that are authorized to connect to the game.
Callback profiler for NewGRF development.
static void StartTimer(uint64_t ticks)
Start the timeout timer that will finish all profiling sessions.
bool active
Is this profiler collecting data.
const GRFFile * grffile
Which GRF is being profiled.
static void AbortTimer()
Abort the timeout timer, so the timer callback is never called.
static size_t GetNumItems()
Returns number of valid items in the pool.
Tindex index
Index of this pool item.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem * GetIfValid(auto index)
Returns Titem with given index.
static constexpr size_t MAX_SIZE
Make template parameter accessible from outside.
Data structure for viewport, display of a part of the world.
ZoomLevel zoom
The zoom level of the viewport.
Data structure for an opened window.
std::unique_ptr< ViewportData > viewport
Pointer to viewport data, if present.
uint32_t ContentID
Unique identifier for the content.
ContentType
The values in the enum are important; they are used as database 'keys'.
@ CONTENT_TYPE_AI_LIBRARY
The content consists of an AI library.
@ CONTENT_TYPE_BASE_GRAPHICS
The content consists of base graphics.
@ CONTENT_TYPE_AI
The content consists of an AI.
@ CONTENT_TYPE_SCENARIO
The content consists of a scenario.
@ CONTENT_TYPE_NEWGRF
The content consists of a NewGRF.
@ CONTENT_TYPE_BEGIN
Helper to mark the begin of the types.
@ CONTENT_TYPE_END
Helper to mark the end of the types.
@ CONTENT_TYPE_HEIGHTMAP
The content consists of a heightmap.
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition of Interval and OneShot timers.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Functions related to (drawing on) viewports.
@ ZOOM_IN
Zoom in (get more detailed view).
@ ZOOM_OUT
Zoom out (get helicopter view).
Window * GetMainWindow()
Get the main window, i.e.
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Window functions not directly related to making/drawing windows.
@ WC_CONSOLE
Console; Window numbers:
ZoomLevel
All zoom levels we know.
@ Begin
Begin for iteration.