Codechange: Use CargoArray for linkgraph refresher. (#13165)
[openttd-github.git] / src / console_cmds.cpp
blob42111748a030394e0554bc01f6379a39644ddf31
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file console_cmds.cpp Implementation of the console hooks. */
10 #include "stdafx.h"
11 #include "console_internal.h"
12 #include "debug.h"
13 #include "engine_func.h"
14 #include "landscape.h"
15 #include "saveload/saveload.h"
16 #include "network/core/network_game_info.h"
17 #include "network/network.h"
18 #include "network/network_func.h"
19 #include "network/network_base.h"
20 #include "network/network_admin.h"
21 #include "network/network_client.h"
22 #include "command_func.h"
23 #include "settings_func.h"
24 #include "fios.h"
25 #include "fileio_func.h"
26 #include "fontcache.h"
27 #include "screenshot.h"
28 #include "genworld.h"
29 #include "strings_func.h"
30 #include "viewport_func.h"
31 #include "window_func.h"
32 #include "timer/timer.h"
33 #include "company_func.h"
34 #include "gamelog.h"
35 #include "ai/ai.hpp"
36 #include "ai/ai_config.hpp"
37 #include "newgrf.h"
38 #include "newgrf_profiling.h"
39 #include "console_func.h"
40 #include "engine_base.h"
41 #include "road.h"
42 #include "rail.h"
43 #include "game/game.hpp"
44 #include "table/strings.h"
45 #include "3rdparty/fmt/chrono.h"
46 #include "company_cmd.h"
47 #include "misc_cmd.h"
49 #include <sstream>
51 #include "safeguards.h"
53 /* scriptfile handling */
54 static uint _script_current_depth; ///< Depth of scripts running (used to abort execution when #ConReturn is encountered).
56 /* Scheduled execution handling. */
57 static std::string _scheduled_monthly_script; ///< Script scheduled to execute by the 'schedule' console command (empty if no script is scheduled).
59 /** Timer that runs every month of game time for the 'schedule' console command. */
60 static IntervalTimer<TimerGameCalendar> _scheduled_monthly_timer = {{TimerGameCalendar::MONTH, TimerGameCalendar::Priority::NONE}, [](auto) {
61 if (_scheduled_monthly_script.empty()) {
62 return;
65 /* Clear the schedule before rather than after the script to allow the script to itself call
66 * schedule without it getting immediately cleared. */
67 const std::string filename = _scheduled_monthly_script;
68 _scheduled_monthly_script.clear();
70 IConsolePrint(CC_DEFAULT, "Executing scheduled script file '{}'...", filename);
71 IConsoleCmdExec(std::string("exec") + " " + filename);
72 }};
74 /** File list storage for the console, for caching the last 'ls' command. */
75 class ConsoleFileList : public FileList {
76 public:
77 ConsoleFileList(AbstractFileType abstract_filetype, bool show_dirs) : FileList(), abstract_filetype(abstract_filetype), show_dirs(show_dirs)
81 /** Declare the file storage cache as being invalid, also clears all stored files. */
82 void InvalidateFileList()
84 this->clear();
85 this->file_list_valid = false;
88 /**
89 * (Re-)validate the file storage cache. Only makes a change if the storage was invalid, or if \a force_reload.
90 * @param force_reload Always reload the file storage cache.
92 void ValidateFileList(bool force_reload = false)
94 if (force_reload || !this->file_list_valid) {
95 this->BuildFileList(this->abstract_filetype, SLO_LOAD, this->show_dirs);
96 this->file_list_valid = true;
100 AbstractFileType abstract_filetype; ///< The abstract file type to list.
101 bool show_dirs; ///< Whether to show directories in the file list.
102 bool file_list_valid = false; ///< If set, the file list is valid.
105 static ConsoleFileList _console_file_list_savegame{FT_SAVEGAME, true}; ///< File storage cache for savegames.
106 static ConsoleFileList _console_file_list_scenario{FT_SCENARIO, false}; ///< File storage cache for scenarios.
107 static ConsoleFileList _console_file_list_heightmap{FT_HEIGHTMAP, false}; ///< File storage cache for heightmaps.
109 /* console command defines */
110 #define DEF_CONSOLE_CMD(function) static bool function([[maybe_unused]] uint8_t argc, [[maybe_unused]] char *argv[])
111 #define DEF_CONSOLE_HOOK(function) static ConsoleHookResult function(bool echo)
114 /****************
115 * command hooks
116 ****************/
119 * Check network availability and inform in console about failure of detection.
120 * @return Network availability.
122 static inline bool NetworkAvailable(bool echo)
124 if (!_network_available) {
125 if (echo) IConsolePrint(CC_ERROR, "You cannot use this command because there is no network available.");
126 return false;
128 return true;
132 * Check whether we are a server.
133 * @return Are we a server? True when yes, false otherwise.
135 DEF_CONSOLE_HOOK(ConHookServerOnly)
137 if (!NetworkAvailable(echo)) return CHR_DISALLOW;
139 if (!_network_server) {
140 if (echo) IConsolePrint(CC_ERROR, "This command is only available to a network server.");
141 return CHR_DISALLOW;
143 return CHR_ALLOW;
147 * Check whether we are a client in a network game.
148 * @return Are we a client in a network game? True when yes, false otherwise.
150 DEF_CONSOLE_HOOK(ConHookClientOnly)
152 if (!NetworkAvailable(echo)) return CHR_DISALLOW;
154 if (_network_server) {
155 if (echo) IConsolePrint(CC_ERROR, "This command is not available to a network server.");
156 return CHR_DISALLOW;
158 return CHR_ALLOW;
162 * Check whether we are in a multiplayer game.
163 * @return True when we are client or server in a network game.
165 DEF_CONSOLE_HOOK(ConHookNeedNetwork)
167 if (!NetworkAvailable(echo)) return CHR_DISALLOW;
169 if (!_networking || (!_network_server && !MyClient::IsConnected())) {
170 if (echo) IConsolePrint(CC_ERROR, "Not connected. This command is only available in multiplayer.");
171 return CHR_DISALLOW;
173 return CHR_ALLOW;
177 * Check whether we are in a multiplayer game and are playing, i.e. we are not the dedicated server.
178 * @return Are we a client or non-dedicated server in a network game? True when yes, false otherwise.
180 DEF_CONSOLE_HOOK(ConHookNeedNonDedicatedNetwork)
182 if (!NetworkAvailable(echo)) return CHR_DISALLOW;
184 if (_network_dedicated) {
185 if (echo) IConsolePrint(CC_ERROR, "This command is not available to a dedicated network server.");
186 return CHR_DISALLOW;
188 return CHR_ALLOW;
192 * Check whether we are in singleplayer mode.
193 * @return True when no network is active.
195 DEF_CONSOLE_HOOK(ConHookNoNetwork)
197 if (_networking) {
198 if (echo) IConsolePrint(CC_ERROR, "This command is forbidden in multiplayer.");
199 return CHR_DISALLOW;
201 return CHR_ALLOW;
205 * Check if are either in singleplayer or a server.
206 * @return True iff we are either in singleplayer or a server.
208 DEF_CONSOLE_HOOK(ConHookServerOrNoNetwork)
210 if (_networking && !_network_server) {
211 if (echo) IConsolePrint(CC_ERROR, "This command is only available to a network server.");
212 return CHR_DISALLOW;
214 return CHR_ALLOW;
217 DEF_CONSOLE_HOOK(ConHookNewGRFDeveloperTool)
219 if (_settings_client.gui.newgrf_developer_tools) {
220 if (_game_mode == GM_MENU) {
221 if (echo) IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
222 return CHR_DISALLOW;
224 return ConHookNoNetwork(echo);
226 return CHR_HIDE;
230 * Reset status of all engines.
231 * @return Will always succeed.
233 DEF_CONSOLE_CMD(ConResetEngines)
235 if (argc == 0) {
236 IConsolePrint(CC_HELP, "Reset status data of all engines. This might solve some issues with 'lost' engines. Usage: 'resetengines'.");
237 return true;
240 StartupEngines();
241 return true;
245 * Reset status of the engine pool.
246 * @return Will always return true.
247 * @note Resetting the pool only succeeds when there are no vehicles ingame.
249 DEF_CONSOLE_CMD(ConResetEnginePool)
251 if (argc == 0) {
252 IConsolePrint(CC_HELP, "Reset NewGRF allocations of engine slots. This will remove invalid engine definitions, and might make default engines available again.");
253 return true;
256 if (_game_mode == GM_MENU) {
257 IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
258 return true;
261 if (!EngineOverrideManager::ResetToCurrentNewGRFConfig()) {
262 IConsolePrint(CC_ERROR, "This can only be done when there are no vehicles in the game.");
263 return true;
266 return true;
269 #ifdef _DEBUG
271 * Reset a tile to bare land in debug mode.
272 * param tile number.
273 * @return True when the tile is reset or the help on usage was printed (0 or two parameters).
275 DEF_CONSOLE_CMD(ConResetTile)
277 if (argc == 0) {
278 IConsolePrint(CC_HELP, "Reset a tile to bare land. Usage: 'resettile <tile>'.");
279 IConsolePrint(CC_HELP, "Tile can be either decimal (34161) or hexadecimal (0x4a5B).");
280 return true;
283 if (argc == 2) {
284 uint32_t result;
285 if (GetArgumentInteger(&result, argv[1])) {
286 DoClearSquare((TileIndex)result);
287 return true;
291 return false;
293 #endif /* _DEBUG */
296 * Zoom map to given level.
297 * param level As defined by ZoomLevel and as limited by zoom_min/zoom_max from GUISettings.
298 * @return True when either console help was shown or a proper amount of parameters given.
300 DEF_CONSOLE_CMD(ConZoomToLevel)
302 switch (argc) {
303 case 0:
304 IConsolePrint(CC_HELP, "Set the current zoom level of the main viewport.");
305 IConsolePrint(CC_HELP, "Usage: 'zoomto <level>'.");
307 if (ZOOM_LVL_MIN < _settings_client.gui.zoom_min) {
308 IConsolePrint(CC_HELP, "The lowest zoom-in level allowed by current client settings is {}.", std::max(ZOOM_LVL_MIN, _settings_client.gui.zoom_min));
309 } else {
310 IConsolePrint(CC_HELP, "The lowest supported zoom-in level is {}.", std::max(ZOOM_LVL_MIN, _settings_client.gui.zoom_min));
313 if (_settings_client.gui.zoom_max < ZOOM_LVL_MAX) {
314 IConsolePrint(CC_HELP, "The highest zoom-out level allowed by current client settings is {}.", std::min(_settings_client.gui.zoom_max, ZOOM_LVL_MAX));
315 } else {
316 IConsolePrint(CC_HELP, "The highest supported zoom-out level is {}.", std::min(_settings_client.gui.zoom_max, ZOOM_LVL_MAX));
318 return true;
320 case 2: {
321 uint32_t level;
322 if (GetArgumentInteger(&level, argv[1])) {
323 /* In case ZOOM_LVL_MIN is more than 0, the next if statement needs to be amended.
324 * A simple check for less than ZOOM_LVL_MIN does not work here because we are
325 * reading an unsigned integer from the console, so just check for a '-' char. */
326 static_assert(ZOOM_LVL_MIN == 0);
327 if (argv[1][0] == '-') {
328 IConsolePrint(CC_ERROR, "Zoom-in levels below {} are not supported.", ZOOM_LVL_MIN);
329 } else if (level < _settings_client.gui.zoom_min) {
330 IConsolePrint(CC_ERROR, "Current client settings do not allow zooming in below level {}.", _settings_client.gui.zoom_min);
331 } else if (level > ZOOM_LVL_MAX) {
332 IConsolePrint(CC_ERROR, "Zoom-in levels above {} are not supported.", ZOOM_LVL_MAX);
333 } else if (level > _settings_client.gui.zoom_max) {
334 IConsolePrint(CC_ERROR, "Current client settings do not allow zooming out beyond level {}.", _settings_client.gui.zoom_max);
335 } else {
336 Window *w = GetMainWindow();
337 Viewport *vp = w->viewport;
338 while (vp->zoom > level) DoZoomInOutWindow(ZOOM_IN, w);
339 while (vp->zoom < level) DoZoomInOutWindow(ZOOM_OUT, w);
341 return true;
343 break;
347 return false;
351 * Scroll to a tile on the map.
352 * param x tile number or tile x coordinate.
353 * param y optional y coordinate.
354 * @note When only one argument is given it is interpreted as the tile number.
355 * When two arguments are given, they are interpreted as the tile's x
356 * and y coordinates.
357 * @return True when either console help was shown or a proper amount of parameters given.
359 DEF_CONSOLE_CMD(ConScrollToTile)
361 if (argc == 0) {
362 IConsolePrint(CC_HELP, "Center the screen on a given tile.");
363 IConsolePrint(CC_HELP, "Usage: 'scrollto [instant] <tile>' or 'scrollto [instant] <x> <y>'.");
364 IConsolePrint(CC_HELP, "Numbers can be either decimal (34161) or hexadecimal (0x4a5B).");
365 IConsolePrint(CC_HELP, "'instant' will immediately move and redraw viewport without smooth scrolling.");
366 return true;
368 if (argc < 2) return false;
370 uint32_t arg_index = 1;
371 bool instant = false;
372 if (strcmp(argv[arg_index], "instant") == 0) {
373 ++arg_index;
374 instant = true;
377 switch (argc - arg_index) {
378 case 1: {
379 uint32_t result;
380 if (GetArgumentInteger(&result, argv[arg_index])) {
381 if (result >= Map::Size()) {
382 IConsolePrint(CC_ERROR, "Tile does not exist.");
383 return true;
385 ScrollMainWindowToTile((TileIndex)result, instant);
386 return true;
388 break;
391 case 2: {
392 uint32_t x, y;
393 if (GetArgumentInteger(&x, argv[arg_index]) && GetArgumentInteger(&y, argv[arg_index + 1])) {
394 if (x >= Map::SizeX() || y >= Map::SizeY()) {
395 IConsolePrint(CC_ERROR, "Tile does not exist.");
396 return true;
398 ScrollMainWindowToTile(TileXY(x, y), instant);
399 return true;
401 break;
405 return false;
409 * Save the map to a file.
410 * param filename the filename to save the map to.
411 * @return True when help was displayed or the file attempted to be saved.
413 DEF_CONSOLE_CMD(ConSave)
415 if (argc == 0) {
416 IConsolePrint(CC_HELP, "Save the current game. Usage: 'save <filename>'.");
417 return true;
420 if (argc == 2) {
421 std::string filename = argv[1];
422 filename += ".sav";
423 IConsolePrint(CC_DEFAULT, "Saving map...");
425 if (SaveOrLoad(filename, SLO_SAVE, DFT_GAME_FILE, SAVE_DIR) != SL_OK) {
426 IConsolePrint(CC_ERROR, "Saving map failed.");
427 } else {
428 IConsolePrint(CC_INFO, "Map successfully saved to '{}'.", filename);
430 return true;
433 return false;
437 * Explicitly save the configuration.
438 * @return True.
440 DEF_CONSOLE_CMD(ConSaveConfig)
442 if (argc == 0) {
443 IConsolePrint(CC_HELP, "Saves the configuration for new games to the configuration file, typically 'openttd.cfg'.");
444 IConsolePrint(CC_HELP, "It does not save the configuration of the current game to the configuration file.");
445 return true;
448 SaveToConfig();
449 IConsolePrint(CC_DEFAULT, "Saved config.");
450 return true;
453 DEF_CONSOLE_CMD(ConLoad)
455 if (argc == 0) {
456 IConsolePrint(CC_HELP, "Load a game by name or index. Usage: 'load <file | number>'.");
457 return true;
460 if (argc != 2) return false;
462 const char *file = argv[1];
463 _console_file_list_savegame.ValidateFileList();
464 const FiosItem *item = _console_file_list_savegame.FindItem(file);
465 if (item != nullptr) {
466 if (GetAbstractFileType(item->type) == FT_SAVEGAME) {
467 _switch_mode = SM_LOAD_GAME;
468 _file_to_saveload.Set(*item);
469 } else {
470 IConsolePrint(CC_ERROR, "'{}' is not a savegame.", file);
472 } else {
473 IConsolePrint(CC_ERROR, "'{}' cannot be found.", file);
476 return true;
479 DEF_CONSOLE_CMD(ConLoadScenario)
481 if (argc == 0) {
482 IConsolePrint(CC_HELP, "Load a scenario by name or index. Usage: 'load_scenario <file | number>'.");
483 return true;
486 if (argc != 2) return false;
488 const char *file = argv[1];
489 _console_file_list_scenario.ValidateFileList();
490 const FiosItem *item = _console_file_list_scenario.FindItem(file);
491 if (item != nullptr) {
492 if (GetAbstractFileType(item->type) == FT_SCENARIO) {
493 _switch_mode = SM_LOAD_GAME;
494 _file_to_saveload.Set(*item);
495 } else {
496 IConsolePrint(CC_ERROR, "'{}' is not a scenario.", file);
498 } else {
499 IConsolePrint(CC_ERROR, "'{}' cannot be found.", file);
502 return true;
505 DEF_CONSOLE_CMD(ConLoadHeightmap)
507 if (argc == 0) {
508 IConsolePrint(CC_HELP, "Load a heightmap by name or index. Usage: 'load_heightmap <file | number>'.");
509 return true;
512 if (argc != 2) return false;
514 const char *file = argv[1];
515 _console_file_list_heightmap.ValidateFileList();
516 const FiosItem *item = _console_file_list_heightmap.FindItem(file);
517 if (item != nullptr) {
518 if (GetAbstractFileType(item->type) == FT_HEIGHTMAP) {
519 _switch_mode = SM_START_HEIGHTMAP;
520 _file_to_saveload.Set(*item);
521 } else {
522 IConsolePrint(CC_ERROR, "'{}' is not a heightmap.", file);
524 } else {
525 IConsolePrint(CC_ERROR, "'{}' cannot be found.", file);
528 return true;
531 DEF_CONSOLE_CMD(ConRemove)
533 if (argc == 0) {
534 IConsolePrint(CC_HELP, "Remove a savegame by name or index. Usage: 'rm <file | number>'.");
535 return true;
538 if (argc != 2) return false;
540 const char *file = argv[1];
541 _console_file_list_savegame.ValidateFileList();
542 const FiosItem *item = _console_file_list_savegame.FindItem(file);
543 if (item != nullptr) {
544 if (!FioRemove(item->name)) {
545 IConsolePrint(CC_ERROR, "Failed to delete '{}'.", item->name);
547 } else {
548 IConsolePrint(CC_ERROR, "'{}' could not be found.", file);
551 _console_file_list_savegame.InvalidateFileList();
552 return true;
556 /* List all the files in the current dir via console */
557 DEF_CONSOLE_CMD(ConListFiles)
559 if (argc == 0) {
560 IConsolePrint(CC_HELP, "List all loadable savegames and directories in the current dir via console. Usage: 'ls | dir'.");
561 return true;
564 _console_file_list_savegame.ValidateFileList(true);
565 for (uint i = 0; i < _console_file_list_savegame.size(); i++) {
566 IConsolePrint(CC_DEFAULT, "{}) {}", i, _console_file_list_savegame[i].title);
569 return true;
572 /* List all the scenarios */
573 DEF_CONSOLE_CMD(ConListScenarios)
575 if (argc == 0) {
576 IConsolePrint(CC_HELP, "List all loadable scenarios. Usage: 'list_scenarios'.");
577 return true;
580 _console_file_list_scenario.ValidateFileList(true);
581 for (uint i = 0; i < _console_file_list_scenario.size(); i++) {
582 IConsolePrint(CC_DEFAULT, "{}) {}", i, _console_file_list_scenario[i].title);
585 return true;
588 /* List all the heightmaps */
589 DEF_CONSOLE_CMD(ConListHeightmaps)
591 if (argc == 0) {
592 IConsolePrint(CC_HELP, "List all loadable heightmaps. Usage: 'list_heightmaps'.");
593 return true;
596 _console_file_list_heightmap.ValidateFileList(true);
597 for (uint i = 0; i < _console_file_list_heightmap.size(); i++) {
598 IConsolePrint(CC_DEFAULT, "{}) {}", i, _console_file_list_heightmap[i].title);
601 return true;
604 /* Change the dir via console */
605 DEF_CONSOLE_CMD(ConChangeDirectory)
607 if (argc == 0) {
608 IConsolePrint(CC_HELP, "Change the dir via console. Usage: 'cd <directory | number>'.");
609 return true;
612 if (argc != 2) return false;
614 const char *file = argv[1];
615 _console_file_list_savegame.ValidateFileList(true);
616 const FiosItem *item = _console_file_list_savegame.FindItem(file);
617 if (item != nullptr) {
618 switch (item->type) {
619 case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:
620 FiosBrowseTo(item);
621 break;
622 default: IConsolePrint(CC_ERROR, "{}: Not a directory.", file);
624 } else {
625 IConsolePrint(CC_ERROR, "{}: No such file or directory.", file);
628 _console_file_list_savegame.InvalidateFileList();
629 return true;
632 DEF_CONSOLE_CMD(ConPrintWorkingDirectory)
634 if (argc == 0) {
635 IConsolePrint(CC_HELP, "Print out the current working directory. Usage: 'pwd'.");
636 return true;
639 /* XXX - Workaround for broken file handling */
640 _console_file_list_savegame.ValidateFileList(true);
641 _console_file_list_savegame.InvalidateFileList();
643 IConsolePrint(CC_DEFAULT, FiosGetCurrentPath());
644 return true;
647 DEF_CONSOLE_CMD(ConClearBuffer)
649 if (argc == 0) {
650 IConsolePrint(CC_HELP, "Clear the console buffer. Usage: 'clear'.");
651 return true;
654 IConsoleClearBuffer();
655 SetWindowDirty(WC_CONSOLE, 0);
656 return true;
660 /**********************************
661 * Network Core Console Commands
662 **********************************/
664 static bool ConKickOrBan(const char *argv, bool ban, const std::string &reason)
666 uint n;
668 if (strchr(argv, '.') == nullptr && strchr(argv, ':') == nullptr) { // banning with ID
669 ClientID client_id = (ClientID)atoi(argv);
671 /* Don't kill the server, or the client doing the rcon. The latter can't be kicked because
672 * kicking frees closes and subsequently free the connection related instances, which we
673 * would be reading from and writing to after returning. So we would read or write data
674 * from freed memory up till the segfault triggers. */
675 if (client_id == CLIENT_ID_SERVER || client_id == _redirect_console_to_client) {
676 IConsolePrint(CC_ERROR, "You can not {} yourself!", ban ? "ban" : "kick");
677 return true;
680 NetworkClientInfo *ci = NetworkClientInfo::GetByClientID(client_id);
681 if (ci == nullptr) {
682 IConsolePrint(CC_ERROR, "Invalid client ID.");
683 return true;
686 if (!ban) {
687 /* Kick only this client, not all clients with that IP */
688 NetworkServerKickClient(client_id, reason);
689 return true;
692 /* When banning, kick+ban all clients with that IP */
693 n = NetworkServerKickOrBanIP(client_id, ban, reason);
694 } else {
695 n = NetworkServerKickOrBanIP(argv, ban, reason);
698 if (n == 0) {
699 IConsolePrint(CC_DEFAULT, ban ? "Client not online, address added to banlist." : "Client not found.");
700 } else {
701 IConsolePrint(CC_DEFAULT, "{}ed {} client(s).", ban ? "Bann" : "Kick", n);
704 return true;
707 DEF_CONSOLE_CMD(ConKick)
709 if (argc == 0) {
710 IConsolePrint(CC_HELP, "Kick a client from a network game. Usage: 'kick <ip | client-id> [<kick-reason>]'.");
711 IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
712 return true;
715 if (argc != 2 && argc != 3) return false;
717 /* No reason supplied for kicking */
718 if (argc == 2) return ConKickOrBan(argv[1], false, {});
720 /* Reason for kicking supplied */
721 size_t kick_message_length = strlen(argv[2]);
722 if (kick_message_length >= 255) {
723 IConsolePrint(CC_ERROR, "Maximum kick message length is 254 characters. You entered {} characters.", kick_message_length);
724 return false;
725 } else {
726 return ConKickOrBan(argv[1], false, argv[2]);
730 DEF_CONSOLE_CMD(ConBan)
732 if (argc == 0) {
733 IConsolePrint(CC_HELP, "Ban a client from a network game. Usage: 'ban <ip | client-id> [<ban-reason>]'.");
734 IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
735 IConsolePrint(CC_HELP, "If the client is no longer online, you can still ban their IP.");
736 return true;
739 if (argc != 2 && argc != 3) return false;
741 /* No reason supplied for kicking */
742 if (argc == 2) return ConKickOrBan(argv[1], true, {});
744 /* Reason for kicking supplied */
745 size_t kick_message_length = strlen(argv[2]);
746 if (kick_message_length >= 255) {
747 IConsolePrint(CC_ERROR, "Maximum kick message length is 254 characters. You entered {} characters.", kick_message_length);
748 return false;
749 } else {
750 return ConKickOrBan(argv[1], true, argv[2]);
754 DEF_CONSOLE_CMD(ConUnBan)
756 if (argc == 0) {
757 IConsolePrint(CC_HELP, "Unban a client from a network game. Usage: 'unban <ip | banlist-index>'.");
758 IConsolePrint(CC_HELP, "For a list of banned IP's, see the command 'banlist'.");
759 return true;
762 if (argc != 2) return false;
764 /* Try by IP. */
765 uint index;
766 for (index = 0; index < _network_ban_list.size(); index++) {
767 if (_network_ban_list[index] == argv[1]) break;
770 /* Try by index. */
771 if (index >= _network_ban_list.size()) {
772 index = atoi(argv[1]) - 1U; // let it wrap
775 if (index < _network_ban_list.size()) {
776 IConsolePrint(CC_DEFAULT, "Unbanned {}.", _network_ban_list[index]);
777 _network_ban_list.erase(_network_ban_list.begin() + index);
778 } else {
779 IConsolePrint(CC_DEFAULT, "Invalid list index or IP not in ban-list.");
780 IConsolePrint(CC_DEFAULT, "For a list of banned IP's, see the command 'banlist'.");
783 return true;
786 DEF_CONSOLE_CMD(ConBanList)
788 if (argc == 0) {
789 IConsolePrint(CC_HELP, "List the IP's of banned clients: Usage 'banlist'.");
790 return true;
793 IConsolePrint(CC_DEFAULT, "Banlist:");
795 uint i = 1;
796 for (const auto &entry : _network_ban_list) {
797 IConsolePrint(CC_DEFAULT, " {}) {}", i, entry);
798 i++;
801 return true;
804 DEF_CONSOLE_CMD(ConPauseGame)
806 if (argc == 0) {
807 IConsolePrint(CC_HELP, "Pause a network game. Usage: 'pause'.");
808 return true;
811 if (_game_mode == GM_MENU) {
812 IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
813 return true;
816 if ((_pause_mode & PM_PAUSED_NORMAL) == PM_UNPAUSED) {
817 Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, true);
818 if (!_networking) IConsolePrint(CC_DEFAULT, "Game paused.");
819 } else {
820 IConsolePrint(CC_DEFAULT, "Game is already paused.");
823 return true;
826 DEF_CONSOLE_CMD(ConUnpauseGame)
828 if (argc == 0) {
829 IConsolePrint(CC_HELP, "Unpause a network game. Usage: 'unpause'.");
830 return true;
833 if (_game_mode == GM_MENU) {
834 IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
835 return true;
838 if ((_pause_mode & PM_PAUSED_NORMAL) != PM_UNPAUSED) {
839 Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, false);
840 if (!_networking) IConsolePrint(CC_DEFAULT, "Game unpaused.");
841 } else if ((_pause_mode & PM_PAUSED_ERROR) != PM_UNPAUSED) {
842 IConsolePrint(CC_DEFAULT, "Game is in error state and cannot be unpaused via console.");
843 } else if (_pause_mode != PM_UNPAUSED) {
844 IConsolePrint(CC_DEFAULT, "Game cannot be unpaused manually; disable pause_on_join/min_active_clients.");
845 } else {
846 IConsolePrint(CC_DEFAULT, "Game is already unpaused.");
849 return true;
852 DEF_CONSOLE_CMD(ConRcon)
854 if (argc == 0) {
855 IConsolePrint(CC_HELP, "Remote control the server from another client. Usage: 'rcon <password> <command>'.");
856 IConsolePrint(CC_HELP, "Remember to enclose the command in quotes, otherwise only the first parameter is sent.");
857 IConsolePrint(CC_HELP, "When your client's public key is in the 'authorized keys' for 'rcon', the password is not checked and may be '*'.");
858 return true;
861 if (argc < 3) return false;
863 if (_network_server) {
864 IConsoleCmdExec(argv[2]);
865 } else {
866 NetworkClientSendRcon(argv[1], argv[2]);
868 return true;
871 DEF_CONSOLE_CMD(ConStatus)
873 if (argc == 0) {
874 IConsolePrint(CC_HELP, "List the status of all clients connected to the server. Usage 'status'.");
875 return true;
878 NetworkServerShowStatusToConsole();
879 return true;
882 DEF_CONSOLE_CMD(ConServerInfo)
884 if (argc == 0) {
885 IConsolePrint(CC_HELP, "List current and maximum client/company limits. Usage 'server_info'.");
886 IConsolePrint(CC_HELP, "You can change these values by modifying settings 'network.max_clients' and 'network.max_companies'.");
887 return true;
890 IConsolePrint(CC_DEFAULT, "Invite code: {}", _network_server_invite_code);
891 IConsolePrint(CC_DEFAULT, "Current/maximum clients: {:3d}/{:3d}", _network_game_info.clients_on, _settings_client.network.max_clients);
892 IConsolePrint(CC_DEFAULT, "Current/maximum companies: {:3d}/{:3d}", Company::GetNumItems(), _settings_client.network.max_companies);
893 IConsolePrint(CC_DEFAULT, "Current spectators: {:3d}", NetworkSpectatorCount());
895 return true;
898 DEF_CONSOLE_CMD(ConClientNickChange)
900 if (argc != 3) {
901 IConsolePrint(CC_HELP, "Change the nickname of a connected client. Usage: 'client_name <client-id> <new-name>'.");
902 IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
903 return true;
906 ClientID client_id = (ClientID)atoi(argv[1]);
908 if (client_id == CLIENT_ID_SERVER) {
909 IConsolePrint(CC_ERROR, "Please use the command 'name' to change your own name!");
910 return true;
913 if (NetworkClientInfo::GetByClientID(client_id) == nullptr) {
914 IConsolePrint(CC_ERROR, "Invalid client ID.");
915 return true;
918 std::string client_name(argv[2]);
919 StrTrimInPlace(client_name);
920 if (!NetworkIsValidClientName(client_name)) {
921 IConsolePrint(CC_ERROR, "Cannot give a client an empty name.");
922 return true;
925 if (!NetworkServerChangeClientName(client_id, client_name)) {
926 IConsolePrint(CC_ERROR, "Cannot give a client a duplicate name.");
929 return true;
932 DEF_CONSOLE_CMD(ConJoinCompany)
934 if (argc < 2) {
935 IConsolePrint(CC_HELP, "Request joining another company. Usage: 'join <company-id>'.");
936 IConsolePrint(CC_HELP, "For valid company-id see company list, use 255 for spectator.");
937 return true;
940 CompanyID company_id = (CompanyID)(atoi(argv[1]) <= MAX_COMPANIES ? atoi(argv[1]) - 1 : atoi(argv[1]));
942 const NetworkClientInfo *info = NetworkClientInfo::GetByClientID(_network_own_client_id);
943 if (info == nullptr) {
944 IConsolePrint(CC_ERROR, "You have not joined the game yet!");
945 return true;
948 /* Check we have a valid company id! */
949 if (!Company::IsValidID(company_id) && company_id != COMPANY_SPECTATOR) {
950 IConsolePrint(CC_ERROR, "Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
951 return true;
954 if (info->client_playas == company_id) {
955 IConsolePrint(CC_ERROR, "You are already there!");
956 return true;
959 if (company_id != COMPANY_SPECTATOR && !Company::IsHumanID(company_id)) {
960 IConsolePrint(CC_ERROR, "Cannot join AI company.");
961 return true;
964 if (!info->CanJoinCompany(company_id)) {
965 IConsolePrint(CC_ERROR, "You are not allowed to join this company.");
966 return true;
969 /* non-dedicated server may just do the move! */
970 if (_network_server) {
971 NetworkServerDoMove(CLIENT_ID_SERVER, company_id);
972 } else {
973 NetworkClientRequestMove(company_id);
976 return true;
979 DEF_CONSOLE_CMD(ConMoveClient)
981 if (argc < 3) {
982 IConsolePrint(CC_HELP, "Move a client to another company. Usage: 'move <client-id> <company-id>'.");
983 IConsolePrint(CC_HELP, "For valid client-id see 'clients', for valid company-id see 'companies', use 255 for moving to spectators.");
984 return true;
987 const NetworkClientInfo *ci = NetworkClientInfo::GetByClientID((ClientID)atoi(argv[1]));
988 CompanyID company_id = (CompanyID)(atoi(argv[2]) <= MAX_COMPANIES ? atoi(argv[2]) - 1 : atoi(argv[2]));
990 /* check the client exists */
991 if (ci == nullptr) {
992 IConsolePrint(CC_ERROR, "Invalid client-id, check the command 'clients' for valid client-id's.");
993 return true;
996 if (!Company::IsValidID(company_id) && company_id != COMPANY_SPECTATOR) {
997 IConsolePrint(CC_ERROR, "Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
998 return true;
1001 if (company_id != COMPANY_SPECTATOR && !Company::IsHumanID(company_id)) {
1002 IConsolePrint(CC_ERROR, "You cannot move clients to AI companies.");
1003 return true;
1006 if (ci->client_id == CLIENT_ID_SERVER && _network_dedicated) {
1007 IConsolePrint(CC_ERROR, "You cannot move the server!");
1008 return true;
1011 if (ci->client_playas == company_id) {
1012 IConsolePrint(CC_ERROR, "You cannot move someone to where they already are!");
1013 return true;
1016 /* we are the server, so force the update */
1017 NetworkServerDoMove(ci->client_id, company_id);
1019 return true;
1022 DEF_CONSOLE_CMD(ConResetCompany)
1024 if (argc == 0) {
1025 IConsolePrint(CC_HELP, "Remove an idle company from the game. Usage: 'reset_company <company-id>'.");
1026 IConsolePrint(CC_HELP, "For company-id's, see the list of companies from the dropdown menu. Company 1 is 1, etc.");
1027 return true;
1030 if (argc != 2) return false;
1032 CompanyID index = (CompanyID)(atoi(argv[1]) - 1);
1034 /* Check valid range */
1035 if (!Company::IsValidID(index)) {
1036 IConsolePrint(CC_ERROR, "Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
1037 return true;
1040 if (!Company::IsHumanID(index)) {
1041 IConsolePrint(CC_ERROR, "Company is owned by an AI.");
1042 return true;
1045 if (NetworkCompanyHasClients(index)) {
1046 IConsolePrint(CC_ERROR, "Cannot remove company: a client is connected to that company.");
1047 return false;
1049 const NetworkClientInfo *ci = NetworkClientInfo::GetByClientID(CLIENT_ID_SERVER);
1050 assert(ci != nullptr);
1051 if (ci->client_playas == index) {
1052 IConsolePrint(CC_ERROR, "Cannot remove company: the server is connected to that company.");
1053 return true;
1056 /* It is safe to remove this company */
1057 Command<CMD_COMPANY_CTRL>::Post(CCA_DELETE, index, CRR_MANUAL, INVALID_CLIENT_ID);
1058 IConsolePrint(CC_DEFAULT, "Company deleted.");
1060 return true;
1063 DEF_CONSOLE_CMD(ConNetworkClients)
1065 if (argc == 0) {
1066 IConsolePrint(CC_HELP, "Get a list of connected clients including their ID, name, company-id, and IP. Usage: 'clients'.");
1067 return true;
1070 NetworkPrintClients();
1072 return true;
1075 DEF_CONSOLE_CMD(ConNetworkReconnect)
1077 if (argc == 0) {
1078 IConsolePrint(CC_HELP, "Reconnect to server to which you were connected last time. Usage: 'reconnect [<company>]'.");
1079 IConsolePrint(CC_HELP, "Company 255 is spectator (default, if not specified), 0 means creating new company.");
1080 IConsolePrint(CC_HELP, "All others are a certain company with Company 1 being #1.");
1081 return true;
1084 CompanyID playas = (argc >= 2) ? (CompanyID)atoi(argv[1]) : COMPANY_SPECTATOR;
1085 switch (playas) {
1086 case 0: playas = COMPANY_NEW_COMPANY; break;
1087 case COMPANY_SPECTATOR: /* nothing to do */ break;
1088 default:
1089 /* From a user pov 0 is a new company, internally it's different and all
1090 * companies are offset by one to ease up on users (eg companies 1-8 not 0-7) */
1091 if (playas < COMPANY_FIRST + 1 || playas > MAX_COMPANIES + 1) return false;
1092 break;
1095 if (_settings_client.network.last_joined.empty()) {
1096 IConsolePrint(CC_DEFAULT, "No server for reconnecting.");
1097 return true;
1100 /* Don't resolve the address first, just print it directly as it comes from the config file. */
1101 IConsolePrint(CC_DEFAULT, "Reconnecting to {} ...", _settings_client.network.last_joined);
1103 return NetworkClientConnectGame(_settings_client.network.last_joined, playas);
1106 DEF_CONSOLE_CMD(ConNetworkConnect)
1108 if (argc == 0) {
1109 IConsolePrint(CC_HELP, "Connect to a remote OTTD server and join the game. Usage: 'connect <ip>'.");
1110 IConsolePrint(CC_HELP, "IP can contain port and company: 'IP[:Port][#Company]', eg: 'server.ottd.org:443#2'.");
1111 IConsolePrint(CC_HELP, "Company #255 is spectator all others are a certain company with Company 1 being #1.");
1112 return true;
1115 if (argc < 2) return false;
1117 return NetworkClientConnectGame(argv[1], COMPANY_NEW_COMPANY);
1120 /*********************************
1121 * script file console commands
1122 *********************************/
1124 DEF_CONSOLE_CMD(ConExec)
1126 if (argc == 0) {
1127 IConsolePrint(CC_HELP, "Execute a local script file. Usage: 'exec <script> <?>'.");
1128 return true;
1131 if (argc < 2) return false;
1133 auto script_file = FioFOpenFile(argv[1], "r", BASE_DIR);
1135 if (!script_file.has_value()) {
1136 if (argc == 2 || atoi(argv[2]) != 0) IConsolePrint(CC_ERROR, "Script file '{}' not found.", argv[1]);
1137 return true;
1140 if (_script_current_depth == 11) {
1141 IConsolePrint(CC_ERROR, "Maximum 'exec' depth reached; script A is calling script B is calling script C ... more than 10 times.");
1142 return true;
1145 _script_current_depth++;
1146 uint script_depth = _script_current_depth;
1148 char cmdline[ICON_CMDLN_SIZE];
1149 while (fgets(cmdline, sizeof(cmdline), *script_file) != nullptr) {
1150 /* Remove newline characters from the executing script */
1151 for (char *cmdptr = cmdline; *cmdptr != '\0'; cmdptr++) {
1152 if (*cmdptr == '\n' || *cmdptr == '\r') {
1153 *cmdptr = '\0';
1154 break;
1157 IConsoleCmdExec(cmdline);
1158 /* Ensure that we are still on the same depth or that we returned via 'return'. */
1159 assert(_script_current_depth == script_depth || _script_current_depth == script_depth - 1);
1161 /* The 'return' command was executed. */
1162 if (_script_current_depth == script_depth - 1) break;
1165 if (ferror(*script_file) != 0) {
1166 IConsolePrint(CC_ERROR, "Encountered error while trying to read from script file '{}'.", argv[1]);
1169 if (_script_current_depth == script_depth) _script_current_depth--;
1170 return true;
1173 DEF_CONSOLE_CMD(ConSchedule)
1175 if (argc < 3 || std::string_view(argv[1]) != "on-next-calendar-month") {
1176 IConsolePrint(CC_HELP, "Schedule a local script to execute later. Usage: 'schedule on-next-calendar-month <script>'.");
1177 return true;
1180 /* Check if the file exists. It might still go away later, but helpful to show an error now. */
1181 if (!FioCheckFileExists(argv[2], BASE_DIR)) {
1182 IConsolePrint(CC_ERROR, "Script file '{}' not found.", argv[2]);
1183 return true;
1186 /* We only support a single script scheduled, so we tell the user what's happening if there was already one. */
1187 const std::string_view filename = std::string_view(argv[2]);
1188 if (!_scheduled_monthly_script.empty() && filename == _scheduled_monthly_script) {
1189 IConsolePrint(CC_INFO, "Script file '{}' was already scheduled to execute at the start of next calendar month.", filename);
1190 } else if (!_scheduled_monthly_script.empty() && filename != _scheduled_monthly_script) {
1191 IConsolePrint(CC_INFO, "Script file '{}' scheduled to execute at the start of next calendar month, replacing the previously scheduled script file '{}'.", filename, _scheduled_monthly_script);
1192 } else {
1193 IConsolePrint(CC_INFO, "Script file '{}' scheduled to execute at the start of next calendar month.", filename);
1196 /* Store the filename to be used by _schedule_timer on the start of next calendar month. */
1197 _scheduled_monthly_script = filename;
1199 return true;
1202 DEF_CONSOLE_CMD(ConReturn)
1204 if (argc == 0) {
1205 IConsolePrint(CC_HELP, "Stop executing a running script. Usage: 'return'.");
1206 return true;
1209 _script_current_depth--;
1210 return true;
1213 /*****************************
1214 * default console commands
1215 ******************************/
1216 extern bool CloseConsoleLogIfActive();
1217 extern const std::vector<GRFFile *> &GetAllGRFFiles();
1218 extern void ConPrintFramerate(); // framerate_gui.cpp
1219 extern void ShowFramerateWindow();
1221 DEF_CONSOLE_CMD(ConScript)
1223 extern std::optional<FileHandle> _iconsole_output_file;
1225 if (argc == 0) {
1226 IConsolePrint(CC_HELP, "Start or stop logging console output to a file. Usage: 'script <filename>'.");
1227 IConsolePrint(CC_HELP, "If filename is omitted, a running log is stopped if it is active.");
1228 return true;
1231 if (!CloseConsoleLogIfActive()) {
1232 if (argc < 2) return false;
1234 _iconsole_output_file = FileHandle::Open(argv[1], "ab");
1235 if (!_iconsole_output_file.has_value()) {
1236 IConsolePrint(CC_ERROR, "Could not open console log file '{}'.", argv[1]);
1237 } else {
1238 IConsolePrint(CC_INFO, "Console log output started to '{}'.", argv[1]);
1242 return true;
1246 DEF_CONSOLE_CMD(ConEcho)
1248 if (argc == 0) {
1249 IConsolePrint(CC_HELP, "Print back the first argument to the console. Usage: 'echo <arg>'.");
1250 return true;
1253 if (argc < 2) return false;
1254 IConsolePrint(CC_DEFAULT, argv[1]);
1255 return true;
1258 DEF_CONSOLE_CMD(ConEchoC)
1260 if (argc == 0) {
1261 IConsolePrint(CC_HELP, "Print back the first argument to the console in a given colour. Usage: 'echoc <colour> <arg2>'.");
1262 return true;
1265 if (argc < 3) return false;
1266 IConsolePrint((TextColour)Clamp(atoi(argv[1]), TC_BEGIN, TC_END - 1), argv[2]);
1267 return true;
1270 DEF_CONSOLE_CMD(ConNewGame)
1272 if (argc == 0) {
1273 IConsolePrint(CC_HELP, "Start a new game. Usage: 'newgame [seed]'.");
1274 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.");
1275 return true;
1278 StartNewGameWithoutGUI((argc == 2) ? std::strtoul(argv[1], nullptr, 10) : GENERATE_NEW_SEED);
1279 return true;
1282 DEF_CONSOLE_CMD(ConRestart)
1284 if (argc == 0 || argc > 2) {
1285 IConsolePrint(CC_HELP, "Restart game. Usage: 'restart [current|newgame]'.");
1286 IConsolePrint(CC_HELP, "Restarts a game, using either the current or newgame (default) settings.");
1287 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.");
1288 IConsolePrint(CC_HELP, " * if you started from a savegame / scenario / heightmap, the game might be different, because the current/newgame settings might differ.");
1289 return true;
1292 if (argc == 1 || std::string_view(argv[1]) == "newgame") {
1293 StartNewGameWithoutGUI(_settings_game.game_creation.generation_seed);
1294 } else {
1295 _settings_game.game_creation.map_x = Map::LogX();
1296 _settings_game.game_creation.map_y = Map::LogY();
1297 _switch_mode = SM_RESTARTGAME;
1300 return true;
1303 DEF_CONSOLE_CMD(ConReload)
1305 if (argc == 0) {
1306 IConsolePrint(CC_HELP, "Reload game. Usage: 'reload'.");
1307 IConsolePrint(CC_HELP, "Reloads a game if loaded via savegame / scenario / heightmap.");
1308 return true;
1311 if (_file_to_saveload.abstract_ftype == FT_NONE || _file_to_saveload.abstract_ftype == FT_INVALID) {
1312 IConsolePrint(CC_ERROR, "No game loaded to reload.");
1313 return true;
1316 /* Use a switch-mode to prevent copying over newgame settings to active settings. */
1317 _settings_game.game_creation.map_x = Map::LogX();
1318 _settings_game.game_creation.map_y = Map::LogY();
1319 _switch_mode = SM_RELOADGAME;
1320 return true;
1324 * Print a text buffer line by line to the console. Lines are separated by '\n'.
1325 * @param full_string The multi-line string to print.
1327 static void PrintLineByLine(const std::string &full_string)
1329 std::istringstream in(full_string);
1330 std::string line;
1331 while (std::getline(in, line)) {
1332 IConsolePrint(CC_DEFAULT, line);
1336 template <typename F, typename ... Args>
1337 bool PrintList(F list_function, Args... args)
1339 std::string output_str;
1340 auto inserter = std::back_inserter(output_str);
1341 list_function(inserter, args...);
1342 PrintLineByLine(output_str);
1344 return true;
1347 DEF_CONSOLE_CMD(ConListAILibs)
1349 if (argc == 0) {
1350 IConsolePrint(CC_HELP, "List installed AI libraries. Usage: 'list_ai_libs'.");
1351 return true;
1354 return PrintList(AI::GetConsoleLibraryList);
1357 DEF_CONSOLE_CMD(ConListAI)
1359 if (argc == 0) {
1360 IConsolePrint(CC_HELP, "List installed AIs. Usage: 'list_ai'.");
1361 return true;
1364 return PrintList(AI::GetConsoleList, false);
1367 DEF_CONSOLE_CMD(ConListGameLibs)
1369 if (argc == 0) {
1370 IConsolePrint(CC_HELP, "List installed Game Script libraries. Usage: 'list_game_libs'.");
1371 return true;
1374 return PrintList(Game::GetConsoleLibraryList);
1377 DEF_CONSOLE_CMD(ConListGame)
1379 if (argc == 0) {
1380 IConsolePrint(CC_HELP, "List installed Game Scripts. Usage: 'list_game'.");
1381 return true;
1384 return PrintList(Game::GetConsoleList, false);
1387 DEF_CONSOLE_CMD(ConStartAI)
1389 if (argc == 0 || argc > 3) {
1390 IConsolePrint(CC_HELP, "Start a new AI. Usage: 'start_ai [<AI>] [<settings>]'.");
1391 IConsolePrint(CC_HELP, "Start a new AI. If <AI> is given, it starts that specific AI (if found).");
1392 IConsolePrint(CC_HELP, "If <settings> is given, it is parsed and the AI settings are set to that.");
1393 return true;
1396 if (_game_mode != GM_NORMAL) {
1397 IConsolePrint(CC_ERROR, "AIs can only be managed in a game.");
1398 return true;
1401 if (Company::GetNumItems() == CompanyPool::MAX_SIZE) {
1402 IConsolePrint(CC_ERROR, "Can't start a new AI (no more free slots).");
1403 return true;
1405 if (_networking && !_network_server) {
1406 IConsolePrint(CC_ERROR, "Only the server can start a new AI.");
1407 return true;
1409 if (_networking && !_settings_game.ai.ai_in_multiplayer) {
1410 IConsolePrint(CC_ERROR, "AIs are not allowed in multiplayer by configuration.");
1411 IConsolePrint(CC_ERROR, "Switch AI -> AI in multiplayer to True.");
1412 return true;
1414 if (!AI::CanStartNew()) {
1415 IConsolePrint(CC_ERROR, "Can't start a new AI.");
1416 return true;
1419 int n = 0;
1420 /* Find the next free slot */
1421 for (const Company *c : Company::Iterate()) {
1422 if (c->index != n) break;
1423 n++;
1426 AIConfig *config = AIConfig::GetConfig((CompanyID)n);
1427 if (argc >= 2) {
1428 config->Change(argv[1], -1, false);
1430 /* If the name is not found, and there is a dot in the name,
1431 * try again with the assumption everything right of the dot is
1432 * the version the user wants to load. */
1433 if (!config->HasScript()) {
1434 const char *e = strrchr(argv[1], '.');
1435 if (e != nullptr) {
1436 size_t name_length = e - argv[1];
1437 e++;
1439 int version = atoi(e);
1440 config->Change(std::string(argv[1], name_length), version, true);
1444 if (!config->HasScript()) {
1445 IConsolePrint(CC_ERROR, "Failed to load the specified AI.");
1446 return true;
1448 if (argc == 3) {
1449 config->StringToSettings(argv[2]);
1453 /* Start a new AI company */
1454 Command<CMD_COMPANY_CTRL>::Post(CCA_NEW_AI, INVALID_COMPANY, CRR_NONE, INVALID_CLIENT_ID);
1456 return true;
1459 DEF_CONSOLE_CMD(ConReloadAI)
1461 if (argc != 2) {
1462 IConsolePrint(CC_HELP, "Reload an AI. Usage: 'reload_ai <company-id>'.");
1463 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.");
1464 return true;
1467 if (_game_mode != GM_NORMAL) {
1468 IConsolePrint(CC_ERROR, "AIs can only be managed in a game.");
1469 return true;
1472 if (_networking && !_network_server) {
1473 IConsolePrint(CC_ERROR, "Only the server can reload an AI.");
1474 return true;
1477 CompanyID company_id = (CompanyID)(atoi(argv[1]) - 1);
1478 if (!Company::IsValidID(company_id)) {
1479 IConsolePrint(CC_ERROR, "Unknown company. Company range is between 1 and {}.", MAX_COMPANIES);
1480 return true;
1483 /* In singleplayer mode the player can be in an AI company, after cheating or loading network save with an AI in first slot. */
1484 if (Company::IsHumanID(company_id) || company_id == _local_company) {
1485 IConsolePrint(CC_ERROR, "Company is not controlled by an AI.");
1486 return true;
1489 /* First kill the company of the AI, then start a new one. This should start the current AI again */
1490 Command<CMD_COMPANY_CTRL>::Post(CCA_DELETE, company_id, CRR_MANUAL, INVALID_CLIENT_ID);
1491 Command<CMD_COMPANY_CTRL>::Post(CCA_NEW_AI, company_id, CRR_NONE, INVALID_CLIENT_ID);
1492 IConsolePrint(CC_DEFAULT, "AI reloaded.");
1494 return true;
1497 DEF_CONSOLE_CMD(ConStopAI)
1499 if (argc != 2) {
1500 IConsolePrint(CC_HELP, "Stop an AI. Usage: 'stop_ai <company-id>'.");
1501 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.");
1502 return true;
1505 if (_game_mode != GM_NORMAL) {
1506 IConsolePrint(CC_ERROR, "AIs can only be managed in a game.");
1507 return true;
1510 if (_networking && !_network_server) {
1511 IConsolePrint(CC_ERROR, "Only the server can stop an AI.");
1512 return true;
1515 CompanyID company_id = (CompanyID)(atoi(argv[1]) - 1);
1516 if (!Company::IsValidID(company_id)) {
1517 IConsolePrint(CC_ERROR, "Unknown company. Company range is between 1 and {}.", MAX_COMPANIES);
1518 return true;
1521 /* In singleplayer mode the player can be in an AI company, after cheating or loading network save with an AI in first slot. */
1522 if (Company::IsHumanID(company_id) || company_id == _local_company) {
1523 IConsolePrint(CC_ERROR, "Company is not controlled by an AI.");
1524 return true;
1527 /* Now kill the company of the AI. */
1528 Command<CMD_COMPANY_CTRL>::Post(CCA_DELETE, company_id, CRR_MANUAL, INVALID_CLIENT_ID);
1529 IConsolePrint(CC_DEFAULT, "AI stopped, company deleted.");
1531 return true;
1534 DEF_CONSOLE_CMD(ConRescanAI)
1536 if (argc == 0) {
1537 IConsolePrint(CC_HELP, "Rescan the AI dir for scripts. Usage: 'rescan_ai'.");
1538 return true;
1541 if (_networking && !_network_server) {
1542 IConsolePrint(CC_ERROR, "Only the server can rescan the AI dir for scripts.");
1543 return true;
1546 AI::Rescan();
1548 return true;
1551 DEF_CONSOLE_CMD(ConRescanGame)
1553 if (argc == 0) {
1554 IConsolePrint(CC_HELP, "Rescan the Game Script dir for scripts. Usage: 'rescan_game'.");
1555 return true;
1558 if (_networking && !_network_server) {
1559 IConsolePrint(CC_ERROR, "Only the server can rescan the Game Script dir for scripts.");
1560 return true;
1563 Game::Rescan();
1565 return true;
1568 DEF_CONSOLE_CMD(ConRescanNewGRF)
1570 if (argc == 0) {
1571 IConsolePrint(CC_HELP, "Rescan the data dir for NewGRFs. Usage: 'rescan_newgrf'.");
1572 return true;
1575 if (!RequestNewGRFScan()) {
1576 IConsolePrint(CC_ERROR, "NewGRF scanning is already running. Please wait until completed to run again.");
1579 return true;
1582 DEF_CONSOLE_CMD(ConGetSeed)
1584 if (argc == 0) {
1585 IConsolePrint(CC_HELP, "Returns the seed used to create this game. Usage: 'getseed'.");
1586 IConsolePrint(CC_HELP, "The seed can be used to reproduce the exact same map as the game started with.");
1587 return true;
1590 IConsolePrint(CC_DEFAULT, "Generation Seed: {}", _settings_game.game_creation.generation_seed);
1591 return true;
1594 DEF_CONSOLE_CMD(ConGetDate)
1596 if (argc == 0) {
1597 IConsolePrint(CC_HELP, "Returns the current date (year-month-day) of the game. Usage: 'getdate'.");
1598 return true;
1601 TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(TimerGameCalendar::date);
1602 IConsolePrint(CC_DEFAULT, "Date: {:04d}-{:02d}-{:02d}", ymd.year, ymd.month + 1, ymd.day);
1603 return true;
1606 DEF_CONSOLE_CMD(ConGetSysDate)
1608 if (argc == 0) {
1609 IConsolePrint(CC_HELP, "Returns the current date (year-month-day) of your system. Usage: 'getsysdate'.");
1610 return true;
1613 IConsolePrint(CC_DEFAULT, "System Date: {:%Y-%m-%d %H:%M:%S}", fmt::localtime(time(nullptr)));
1614 return true;
1618 DEF_CONSOLE_CMD(ConAlias)
1620 IConsoleAlias *alias;
1622 if (argc == 0) {
1623 IConsolePrint(CC_HELP, "Add a new alias, or redefine the behaviour of an existing alias . Usage: 'alias <name> <command>'.");
1624 return true;
1627 if (argc < 3) return false;
1629 alias = IConsole::AliasGet(argv[1]);
1630 if (alias == nullptr) {
1631 IConsole::AliasRegister(argv[1], argv[2]);
1632 } else {
1633 alias->cmdline = argv[2];
1635 return true;
1638 DEF_CONSOLE_CMD(ConScreenShot)
1640 if (argc == 0) {
1641 IConsolePrint(CC_HELP, "Create a screenshot of the game. Usage: 'screenshot [viewport | normal | big | giant | heightmap | minimap] [no_con] [size <width> <height>] [<filename>]'.");
1642 IConsolePrint(CC_HELP, " 'viewport' (default) makes a screenshot of the current viewport (including menus, windows).");
1643 IConsolePrint(CC_HELP, " 'normal' makes a screenshot of the visible area.");
1644 IConsolePrint(CC_HELP, " 'big' makes a zoomed-in screenshot of the visible area.");
1645 IConsolePrint(CC_HELP, " 'giant' makes a screenshot of the whole map.");
1646 IConsolePrint(CC_HELP, " 'heightmap' makes a heightmap screenshot of the map that can be loaded in as heightmap.");
1647 IConsolePrint(CC_HELP, " 'minimap' makes a top-viewed minimap screenshot of the whole world which represents one tile by one pixel.");
1648 IConsolePrint(CC_HELP, " 'no_con' hides the console to create the screenshot (only useful in combination with 'viewport').");
1649 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').");
1650 IConsolePrint(CC_HELP, " A filename ending in # will prevent overwriting existing files and will number files counting upwards.");
1651 return true;
1654 if (argc > 7) return false;
1656 ScreenshotType type = SC_VIEWPORT;
1657 uint32_t width = 0;
1658 uint32_t height = 0;
1659 std::string name{};
1660 uint32_t arg_index = 1;
1662 if (argc > arg_index) {
1663 if (strcmp(argv[arg_index], "viewport") == 0) {
1664 type = SC_VIEWPORT;
1665 arg_index += 1;
1666 } else if (strcmp(argv[arg_index], "normal") == 0) {
1667 type = SC_DEFAULTZOOM;
1668 arg_index += 1;
1669 } else if (strcmp(argv[arg_index], "big") == 0) {
1670 type = SC_ZOOMEDIN;
1671 arg_index += 1;
1672 } else if (strcmp(argv[arg_index], "giant") == 0) {
1673 type = SC_WORLD;
1674 arg_index += 1;
1675 } else if (strcmp(argv[arg_index], "heightmap") == 0) {
1676 type = SC_HEIGHTMAP;
1677 arg_index += 1;
1678 } else if (strcmp(argv[arg_index], "minimap") == 0) {
1679 type = SC_MINIMAP;
1680 arg_index += 1;
1684 if (argc > arg_index && strcmp(argv[arg_index], "no_con") == 0) {
1685 if (type != SC_VIEWPORT) {
1686 IConsolePrint(CC_ERROR, "'no_con' can only be used in combination with 'viewport'.");
1687 return true;
1689 IConsoleClose();
1690 arg_index += 1;
1693 if (argc > arg_index + 2 && strcmp(argv[arg_index], "size") == 0) {
1694 /* size <width> <height> */
1695 if (type != SC_DEFAULTZOOM && type != SC_ZOOMEDIN) {
1696 IConsolePrint(CC_ERROR, "'size' can only be used in combination with 'normal' or 'big'.");
1697 return true;
1699 GetArgumentInteger(&width, argv[arg_index + 1]);
1700 GetArgumentInteger(&height, argv[arg_index + 2]);
1701 arg_index += 3;
1704 if (argc > arg_index) {
1705 /* Last parameter that was not one of the keywords must be the filename. */
1706 name = argv[arg_index];
1707 arg_index += 1;
1710 if (argc > arg_index) {
1711 /* We have parameters we did not process; means we misunderstood any of the above. */
1712 return false;
1715 MakeScreenshot(type, name, width, height);
1716 return true;
1719 DEF_CONSOLE_CMD(ConInfoCmd)
1721 if (argc == 0) {
1722 IConsolePrint(CC_HELP, "Print out debugging information about a command. Usage: 'info_cmd <cmd>'.");
1723 return true;
1726 if (argc < 2) return false;
1728 const IConsoleCmd *cmd = IConsole::CmdGet(argv[1]);
1729 if (cmd == nullptr) {
1730 IConsolePrint(CC_ERROR, "The given command was not found.");
1731 return true;
1734 IConsolePrint(CC_DEFAULT, "Command name: '{}'", cmd->name);
1736 if (cmd->hook != nullptr) IConsolePrint(CC_DEFAULT, "Command is hooked.");
1738 return true;
1741 DEF_CONSOLE_CMD(ConDebugLevel)
1743 if (argc == 0) {
1744 IConsolePrint(CC_HELP, "Get/set the default debugging level for the game. Usage: 'debug_level [<level>]'.");
1745 IConsolePrint(CC_HELP, "Level can be any combination of names, levels. Eg 'net=5 ms=4'. Remember to enclose it in \"'\"s.");
1746 return true;
1749 if (argc > 2) return false;
1751 if (argc == 1) {
1752 IConsolePrint(CC_DEFAULT, "Current debug-level: '{}'", GetDebugString());
1753 } else {
1754 SetDebugString(argv[1], [](const std::string &err) { IConsolePrint(CC_ERROR, err); });
1757 return true;
1760 DEF_CONSOLE_CMD(ConExit)
1762 if (argc == 0) {
1763 IConsolePrint(CC_HELP, "Exit the game. Usage: 'exit'.");
1764 return true;
1767 if (_game_mode == GM_NORMAL && _settings_client.gui.autosave_on_exit) DoExitSave();
1769 _exit_game = true;
1770 return true;
1773 DEF_CONSOLE_CMD(ConPart)
1775 if (argc == 0) {
1776 IConsolePrint(CC_HELP, "Leave the currently joined/running game (only ingame). Usage: 'part'.");
1777 return true;
1780 if (_game_mode != GM_NORMAL) return false;
1782 if (_network_dedicated) {
1783 IConsolePrint(CC_ERROR, "A dedicated server can not leave the game.");
1784 return false;
1787 _switch_mode = SM_MENU;
1788 return true;
1791 DEF_CONSOLE_CMD(ConHelp)
1793 if (argc == 2) {
1794 const IConsoleCmd *cmd;
1795 const IConsoleAlias *alias;
1797 cmd = IConsole::CmdGet(argv[1]);
1798 if (cmd != nullptr) {
1799 cmd->proc(0, nullptr);
1800 return true;
1803 alias = IConsole::AliasGet(argv[1]);
1804 if (alias != nullptr) {
1805 cmd = IConsole::CmdGet(alias->cmdline);
1806 if (cmd != nullptr) {
1807 cmd->proc(0, nullptr);
1808 return true;
1810 IConsolePrint(CC_ERROR, "Alias is of special type, please see its execution-line: '{}'.", alias->cmdline);
1811 return true;
1814 IConsolePrint(CC_ERROR, "Command not found.");
1815 return true;
1818 IConsolePrint(TC_LIGHT_BLUE, " ---- OpenTTD Console Help ---- ");
1819 IConsolePrint(CC_DEFAULT, " - commands: the command to list all commands is 'list_cmds'.");
1820 IConsolePrint(CC_DEFAULT, " call commands with '<command> <arg2> <arg3>...'");
1821 IConsolePrint(CC_DEFAULT, " - to assign strings, or use them as arguments, enclose it within quotes.");
1822 IConsolePrint(CC_DEFAULT, " like this: '<command> \"string argument with spaces\"'.");
1823 IConsolePrint(CC_DEFAULT, " - use 'help <command>' to get specific information.");
1824 IConsolePrint(CC_DEFAULT, " - scroll console output with shift + (up | down | pageup | pagedown).");
1825 IConsolePrint(CC_DEFAULT, " - scroll console input history with the up or down arrows.");
1826 IConsolePrint(CC_DEFAULT, "");
1827 return true;
1830 DEF_CONSOLE_CMD(ConListCommands)
1832 if (argc == 0) {
1833 IConsolePrint(CC_HELP, "List all registered commands. Usage: 'list_cmds [<pre-filter>]'.");
1834 return true;
1837 for (auto &it : IConsole::Commands()) {
1838 const IConsoleCmd *cmd = &it.second;
1839 if (argv[1] == nullptr || cmd->name.find(argv[1]) != std::string::npos) {
1840 if (cmd->hook == nullptr || cmd->hook(false) != CHR_HIDE) IConsolePrint(CC_DEFAULT, cmd->name);
1844 return true;
1847 DEF_CONSOLE_CMD(ConListAliases)
1849 if (argc == 0) {
1850 IConsolePrint(CC_HELP, "List all registered aliases. Usage: 'list_aliases [<pre-filter>]'.");
1851 return true;
1854 for (auto &it : IConsole::Aliases()) {
1855 const IConsoleAlias *alias = &it.second;
1856 if (argv[1] == nullptr || alias->name.find(argv[1]) != std::string::npos) {
1857 IConsolePrint(CC_DEFAULT, "{} => {}", alias->name, alias->cmdline);
1861 return true;
1864 DEF_CONSOLE_CMD(ConCompanies)
1866 if (argc == 0) {
1867 IConsolePrint(CC_HELP, "List the details of all companies in the game. Usage 'companies'.");
1868 return true;
1871 for (const Company *c : Company::Iterate()) {
1872 /* Grab the company name */
1873 SetDParam(0, c->index);
1874 std::string company_name = GetString(STR_COMPANY_NAME);
1876 std::string colour = GetString(STR_COLOUR_DARK_BLUE + _company_colours[c->index]);
1877 IConsolePrint(CC_INFO, "#:{}({}) Company Name: '{}' Year Founded: {} Money: {} Loan: {} Value: {} (T:{}, R:{}, P:{}, S:{}) {}",
1878 c->index + 1, colour, company_name,
1879 c->inaugurated_year, (int64_t)c->money, (int64_t)c->current_loan, (int64_t)CalculateCompanyValue(c),
1880 c->group_all[VEH_TRAIN].num_vehicle,
1881 c->group_all[VEH_ROAD].num_vehicle,
1882 c->group_all[VEH_AIRCRAFT].num_vehicle,
1883 c->group_all[VEH_SHIP].num_vehicle,
1884 c->is_ai ? "AI" : "");
1887 return true;
1890 DEF_CONSOLE_CMD(ConSay)
1892 if (argc == 0) {
1893 IConsolePrint(CC_HELP, "Chat to your fellow players in a multiplayer game. Usage: 'say \"<msg>\"'.");
1894 return true;
1897 if (argc != 2) return false;
1899 if (!_network_server) {
1900 NetworkClientSendChat(NETWORK_ACTION_CHAT, DESTTYPE_BROADCAST, 0 /* param does not matter */, argv[1]);
1901 } else {
1902 bool from_admin = (_redirect_console_to_admin < INVALID_ADMIN_ID);
1903 NetworkServerSendChat(NETWORK_ACTION_CHAT, DESTTYPE_BROADCAST, 0, argv[1], CLIENT_ID_SERVER, from_admin);
1906 return true;
1909 DEF_CONSOLE_CMD(ConSayCompany)
1911 if (argc == 0) {
1912 IConsolePrint(CC_HELP, "Chat to a certain company in a multiplayer game. Usage: 'say_company <company-no> \"<msg>\"'.");
1913 IConsolePrint(CC_HELP, "CompanyNo is the company that plays as company <companyno>, 1 through max_companies.");
1914 return true;
1917 if (argc != 3) return false;
1919 CompanyID company_id = (CompanyID)(atoi(argv[1]) - 1);
1920 if (!Company::IsValidID(company_id)) {
1921 IConsolePrint(CC_DEFAULT, "Unknown company. Company range is between 1 and {}.", MAX_COMPANIES);
1922 return true;
1925 if (!_network_server) {
1926 NetworkClientSendChat(NETWORK_ACTION_CHAT_COMPANY, DESTTYPE_TEAM, company_id, argv[2]);
1927 } else {
1928 bool from_admin = (_redirect_console_to_admin < INVALID_ADMIN_ID);
1929 NetworkServerSendChat(NETWORK_ACTION_CHAT_COMPANY, DESTTYPE_TEAM, company_id, argv[2], CLIENT_ID_SERVER, from_admin);
1932 return true;
1935 DEF_CONSOLE_CMD(ConSayClient)
1937 if (argc == 0) {
1938 IConsolePrint(CC_HELP, "Chat to a certain client in a multiplayer game. Usage: 'say_client <client-no> \"<msg>\"'.");
1939 IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
1940 return true;
1943 if (argc != 3) return false;
1945 if (!_network_server) {
1946 NetworkClientSendChat(NETWORK_ACTION_CHAT_CLIENT, DESTTYPE_CLIENT, atoi(argv[1]), argv[2]);
1947 } else {
1948 bool from_admin = (_redirect_console_to_admin < INVALID_ADMIN_ID);
1949 NetworkServerSendChat(NETWORK_ACTION_CHAT_CLIENT, DESTTYPE_CLIENT, atoi(argv[1]), argv[2], CLIENT_ID_SERVER, from_admin);
1952 return true;
1955 /** All the known authorized keys with their name. */
1956 static std::vector<std::pair<std::string_view, NetworkAuthorizedKeys *>> _console_cmd_authorized_keys{
1957 { "admin", &_settings_client.network.admin_authorized_keys },
1958 { "rcon", &_settings_client.network.rcon_authorized_keys },
1959 { "server", &_settings_client.network.server_authorized_keys },
1962 enum ConNetworkAuthorizedKeyAction {
1963 CNAKA_LIST,
1964 CNAKA_ADD,
1965 CNAKA_REMOVE,
1968 static void PerformNetworkAuthorizedKeyAction(std::string_view name, NetworkAuthorizedKeys *authorized_keys, ConNetworkAuthorizedKeyAction action, const std::string &authorized_key, CompanyID company = INVALID_COMPANY)
1970 switch (action) {
1971 case CNAKA_LIST:
1972 IConsolePrint(CC_WHITE, "The authorized keys for {} are:", name);
1973 for (auto &ak : *authorized_keys) IConsolePrint(CC_INFO, " {}", ak);
1974 return;
1976 case CNAKA_ADD:
1977 if (authorized_keys->Contains(authorized_key)) {
1978 IConsolePrint(CC_WARNING, "Not added {} to {} as it already exists.", authorized_key, name);
1979 return;
1982 if (company == INVALID_COMPANY) {
1983 authorized_keys->Add(authorized_key);
1984 } else {
1985 AutoRestoreBackup backup(_current_company, company);
1986 Command<CMD_COMPANY_ALLOW_LIST_CTRL>::Post(CALCA_ADD, authorized_key);
1988 IConsolePrint(CC_INFO, "Added {} to {}.", authorized_key, name);
1989 return;
1991 case CNAKA_REMOVE:
1992 if (!authorized_keys->Contains(authorized_key)) {
1993 IConsolePrint(CC_WARNING, "Not removed {} from {} as it does not exist.", authorized_key, name);
1994 return;
1997 if (company == INVALID_COMPANY) {
1998 authorized_keys->Remove(authorized_key);
1999 } else {
2000 AutoRestoreBackup backup(_current_company, company);
2001 Command<CMD_COMPANY_ALLOW_LIST_CTRL>::Post(CALCA_REMOVE, authorized_key);
2003 IConsolePrint(CC_INFO, "Removed {} from {}.", authorized_key, name);
2004 return;
2008 DEF_CONSOLE_CMD(ConNetworkAuthorizedKey)
2010 if (argc <= 2) {
2011 IConsolePrint(CC_HELP, "List and update authorized keys. Usage: 'authorized_key list [type]|add [type] [key]|remove [type] [key]'.");
2012 IConsolePrint(CC_HELP, " list: list all the authorized keys of the given type.");
2013 IConsolePrint(CC_HELP, " add: add the given key to the authorized keys of the given type.");
2014 IConsolePrint(CC_HELP, " remove: remove the given key from the authorized keys of the given type; use 'all' to remove all authorized keys.");
2015 IConsolePrint(CC_HELP, "Instead of a key, use 'client:<id>' to add/remove the key of that given client.");
2017 std::string buffer;
2018 for (auto [name, _] : _console_cmd_authorized_keys) fmt::format_to(std::back_inserter(buffer), ", {}", name);
2019 IConsolePrint(CC_HELP, "The supported types are: all{} and company:<id>.", buffer);
2020 return true;
2023 ConNetworkAuthorizedKeyAction action;
2024 std::string_view action_string = argv[1];
2025 if (StrEqualsIgnoreCase(action_string, "list")) {
2026 action = CNAKA_LIST;
2027 } else if (StrEqualsIgnoreCase(action_string, "add")) {
2028 action = CNAKA_ADD;
2029 } else if (StrEqualsIgnoreCase(action_string, "remove") || StrEqualsIgnoreCase(action_string, "delete")) {
2030 action = CNAKA_REMOVE;
2031 } else {
2032 IConsolePrint(CC_WARNING, "No valid action was given.");
2033 return false;
2036 std::string authorized_key;
2037 if (action != CNAKA_LIST) {
2038 if (argc <= 3) {
2039 IConsolePrint(CC_ERROR, "You must enter the key.");
2040 return false;
2043 authorized_key = argv[3];
2044 if (StrStartsWithIgnoreCase(authorized_key, "client:")) {
2045 std::string id_string(authorized_key.substr(7));
2046 authorized_key = NetworkGetPublicKeyOfClient(static_cast<ClientID>(std::stoi(id_string)));
2047 if (authorized_key.empty()) {
2048 IConsolePrint(CC_ERROR, "You must enter a valid client id; see 'clients'.");
2049 return false;
2053 if (authorized_key.size() != NETWORK_PUBLIC_KEY_LENGTH - 1) {
2054 IConsolePrint(CC_ERROR, "You must enter a valid authorized key.");
2055 return false;
2059 std::string_view type = argv[2];
2060 if (StrEqualsIgnoreCase(type, "all")) {
2061 for (auto [name, authorized_keys] : _console_cmd_authorized_keys) PerformNetworkAuthorizedKeyAction(name, authorized_keys, action, authorized_key);
2062 for (Company *c : Company::Iterate()) PerformNetworkAuthorizedKeyAction(fmt::format("company:{}", c->index + 1), &c->allow_list, action, authorized_key, c->index);
2063 return true;
2066 if (StrStartsWithIgnoreCase(type, "company:")) {
2067 std::string id_string(type.substr(8));
2068 Company *c = Company::GetIfValid(std::stoi(id_string) - 1);
2069 if (c == nullptr) {
2070 IConsolePrint(CC_ERROR, "You must enter a valid company id; see 'companies'.");
2071 return false;
2074 PerformNetworkAuthorizedKeyAction(type, &c->allow_list, action, authorized_key, c->index);
2075 return true;
2078 for (auto [name, authorized_keys] : _console_cmd_authorized_keys) {
2079 if (StrEqualsIgnoreCase(type, name)) continue;
2081 PerformNetworkAuthorizedKeyAction(name, authorized_keys, action, authorized_key);
2082 return true;
2085 IConsolePrint(CC_WARNING, "No valid type was given.");
2086 return false;
2090 /* Content downloading only is available with ZLIB */
2091 #if defined(WITH_ZLIB)
2092 #include "network/network_content.h"
2094 /** Resolve a string to a content type. */
2095 static ContentType StringToContentType(const char *str)
2097 static const std::initializer_list<std::pair<std::string_view, ContentType>> content_types = {
2098 {"base", CONTENT_TYPE_BASE_GRAPHICS},
2099 {"newgrf", CONTENT_TYPE_NEWGRF},
2100 {"ai", CONTENT_TYPE_AI},
2101 {"ailib", CONTENT_TYPE_AI_LIBRARY},
2102 {"scenario", CONTENT_TYPE_SCENARIO},
2103 {"heightmap", CONTENT_TYPE_HEIGHTMAP},
2105 for (const auto &ct : content_types) {
2106 if (StrEqualsIgnoreCase(str, ct.first)) return ct.second;
2108 return CONTENT_TYPE_END;
2111 /** Asynchronous callback */
2112 struct ConsoleContentCallback : public ContentCallback {
2113 void OnConnect(bool success) override
2115 IConsolePrint(CC_DEFAULT, "Content server connection {}.", success ? "established" : "failed");
2118 void OnDisconnect() override
2120 IConsolePrint(CC_DEFAULT, "Content server connection closed.");
2123 void OnDownloadComplete(ContentID cid) override
2125 IConsolePrint(CC_DEFAULT, "Completed download of {}.", cid);
2130 * Outputs content state information to console
2131 * @param ci the content info
2133 static void OutputContentState(const ContentInfo *const ci)
2135 static const char * const types[] = { "Base graphics", "NewGRF", "AI", "AI library", "Scenario", "Heightmap", "Base sound", "Base music", "Game script", "GS library" };
2136 static_assert(lengthof(types) == CONTENT_TYPE_END - CONTENT_TYPE_BEGIN);
2137 static const char * const states[] = { "Not selected", "Selected", "Dep Selected", "Installed", "Unknown" };
2138 static const TextColour state_to_colour[] = { CC_COMMAND, CC_INFO, CC_INFO, CC_WHITE, CC_ERROR };
2140 IConsolePrint(state_to_colour[ci->state], "{}, {}, {}, {}, {:08X}, {}", ci->id, types[ci->type - 1], states[ci->state], ci->name, ci->unique_id, FormatArrayAsHex(ci->md5sum));
2143 DEF_CONSOLE_CMD(ConContent)
2145 static ContentCallback *cb = nullptr;
2146 if (cb == nullptr) {
2147 cb = new ConsoleContentCallback();
2148 _network_content_client.AddCallback(cb);
2151 if (argc <= 1) {
2152 IConsolePrint(CC_HELP, "Query, select and download content. Usage: 'content update|upgrade|select [id]|unselect [all|id]|state [filter]|download'.");
2153 IConsolePrint(CC_HELP, " update: get a new list of downloadable content; must be run first.");
2154 IConsolePrint(CC_HELP, " upgrade: select all items that are upgrades.");
2155 IConsolePrint(CC_HELP, " select: select a specific item given by its id. If no parameter is given, all selected content will be listed.");
2156 IConsolePrint(CC_HELP, " unselect: unselect a specific item given by its id or 'all' to unselect all.");
2157 IConsolePrint(CC_HELP, " state: show the download/select state of all downloadable content. Optionally give a filter string.");
2158 IConsolePrint(CC_HELP, " download: download all content you've selected.");
2159 return true;
2162 if (StrEqualsIgnoreCase(argv[1], "update")) {
2163 _network_content_client.RequestContentList((argc > 2) ? StringToContentType(argv[2]) : CONTENT_TYPE_END);
2164 return true;
2167 if (StrEqualsIgnoreCase(argv[1], "upgrade")) {
2168 _network_content_client.SelectUpgrade();
2169 return true;
2172 if (StrEqualsIgnoreCase(argv[1], "select")) {
2173 if (argc <= 2) {
2174 /* List selected content */
2175 IConsolePrint(CC_WHITE, "id, type, state, name");
2176 for (ConstContentIterator iter = _network_content_client.Begin(); iter != _network_content_client.End(); iter++) {
2177 if ((*iter)->state != ContentInfo::SELECTED && (*iter)->state != ContentInfo::AUTOSELECTED) continue;
2178 OutputContentState(*iter);
2180 } else if (StrEqualsIgnoreCase(argv[2], "all")) {
2181 /* The intention of this function was that you could download
2182 * everything after a filter was applied; but this never really
2183 * took off. Instead, a select few people used this functionality
2184 * to download every available package on BaNaNaS. This is not in
2185 * the spirit of this service. Additionally, these few people were
2186 * good for 70% of the consumed bandwidth of BaNaNaS. */
2187 IConsolePrint(CC_ERROR, "'select all' is no longer supported since 1.11.");
2188 } else {
2189 _network_content_client.Select((ContentID)atoi(argv[2]));
2191 return true;
2194 if (StrEqualsIgnoreCase(argv[1], "unselect")) {
2195 if (argc <= 2) {
2196 IConsolePrint(CC_ERROR, "You must enter the id.");
2197 return false;
2199 if (StrEqualsIgnoreCase(argv[2], "all")) {
2200 _network_content_client.UnselectAll();
2201 } else {
2202 _network_content_client.Unselect((ContentID)atoi(argv[2]));
2204 return true;
2207 if (StrEqualsIgnoreCase(argv[1], "state")) {
2208 IConsolePrint(CC_WHITE, "id, type, state, name");
2209 for (ConstContentIterator iter = _network_content_client.Begin(); iter != _network_content_client.End(); iter++) {
2210 if (argc > 2 && strcasestr((*iter)->name.c_str(), argv[2]) == nullptr) continue;
2211 OutputContentState(*iter);
2213 return true;
2216 if (StrEqualsIgnoreCase(argv[1], "download")) {
2217 uint files;
2218 uint bytes;
2219 _network_content_client.DownloadSelectedContent(files, bytes);
2220 IConsolePrint(CC_DEFAULT, "Downloading {} file(s) ({} bytes).", files, bytes);
2221 return true;
2224 return false;
2226 #endif /* defined(WITH_ZLIB) */
2228 DEF_CONSOLE_CMD(ConFont)
2230 if (argc == 0) {
2231 IConsolePrint(CC_HELP, "Manage the fonts configuration.");
2232 IConsolePrint(CC_HELP, "Usage 'font'.");
2233 IConsolePrint(CC_HELP, " Print out the fonts configuration.");
2234 IConsolePrint(CC_HELP, " The \"Currently active\" configuration is the one actually in effect (after interface scaling and replacing unavailable fonts).");
2235 IConsolePrint(CC_HELP, " The \"Requested\" configuration is the one requested via console command or config file.");
2236 IConsolePrint(CC_HELP, "Usage 'font [medium|small|large|mono] [<font name>] [<size>]'.");
2237 IConsolePrint(CC_HELP, " Change the configuration for a font.");
2238 IConsolePrint(CC_HELP, " Omitting an argument will keep the current value.");
2239 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.");
2240 IConsolePrint(CC_HELP, " If the sprite font is enabled in Game Options, it is used instead of the default font.");
2241 IConsolePrint(CC_HELP, " The <size> is automatically multiplied by the current interface scaling.");
2242 return true;
2245 FontSize argfs;
2246 for (argfs = FS_BEGIN; argfs < FS_END; argfs++) {
2247 if (argc > 1 && StrEqualsIgnoreCase(argv[1], FontSizeToName(argfs))) break;
2250 /* First argument must be a FontSize. */
2251 if (argc > 1 && argfs == FS_END) return false;
2253 if (argc > 2) {
2254 FontCacheSubSetting *setting = GetFontCacheSubSetting(argfs);
2255 std::string font = setting->font;
2256 uint size = setting->size;
2257 uint v;
2258 uint8_t arg_index = 2;
2259 /* For <name> we want a string. */
2261 if (!GetArgumentInteger(&v, argv[arg_index])) {
2262 font = argv[arg_index++];
2265 if (argc > arg_index) {
2266 /* For <size> we want a number. */
2267 if (GetArgumentInteger(&v, argv[arg_index])) {
2268 size = v;
2269 arg_index++;
2273 SetFont(argfs, font, size);
2276 for (FontSize fs = FS_BEGIN; fs < FS_END; fs++) {
2277 FontCache *fc = FontCache::Get(fs);
2278 FontCacheSubSetting *setting = GetFontCacheSubSetting(fs);
2279 /* Make sure all non sprite fonts are loaded. */
2280 if (!setting->font.empty() && !fc->HasParent()) {
2281 InitFontCache(fs == FS_MONO);
2282 fc = FontCache::Get(fs);
2284 IConsolePrint(CC_DEFAULT, "{} font:", FontSizeToName(fs));
2285 IConsolePrint(CC_DEFAULT, "Currently active: \"{}\", size {}", fc->GetFontName(), fc->GetFontSize());
2286 IConsolePrint(CC_DEFAULT, "Requested: \"{}\", size {}", setting->font, setting->size);
2289 return true;
2292 DEF_CONSOLE_CMD(ConSetting)
2294 if (argc == 0) {
2295 IConsolePrint(CC_HELP, "Change setting for all clients. Usage: 'setting <name> [<value>]'.");
2296 IConsolePrint(CC_HELP, "Omitting <value> will print out the current value of the setting.");
2297 return true;
2300 if (argc == 1 || argc > 3) return false;
2302 if (argc == 2) {
2303 IConsoleGetSetting(argv[1]);
2304 } else {
2305 IConsoleSetSetting(argv[1], argv[2]);
2308 return true;
2311 DEF_CONSOLE_CMD(ConSettingNewgame)
2313 if (argc == 0) {
2314 IConsolePrint(CC_HELP, "Change setting for the next game. Usage: 'setting_newgame <name> [<value>]'.");
2315 IConsolePrint(CC_HELP, "Omitting <value> will print out the current value of the setting.");
2316 return true;
2319 if (argc == 1 || argc > 3) return false;
2321 if (argc == 2) {
2322 IConsoleGetSetting(argv[1], true);
2323 } else {
2324 IConsoleSetSetting(argv[1], argv[2], true);
2327 return true;
2330 DEF_CONSOLE_CMD(ConListSettings)
2332 if (argc == 0) {
2333 IConsolePrint(CC_HELP, "List settings. Usage: 'list_settings [<pre-filter>]'.");
2334 return true;
2337 if (argc > 2) return false;
2339 IConsoleListSettings((argc == 2) ? argv[1] : nullptr);
2340 return true;
2343 DEF_CONSOLE_CMD(ConGamelogPrint)
2345 if (argc == 0) {
2346 IConsolePrint(CC_HELP, "Print logged fundamental changes to the game since the start. Usage: 'gamelog'.");
2347 return true;
2350 _gamelog.PrintConsole();
2351 return true;
2354 DEF_CONSOLE_CMD(ConNewGRFReload)
2356 if (argc == 0) {
2357 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!");
2358 return true;
2361 ReloadNewGRFData();
2362 return true;
2365 DEF_CONSOLE_CMD(ConListDirs)
2367 struct SubdirNameMap {
2368 Subdirectory subdir; ///< Index of subdirectory type
2369 const char *name; ///< UI name for the directory
2370 bool default_only; ///< Whether only the default (first existing) directory for this is interesting
2372 static const SubdirNameMap subdir_name_map[] = {
2373 /* Game data directories */
2374 { BASESET_DIR, "baseset", false },
2375 { NEWGRF_DIR, "newgrf", false },
2376 { AI_DIR, "ai", false },
2377 { AI_LIBRARY_DIR, "ailib", false },
2378 { GAME_DIR, "gs", false },
2379 { GAME_LIBRARY_DIR, "gslib", false },
2380 { SCENARIO_DIR, "scenario", false },
2381 { HEIGHTMAP_DIR, "heightmap", false },
2382 /* Default save locations for user data */
2383 { SAVE_DIR, "save", true },
2384 { AUTOSAVE_DIR, "autosave", true },
2385 { SCREENSHOT_DIR, "screenshot", true },
2386 { SOCIAL_INTEGRATION_DIR, "social_integration", true },
2389 if (argc != 2) {
2390 IConsolePrint(CC_HELP, "List all search paths or default directories for various categories.");
2391 IConsolePrint(CC_HELP, "Usage: list_dirs <category>");
2392 std::string cats = subdir_name_map[0].name;
2393 bool first = true;
2394 for (const SubdirNameMap &sdn : subdir_name_map) {
2395 if (!first) cats = cats + ", " + sdn.name;
2396 first = false;
2398 IConsolePrint(CC_HELP, "Valid categories: {}", cats);
2399 return true;
2402 std::set<std::string> seen_dirs;
2403 for (const SubdirNameMap &sdn : subdir_name_map) {
2404 if (!StrEqualsIgnoreCase(argv[1], sdn.name)) continue;
2405 bool found = false;
2406 for (Searchpath sp : _valid_searchpaths) {
2407 /* Get the directory */
2408 std::string path = FioGetDirectory(sp, sdn.subdir);
2409 /* Check it hasn't already been listed */
2410 if (seen_dirs.find(path) != seen_dirs.end()) continue;
2411 seen_dirs.insert(path);
2412 /* Check if exists and mark found */
2413 bool exists = FileExists(path);
2414 found |= exists;
2415 /* Print */
2416 if (!sdn.default_only || exists) {
2417 IConsolePrint(exists ? CC_DEFAULT : CC_INFO, "{} {}", path, exists ? "[ok]" : "[not found]");
2418 if (sdn.default_only) break;
2421 if (!found) {
2422 IConsolePrint(CC_ERROR, "No directories exist for category {}", argv[1]);
2424 return true;
2427 IConsolePrint(CC_ERROR, "Invalid category name: {}", argv[1]);
2428 return false;
2431 DEF_CONSOLE_CMD(ConNewGRFProfile)
2433 if (argc == 0) {
2434 IConsolePrint(CC_HELP, "Collect performance data about NewGRF sprite requests and callbacks. Sub-commands can be abbreviated.");
2435 IConsolePrint(CC_HELP, "Usage: 'newgrf_profile [list]':");
2436 IConsolePrint(CC_HELP, " List all NewGRFs that can be profiled, and their status.");
2437 IConsolePrint(CC_HELP, "Usage: 'newgrf_profile select <grf-num>...':");
2438 IConsolePrint(CC_HELP, " Select one or more GRFs for profiling.");
2439 IConsolePrint(CC_HELP, "Usage: 'newgrf_profile unselect <grf-num>...':");
2440 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.");
2441 IConsolePrint(CC_HELP, "Usage: 'newgrf_profile start [<num-ticks>]':");
2442 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.");
2443 IConsolePrint(CC_HELP, "Usage: 'newgrf_profile stop':");
2444 IConsolePrint(CC_HELP, " End profiling and write the collected data to CSV files.");
2445 IConsolePrint(CC_HELP, "Usage: 'newgrf_profile abort':");
2446 IConsolePrint(CC_HELP, " End profiling and discard all collected data.");
2447 return true;
2450 const std::vector<GRFFile *> &files = GetAllGRFFiles();
2452 /* "list" sub-command */
2453 if (argc == 1 || StrStartsWithIgnoreCase(argv[1], "lis")) {
2454 IConsolePrint(CC_INFO, "Loaded GRF files:");
2455 int i = 1;
2456 for (GRFFile *grf : files) {
2457 auto profiler = std::ranges::find(_newgrf_profilers, grf, &NewGRFProfiler::grffile);
2458 bool selected = profiler != _newgrf_profilers.end();
2459 bool active = selected && profiler->active;
2460 TextColour tc = active ? TC_LIGHT_BLUE : selected ? TC_GREEN : CC_INFO;
2461 const char *statustext = active ? " (active)" : selected ? " (selected)" : "";
2462 IConsolePrint(tc, "{}: [{:08X}] {}{}", i, BSWAP32(grf->grfid), grf->filename, statustext);
2463 i++;
2465 return true;
2468 /* "select" sub-command */
2469 if (StrStartsWithIgnoreCase(argv[1], "sel") && argc >= 3) {
2470 for (size_t argnum = 2; argnum < argc; ++argnum) {
2471 int grfnum = atoi(argv[argnum]);
2472 if (grfnum < 1 || grfnum > (int)files.size()) { // safe cast, files.size() should not be larger than a few hundred in the most extreme cases
2473 IConsolePrint(CC_WARNING, "GRF number {} out of range, not added.", grfnum);
2474 continue;
2476 GRFFile *grf = files[grfnum - 1];
2477 if (std::any_of(_newgrf_profilers.begin(), _newgrf_profilers.end(), [&](NewGRFProfiler &pr) { return pr.grffile == grf; })) {
2478 IConsolePrint(CC_WARNING, "GRF number {} [{:08X}] is already selected for profiling.", grfnum, BSWAP32(grf->grfid));
2479 continue;
2481 _newgrf_profilers.emplace_back(grf);
2483 return true;
2486 /* "unselect" sub-command */
2487 if (StrStartsWithIgnoreCase(argv[1], "uns") && argc >= 3) {
2488 for (size_t argnum = 2; argnum < argc; ++argnum) {
2489 if (StrEqualsIgnoreCase(argv[argnum], "all")) {
2490 _newgrf_profilers.clear();
2491 break;
2493 int grfnum = atoi(argv[argnum]);
2494 if (grfnum < 1 || grfnum > (int)files.size()) {
2495 IConsolePrint(CC_WARNING, "GRF number {} out of range, not removing.", grfnum);
2496 continue;
2498 GRFFile *grf = files[grfnum - 1];
2499 _newgrf_profilers.erase(std::ranges::find(_newgrf_profilers, grf, &NewGRFProfiler::grffile));
2501 return true;
2504 /* "start" sub-command */
2505 if (StrStartsWithIgnoreCase(argv[1], "sta")) {
2506 std::string grfids;
2507 size_t started = 0;
2508 for (NewGRFProfiler &pr : _newgrf_profilers) {
2509 if (!pr.active) {
2510 pr.Start();
2511 started++;
2513 if (!grfids.empty()) grfids += ", ";
2514 fmt::format_to(std::back_inserter(grfids), "[{:08X}]", BSWAP32(pr.grffile->grfid));
2517 if (started > 0) {
2518 IConsolePrint(CC_DEBUG, "Started profiling for GRFID{} {}.", (started > 1) ? "s" : "", grfids);
2520 if (argc >= 3) {
2521 uint64_t ticks = std::max(atoi(argv[2]), 1);
2522 NewGRFProfiler::StartTimer(ticks);
2523 IConsolePrint(CC_DEBUG, "Profiling will automatically stop after {} ticks.", ticks);
2525 } else if (_newgrf_profilers.empty()) {
2526 IConsolePrint(CC_ERROR, "No GRFs selected for profiling, did not start.");
2527 } else {
2528 IConsolePrint(CC_ERROR, "Did not start profiling for any GRFs, all selected GRFs are already profiling.");
2530 return true;
2533 /* "stop" sub-command */
2534 if (StrStartsWithIgnoreCase(argv[1], "sto")) {
2535 NewGRFProfiler::FinishAll();
2536 return true;
2539 /* "abort" sub-command */
2540 if (StrStartsWithIgnoreCase(argv[1], "abo")) {
2541 for (NewGRFProfiler &pr : _newgrf_profilers) {
2542 pr.Abort();
2544 NewGRFProfiler::AbortTimer();
2545 return true;
2548 return false;
2551 #ifdef _DEBUG
2552 /******************
2553 * debug commands
2554 ******************/
2556 static void IConsoleDebugLibRegister()
2558 IConsole::CmdRegister("resettile", ConResetTile);
2559 IConsole::AliasRegister("dbg_echo", "echo %A; echo %B");
2560 IConsole::AliasRegister("dbg_echo2", "echo %!");
2562 #endif
2564 DEF_CONSOLE_CMD(ConFramerate)
2566 if (argc == 0) {
2567 IConsolePrint(CC_HELP, "Show frame rate and game speed information.");
2568 return true;
2571 ConPrintFramerate();
2572 return true;
2575 DEF_CONSOLE_CMD(ConFramerateWindow)
2577 if (argc == 0) {
2578 IConsolePrint(CC_HELP, "Open the frame rate window.");
2579 return true;
2582 if (_network_dedicated) {
2583 IConsolePrint(CC_ERROR, "Can not open frame rate window on a dedicated server.");
2584 return false;
2587 ShowFramerateWindow();
2588 return true;
2592 * Format a label as a string.
2593 * If all elements are visible ASCII (excluding space) then the label will be formatted as a string of 4 characters,
2594 * otherwise it will be output as an 8-digit hexadecimal value.
2595 * @param label Label to format.
2596 * @return string representation of label.
2598 static std::string FormatLabel(uint32_t label)
2600 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))) {
2601 return fmt::format("{:c}{:c}{:c}{:c}", GB(label, 24, 8), GB(label, 16, 8), GB(label, 8, 8), GB(label, 0, 8));
2604 return fmt::format("{:08X}", BSWAP32(label));
2607 static void ConDumpRoadTypes()
2609 IConsolePrint(CC_DEFAULT, " Flags:");
2610 IConsolePrint(CC_DEFAULT, " c = catenary");
2611 IConsolePrint(CC_DEFAULT, " l = no level crossings");
2612 IConsolePrint(CC_DEFAULT, " X = no houses");
2613 IConsolePrint(CC_DEFAULT, " h = hidden");
2614 IConsolePrint(CC_DEFAULT, " T = buildable by towns");
2616 std::map<uint32_t, const GRFFile *> grfs;
2617 for (RoadType rt = ROADTYPE_BEGIN; rt < ROADTYPE_END; rt++) {
2618 const RoadTypeInfo *rti = GetRoadTypeInfo(rt);
2619 if (rti->label == 0) continue;
2620 uint32_t grfid = 0;
2621 const GRFFile *grf = rti->grffile[ROTSG_GROUND];
2622 if (grf != nullptr) {
2623 grfid = grf->grfid;
2624 grfs.emplace(grfid, grf);
2626 IConsolePrint(CC_DEFAULT, " {:02d} {} {}, Flags: {}{}{}{}{}, GRF: {:08X}, {}",
2627 (uint)rt,
2628 RoadTypeIsTram(rt) ? "Tram" : "Road",
2629 FormatLabel(rti->label),
2630 HasBit(rti->flags, ROTF_CATENARY) ? 'c' : '-',
2631 HasBit(rti->flags, ROTF_NO_LEVEL_CROSSING) ? 'l' : '-',
2632 HasBit(rti->flags, ROTF_NO_HOUSES) ? 'X' : '-',
2633 HasBit(rti->flags, ROTF_HIDDEN) ? 'h' : '-',
2634 HasBit(rti->flags, ROTF_TOWN_BUILD) ? 'T' : '-',
2635 BSWAP32(grfid),
2636 GetStringPtr(rti->strings.name)
2639 for (const auto &grf : grfs) {
2640 IConsolePrint(CC_DEFAULT, " GRF: {:08X} = {}", BSWAP32(grf.first), grf.second->filename);
2644 static void ConDumpRailTypes()
2646 IConsolePrint(CC_DEFAULT, " Flags:");
2647 IConsolePrint(CC_DEFAULT, " c = catenary");
2648 IConsolePrint(CC_DEFAULT, " l = no level crossings");
2649 IConsolePrint(CC_DEFAULT, " h = hidden");
2650 IConsolePrint(CC_DEFAULT, " s = no sprite combine");
2651 IConsolePrint(CC_DEFAULT, " a = always allow 90 degree turns");
2652 IConsolePrint(CC_DEFAULT, " d = always disallow 90 degree turns");
2654 std::map<uint32_t, const GRFFile *> grfs;
2655 for (RailType rt = RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) {
2656 const RailTypeInfo *rti = GetRailTypeInfo(rt);
2657 if (rti->label == 0) continue;
2658 uint32_t grfid = 0;
2659 const GRFFile *grf = rti->grffile[RTSG_GROUND];
2660 if (grf != nullptr) {
2661 grfid = grf->grfid;
2662 grfs.emplace(grfid, grf);
2664 IConsolePrint(CC_DEFAULT, " {:02d} {}, Flags: {}{}{}{}{}{}, GRF: {:08X}, {}",
2665 (uint)rt,
2666 FormatLabel(rti->label),
2667 HasBit(rti->flags, RTF_CATENARY) ? 'c' : '-',
2668 HasBit(rti->flags, RTF_NO_LEVEL_CROSSING) ? 'l' : '-',
2669 HasBit(rti->flags, RTF_HIDDEN) ? 'h' : '-',
2670 HasBit(rti->flags, RTF_NO_SPRITE_COMBINE) ? 's' : '-',
2671 HasBit(rti->flags, RTF_ALLOW_90DEG) ? 'a' : '-',
2672 HasBit(rti->flags, RTF_DISALLOW_90DEG) ? 'd' : '-',
2673 BSWAP32(grfid),
2674 GetStringPtr(rti->strings.name)
2677 for (const auto &grf : grfs) {
2678 IConsolePrint(CC_DEFAULT, " GRF: {:08X} = {}", BSWAP32(grf.first), grf.second->filename);
2682 static void ConDumpCargoTypes()
2684 IConsolePrint(CC_DEFAULT, " Cargo classes:");
2685 IConsolePrint(CC_DEFAULT, " p = passenger");
2686 IConsolePrint(CC_DEFAULT, " m = mail");
2687 IConsolePrint(CC_DEFAULT, " x = express");
2688 IConsolePrint(CC_DEFAULT, " a = armoured");
2689 IConsolePrint(CC_DEFAULT, " b = bulk");
2690 IConsolePrint(CC_DEFAULT, " g = piece goods");
2691 IConsolePrint(CC_DEFAULT, " l = liquid");
2692 IConsolePrint(CC_DEFAULT, " r = refrigerated");
2693 IConsolePrint(CC_DEFAULT, " h = hazardous");
2694 IConsolePrint(CC_DEFAULT, " c = covered/sheltered");
2695 IConsolePrint(CC_DEFAULT, " S = special");
2697 std::map<uint32_t, const GRFFile *> grfs;
2698 for (const CargoSpec *spec : CargoSpec::Iterate()) {
2699 if (!spec->IsValid()) continue;
2700 uint32_t grfid = 0;
2701 const GRFFile *grf = spec->grffile;
2702 if (grf != nullptr) {
2703 grfid = grf->grfid;
2704 grfs.emplace(grfid, grf);
2706 IConsolePrint(CC_DEFAULT, " {:02d} Bit: {:2d}, Label: {}, Callback mask: 0x{:02X}, Cargo class: {}{}{}{}{}{}{}{}{}{}{}, GRF: {:08X}, {}",
2707 spec->Index(),
2708 spec->bitnum,
2709 FormatLabel(spec->label.base()),
2710 spec->callback_mask,
2711 (spec->classes & CC_PASSENGERS) != 0 ? 'p' : '-',
2712 (spec->classes & CC_MAIL) != 0 ? 'm' : '-',
2713 (spec->classes & CC_EXPRESS) != 0 ? 'x' : '-',
2714 (spec->classes & CC_ARMOURED) != 0 ? 'a' : '-',
2715 (spec->classes & CC_BULK) != 0 ? 'b' : '-',
2716 (spec->classes & CC_PIECE_GOODS) != 0 ? 'g' : '-',
2717 (spec->classes & CC_LIQUID) != 0 ? 'l' : '-',
2718 (spec->classes & CC_REFRIGERATED) != 0 ? 'r' : '-',
2719 (spec->classes & CC_HAZARDOUS) != 0 ? 'h' : '-',
2720 (spec->classes & CC_COVERED) != 0 ? 'c' : '-',
2721 (spec->classes & CC_SPECIAL) != 0 ? 'S' : '-',
2722 BSWAP32(grfid),
2723 GetStringPtr(spec->name)
2726 for (const auto &grf : grfs) {
2727 IConsolePrint(CC_DEFAULT, " GRF: {:08X} = {}", BSWAP32(grf.first), grf.second->filename);
2732 DEF_CONSOLE_CMD(ConDumpInfo)
2734 if (argc != 2) {
2735 IConsolePrint(CC_HELP, "Dump debugging information.");
2736 IConsolePrint(CC_HELP, "Usage: 'dump_info roadtypes|railtypes|cargotypes'.");
2737 IConsolePrint(CC_HELP, " Show information about road/tram types, rail types or cargo types.");
2738 return true;
2741 if (StrEqualsIgnoreCase(argv[1], "roadtypes")) {
2742 ConDumpRoadTypes();
2743 return true;
2746 if (StrEqualsIgnoreCase(argv[1], "railtypes")) {
2747 ConDumpRailTypes();
2748 return true;
2751 if (StrEqualsIgnoreCase(argv[1], "cargotypes")) {
2752 ConDumpCargoTypes();
2753 return true;
2756 return false;
2759 /*******************************
2760 * console command registration
2761 *******************************/
2763 void IConsoleStdLibRegister()
2765 IConsole::CmdRegister("debug_level", ConDebugLevel);
2766 IConsole::CmdRegister("echo", ConEcho);
2767 IConsole::CmdRegister("echoc", ConEchoC);
2768 IConsole::CmdRegister("exec", ConExec);
2769 IConsole::CmdRegister("schedule", ConSchedule);
2770 IConsole::CmdRegister("exit", ConExit);
2771 IConsole::CmdRegister("part", ConPart);
2772 IConsole::CmdRegister("help", ConHelp);
2773 IConsole::CmdRegister("info_cmd", ConInfoCmd);
2774 IConsole::CmdRegister("list_cmds", ConListCommands);
2775 IConsole::CmdRegister("list_aliases", ConListAliases);
2776 IConsole::CmdRegister("newgame", ConNewGame);
2777 IConsole::CmdRegister("restart", ConRestart);
2778 IConsole::CmdRegister("reload", ConReload);
2779 IConsole::CmdRegister("getseed", ConGetSeed);
2780 IConsole::CmdRegister("getdate", ConGetDate);
2781 IConsole::CmdRegister("getsysdate", ConGetSysDate);
2782 IConsole::CmdRegister("quit", ConExit);
2783 IConsole::CmdRegister("resetengines", ConResetEngines, ConHookNoNetwork);
2784 IConsole::CmdRegister("reset_enginepool", ConResetEnginePool, ConHookNoNetwork);
2785 IConsole::CmdRegister("return", ConReturn);
2786 IConsole::CmdRegister("screenshot", ConScreenShot);
2787 IConsole::CmdRegister("script", ConScript);
2788 IConsole::CmdRegister("zoomto", ConZoomToLevel);
2789 IConsole::CmdRegister("scrollto", ConScrollToTile);
2790 IConsole::CmdRegister("alias", ConAlias);
2791 IConsole::CmdRegister("load", ConLoad);
2792 IConsole::CmdRegister("load_save", ConLoad);
2793 IConsole::CmdRegister("load_scenario", ConLoadScenario);
2794 IConsole::CmdRegister("load_heightmap", ConLoadHeightmap);
2795 IConsole::CmdRegister("rm", ConRemove);
2796 IConsole::CmdRegister("save", ConSave);
2797 IConsole::CmdRegister("saveconfig", ConSaveConfig);
2798 IConsole::CmdRegister("ls", ConListFiles);
2799 IConsole::CmdRegister("list_saves", ConListFiles);
2800 IConsole::CmdRegister("list_scenarios", ConListScenarios);
2801 IConsole::CmdRegister("list_heightmaps", ConListHeightmaps);
2802 IConsole::CmdRegister("cd", ConChangeDirectory);
2803 IConsole::CmdRegister("pwd", ConPrintWorkingDirectory);
2804 IConsole::CmdRegister("clear", ConClearBuffer);
2805 IConsole::CmdRegister("font", ConFont);
2806 IConsole::CmdRegister("setting", ConSetting);
2807 IConsole::CmdRegister("setting_newgame", ConSettingNewgame);
2808 IConsole::CmdRegister("list_settings", ConListSettings);
2809 IConsole::CmdRegister("gamelog", ConGamelogPrint);
2810 IConsole::CmdRegister("rescan_newgrf", ConRescanNewGRF);
2811 IConsole::CmdRegister("list_dirs", ConListDirs);
2813 IConsole::AliasRegister("dir", "ls");
2814 IConsole::AliasRegister("del", "rm %+");
2815 IConsole::AliasRegister("newmap", "newgame");
2816 IConsole::AliasRegister("patch", "setting %+");
2817 IConsole::AliasRegister("set", "setting %+");
2818 IConsole::AliasRegister("set_newgame", "setting_newgame %+");
2819 IConsole::AliasRegister("list_patches", "list_settings %+");
2820 IConsole::AliasRegister("developer", "setting developer %+");
2822 IConsole::CmdRegister("list_ai_libs", ConListAILibs);
2823 IConsole::CmdRegister("list_ai", ConListAI);
2824 IConsole::CmdRegister("reload_ai", ConReloadAI);
2825 IConsole::CmdRegister("rescan_ai", ConRescanAI);
2826 IConsole::CmdRegister("start_ai", ConStartAI);
2827 IConsole::CmdRegister("stop_ai", ConStopAI);
2829 IConsole::CmdRegister("list_game", ConListGame);
2830 IConsole::CmdRegister("list_game_libs", ConListGameLibs);
2831 IConsole::CmdRegister("rescan_game", ConRescanGame);
2833 IConsole::CmdRegister("companies", ConCompanies);
2834 IConsole::AliasRegister("players", "companies");
2836 /* networking functions */
2838 /* Content downloading is only available with ZLIB */
2839 #if defined(WITH_ZLIB)
2840 IConsole::CmdRegister("content", ConContent);
2841 #endif /* defined(WITH_ZLIB) */
2843 /*** Networking commands ***/
2844 IConsole::CmdRegister("say", ConSay, ConHookNeedNetwork);
2845 IConsole::CmdRegister("say_company", ConSayCompany, ConHookNeedNetwork);
2846 IConsole::AliasRegister("say_player", "say_company %+");
2847 IConsole::CmdRegister("say_client", ConSayClient, ConHookNeedNetwork);
2849 IConsole::CmdRegister("connect", ConNetworkConnect, ConHookClientOnly);
2850 IConsole::CmdRegister("clients", ConNetworkClients, ConHookNeedNetwork);
2851 IConsole::CmdRegister("status", ConStatus, ConHookServerOnly);
2852 IConsole::CmdRegister("server_info", ConServerInfo, ConHookServerOnly);
2853 IConsole::AliasRegister("info", "server_info");
2854 IConsole::CmdRegister("reconnect", ConNetworkReconnect, ConHookClientOnly);
2855 IConsole::CmdRegister("rcon", ConRcon, ConHookNeedNetwork);
2857 IConsole::CmdRegister("join", ConJoinCompany, ConHookNeedNonDedicatedNetwork);
2858 IConsole::AliasRegister("spectate", "join 255");
2859 IConsole::CmdRegister("move", ConMoveClient, ConHookServerOnly);
2860 IConsole::CmdRegister("reset_company", ConResetCompany, ConHookServerOnly);
2861 IConsole::AliasRegister("clean_company", "reset_company %A");
2862 IConsole::CmdRegister("client_name", ConClientNickChange, ConHookServerOnly);
2863 IConsole::CmdRegister("kick", ConKick, ConHookServerOnly);
2864 IConsole::CmdRegister("ban", ConBan, ConHookServerOnly);
2865 IConsole::CmdRegister("unban", ConUnBan, ConHookServerOnly);
2866 IConsole::CmdRegister("banlist", ConBanList, ConHookServerOnly);
2868 IConsole::CmdRegister("pause", ConPauseGame, ConHookServerOrNoNetwork);
2869 IConsole::CmdRegister("unpause", ConUnpauseGame, ConHookServerOrNoNetwork);
2871 IConsole::CmdRegister("authorized_key", ConNetworkAuthorizedKey, ConHookServerOnly);
2872 IConsole::AliasRegister("ak", "authorized_key %+");
2874 IConsole::AliasRegister("net_frame_freq", "setting frame_freq %+");
2875 IConsole::AliasRegister("net_sync_freq", "setting sync_freq %+");
2876 IConsole::AliasRegister("server_pw", "setting server_password %+");
2877 IConsole::AliasRegister("server_password", "setting server_password %+");
2878 IConsole::AliasRegister("rcon_pw", "setting rcon_password %+");
2879 IConsole::AliasRegister("rcon_password", "setting rcon_password %+");
2880 IConsole::AliasRegister("name", "setting client_name %+");
2881 IConsole::AliasRegister("server_name", "setting server_name %+");
2882 IConsole::AliasRegister("server_port", "setting server_port %+");
2883 IConsole::AliasRegister("max_clients", "setting max_clients %+");
2884 IConsole::AliasRegister("max_companies", "setting max_companies %+");
2885 IConsole::AliasRegister("max_join_time", "setting max_join_time %+");
2886 IConsole::AliasRegister("pause_on_join", "setting pause_on_join %+");
2887 IConsole::AliasRegister("autoclean_companies", "setting autoclean_companies %+");
2888 IConsole::AliasRegister("autoclean_protected", "setting autoclean_protected %+");
2889 IConsole::AliasRegister("restart_game_year", "setting restart_game_year %+");
2890 IConsole::AliasRegister("min_players", "setting min_active_clients %+");
2891 IConsole::AliasRegister("reload_cfg", "setting reload_cfg %+");
2893 /* debugging stuff */
2894 #ifdef _DEBUG
2895 IConsoleDebugLibRegister();
2896 #endif
2897 IConsole::CmdRegister("fps", ConFramerate);
2898 IConsole::CmdRegister("fps_wnd", ConFramerateWindow);
2900 /* NewGRF development stuff */
2901 IConsole::CmdRegister("reload_newgrfs", ConNewGRFReload, ConHookNewGRFDeveloperTool);
2902 IConsole::CmdRegister("newgrf_profile", ConNewGRFProfile, ConHookNewGRFDeveloperTool);
2904 IConsole::CmdRegister("dump_info", ConDumpInfo);