4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
10 /** @file console_cmds.cpp Implementation of the console hooks. */
13 #include "console_internal.h"
15 #include "engine_func.h"
16 #include "landscape.h"
17 #include "saveload/saveload.h"
18 #include "network/network.h"
19 #include "network/network_func.h"
20 #include "network/network_base.h"
21 #include "network/network_admin.h"
22 #include "network/network_client.h"
23 #include "command_func.h"
24 #include "settings_func.h"
26 #include "fileio_func.h"
27 #include "screenshot.h"
29 #include "strings_func.h"
30 #include "viewport_func.h"
31 #include "window_func.h"
32 #include "date_func.h"
33 #include "company_func.h"
36 #include "ai/ai_config.hpp"
38 #include "console_func.h"
39 #include "engine_base.h"
40 #include "game/game.hpp"
41 #include "table/strings.h"
43 #include "safeguards.h"
45 /* scriptfile handling */
46 static bool _script_running
; ///< Script is running (used to abort execution when #ConReturn is encountered).
48 /** File list storage for the console, for caching the last 'ls' command. */
49 class ConsoleFileList
: public FileList
{
51 ConsoleFileList() : FileList()
53 this->file_list_valid
= false;
56 /** Declare the file storage cache as being invalid, also clears all stored files. */
57 void InvalidateFileList()
60 this->file_list_valid
= false;
64 * (Re-)validate the file storage cache. Only makes a change if the storage was invalid, or if \a force_reload.
65 * @param Always reload the file storage cache.
67 void ValidateFileList(bool force_reload
= false)
69 if (force_reload
|| !this->file_list_valid
) {
70 this->BuildFileList(FT_SAVEGAME
, SLO_LOAD
);
71 this->file_list_valid
= true;
75 bool file_list_valid
; ///< If set, the file list is valid.
78 static ConsoleFileList _console_file_list
; ///< File storage cache for the console.
80 /* console command defines */
81 #define DEF_CONSOLE_CMD(function) static bool function(byte argc, char *argv[])
82 #define DEF_CONSOLE_HOOK(function) static ConsoleHookResult function(bool echo)
92 * Check network availability and inform in console about failure of detection.
93 * @return Network availability.
95 static inline bool NetworkAvailable(bool echo
)
97 if (!_network_available
) {
98 if (echo
) IConsoleError("You cannot use this command because there is no network available.");
105 * Check whether we are a server.
106 * @return Are we a server? True when yes, false otherwise.
108 DEF_CONSOLE_HOOK(ConHookServerOnly
)
110 if (!NetworkAvailable(echo
)) return CHR_DISALLOW
;
112 if (!_network_server
) {
113 if (echo
) IConsoleError("This command is only available to a network server.");
120 * Check whether we are a client in a network game.
121 * @return Are we a client in a network game? True when yes, false otherwise.
123 DEF_CONSOLE_HOOK(ConHookClientOnly
)
125 if (!NetworkAvailable(echo
)) return CHR_DISALLOW
;
127 if (_network_server
) {
128 if (echo
) IConsoleError("This command is not available to a network server.");
135 * Check whether we are in a multiplayer game.
136 * @return True when we are client or server in a network game.
138 DEF_CONSOLE_HOOK(ConHookNeedNetwork
)
140 if (!NetworkAvailable(echo
)) return CHR_DISALLOW
;
142 if (!_networking
|| (!_network_server
&& !MyClient::IsConnected())) {
143 if (echo
) IConsoleError("Not connected. This command is only available in multiplayer.");
150 * Check whether we are in single player mode.
151 * @return True when no network is active.
153 DEF_CONSOLE_HOOK(ConHookNoNetwork
)
156 if (echo
) IConsoleError("This command is forbidden in multiplayer.");
163 # define ConHookNoNetwork NULL
164 #endif /* ENABLE_NETWORK */
166 DEF_CONSOLE_HOOK(ConHookNewGRFDeveloperTool
)
168 if (_settings_client
.gui
.newgrf_developer_tools
) {
169 if (_game_mode
== GM_MENU
) {
170 if (echo
) IConsoleError("This command is only available in game and editor.");
173 #ifdef ENABLE_NETWORK
174 return ConHookNoNetwork(echo
);
183 * Show help for the console.
184 * @param str String to print in the console.
186 static void IConsoleHelp(const char *str
)
188 IConsolePrintF(CC_WARNING
, "- %s", str
);
192 * Reset status of all engines.
193 * @return Will always succeed.
195 DEF_CONSOLE_CMD(ConResetEngines
)
198 IConsoleHelp("Reset status data of all engines. This might solve some issues with 'lost' engines. Usage: 'resetengines'");
207 * Reset status of the engine pool.
208 * @return Will always return true.
209 * @note Resetting the pool only succeeds when there are no vehicles ingame.
211 DEF_CONSOLE_CMD(ConResetEnginePool
)
214 IConsoleHelp("Reset NewGRF allocations of engine slots. This will remove invalid engine definitions, and might make default engines available again.");
218 if (_game_mode
== GM_MENU
) {
219 IConsoleError("This command is only available in game and editor.");
223 if (!EngineOverrideManager::ResetToCurrentNewGRFConfig()) {
224 IConsoleError("This can only be done when there are no vehicles in the game.");
233 * Reset a tile to bare land in debug mode.
235 * @return True when the tile is reset or the help on usage was printed (0 or two parameters).
237 DEF_CONSOLE_CMD(ConResetTile
)
240 IConsoleHelp("Reset a tile to bare land. Usage: 'resettile <tile>'");
241 IConsoleHelp("Tile can be either decimal (34161) or hexadecimal (0x4a5B)");
247 if (GetArgumentInteger(&result
, argv
[1])) {
248 DoClearSquare((TileIndex
)result
);
258 * Scroll to a tile on the map.
259 * @param arg1 tile tile number or tile x coordinate.
260 * @param arg2 optionally tile y coordinate.
261 * @note When only one argument is given it is intepreted as the tile number.
262 * When two arguments are given, they are interpreted as the tile's x
264 * @return True when either console help was shown or a proper amount of parameters given.
266 DEF_CONSOLE_CMD(ConScrollToTile
)
270 IConsoleHelp("Center the screen on a given tile.");
271 IConsoleHelp("Usage: 'scrollto <tile>' or 'scrollto <x> <y>'");
272 IConsoleHelp("Numbers can be either decimal (34161) or hexadecimal (0x4a5B).");
277 if (GetArgumentInteger(&result
, argv
[1])) {
278 if (result
>= MapSize()) {
279 IConsolePrint(CC_ERROR
, "Tile does not exist");
282 ScrollMainWindowToTile((TileIndex
)result
);
290 if (GetArgumentInteger(&x
, argv
[1]) && GetArgumentInteger(&y
, argv
[2])) {
291 if (x
>= MapSizeX() || y
>= MapSizeY()) {
292 IConsolePrint(CC_ERROR
, "Tile does not exist");
295 ScrollMainWindowToTile(TileXY(x
, y
));
306 * Save the map to a file.
307 * @param filename the filename to save the map to.
308 * @return True when help was displayed or the file attempted to be saved.
310 DEF_CONSOLE_CMD(ConSave
)
313 IConsoleHelp("Save the current game. Usage: 'save <filename>'");
318 char *filename
= str_fmt("%s.sav", argv
[1]);
319 IConsolePrint(CC_DEFAULT
, "Saving map...");
321 if (SaveOrLoad(filename
, SLO_SAVE
, DFT_GAME_FILE
, SAVE_DIR
) != SL_OK
) {
322 IConsolePrint(CC_ERROR
, "Saving map failed");
324 IConsolePrintF(CC_DEFAULT
, "Map successfully saved to %s", filename
);
334 * Explicitly save the configuration.
337 DEF_CONSOLE_CMD(ConSaveConfig
)
340 IConsoleHelp("Saves the configuration for new games to the configuration file, typically 'openttd.cfg'.");
341 IConsoleHelp("It does not save the configuration of the current game to the configuration file.");
346 IConsolePrint(CC_DEFAULT
, "Saved config.");
350 DEF_CONSOLE_CMD(ConLoad
)
353 IConsoleHelp("Load a game by name or index. Usage: 'load <file | number>'");
357 if (argc
!= 2) return false;
359 const char *file
= argv
[1];
360 _console_file_list
.ValidateFileList();
361 const FiosItem
*item
= _console_file_list
.FindItem(file
);
363 if (GetAbstractFileType(item
->type
) == FT_SAVEGAME
) {
364 _switch_mode
= SM_LOAD_GAME
;
365 _file_to_saveload
.SetMode(item
->type
);
366 _file_to_saveload
.SetName(FiosBrowseTo(item
));
367 _file_to_saveload
.SetTitle(item
->title
);
369 IConsolePrintF(CC_ERROR
, "%s: Not a savegame.", file
);
372 IConsolePrintF(CC_ERROR
, "%s: No such file or directory.", file
);
379 DEF_CONSOLE_CMD(ConRemove
)
382 IConsoleHelp("Remove a savegame by name or index. Usage: 'rm <file | number>'");
386 if (argc
!= 2) return false;
388 const char *file
= argv
[1];
389 _console_file_list
.ValidateFileList();
390 const FiosItem
*item
= _console_file_list
.FindItem(file
);
392 if (!FiosDelete(item
->name
)) {
393 IConsolePrintF(CC_ERROR
, "%s: Failed to delete file", file
);
396 IConsolePrintF(CC_ERROR
, "%s: No such file or directory.", file
);
399 _console_file_list
.InvalidateFileList();
404 /* List all the files in the current dir via console */
405 DEF_CONSOLE_CMD(ConListFiles
)
408 IConsoleHelp("List all loadable savegames and directories in the current dir via console. Usage: 'ls | dir'");
412 _console_file_list
.ValidateFileList(true);
413 for (uint i
= 0; i
< _console_file_list
.Length(); i
++) {
414 IConsolePrintF(CC_DEFAULT
, "%d) %s", i
, _console_file_list
[i
].title
);
420 /* Change the dir via console */
421 DEF_CONSOLE_CMD(ConChangeDirectory
)
424 IConsoleHelp("Change the dir via console. Usage: 'cd <directory | number>'");
428 if (argc
!= 2) return false;
430 const char *file
= argv
[1];
431 _console_file_list
.ValidateFileList(true);
432 const FiosItem
*item
= _console_file_list
.FindItem(file
);
434 switch (item
->type
) {
435 case FIOS_TYPE_DIR
: case FIOS_TYPE_DRIVE
: case FIOS_TYPE_PARENT
:
438 default: IConsolePrintF(CC_ERROR
, "%s: Not a directory.", file
);
441 IConsolePrintF(CC_ERROR
, "%s: No such file or directory.", file
);
444 _console_file_list
.InvalidateFileList();
448 DEF_CONSOLE_CMD(ConPrintWorkingDirectory
)
453 IConsoleHelp("Print out the current working directory. Usage: 'pwd'");
457 /* XXX - Workaround for broken file handling */
458 _console_file_list
.ValidateFileList(true);
459 _console_file_list
.InvalidateFileList();
461 FiosGetDescText(&path
, NULL
);
462 IConsolePrint(CC_DEFAULT
, path
);
466 DEF_CONSOLE_CMD(ConClearBuffer
)
469 IConsoleHelp("Clear the console buffer. Usage: 'clear'");
473 IConsoleClearBuffer();
474 SetWindowDirty(WC_CONSOLE
, 0);
479 /**********************************
480 * Network Core Console Commands
481 **********************************/
482 #ifdef ENABLE_NETWORK
484 static bool ConKickOrBan(const char *argv
, bool ban
)
488 if (strchr(argv
, '.') == NULL
&& strchr(argv
, ':') == NULL
) { // banning with ID
489 ClientID client_id
= (ClientID
)atoi(argv
);
491 /* Don't kill the server, or the client doing the rcon. The latter can't be kicked because
492 * kicking frees closes and subsequently free the connection related instances, which we
493 * would be reading from and writing to after returning. So we would read or write data
494 * from freed memory up till the segfault triggers. */
495 if (client_id
== CLIENT_ID_SERVER
|| client_id
== _redirect_console_to_client
) {
496 IConsolePrintF(CC_ERROR
, "ERROR: Silly boy, you can not %s yourself!", ban
? "ban" : "kick");
500 NetworkClientInfo
*ci
= NetworkClientInfo::GetByClientID(client_id
);
502 IConsoleError("Invalid client");
507 /* Kick only this client, not all clients with that IP */
508 NetworkServerKickClient(client_id
);
512 /* When banning, kick+ban all clients with that IP */
513 n
= NetworkServerKickOrBanIP(client_id
, ban
);
515 n
= NetworkServerKickOrBanIP(argv
, ban
);
519 IConsolePrint(CC_DEFAULT
, ban
? "Client not online, address added to banlist" : "Client not found");
521 IConsolePrintF(CC_DEFAULT
, "%sed %u client(s)", ban
? "Bann" : "Kick", n
);
527 DEF_CONSOLE_CMD(ConKick
)
530 IConsoleHelp("Kick a client from a network game. Usage: 'kick <ip | client-id>'");
531 IConsoleHelp("For client-id's, see the command 'clients'");
535 if (argc
!= 2) return false;
537 return ConKickOrBan(argv
[1], false);
540 DEF_CONSOLE_CMD(ConBan
)
543 IConsoleHelp("Ban a client from a network game. Usage: 'ban <ip | client-id>'");
544 IConsoleHelp("For client-id's, see the command 'clients'");
545 IConsoleHelp("If the client is no longer online, you can still ban his/her IP");
549 if (argc
!= 2) return false;
551 return ConKickOrBan(argv
[1], true);
554 DEF_CONSOLE_CMD(ConUnBan
)
558 IConsoleHelp("Unban a client from a network game. Usage: 'unban <ip | client-id>'");
559 IConsoleHelp("For a list of banned IP's, see the command 'banlist'");
563 if (argc
!= 2) return false;
565 uint index
= (strchr(argv
[1], '.') == NULL
) ? atoi(argv
[1]) : 0;
569 for (char **iter
= _network_ban_list
.Begin(); iter
!= _network_ban_list
.End(); iter
++, i
++) {
570 if (strcmp(_network_ban_list
[i
], argv
[1]) == 0 || index
== i
) {
571 free(_network_ban_list
[i
]);
572 _network_ban_list
.Erase(iter
);
573 IConsolePrint(CC_DEFAULT
, "IP unbanned.");
578 IConsolePrint(CC_DEFAULT
, "IP not in ban-list.");
582 DEF_CONSOLE_CMD(ConBanList
)
585 IConsoleHelp("List the IP's of banned clients: Usage 'banlist'");
589 IConsolePrint(CC_DEFAULT
, "Banlist: ");
592 for (char **iter
= _network_ban_list
.Begin(); iter
!= _network_ban_list
.End(); iter
++, i
++) {
593 IConsolePrintF(CC_DEFAULT
, " %d) %s", i
, *iter
);
599 DEF_CONSOLE_CMD(ConPauseGame
)
602 IConsoleHelp("Pause a network game. Usage: 'pause'");
606 if ((_pause_mode
& PM_PAUSED_NORMAL
) == PM_UNPAUSED
) {
607 DoCommandP(0, PM_PAUSED_NORMAL
, 1, CMD_PAUSE
);
608 if (!_networking
) IConsolePrint(CC_DEFAULT
, "Game paused.");
610 IConsolePrint(CC_DEFAULT
, "Game is already paused.");
616 DEF_CONSOLE_CMD(ConUnpauseGame
)
619 IConsoleHelp("Unpause a network game. Usage: 'unpause'");
623 if ((_pause_mode
& PM_PAUSED_NORMAL
) != PM_UNPAUSED
) {
624 DoCommandP(0, PM_PAUSED_NORMAL
, 0, CMD_PAUSE
);
625 if (!_networking
) IConsolePrint(CC_DEFAULT
, "Game unpaused.");
626 } else if ((_pause_mode
& PM_PAUSED_ERROR
) != PM_UNPAUSED
) {
627 IConsolePrint(CC_DEFAULT
, "Game is in error state and cannot be unpaused via console.");
628 } else if (_pause_mode
!= PM_UNPAUSED
) {
629 IConsolePrint(CC_DEFAULT
, "Game cannot be unpaused manually; disable pause_on_join/min_active_clients.");
631 IConsolePrint(CC_DEFAULT
, "Game is already unpaused.");
637 DEF_CONSOLE_CMD(ConRcon
)
640 IConsoleHelp("Remote control the server from another client. Usage: 'rcon <password> <command>'");
641 IConsoleHelp("Remember to enclose the command in quotes, otherwise only the first parameter is sent");
645 if (argc
< 3) return false;
647 if (_network_server
) {
648 IConsoleCmdExec(argv
[2]);
650 NetworkClientSendRcon(argv
[1], argv
[2]);
655 DEF_CONSOLE_CMD(ConStatus
)
658 IConsoleHelp("List the status of all clients connected to the server. Usage 'status'");
662 NetworkServerShowStatusToConsole();
666 DEF_CONSOLE_CMD(ConServerInfo
)
669 IConsoleHelp("List current and maximum client/company limits. Usage 'server_info'");
670 IConsoleHelp("You can change these values by modifying settings 'network.max_clients', 'network.max_companies' and 'network.max_spectators'");
674 IConsolePrintF(CC_DEFAULT
, "Current/maximum clients: %2d/%2d", _network_game_info
.clients_on
, _settings_client
.network
.max_clients
);
675 IConsolePrintF(CC_DEFAULT
, "Current/maximum companies: %2d/%2d", (int)Company::GetNumItems(), _settings_client
.network
.max_companies
);
676 IConsolePrintF(CC_DEFAULT
, "Current/maximum spectators: %2d/%2d", NetworkSpectatorCount(), _settings_client
.network
.max_spectators
);
681 DEF_CONSOLE_CMD(ConClientNickChange
)
684 IConsoleHelp("Change the nickname of a connected client. Usage: 'client_name <client-id> <new-name>'");
685 IConsoleHelp("For client-id's, see the command 'clients'");
689 ClientID client_id
= (ClientID
)atoi(argv
[1]);
691 if (client_id
== CLIENT_ID_SERVER
) {
692 IConsoleError("Please use the command 'name' to change your own name!");
696 if (NetworkClientInfo::GetByClientID(client_id
) == NULL
) {
697 IConsoleError("Invalid client");
701 if (!NetworkServerChangeClientName(client_id
, argv
[2])) {
702 IConsoleError("Cannot give a client a duplicate name");
708 DEF_CONSOLE_CMD(ConJoinCompany
)
711 IConsoleHelp("Request joining another company. Usage: join <company-id> [<password>]");
712 IConsoleHelp("For valid company-id see company list, use 255 for spectator");
716 CompanyID company_id
= (CompanyID
)(atoi(argv
[1]) <= MAX_COMPANIES
? atoi(argv
[1]) - 1 : atoi(argv
[1]));
718 /* Check we have a valid company id! */
719 if (!Company::IsValidID(company_id
) && company_id
!= COMPANY_SPECTATOR
) {
720 IConsolePrintF(CC_ERROR
, "Company does not exist. Company-id must be between 1 and %d.", MAX_COMPANIES
);
724 if (NetworkClientInfo::GetByClientID(_network_own_client_id
)->client_playas
== company_id
) {
725 IConsoleError("You are already there!");
729 if (company_id
== COMPANY_SPECTATOR
&& NetworkMaxSpectatorsReached()) {
730 IConsoleError("Cannot join spectators, maximum number of spectators reached.");
734 if (company_id
!= COMPANY_SPECTATOR
&& !Company::IsHumanID(company_id
)) {
735 IConsoleError("Cannot join AI company.");
739 /* Check if the company requires a password */
740 if (NetworkCompanyIsPassworded(company_id
) && argc
< 3) {
741 IConsolePrintF(CC_ERROR
, "Company %d requires a password to join.", company_id
+ 1);
745 /* non-dedicated server may just do the move! */
746 if (_network_server
) {
747 NetworkServerDoMove(CLIENT_ID_SERVER
, company_id
);
749 NetworkClientRequestMove(company_id
, NetworkCompanyIsPassworded(company_id
) ? argv
[2] : "");
755 DEF_CONSOLE_CMD(ConMoveClient
)
758 IConsoleHelp("Move a client to another company. Usage: move <client-id> <company-id>");
759 IConsoleHelp("For valid client-id see 'clients', for valid company-id see 'companies', use 255 for moving to spectators");
763 const NetworkClientInfo
*ci
= NetworkClientInfo::GetByClientID((ClientID
)atoi(argv
[1]));
764 CompanyID company_id
= (CompanyID
)(atoi(argv
[2]) <= MAX_COMPANIES
? atoi(argv
[2]) - 1 : atoi(argv
[2]));
766 /* check the client exists */
768 IConsoleError("Invalid client-id, check the command 'clients' for valid client-id's.");
772 if (!Company::IsValidID(company_id
) && company_id
!= COMPANY_SPECTATOR
) {
773 IConsolePrintF(CC_ERROR
, "Company does not exist. Company-id must be between 1 and %d.", MAX_COMPANIES
);
777 if (company_id
!= COMPANY_SPECTATOR
&& !Company::IsHumanID(company_id
)) {
778 IConsoleError("You cannot move clients to AI companies.");
782 if (ci
->client_id
== CLIENT_ID_SERVER
&& _network_dedicated
) {
783 IConsoleError("Silly boy, you cannot move the server!");
787 if (ci
->client_playas
== company_id
) {
788 IConsoleError("You cannot move someone to where he/she already is!");
792 /* we are the server, so force the update */
793 NetworkServerDoMove(ci
->client_id
, company_id
);
798 DEF_CONSOLE_CMD(ConResetCompany
)
801 IConsoleHelp("Remove an idle company from the game. Usage: 'reset_company <company-id>'");
802 IConsoleHelp("For company-id's, see the list of companies from the dropdown menu. Company 1 is 1, etc.");
806 if (argc
!= 2) return false;
808 CompanyID index
= (CompanyID
)(atoi(argv
[1]) - 1);
810 /* Check valid range */
811 if (!Company::IsValidID(index
)) {
812 IConsolePrintF(CC_ERROR
, "Company does not exist. Company-id must be between 1 and %d.", MAX_COMPANIES
);
816 if (!Company::IsHumanID(index
)) {
817 IConsoleError("Company is owned by an AI.");
821 if (NetworkCompanyHasClients(index
)) {
822 IConsoleError("Cannot remove company: a client is connected to that company.");
825 const NetworkClientInfo
*ci
= NetworkClientInfo::GetByClientID(CLIENT_ID_SERVER
);
826 if (ci
->client_playas
== index
) {
827 IConsoleError("Cannot remove company: the server is connected to that company.");
831 /* It is safe to remove this company */
832 DoCommandP(0, 2 | index
<< 16, CRR_MANUAL
, CMD_COMPANY_CTRL
);
833 IConsolePrint(CC_DEFAULT
, "Company deleted.");
838 DEF_CONSOLE_CMD(ConNetworkClients
)
841 IConsoleHelp("Get a list of connected clients including their ID, name, company-id, and IP. Usage: 'clients'");
845 NetworkPrintClients();
850 DEF_CONSOLE_CMD(ConNetworkReconnect
)
853 IConsoleHelp("Reconnect to server to which you were connected last time. Usage: 'reconnect [<company>]'");
854 IConsoleHelp("Company 255 is spectator (default, if not specified), 0 means creating new company.");
855 IConsoleHelp("All others are a certain company with Company 1 being #1");
859 CompanyID playas
= (argc
>= 2) ? (CompanyID
)atoi(argv
[1]) : COMPANY_SPECTATOR
;
861 case 0: playas
= COMPANY_NEW_COMPANY
; break;
862 case COMPANY_SPECTATOR
: /* nothing to do */ break;
864 /* From a user pov 0 is a new company, internally it's different and all
865 * companies are offset by one to ease up on users (eg companies 1-8 not 0-7) */
867 if (playas
< COMPANY_FIRST
|| playas
>= MAX_COMPANIES
) return false;
871 if (StrEmpty(_settings_client
.network
.last_host
)) {
872 IConsolePrint(CC_DEFAULT
, "No server for reconnecting.");
876 /* Don't resolve the address first, just print it directly as it comes from the config file. */
877 IConsolePrintF(CC_DEFAULT
, "Reconnecting to %s:%d...", _settings_client
.network
.last_host
, _settings_client
.network
.last_port
);
879 NetworkClientConnectGame(NetworkAddress(_settings_client
.network
.last_host
, _settings_client
.network
.last_port
), playas
);
883 DEF_CONSOLE_CMD(ConNetworkConnect
)
886 IConsoleHelp("Connect to a remote OTTD server and join the game. Usage: 'connect <ip>'");
887 IConsoleHelp("IP can contain port and company: 'IP[:Port][#Company]', eg: 'server.ottd.org:443#2'");
888 IConsoleHelp("Company #255 is spectator all others are a certain company with Company 1 being #1");
892 if (argc
< 2) return false;
893 if (_networking
) NetworkDisconnect(); // we are in network-mode, first close it!
895 const char *port
= NULL
;
896 const char *company
= NULL
;
898 /* Default settings: default port and new company */
899 uint16 rport
= NETWORK_DEFAULT_PORT
;
900 CompanyID join_as
= COMPANY_NEW_COMPANY
;
902 ParseConnectionString(&company
, &port
, ip
);
904 IConsolePrintF(CC_DEFAULT
, "Connecting to %s...", ip
);
905 if (company
!= NULL
) {
906 join_as
= (CompanyID
)atoi(company
);
907 IConsolePrintF(CC_DEFAULT
, " company-no: %d", join_as
);
909 /* From a user pov 0 is a new company, internally it's different and all
910 * companies are offset by one to ease up on users (eg companies 1-8 not 0-7) */
911 if (join_as
!= COMPANY_SPECTATOR
) {
912 if (join_as
> MAX_COMPANIES
) return false;
918 IConsolePrintF(CC_DEFAULT
, " port: %s", port
);
921 NetworkClientConnectGame(NetworkAddress(ip
, rport
), join_as
);
926 #endif /* ENABLE_NETWORK */
928 /*********************************
929 * script file console commands
930 *********************************/
932 DEF_CONSOLE_CMD(ConExec
)
935 IConsoleHelp("Execute a local script file. Usage: 'exec <script> <?>'");
939 if (argc
< 2) return false;
941 FILE *script_file
= FioFOpenFile(argv
[1], "r", BASE_DIR
);
943 if (script_file
== NULL
) {
944 if (argc
== 2 || atoi(argv
[2]) != 0) IConsoleError("script file not found");
948 _script_running
= true;
950 char cmdline
[ICON_CMDLN_SIZE
];
951 while (_script_running
&& fgets(cmdline
, sizeof(cmdline
), script_file
) != NULL
) {
952 /* Remove newline characters from the executing script */
953 for (char *cmdptr
= cmdline
; *cmdptr
!= '\0'; cmdptr
++) {
954 if (*cmdptr
== '\n' || *cmdptr
== '\r') {
959 IConsoleCmdExec(cmdline
);
962 if (ferror(script_file
)) {
963 IConsoleError("Encountered error while trying to read from script file");
966 _script_running
= false;
967 FioFCloseFile(script_file
);
971 DEF_CONSOLE_CMD(ConReturn
)
974 IConsoleHelp("Stop executing a running script. Usage: 'return'");
978 _script_running
= false;
982 /*****************************
983 * default console commands
984 ******************************/
985 extern bool CloseConsoleLogIfActive();
987 DEF_CONSOLE_CMD(ConScript
)
989 extern FILE *_iconsole_output_file
;
992 IConsoleHelp("Start or stop logging console output to a file. Usage: 'script <filename>'");
993 IConsoleHelp("If filename is omitted, a running log is stopped if it is active");
997 if (!CloseConsoleLogIfActive()) {
998 if (argc
< 2) return false;
1000 IConsolePrintF(CC_DEFAULT
, "file output started to: %s", argv
[1]);
1001 _iconsole_output_file
= fopen(argv
[1], "ab");
1002 if (_iconsole_output_file
== NULL
) IConsoleError("could not open file");
1009 DEF_CONSOLE_CMD(ConEcho
)
1012 IConsoleHelp("Print back the first argument to the console. Usage: 'echo <arg>'");
1016 if (argc
< 2) return false;
1017 IConsolePrint(CC_DEFAULT
, argv
[1]);
1021 DEF_CONSOLE_CMD(ConEchoC
)
1024 IConsoleHelp("Print back the first argument to the console in a given colour. Usage: 'echoc <colour> <arg2>'");
1028 if (argc
< 3) return false;
1029 IConsolePrint((TextColour
)Clamp(atoi(argv
[1]), TC_BEGIN
, TC_END
- 1), argv
[2]);
1033 DEF_CONSOLE_CMD(ConNewGame
)
1036 IConsoleHelp("Start a new game. Usage: 'newgame [seed]'");
1037 IConsoleHelp("The server can force a new game using 'newgame'; any client joined will rejoin after the server is done generating the new game.");
1041 StartNewGameWithoutGUI((argc
== 2) ? strtoul(argv
[1], NULL
, 10) : GENERATE_NEW_SEED
);
1045 DEF_CONSOLE_CMD(ConRestart
)
1048 IConsoleHelp("Restart game. Usage: 'restart'");
1049 IConsoleHelp("Restarts a game. It tries to reproduce the exact same map as the game started with.");
1050 IConsoleHelp("However:");
1051 IConsoleHelp(" * restarting games started in another version might create another map due to difference in map generation");
1052 IConsoleHelp(" * restarting games based on scenarios, loaded games or heightmaps will start a new game based on the settings stored in the scenario/savegame");
1056 /* Don't copy the _newgame pointers to the real pointers, so call SwitchToMode directly */
1057 _settings_game
.game_creation
.map_x
= MapLogX();
1058 _settings_game
.game_creation
.map_y
= FindFirstBit(MapSizeY());
1059 _switch_mode
= SM_RESTARTGAME
;
1064 * Print a text buffer line by line to the console. Lines are separated by '\n'.
1065 * @param buf The buffer to print.
1066 * @note All newlines are replace by '\0' characters.
1068 static void PrintLineByLine(char *buf
)
1071 /* Print output line by line */
1072 for (char *p2
= buf
; *p2
!= '\0'; p2
++) {
1075 IConsolePrintF(CC_DEFAULT
, "%s", p
);
1081 DEF_CONSOLE_CMD(ConListAILibs
)
1084 AI::GetConsoleLibraryList(buf
, lastof(buf
));
1086 PrintLineByLine(buf
);
1091 DEF_CONSOLE_CMD(ConListAI
)
1094 AI::GetConsoleList(buf
, lastof(buf
));
1096 PrintLineByLine(buf
);
1101 DEF_CONSOLE_CMD(ConListGameLibs
)
1104 Game::GetConsoleLibraryList(buf
, lastof(buf
));
1106 PrintLineByLine(buf
);
1111 DEF_CONSOLE_CMD(ConListGame
)
1114 Game::GetConsoleList(buf
, lastof(buf
));
1116 PrintLineByLine(buf
);
1121 DEF_CONSOLE_CMD(ConStartAI
)
1123 if (argc
== 0 || argc
> 3) {
1124 IConsoleHelp("Start a new AI. Usage: 'start_ai [<AI>] [<settings>]'");
1125 IConsoleHelp("Start a new AI. If <AI> is given, it starts that specific AI (if found).");
1126 IConsoleHelp("If <settings> is given, it is parsed and the AI settings are set to that.");
1130 if (_game_mode
!= GM_NORMAL
) {
1131 IConsoleWarning("AIs can only be managed in a game.");
1135 if (Company::GetNumItems() == CompanyPool::MAX_SIZE
) {
1136 IConsoleWarning("Can't start a new AI (no more free slots).");
1139 if (_networking
&& !_network_server
) {
1140 IConsoleWarning("Only the server can start a new AI.");
1143 if (_networking
&& !_settings_game
.ai
.ai_in_multiplayer
) {
1144 IConsoleWarning("AIs are not allowed in multiplayer by configuration.");
1145 IConsoleWarning("Switch AI -> AI in multiplayer to True.");
1148 if (!AI::CanStartNew()) {
1149 IConsoleWarning("Can't start a new AI.");
1155 /* Find the next free slot */
1156 FOR_ALL_COMPANIES(c
) {
1157 if (c
->index
!= n
) break;
1161 AIConfig
*config
= AIConfig::GetConfig((CompanyID
)n
);
1163 config
->Change(argv
[1], -1, true);
1164 if (!config
->HasScript()) {
1165 IConsoleWarning("Failed to load the specified AI");
1169 config
->StringToSettings(argv
[2]);
1173 /* Start a new AI company */
1174 DoCommandP(0, 1 | INVALID_COMPANY
<< 16, 0, CMD_COMPANY_CTRL
);
1179 DEF_CONSOLE_CMD(ConReloadAI
)
1182 IConsoleHelp("Reload an AI. Usage: 'reload_ai <company-id>'");
1183 IConsoleHelp("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.");
1187 if (_game_mode
!= GM_NORMAL
) {
1188 IConsoleWarning("AIs can only be managed in a game.");
1192 if (_networking
&& !_network_server
) {
1193 IConsoleWarning("Only the server can reload an AI.");
1197 CompanyID company_id
= (CompanyID
)(atoi(argv
[1]) - 1);
1198 if (!Company::IsValidID(company_id
)) {
1199 IConsolePrintF(CC_DEFAULT
, "Unknown company. Company range is between 1 and %d.", MAX_COMPANIES
);
1203 if (Company::IsHumanID(company_id
)) {
1204 IConsoleWarning("Company is not controlled by an AI.");
1208 /* First kill the company of the AI, then start a new one. This should start the current AI again */
1209 DoCommandP(0, 2 | company_id
<< 16, CRR_MANUAL
, CMD_COMPANY_CTRL
);
1210 DoCommandP(0, 1 | company_id
<< 16, 0, CMD_COMPANY_CTRL
);
1211 IConsolePrint(CC_DEFAULT
, "AI reloaded.");
1216 DEF_CONSOLE_CMD(ConStopAI
)
1219 IConsoleHelp("Stop an AI. Usage: 'stop_ai <company-id>'");
1220 IConsoleHelp("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.");
1224 if (_game_mode
!= GM_NORMAL
) {
1225 IConsoleWarning("AIs can only be managed in a game.");
1229 if (_networking
&& !_network_server
) {
1230 IConsoleWarning("Only the server can stop an AI.");
1234 CompanyID company_id
= (CompanyID
)(atoi(argv
[1]) - 1);
1235 if (!Company::IsValidID(company_id
)) {
1236 IConsolePrintF(CC_DEFAULT
, "Unknown company. Company range is between 1 and %d.", MAX_COMPANIES
);
1240 if (Company::IsHumanID(company_id
) || company_id
== _local_company
) {
1241 IConsoleWarning("Company is not controlled by an AI.");
1245 /* Now kill the company of the AI. */
1246 DoCommandP(0, 2 | company_id
<< 16, CRR_MANUAL
, CMD_COMPANY_CTRL
);
1247 IConsolePrint(CC_DEFAULT
, "AI stopped, company deleted.");
1252 DEF_CONSOLE_CMD(ConRescanAI
)
1255 IConsoleHelp("Rescan the AI dir for scripts. Usage: 'rescan_ai'");
1259 if (_networking
&& !_network_server
) {
1260 IConsoleWarning("Only the server can rescan the AI dir for scripts.");
1269 DEF_CONSOLE_CMD(ConRescanGame
)
1272 IConsoleHelp("Rescan the Game Script dir for scripts. Usage: 'rescan_game'");
1276 if (_networking
&& !_network_server
) {
1277 IConsoleWarning("Only the server can rescan the Game Script dir for scripts.");
1286 DEF_CONSOLE_CMD(ConRescanNewGRF
)
1289 IConsoleHelp("Rescan the data dir for NewGRFs. Usage: 'rescan_newgrf'");
1293 ScanNewGRFFiles(NULL
);
1298 DEF_CONSOLE_CMD(ConGetSeed
)
1301 IConsoleHelp("Returns the seed used to create this game. Usage: 'getseed'");
1302 IConsoleHelp("The seed can be used to reproduce the exact same map as the game started with.");
1306 IConsolePrintF(CC_DEFAULT
, "Generation Seed: %u", _settings_game
.game_creation
.generation_seed
);
1310 DEF_CONSOLE_CMD(ConGetDate
)
1313 IConsoleHelp("Returns the current date (day-month-year) of the game. Usage: 'getdate'");
1318 ConvertDateToYMD(_date
, &ymd
);
1319 IConsolePrintF(CC_DEFAULT
, "Date: %d-%d-%d", ymd
.day
, ymd
.month
+ 1, ymd
.year
);
1324 DEF_CONSOLE_CMD(ConAlias
)
1326 IConsoleAlias
*alias
;
1329 IConsoleHelp("Add a new alias, or redefine the behaviour of an existing alias . Usage: 'alias <name> <command>'");
1333 if (argc
< 3) return false;
1335 alias
= IConsoleAliasGet(argv
[1]);
1336 if (alias
== NULL
) {
1337 IConsoleAliasRegister(argv
[1], argv
[2]);
1339 free(alias
->cmdline
);
1340 alias
->cmdline
= stredup(argv
[2]);
1345 DEF_CONSOLE_CMD(ConScreenShot
)
1348 IConsoleHelp("Create a screenshot of the game. Usage: 'screenshot [big | giant | no_con] [file name]'");
1349 IConsoleHelp("'big' makes a zoomed-in screenshot of the visible area, 'giant' makes a screenshot of the "
1350 "whole map, 'no_con' hides the console to create the screenshot. 'big' or 'giant' "
1351 "screenshots are always drawn without console");
1355 if (argc
> 3) return false;
1357 ScreenshotType type
= SC_VIEWPORT
;
1358 const char *name
= NULL
;
1361 if (strcmp(argv
[1], "big") == 0) {
1362 /* screenshot big [filename] */
1364 if (argc
> 2) name
= argv
[2];
1365 } else if (strcmp(argv
[1], "giant") == 0) {
1366 /* screenshot giant [filename] */
1368 if (argc
> 2) name
= argv
[2];
1369 } else if (strcmp(argv
[1], "no_con") == 0) {
1370 /* screenshot no_con [filename] */
1372 if (argc
> 2) name
= argv
[2];
1373 } else if (argc
== 2) {
1374 /* screenshot filename */
1377 /* screenshot argv[1] argv[2] - invalid */
1382 MakeScreenshot(type
, name
);
1386 DEF_CONSOLE_CMD(ConInfoCmd
)
1389 IConsoleHelp("Print out debugging information about a command. Usage: 'info_cmd <cmd>'");
1393 if (argc
< 2) return false;
1395 const IConsoleCmd
*cmd
= IConsoleCmdGet(argv
[1]);
1397 IConsoleError("the given command was not found");
1401 IConsolePrintF(CC_DEFAULT
, "command name: %s", cmd
->name
);
1402 IConsolePrintF(CC_DEFAULT
, "command proc: %p", cmd
->proc
);
1404 if (cmd
->hook
!= NULL
) IConsoleWarning("command is hooked");
1409 DEF_CONSOLE_CMD(ConDebugLevel
)
1412 IConsoleHelp("Get/set the default debugging level for the game. Usage: 'debug_level [<level>]'");
1413 IConsoleHelp("Level can be any combination of names, levels. Eg 'net=5 ms=4'. Remember to enclose it in \"'s");
1417 if (argc
> 2) return false;
1420 IConsolePrintF(CC_DEFAULT
, "Current debug-level: '%s'", GetDebugString());
1422 SetDebugString(argv
[1]);
1428 DEF_CONSOLE_CMD(ConExit
)
1431 IConsoleHelp("Exit the game. Usage: 'exit'");
1435 if (_game_mode
== GM_NORMAL
&& _settings_client
.gui
.autosave_on_exit
) DoExitSave();
1441 DEF_CONSOLE_CMD(ConPart
)
1444 IConsoleHelp("Leave the currently joined/running game (only ingame). Usage: 'part'");
1448 if (_game_mode
!= GM_NORMAL
) return false;
1450 _switch_mode
= SM_MENU
;
1454 DEF_CONSOLE_CMD(ConHelp
)
1457 const IConsoleCmd
*cmd
;
1458 const IConsoleAlias
*alias
;
1460 RemoveUnderscores(argv
[1]);
1461 cmd
= IConsoleCmdGet(argv
[1]);
1467 alias
= IConsoleAliasGet(argv
[1]);
1468 if (alias
!= NULL
) {
1469 cmd
= IConsoleCmdGet(alias
->cmdline
);
1474 IConsolePrintF(CC_ERROR
, "ERROR: alias is of special type, please see its execution-line: '%s'", alias
->cmdline
);
1478 IConsoleError("command not found");
1482 IConsolePrint(CC_WARNING
, " ---- OpenTTD Console Help ---- ");
1483 IConsolePrint(CC_DEFAULT
, " - commands: [command to list all commands: list_cmds]");
1484 IConsolePrint(CC_DEFAULT
, " call commands with '<command> <arg2> <arg3>...'");
1485 IConsolePrint(CC_DEFAULT
, " - to assign strings, or use them as arguments, enclose it within quotes");
1486 IConsolePrint(CC_DEFAULT
, " like this: '<command> \"string argument with spaces\"'");
1487 IConsolePrint(CC_DEFAULT
, " - use 'help <command>' to get specific information");
1488 IConsolePrint(CC_DEFAULT
, " - scroll console output with shift + (up | down | pageup | pagedown)");
1489 IConsolePrint(CC_DEFAULT
, " - scroll console input history with the up or down arrows");
1490 IConsolePrint(CC_DEFAULT
, "");
1494 DEF_CONSOLE_CMD(ConListCommands
)
1497 IConsoleHelp("List all registered commands. Usage: 'list_cmds [<pre-filter>]'");
1501 for (const IConsoleCmd
*cmd
= _iconsole_cmds
; cmd
!= NULL
; cmd
= cmd
->next
) {
1502 if (argv
[1] == NULL
|| strstr(cmd
->name
, argv
[1]) != NULL
) {
1503 if (cmd
->hook
== NULL
|| cmd
->hook(false) != CHR_HIDE
) IConsolePrintF(CC_DEFAULT
, "%s", cmd
->name
);
1510 DEF_CONSOLE_CMD(ConListAliases
)
1513 IConsoleHelp("List all registered aliases. Usage: 'list_aliases [<pre-filter>]'");
1517 for (const IConsoleAlias
*alias
= _iconsole_aliases
; alias
!= NULL
; alias
= alias
->next
) {
1518 if (argv
[1] == NULL
|| strstr(alias
->name
, argv
[1]) != NULL
) {
1519 IConsolePrintF(CC_DEFAULT
, "%s => %s", alias
->name
, alias
->cmdline
);
1526 DEF_CONSOLE_CMD(ConCompanies
)
1529 IConsoleHelp("List the details of all companies in the game. Usage 'companies'");
1534 FOR_ALL_COMPANIES(c
) {
1535 /* Grab the company name */
1536 char company_name
[512];
1537 SetDParam(0, c
->index
);
1538 GetString(company_name
, STR_COMPANY_NAME
, lastof(company_name
));
1540 const char *password_state
= "";
1542 password_state
= "AI";
1544 #ifdef ENABLE_NETWORK
1545 else if (_network_server
) {
1546 password_state
= StrEmpty(_network_company_states
[c
->index
].password
) ? "unprotected" : "protected";
1551 GetString(colour
, STR_COLOUR_DARK_BLUE
+ _company_colours
[c
->index
], lastof(colour
));
1552 IConsolePrintF(CC_INFO
, "#:%d(%s) Company Name: '%s' Year Founded: %d Money: " OTTD_PRINTF64
" Loan: " OTTD_PRINTF64
" Value: " OTTD_PRINTF64
" (T:%d, R:%d, P:%d, S:%d) %s",
1553 c
->index
+ 1, colour
, company_name
,
1554 c
->inaugurated_year
, (int64
)c
->money
, (int64
)c
->current_loan
, (int64
)CalculateCompanyValue(c
),
1555 c
->group_all
[VEH_TRAIN
].num_vehicle
,
1556 c
->group_all
[VEH_ROAD
].num_vehicle
,
1557 c
->group_all
[VEH_AIRCRAFT
].num_vehicle
,
1558 c
->group_all
[VEH_SHIP
].num_vehicle
,
1565 #ifdef ENABLE_NETWORK
1567 DEF_CONSOLE_CMD(ConSay
)
1570 IConsoleHelp("Chat to your fellow players in a multiplayer game. Usage: 'say \"<msg>\"'");
1574 if (argc
!= 2) return false;
1576 if (!_network_server
) {
1577 NetworkClientSendChat(NETWORK_ACTION_CHAT
, DESTTYPE_BROADCAST
, 0 /* param does not matter */, argv
[1]);
1579 bool from_admin
= (_redirect_console_to_admin
< INVALID_ADMIN_ID
);
1580 NetworkServerSendChat(NETWORK_ACTION_CHAT
, DESTTYPE_BROADCAST
, 0, argv
[1], CLIENT_ID_SERVER
, from_admin
);
1586 DEF_CONSOLE_CMD(ConSayCompany
)
1589 IConsoleHelp("Chat to a certain company in a multiplayer game. Usage: 'say_company <company-no> \"<msg>\"'");
1590 IConsoleHelp("CompanyNo is the company that plays as company <companyno>, 1 through max_companies");
1594 if (argc
!= 3) return false;
1596 CompanyID company_id
= (CompanyID
)(atoi(argv
[1]) - 1);
1597 if (!Company::IsValidID(company_id
)) {
1598 IConsolePrintF(CC_DEFAULT
, "Unknown company. Company range is between 1 and %d.", MAX_COMPANIES
);
1602 if (!_network_server
) {
1603 NetworkClientSendChat(NETWORK_ACTION_CHAT_COMPANY
, DESTTYPE_TEAM
, company_id
, argv
[2]);
1605 bool from_admin
= (_redirect_console_to_admin
< INVALID_ADMIN_ID
);
1606 NetworkServerSendChat(NETWORK_ACTION_CHAT_COMPANY
, DESTTYPE_TEAM
, company_id
, argv
[2], CLIENT_ID_SERVER
, from_admin
);
1612 DEF_CONSOLE_CMD(ConSayClient
)
1615 IConsoleHelp("Chat to a certain client in a multiplayer game. Usage: 'say_client <client-no> \"<msg>\"'");
1616 IConsoleHelp("For client-id's, see the command 'clients'");
1620 if (argc
!= 3) return false;
1622 if (!_network_server
) {
1623 NetworkClientSendChat(NETWORK_ACTION_CHAT_CLIENT
, DESTTYPE_CLIENT
, atoi(argv
[1]), argv
[2]);
1625 bool from_admin
= (_redirect_console_to_admin
< INVALID_ADMIN_ID
);
1626 NetworkServerSendChat(NETWORK_ACTION_CHAT_CLIENT
, DESTTYPE_CLIENT
, atoi(argv
[1]), argv
[2], CLIENT_ID_SERVER
, from_admin
);
1632 DEF_CONSOLE_CMD(ConCompanyPassword
)
1635 const char *helpmsg
;
1637 if (_network_dedicated
) {
1638 helpmsg
= "Change the password of a company. Usage: 'company_pw <company-no> \"<password>\"";
1639 } else if (_network_server
) {
1640 helpmsg
= "Change the password of your or any other company. Usage: 'company_pw [<company-no>] \"<password>\"'";
1642 helpmsg
= "Change the password of your company. Usage: 'company_pw \"<password>\"'";
1645 IConsoleHelp(helpmsg
);
1646 IConsoleHelp("Use \"*\" to disable the password.");
1650 CompanyID company_id
;
1651 const char *password
;
1652 const char *errormsg
;
1655 company_id
= _local_company
;
1657 errormsg
= "You have to own a company to make use of this command.";
1658 } else if (argc
== 3 && _network_server
) {
1659 company_id
= (CompanyID
)(atoi(argv
[1]) - 1);
1661 errormsg
= "You have to specify the ID of a valid human controlled company.";
1666 if (!Company::IsValidHumanID(company_id
)) {
1667 IConsoleError(errormsg
);
1671 password
= NetworkChangeCompanyPassword(company_id
, password
);
1673 if (StrEmpty(password
)) {
1674 IConsolePrintF(CC_WARNING
, "Company password cleared");
1676 IConsolePrintF(CC_WARNING
, "Company password changed to: %s", password
);
1682 /* Content downloading only is available with ZLIB */
1683 #if defined(WITH_ZLIB)
1684 #include "network/network_content.h"
1686 /** Resolve a string to a content type. */
1687 static ContentType
StringToContentType(const char *str
)
1689 static const char * const inv_lookup
[] = { "", "base", "newgrf", "ai", "ailib", "scenario", "heightmap" };
1690 for (uint i
= 1 /* there is no type 0 */; i
< lengthof(inv_lookup
); i
++) {
1691 if (strcasecmp(str
, inv_lookup
[i
]) == 0) return (ContentType
)i
;
1693 return CONTENT_TYPE_END
;
1696 /** Asynchronous callback */
1697 struct ConsoleContentCallback
: public ContentCallback
{
1698 void OnConnect(bool success
)
1700 IConsolePrintF(CC_DEFAULT
, "Content server connection %s", success
? "established" : "failed");
1705 IConsolePrintF(CC_DEFAULT
, "Content server connection closed");
1708 void OnDownloadComplete(ContentID cid
)
1710 IConsolePrintF(CC_DEFAULT
, "Completed download of %d", cid
);
1715 * Outputs content state information to console
1716 * @param ci the content info
1718 static void OutputContentState(const ContentInfo
*const ci
)
1720 static const char * const types
[] = { "Base graphics", "NewGRF", "AI", "AI library", "Scenario", "Heightmap", "Base sound", "Base music", "Game script", "GS library" };
1721 assert_compile(lengthof(types
) == CONTENT_TYPE_END
- CONTENT_TYPE_BEGIN
);
1722 static const char * const states
[] = { "Not selected", "Selected", "Dep Selected", "Installed", "Unknown" };
1723 static const TextColour state_to_colour
[] = { CC_COMMAND
, CC_INFO
, CC_INFO
, CC_WHITE
, CC_ERROR
};
1725 char buf
[sizeof(ci
->md5sum
) * 2 + 1];
1726 md5sumToString(buf
, lastof(buf
), ci
->md5sum
);
1727 IConsolePrintF(state_to_colour
[ci
->state
], "%d, %s, %s, %s, %08X, %s", ci
->id
, types
[ci
->type
- 1], states
[ci
->state
], ci
->name
, ci
->unique_id
, buf
);
1730 DEF_CONSOLE_CMD(ConContent
)
1732 static ContentCallback
*cb
= NULL
;
1734 cb
= new ConsoleContentCallback();
1735 _network_content_client
.AddCallback(cb
);
1739 IConsoleHelp("Query, select and download content. Usage: 'content update|upgrade|select [all|id]|unselect [all|id]|state [filter]|download'");
1740 IConsoleHelp(" update: get a new list of downloadable content; must be run first");
1741 IConsoleHelp(" upgrade: select all items that are upgrades");
1742 IConsoleHelp(" select: select a specific item given by its id or 'all' to select all. If no parameter is given, all selected content will be listed");
1743 IConsoleHelp(" unselect: unselect a specific item given by its id or 'all' to unselect all");
1744 IConsoleHelp(" state: show the download/select state of all downloadable content. Optionally give a filter string");
1745 IConsoleHelp(" download: download all content you've selected");
1749 if (strcasecmp(argv
[1], "update") == 0) {
1750 _network_content_client
.RequestContentList((argc
> 2) ? StringToContentType(argv
[2]) : CONTENT_TYPE_END
);
1754 if (strcasecmp(argv
[1], "upgrade") == 0) {
1755 _network_content_client
.SelectUpgrade();
1759 if (strcasecmp(argv
[1], "select") == 0) {
1761 /* List selected content */
1762 IConsolePrintF(CC_WHITE
, "id, type, state, name");
1763 for (ConstContentIterator iter
= _network_content_client
.Begin(); iter
!= _network_content_client
.End(); iter
++) {
1764 if ((*iter
)->state
!= ContentInfo::SELECTED
&& (*iter
)->state
!= ContentInfo::AUTOSELECTED
) continue;
1765 OutputContentState(*iter
);
1767 } else if (strcasecmp(argv
[2], "all") == 0) {
1768 _network_content_client
.SelectAll();
1770 _network_content_client
.Select((ContentID
)atoi(argv
[2]));
1775 if (strcasecmp(argv
[1], "unselect") == 0) {
1777 IConsoleError("You must enter the id.");
1780 if (strcasecmp(argv
[2], "all") == 0) {
1781 _network_content_client
.UnselectAll();
1783 _network_content_client
.Unselect((ContentID
)atoi(argv
[2]));
1788 if (strcasecmp(argv
[1], "state") == 0) {
1789 IConsolePrintF(CC_WHITE
, "id, type, state, name");
1790 for (ConstContentIterator iter
= _network_content_client
.Begin(); iter
!= _network_content_client
.End(); iter
++) {
1791 if (argc
> 2 && strcasestr((*iter
)->name
, argv
[2]) == NULL
) continue;
1792 OutputContentState(*iter
);
1797 if (strcasecmp(argv
[1], "download") == 0) {
1800 _network_content_client
.DownloadSelectedContent(files
, bytes
);
1801 IConsolePrintF(CC_DEFAULT
, "Downloading %d file(s) (%d bytes)", files
, bytes
);
1807 #endif /* defined(WITH_ZLIB) */
1808 #endif /* ENABLE_NETWORK */
1810 DEF_CONSOLE_CMD(ConSetting
)
1813 IConsoleHelp("Change setting for all clients. Usage: 'setting <name> [<value>]'");
1814 IConsoleHelp("Omitting <value> will print out the current value of the setting.");
1818 if (argc
== 1 || argc
> 3) return false;
1821 IConsoleGetSetting(argv
[1]);
1823 IConsoleSetSetting(argv
[1], argv
[2]);
1829 DEF_CONSOLE_CMD(ConSettingNewgame
)
1832 IConsoleHelp("Change setting for the next game. Usage: 'setting_newgame <name> [<value>]'");
1833 IConsoleHelp("Omitting <value> will print out the current value of the setting.");
1837 if (argc
== 1 || argc
> 3) return false;
1840 IConsoleGetSetting(argv
[1], true);
1842 IConsoleSetSetting(argv
[1], argv
[2], true);
1848 DEF_CONSOLE_CMD(ConListSettings
)
1851 IConsoleHelp("List settings. Usage: 'list_settings [<pre-filter>]'");
1855 if (argc
> 2) return false;
1857 IConsoleListSettings((argc
== 2) ? argv
[1] : NULL
);
1861 DEF_CONSOLE_CMD(ConGamelogPrint
)
1863 GamelogPrintConsole();
1867 DEF_CONSOLE_CMD(ConNewGRFReload
)
1870 IConsoleHelp("Reloads all active NewGRFs from disk. Equivalent to reapplying NewGRFs via the settings, but without asking for confirmation. This might crash OpenTTD!");
1883 static void IConsoleDebugLibRegister()
1885 IConsoleCmdRegister("resettile", ConResetTile
);
1886 IConsoleAliasRegister("dbg_echo", "echo %A; echo %B");
1887 IConsoleAliasRegister("dbg_echo2", "echo %!");
1891 /*******************************
1892 * console command registration
1893 *******************************/
1895 void IConsoleStdLibRegister()
1897 IConsoleCmdRegister("debug_level", ConDebugLevel
);
1898 IConsoleCmdRegister("echo", ConEcho
);
1899 IConsoleCmdRegister("echoc", ConEchoC
);
1900 IConsoleCmdRegister("exec", ConExec
);
1901 IConsoleCmdRegister("exit", ConExit
);
1902 IConsoleCmdRegister("part", ConPart
);
1903 IConsoleCmdRegister("help", ConHelp
);
1904 IConsoleCmdRegister("info_cmd", ConInfoCmd
);
1905 IConsoleCmdRegister("list_cmds", ConListCommands
);
1906 IConsoleCmdRegister("list_aliases", ConListAliases
);
1907 IConsoleCmdRegister("newgame", ConNewGame
);
1908 IConsoleCmdRegister("restart", ConRestart
);
1909 IConsoleCmdRegister("getseed", ConGetSeed
);
1910 IConsoleCmdRegister("getdate", ConGetDate
);
1911 IConsoleCmdRegister("quit", ConExit
);
1912 IConsoleCmdRegister("resetengines", ConResetEngines
, ConHookNoNetwork
);
1913 IConsoleCmdRegister("reset_enginepool", ConResetEnginePool
, ConHookNoNetwork
);
1914 IConsoleCmdRegister("return", ConReturn
);
1915 IConsoleCmdRegister("screenshot", ConScreenShot
);
1916 IConsoleCmdRegister("script", ConScript
);
1917 IConsoleCmdRegister("scrollto", ConScrollToTile
);
1918 IConsoleCmdRegister("alias", ConAlias
);
1919 IConsoleCmdRegister("load", ConLoad
);
1920 IConsoleCmdRegister("rm", ConRemove
);
1921 IConsoleCmdRegister("save", ConSave
);
1922 IConsoleCmdRegister("saveconfig", ConSaveConfig
);
1923 IConsoleCmdRegister("ls", ConListFiles
);
1924 IConsoleCmdRegister("cd", ConChangeDirectory
);
1925 IConsoleCmdRegister("pwd", ConPrintWorkingDirectory
);
1926 IConsoleCmdRegister("clear", ConClearBuffer
);
1927 IConsoleCmdRegister("setting", ConSetting
);
1928 IConsoleCmdRegister("setting_newgame", ConSettingNewgame
);
1929 IConsoleCmdRegister("list_settings",ConListSettings
);
1930 IConsoleCmdRegister("gamelog", ConGamelogPrint
);
1931 IConsoleCmdRegister("rescan_newgrf", ConRescanNewGRF
);
1933 IConsoleAliasRegister("dir", "ls");
1934 IConsoleAliasRegister("del", "rm %+");
1935 IConsoleAliasRegister("newmap", "newgame");
1936 IConsoleAliasRegister("patch", "setting %+");
1937 IConsoleAliasRegister("set", "setting %+");
1938 IConsoleAliasRegister("set_newgame", "setting_newgame %+");
1939 IConsoleAliasRegister("list_patches", "list_settings %+");
1940 IConsoleAliasRegister("developer", "setting developer %+");
1942 IConsoleCmdRegister("list_ai_libs", ConListAILibs
);
1943 IConsoleCmdRegister("list_ai", ConListAI
);
1944 IConsoleCmdRegister("reload_ai", ConReloadAI
);
1945 IConsoleCmdRegister("rescan_ai", ConRescanAI
);
1946 IConsoleCmdRegister("start_ai", ConStartAI
);
1947 IConsoleCmdRegister("stop_ai", ConStopAI
);
1949 IConsoleCmdRegister("list_game", ConListGame
);
1950 IConsoleCmdRegister("list_game_libs", ConListGameLibs
);
1951 IConsoleCmdRegister("rescan_game", ConRescanGame
);
1953 IConsoleCmdRegister("companies", ConCompanies
);
1954 IConsoleAliasRegister("players", "companies");
1956 /* networking functions */
1957 #ifdef ENABLE_NETWORK
1958 /* Content downloading is only available with ZLIB */
1959 #if defined(WITH_ZLIB)
1960 IConsoleCmdRegister("content", ConContent
);
1961 #endif /* defined(WITH_ZLIB) */
1963 /*** Networking commands ***/
1964 IConsoleCmdRegister("say", ConSay
, ConHookNeedNetwork
);
1965 IConsoleCmdRegister("say_company", ConSayCompany
, ConHookNeedNetwork
);
1966 IConsoleAliasRegister("say_player", "say_company %+");
1967 IConsoleCmdRegister("say_client", ConSayClient
, ConHookNeedNetwork
);
1969 IConsoleCmdRegister("connect", ConNetworkConnect
, ConHookClientOnly
);
1970 IConsoleCmdRegister("clients", ConNetworkClients
, ConHookNeedNetwork
);
1971 IConsoleCmdRegister("status", ConStatus
, ConHookServerOnly
);
1972 IConsoleCmdRegister("server_info", ConServerInfo
, ConHookServerOnly
);
1973 IConsoleAliasRegister("info", "server_info");
1974 IConsoleCmdRegister("reconnect", ConNetworkReconnect
, ConHookClientOnly
);
1975 IConsoleCmdRegister("rcon", ConRcon
, ConHookNeedNetwork
);
1977 IConsoleCmdRegister("join", ConJoinCompany
, ConHookNeedNetwork
);
1978 IConsoleAliasRegister("spectate", "join 255");
1979 IConsoleCmdRegister("move", ConMoveClient
, ConHookServerOnly
);
1980 IConsoleCmdRegister("reset_company", ConResetCompany
, ConHookServerOnly
);
1981 IConsoleAliasRegister("clean_company", "reset_company %A");
1982 IConsoleCmdRegister("client_name", ConClientNickChange
, ConHookServerOnly
);
1983 IConsoleCmdRegister("kick", ConKick
, ConHookServerOnly
);
1984 IConsoleCmdRegister("ban", ConBan
, ConHookServerOnly
);
1985 IConsoleCmdRegister("unban", ConUnBan
, ConHookServerOnly
);
1986 IConsoleCmdRegister("banlist", ConBanList
, ConHookServerOnly
);
1988 IConsoleCmdRegister("pause", ConPauseGame
, ConHookServerOnly
);
1989 IConsoleCmdRegister("unpause", ConUnpauseGame
, ConHookServerOnly
);
1991 IConsoleCmdRegister("company_pw", ConCompanyPassword
, ConHookNeedNetwork
);
1992 IConsoleAliasRegister("company_password", "company_pw %+");
1994 IConsoleAliasRegister("net_frame_freq", "setting frame_freq %+");
1995 IConsoleAliasRegister("net_sync_freq", "setting sync_freq %+");
1996 IConsoleAliasRegister("server_pw", "setting server_password %+");
1997 IConsoleAliasRegister("server_password", "setting server_password %+");
1998 IConsoleAliasRegister("rcon_pw", "setting rcon_password %+");
1999 IConsoleAliasRegister("rcon_password", "setting rcon_password %+");
2000 IConsoleAliasRegister("name", "setting client_name %+");
2001 IConsoleAliasRegister("server_name", "setting server_name %+");
2002 IConsoleAliasRegister("server_port", "setting server_port %+");
2003 IConsoleAliasRegister("server_advertise", "setting server_advertise %+");
2004 IConsoleAliasRegister("max_clients", "setting max_clients %+");
2005 IConsoleAliasRegister("max_companies", "setting max_companies %+");
2006 IConsoleAliasRegister("max_spectators", "setting max_spectators %+");
2007 IConsoleAliasRegister("max_join_time", "setting max_join_time %+");
2008 IConsoleAliasRegister("pause_on_join", "setting pause_on_join %+");
2009 IConsoleAliasRegister("autoclean_companies", "setting autoclean_companies %+");
2010 IConsoleAliasRegister("autoclean_protected", "setting autoclean_protected %+");
2011 IConsoleAliasRegister("autoclean_unprotected", "setting autoclean_unprotected %+");
2012 IConsoleAliasRegister("restart_game_year", "setting restart_game_year %+");
2013 IConsoleAliasRegister("min_players", "setting min_active_clients %+");
2014 IConsoleAliasRegister("reload_cfg", "setting reload_cfg %+");
2015 #endif /* ENABLE_NETWORK */
2017 /* debugging stuff */
2019 IConsoleDebugLibRegister();
2022 /* NewGRF development stuff */
2023 IConsoleCmdRegister("reload_newgrfs", ConNewGRFReload
, ConHookNewGRFDeveloperTool
);