console_cmds.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#include "stdafx.h"
#include "console_internal.h"
#include "debug.h"
#include "engine_func.h"
#include "landscape.h"
#include "saveload/saveload.h"
#include "network/core/game_info.h"
#include "network/network.h"
#include "network/network_func.h"
#include "network/network_base.h"
#include "network/network_admin.h"
#include "network/network_client.h"
#include "command_func.h"
#include "settings_func.h"
#include "fios.h"
#include "fileio_func.h"
#include "screenshot.h"
#include "genworld.h"
#include "strings_func.h"
#include "viewport_func.h"
#include "window_func.h"
#include "date_func.h"
#include "company_func.h"
#include "gamelog.h"
#include "ai/ai.hpp"
#include "ai/ai_config.hpp"
#include "newgrf.h"
#include "newgrf_profiling.h"
#include "console_func.h"
#include "engine_base.h"
#include "road.h"
#include "rail.h"
#include "game/game.hpp"
#include "table/strings.h"
#include "walltime_func.h"
#include "company_cmd.h"
#include "misc_cmd.h"
 
#include <sstream>
 
#include "safeguards.h"
 
/* scriptfile handling */
static uint _script_current_depth; 
 
class ConsoleFileList : public FileList {
public:
  ConsoleFileList() : FileList()
  {
    this->file_list_valid = false;
  }
 
  void InvalidateFileList()
  {
    this->clear();
    this->file_list_valid = false;
  }
 
  void ValidateFileList(bool force_reload = false)
  {
    if (force_reload || !this->file_list_valid) {
      this->BuildFileList(FT_SAVEGAME, SLO_LOAD);
      this->file_list_valid = true;
    }
  }
 
  bool file_list_valid; 
};
 
static ConsoleFileList _console_file_list; 
 
/* console command defines */
#define DEF_CONSOLE_CMD(function) static bool function(byte argc, char *argv[])
#define DEF_CONSOLE_HOOK(function) static ConsoleHookResult function(bool echo)
 
 
/****************
 * command hooks
 ****************/
 
static inline bool NetworkAvailable(bool echo)
{
  if (!_network_available) {
    if (echo) IConsolePrint(CC_ERROR, "You cannot use this command because there is no network available.");
    return false;
  }
  return true;
}
 
DEF_CONSOLE_HOOK(ConHookServerOnly)
{
  if (!NetworkAvailable(echo)) return CHR_DISALLOW;
 
  if (!_network_server) {
    if (echo) IConsolePrint(CC_ERROR, "This command is only available to a network server.");
    return CHR_DISALLOW;
  }
  return CHR_ALLOW;
}
 
DEF_CONSOLE_HOOK(ConHookClientOnly)
{
  if (!NetworkAvailable(echo)) return CHR_DISALLOW;
 
  if (_network_server) {
    if (echo) IConsolePrint(CC_ERROR, "This command is not available to a network server.");
    return CHR_DISALLOW;
  }
  return CHR_ALLOW;
}
 
DEF_CONSOLE_HOOK(ConHookNeedNetwork)
{
  if (!NetworkAvailable(echo)) return CHR_DISALLOW;
 
  if (!_networking || (!_network_server && !MyClient::IsConnected())) {
    if (echo) IConsolePrint(CC_ERROR, "Not connected. This command is only available in multiplayer.");
    return CHR_DISALLOW;
  }
  return CHR_ALLOW;
}
 
DEF_CONSOLE_HOOK(ConHookNoNetwork)
{
  if (_networking) {
    if (echo) IConsolePrint(CC_ERROR, "This command is forbidden in multiplayer.");
    return CHR_DISALLOW;
  }
  return CHR_ALLOW;
}
 
DEF_CONSOLE_HOOK(ConHookServerOrNoNetwork)
{
  if (_networking && !_network_server) {
    if (echo) IConsolePrint(CC_ERROR, "This command is only available to a network server.");
    return CHR_DISALLOW;
  }
  return CHR_ALLOW;
}
 
DEF_CONSOLE_HOOK(ConHookNewGRFDeveloperTool)
{
  if (_settings_client.gui.newgrf_developer_tools) {
    if (_game_mode == GM_MENU) {
      if (echo) IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
      return CHR_DISALLOW;
    }
    return ConHookNoNetwork(echo);
  }
  return CHR_HIDE;
}
 
DEF_CONSOLE_CMD(ConResetEngines)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Reset status data of all engines. This might solve some issues with 'lost' engines. Usage: 'resetengines'.");
    return true;
  }
 
  StartupEngines();
  return true;
}
 
DEF_CONSOLE_CMD(ConResetEnginePool)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Reset NewGRF allocations of engine slots. This will remove invalid engine definitions, and might make default engines available again.");
    return true;
  }
 
  if (_game_mode == GM_MENU) {
    IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
    return true;
  }
 
  if (!EngineOverrideManager::ResetToCurrentNewGRFConfig()) {
    IConsolePrint(CC_ERROR, "This can only be done when there are no vehicles in the game.");
    return true;
  }
 
  return true;
}
 
#ifdef _DEBUG
 
DEF_CONSOLE_CMD(ConResetTile)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Reset a tile to bare land. Usage: 'resettile <tile>'.");
    IConsolePrint(CC_HELP, "Tile can be either decimal (34161) or hexadecimal (0x4a5B).");
    return true;
  }
 
  if (argc == 2) {
    uint32 result;
    if (GetArgumentInteger(&result, argv[1])) {
      DoClearSquare((TileIndex)result);
      return true;
    }
  }
 
  return false;
}
#endif /* _DEBUG */
 
DEF_CONSOLE_CMD(ConZoomToLevel)
{
  switch (argc) {
    case 0:
      IConsolePrint(CC_HELP, "Set the current zoom level of the main viewport.");
      IConsolePrint(CC_HELP, "Usage: 'zoomto <level>'.");
      IConsolePrint(
        CC_HELP,
        ZOOM_LVL_MIN < _settings_client.gui.zoom_min ?
          "The lowest zoom-in level allowed by current client settings is {}." :
          "The lowest supported zoom-in level is {}.",
        std::max(ZOOM_LVL_MIN, _settings_client.gui.zoom_min)
      );
      IConsolePrint(
        CC_HELP,
        _settings_client.gui.zoom_max < ZOOM_LVL_MAX ?
          "The highest zoom-out level allowed by current client settings is {}." :
          "The highest supported zoom-out level is {}.",
        std::min(_settings_client.gui.zoom_max, ZOOM_LVL_MAX)
      );
      return true;
 
    case 2: {
      uint32 level;
      if (GetArgumentInteger(&level, argv[1])) {
        if (level < ZOOM_LVL_MIN) {
          IConsolePrint(CC_ERROR, "Zoom-in levels below {} are not supported.", ZOOM_LVL_MIN);
        } else if (level < _settings_client.gui.zoom_min) {
          IConsolePrint(CC_ERROR, "Current client settings do not allow zooming in below level {}.", _settings_client.gui.zoom_min);
        } else if (level > ZOOM_LVL_MAX) {
          IConsolePrint(CC_ERROR, "Zoom-in levels above {} are not supported.", ZOOM_LVL_MAX);
        } else if (level > _settings_client.gui.zoom_max) {
          IConsolePrint(CC_ERROR, "Current client settings do not allow zooming out beyond level {}.", _settings_client.gui.zoom_max);
        } else {
          Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
          Viewport *vp = w->viewport;
          while (vp->zoom > level) DoZoomInOutWindow(ZOOM_IN, w);
          while (vp->zoom < level) DoZoomInOutWindow(ZOOM_OUT, w);
        }
        return true;
      }
      break;
    }
  }
 
  return false;
}
 
DEF_CONSOLE_CMD(ConScrollToTile)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Center the screen on a given tile.");
    IConsolePrint(CC_HELP, "Usage: 'scrollto [instant] <tile>' or 'scrollto [instant] <x> <y>'.");
    IConsolePrint(CC_HELP, "Numbers can be either decimal (34161) or hexadecimal (0x4a5B).");
    IConsolePrint(CC_HELP, "'instant' will immediately move and redraw viewport without smooth scrolling.");
    return true;
  }
  if (argc < 2) return false;
 
  uint32 arg_index = 1;
  bool instant = false;
  if (strcmp(argv[arg_index], "instant") == 0) {
    ++arg_index;
    instant = true;
  }
 
  switch (argc - arg_index) {
    case 1: {
      uint32 result;
      if (GetArgumentInteger(&result, argv[arg_index])) {
        if (result >= MapSize()) {
          IConsolePrint(CC_ERROR, "Tile does not exist.");
          return true;
        }
        ScrollMainWindowToTile((TileIndex)result, instant);
        return true;
      }
      break;
    }
 
    case 2: {
      uint32 x, y;
      if (GetArgumentInteger(&x, argv[arg_index]) && GetArgumentInteger(&y, argv[arg_index + 1])) {
        if (x >= MapSizeX() || y >= MapSizeY()) {
          IConsolePrint(CC_ERROR, "Tile does not exist.");
          return true;
        }
        ScrollMainWindowToTile(TileXY(x, y), instant);
        return true;
      }
      break;
    }
  }
 
  return false;
}
 
DEF_CONSOLE_CMD(ConSave)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Save the current game. Usage: 'save <filename>'.");
    return true;
  }
 
  if (argc == 2) {
    char *filename = str_fmt("%s.sav", argv[1]);
    IConsolePrint(CC_DEFAULT, "Saving map...");
 
    if (SaveOrLoad(filename, SLO_SAVE, DFT_GAME_FILE, SAVE_DIR) != SL_OK) {
      IConsolePrint(CC_ERROR, "Saving map failed.");
    } else {
      IConsolePrint(CC_INFO, "Map successfully saved to '{}'.", filename);
    }
    free(filename);
    return true;
  }
 
  return false;
}
 
DEF_CONSOLE_CMD(ConSaveConfig)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Saves the configuration for new games to the configuration file, typically 'openttd.cfg'.");
    IConsolePrint(CC_HELP, "It does not save the configuration of the current game to the configuration file.");
    return true;
  }
 
  SaveToConfig();
  IConsolePrint(CC_DEFAULT, "Saved config.");
  return true;
}
 
DEF_CONSOLE_CMD(ConLoad)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Load a game by name or index. Usage: 'load <file | number>'.");
    return true;
  }
 
  if (argc != 2) return false;
 
  const char *file = argv[1];
  _console_file_list.ValidateFileList();
  const FiosItem *item = _console_file_list.FindItem(file);
  if (item != nullptr) {
    if (GetAbstractFileType(item->type) == FT_SAVEGAME) {
      _switch_mode = SM_LOAD_GAME;
      _file_to_saveload.SetMode(item->type);
      _file_to_saveload.SetName(FiosBrowseTo(item));
      _file_to_saveload.SetTitle(item->title);
    } else {
      IConsolePrint(CC_ERROR, "'{}' is not a savegame.", file);
    }
  } else {
    IConsolePrint(CC_ERROR, "'{}' cannot be found.", file);
  }
 
  return true;
}
 
 
DEF_CONSOLE_CMD(ConRemove)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Remove a savegame by name or index. Usage: 'rm <file | number>'.");
    return true;
  }
 
  if (argc != 2) return false;
 
  const char *file = argv[1];
  _console_file_list.ValidateFileList();
  const FiosItem *item = _console_file_list.FindItem(file);
  if (item != nullptr) {
    if (!FiosDelete(item->name)) {
      IConsolePrint(CC_ERROR, "Failed to delete '{}'.", file);
    }
  } else {
    IConsolePrint(CC_ERROR, "'{}' could not be found.", file);
  }
 
  _console_file_list.InvalidateFileList();
  return true;
}
 
 
/* List all the files in the current dir via console */
DEF_CONSOLE_CMD(ConListFiles)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List all loadable savegames and directories in the current dir via console. Usage: 'ls | dir'.");
    return true;
  }
 
  _console_file_list.ValidateFileList(true);
  for (uint i = 0; i < _console_file_list.size(); i++) {
    IConsolePrint(CC_DEFAULT, "{}) {}", i, _console_file_list[i].title);
  }
 
  return true;
}
 
/* Change the dir via console */
DEF_CONSOLE_CMD(ConChangeDirectory)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Change the dir via console. Usage: 'cd <directory | number>'.");
    return true;
  }
 
  if (argc != 2) return false;
 
  const char *file = argv[1];
  _console_file_list.ValidateFileList(true);
  const FiosItem *item = _console_file_list.FindItem(file);
  if (item != nullptr) {
    switch (item->type) {
      case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:
        FiosBrowseTo(item);
        break;
      default: IConsolePrint(CC_ERROR, "{}: Not a directory.", file);
    }
  } else {
    IConsolePrint(CC_ERROR, "{}: No such file or directory.", file);
  }
 
  _console_file_list.InvalidateFileList();
  return true;
}
 
DEF_CONSOLE_CMD(ConPrintWorkingDirectory)
{
  const char *path;
 
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Print out the current working directory. Usage: 'pwd'.");
    return true;
  }
 
  /* XXX - Workaround for broken file handling */
  _console_file_list.ValidateFileList(true);
  _console_file_list.InvalidateFileList();
 
  FiosGetDescText(&path, nullptr);
  IConsolePrint(CC_DEFAULT, path);
  return true;
}
 
DEF_CONSOLE_CMD(ConClearBuffer)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Clear the console buffer. Usage: 'clear'.");
    return true;
  }
 
  IConsoleClearBuffer();
  SetWindowDirty(WC_CONSOLE, 0);
  return true;
}
 
 
/**********************************
 * Network Core Console Commands
 **********************************/
 
static bool ConKickOrBan(const char *argv, bool ban, const std::string &reason)
{
  uint n;
 
  if (strchr(argv, '.') == nullptr && strchr(argv, ':') == nullptr) { // banning with ID
    ClientID client_id = (ClientID)atoi(argv);
 
    /* Don't kill the server, or the client doing the rcon. The latter can't be kicked because
     * kicking frees closes and subsequently free the connection related instances, which we
     * would be reading from and writing to after returning. So we would read or write data
     * from freed memory up till the segfault triggers. */
    if (client_id == CLIENT_ID_SERVER || client_id == _redirect_console_to_client) {
      IConsolePrint(CC_ERROR, "You can not {} yourself!", ban ? "ban" : "kick");
      return true;
    }
 
    NetworkClientInfo *ci = NetworkClientInfo::GetByClientID(client_id);
    if (ci == nullptr) {
      IConsolePrint(CC_ERROR, "Invalid client ID.");
      return true;
    }
 
    if (!ban) {
      /* Kick only this client, not all clients with that IP */
      NetworkServerKickClient(client_id, reason);
      return true;
    }
 
    /* When banning, kick+ban all clients with that IP */
    n = NetworkServerKickOrBanIP(client_id, ban, reason);
  } else {
    n = NetworkServerKickOrBanIP(argv, ban, reason);
  }
 
  if (n == 0) {
    IConsolePrint(CC_DEFAULT, ban ? "Client not online, address added to banlist." : "Client not found.");
  } else {
    IConsolePrint(CC_DEFAULT, "{}ed {} client(s).", ban ? "Bann" : "Kick", n);
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConKick)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Kick a client from a network game. Usage: 'kick <ip | client-id> [<kick-reason>]'.");
    IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
    return true;
  }
 
  if (argc != 2 && argc != 3) return false;
 
  /* No reason supplied for kicking */
  if (argc == 2) return ConKickOrBan(argv[1], false, {});
 
  /* Reason for kicking supplied */
  size_t kick_message_length = strlen(argv[2]);
  if (kick_message_length >= 255) {
    IConsolePrint(CC_ERROR, "Maximum kick message length is 254 characters. You entered {} characters.", kick_message_length);
    return false;
  } else {
    return ConKickOrBan(argv[1], false, argv[2]);
  }
}
 
DEF_CONSOLE_CMD(ConBan)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Ban a client from a network game. Usage: 'ban <ip | client-id> [<ban-reason>]'.");
    IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
    IConsolePrint(CC_HELP, "If the client is no longer online, you can still ban their IP.");
    return true;
  }
 
  if (argc != 2 && argc != 3) return false;
 
  /* No reason supplied for kicking */
  if (argc == 2) return ConKickOrBan(argv[1], true, {});
 
  /* Reason for kicking supplied */
  size_t kick_message_length = strlen(argv[2]);
  if (kick_message_length >= 255) {
    IConsolePrint(CC_ERROR, "Maximum kick message length is 254 characters. You entered {} characters.", kick_message_length);
    return false;
  } else {
    return ConKickOrBan(argv[1], true, argv[2]);
  }
}
 
DEF_CONSOLE_CMD(ConUnBan)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Unban a client from a network game. Usage: 'unban <ip | banlist-index>'.");
    IConsolePrint(CC_HELP, "For a list of banned IP's, see the command 'banlist'.");
    return true;
  }
 
  if (argc != 2) return false;
 
  /* Try by IP. */
  uint index;
  for (index = 0; index < _network_ban_list.size(); index++) {
    if (_network_ban_list[index] == argv[1]) break;
  }
 
  /* Try by index. */
  if (index >= _network_ban_list.size()) {
    index = atoi(argv[1]) - 1U; // let it wrap
  }
 
  if (index < _network_ban_list.size()) {
    IConsolePrint(CC_DEFAULT, "Unbanned {}.", _network_ban_list[index]);
    _network_ban_list.erase(_network_ban_list.begin() + index);
  } else {
    IConsolePrint(CC_DEFAULT, "Invalid list index or IP not in ban-list.");
    IConsolePrint(CC_DEFAULT, "For a list of banned IP's, see the command 'banlist'.");
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConBanList)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List the IP's of banned clients: Usage 'banlist'.");
    return true;
  }
 
  IConsolePrint(CC_DEFAULT, "Banlist:");
 
  uint i = 1;
  for (const auto &entry : _network_ban_list) {
    IConsolePrint(CC_DEFAULT, "  {}) {}", i, entry);
    i++;
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConPauseGame)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Pause a network game. Usage: 'pause'.");
    return true;
  }
 
  if (_game_mode == GM_MENU) {
    IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
    return true;
  }
 
  if ((_pause_mode & PM_PAUSED_NORMAL) == PM_UNPAUSED) {
    Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, true);
    if (!_networking) IConsolePrint(CC_DEFAULT, "Game paused.");
  } else {
    IConsolePrint(CC_DEFAULT, "Game is already paused.");
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConUnpauseGame)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Unpause a network game. Usage: 'unpause'.");
    return true;
  }
 
  if (_game_mode == GM_MENU) {
    IConsolePrint(CC_ERROR, "This command is only available in-game and in the editor.");
    return true;
  }
 
  if ((_pause_mode & PM_PAUSED_NORMAL) != PM_UNPAUSED) {
    Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, false);
    if (!_networking) IConsolePrint(CC_DEFAULT, "Game unpaused.");
  } else if ((_pause_mode & PM_PAUSED_ERROR) != PM_UNPAUSED) {
    IConsolePrint(CC_DEFAULT, "Game is in error state and cannot be unpaused via console.");
  } else if (_pause_mode != PM_UNPAUSED) {
    IConsolePrint(CC_DEFAULT, "Game cannot be unpaused manually; disable pause_on_join/min_active_clients.");
  } else {
    IConsolePrint(CC_DEFAULT, "Game is already unpaused.");
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConRcon)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Remote control the server from another client. Usage: 'rcon <password> <command>'.");
    IConsolePrint(CC_HELP, "Remember to enclose the command in quotes, otherwise only the first parameter is sent.");
    return true;
  }
 
  if (argc < 3) return false;
 
  if (_network_server) {
    IConsoleCmdExec(argv[2]);
  } else {
    NetworkClientSendRcon(argv[1], argv[2]);
  }
  return true;
}
 
DEF_CONSOLE_CMD(ConStatus)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List the status of all clients connected to the server. Usage 'status'.");
    return true;
  }
 
  NetworkServerShowStatusToConsole();
  return true;
}
 
DEF_CONSOLE_CMD(ConServerInfo)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List current and maximum client/company limits. Usage 'server_info'.");
    IConsolePrint(CC_HELP, "You can change these values by modifying settings 'network.max_clients' and 'network.max_companies'.");
    return true;
  }
 
  IConsolePrint(CC_DEFAULT, "Invite code:                {}", _network_server_invite_code);
  IConsolePrint(CC_DEFAULT, "Current/maximum clients:    {:3d}/{:3d}", _network_game_info.clients_on, _settings_client.network.max_clients);
  IConsolePrint(CC_DEFAULT, "Current/maximum companies:  {:3d}/{:3d}", Company::GetNumItems(), _settings_client.network.max_companies);
  IConsolePrint(CC_DEFAULT, "Current spectators:         {:3d}", NetworkSpectatorCount());
 
  return true;
}
 
DEF_CONSOLE_CMD(ConClientNickChange)
{
  if (argc != 3) {
    IConsolePrint(CC_HELP, "Change the nickname of a connected client. Usage: 'client_name <client-id> <new-name>'.");
    IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
    return true;
  }
 
  ClientID client_id = (ClientID)atoi(argv[1]);
 
  if (client_id == CLIENT_ID_SERVER) {
    IConsolePrint(CC_ERROR, "Please use the command 'name' to change your own name!");
    return true;
  }
 
  if (NetworkClientInfo::GetByClientID(client_id) == nullptr) {
    IConsolePrint(CC_ERROR, "Invalid client ID.");
    return true;
  }
 
  std::string client_name(argv[2]);
  StrTrimInPlace(client_name);
  if (!NetworkIsValidClientName(client_name)) {
    IConsolePrint(CC_ERROR, "Cannot give a client an empty name.");
    return true;
  }
 
  if (!NetworkServerChangeClientName(client_id, client_name)) {
    IConsolePrint(CC_ERROR, "Cannot give a client a duplicate name.");
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConJoinCompany)
{
  if (argc < 2) {
    IConsolePrint(CC_HELP, "Request joining another company. Usage: 'join <company-id> [<password>]'.");
    IConsolePrint(CC_HELP, "For valid company-id see company list, use 255 for spectator.");
    return true;
  }
 
  CompanyID company_id = (CompanyID)(atoi(argv[1]) <= MAX_COMPANIES ? atoi(argv[1]) - 1 : atoi(argv[1]));
 
  /* Check we have a valid company id! */
  if (!Company::IsValidID(company_id) && company_id != COMPANY_SPECTATOR) {
    IConsolePrint(CC_ERROR, "Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
    return true;
  }
 
  if (NetworkClientInfo::GetByClientID(_network_own_client_id)->client_playas == company_id) {
    IConsolePrint(CC_ERROR, "You are already there!");
    return true;
  }
 
  if (company_id != COMPANY_SPECTATOR && !Company::IsHumanID(company_id)) {
    IConsolePrint(CC_ERROR, "Cannot join AI company.");
    return true;
  }
 
  /* Check if the company requires a password */
  if (NetworkCompanyIsPassworded(company_id) && argc < 3) {
    IConsolePrint(CC_ERROR, "Company {} requires a password to join.", company_id + 1);
    return true;
  }
 
  /* non-dedicated server may just do the move! */
  if (_network_server) {
    NetworkServerDoMove(CLIENT_ID_SERVER, company_id);
  } else {
    NetworkClientRequestMove(company_id, NetworkCompanyIsPassworded(company_id) ? argv[2] : "");
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConMoveClient)
{
  if (argc < 3) {
    IConsolePrint(CC_HELP, "Move a client to another company. Usage: 'move <client-id> <company-id>'.");
    IConsolePrint(CC_HELP, "For valid client-id see 'clients', for valid company-id see 'companies', use 255 for moving to spectators.");
    return true;
  }
 
  const NetworkClientInfo *ci = NetworkClientInfo::GetByClientID((ClientID)atoi(argv[1]));
  CompanyID company_id = (CompanyID)(atoi(argv[2]) <= MAX_COMPANIES ? atoi(argv[2]) - 1 : atoi(argv[2]));
 
  /* check the client exists */
  if (ci == nullptr) {
    IConsolePrint(CC_ERROR, "Invalid client-id, check the command 'clients' for valid client-id's.");
    return true;
  }
 
  if (!Company::IsValidID(company_id) && company_id != COMPANY_SPECTATOR) {
    IConsolePrint(CC_ERROR, "Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
    return true;
  }
 
  if (company_id != COMPANY_SPECTATOR && !Company::IsHumanID(company_id)) {
    IConsolePrint(CC_ERROR, "You cannot move clients to AI companies.");
    return true;
  }
 
  if (ci->client_id == CLIENT_ID_SERVER && _network_dedicated) {
    IConsolePrint(CC_ERROR, "You cannot move the server!");
    return true;
  }
 
  if (ci->client_playas == company_id) {
    IConsolePrint(CC_ERROR, "You cannot move someone to where they already are!");
    return true;
  }
 
  /* we are the server, so force the update */
  NetworkServerDoMove(ci->client_id, company_id);
 
  return true;
}
 
DEF_CONSOLE_CMD(ConResetCompany)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Remove an idle company from the game. Usage: 'reset_company <company-id>'.");
    IConsolePrint(CC_HELP, "For company-id's, see the list of companies from the dropdown menu. Company 1 is 1, etc.");
    return true;
  }
 
  if (argc != 2) return false;
 
  CompanyID index = (CompanyID)(atoi(argv[1]) - 1);
 
  /* Check valid range */
  if (!Company::IsValidID(index)) {
    IConsolePrint(CC_ERROR, "Company does not exist. Company-id must be between 1 and {}.", MAX_COMPANIES);
    return true;
  }
 
  if (!Company::IsHumanID(index)) {
    IConsolePrint(CC_ERROR, "Company is owned by an AI.");
    return true;
  }
 
  if (NetworkCompanyHasClients(index)) {
    IConsolePrint(CC_ERROR, "Cannot remove company: a client is connected to that company.");
    return false;
  }
  const NetworkClientInfo *ci = NetworkClientInfo::GetByClientID(CLIENT_ID_SERVER);
  if (ci->client_playas == index) {
    IConsolePrint(CC_ERROR, "Cannot remove company: the server is connected to that company.");
    return true;
  }
 
  /* It is safe to remove this company */
  Command<CMD_COMPANY_CTRL>::Post(CCA_DELETE, index, CRR_MANUAL, INVALID_CLIENT_ID);
  IConsolePrint(CC_DEFAULT, "Company deleted.");
 
  return true;
}
 
DEF_CONSOLE_CMD(ConNetworkClients)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Get a list of connected clients including their ID, name, company-id, and IP. Usage: 'clients'.");
    return true;
  }
 
  NetworkPrintClients();
 
  return true;
}
 
DEF_CONSOLE_CMD(ConNetworkReconnect)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Reconnect to server to which you were connected last time. Usage: 'reconnect [<company>]'.");
    IConsolePrint(CC_HELP, "Company 255 is spectator (default, if not specified), 0 means creating new company.");
    IConsolePrint(CC_HELP, "All others are a certain company with Company 1 being #1.");
    return true;
  }
 
  CompanyID playas = (argc >= 2) ? (CompanyID)atoi(argv[1]) : COMPANY_SPECTATOR;
  switch (playas) {
    case 0: playas = COMPANY_NEW_COMPANY; break;
    case COMPANY_SPECTATOR: /* nothing to do */ break;
    default:
      /* From a user pov 0 is a new company, internally it's different and all
       * companies are offset by one to ease up on users (eg companies 1-8 not 0-7) */
      if (playas < COMPANY_FIRST + 1 || playas > MAX_COMPANIES + 1) return false;
      break;
  }
 
  if (_settings_client.network.last_joined.empty()) {
    IConsolePrint(CC_DEFAULT, "No server for reconnecting.");
    return true;
  }
 
  /* Don't resolve the address first, just print it directly as it comes from the config file. */
  IConsolePrint(CC_DEFAULT, "Reconnecting to {} ...", _settings_client.network.last_joined);
 
  return NetworkClientConnectGame(_settings_client.network.last_joined, playas);
}
 
DEF_CONSOLE_CMD(ConNetworkConnect)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Connect to a remote OTTD server and join the game. Usage: 'connect <ip>'.");
    IConsolePrint(CC_HELP, "IP can contain port and company: 'IP[:Port][#Company]', eg: 'server.ottd.org:443#2'.");
    IConsolePrint(CC_HELP, "Company #255 is spectator all others are a certain company with Company 1 being #1.");
    return true;
  }
 
  if (argc < 2) return false;
 
  return NetworkClientConnectGame(argv[1], COMPANY_NEW_COMPANY);
}
 
/*********************************
 *  script file console commands
 *********************************/
 
DEF_CONSOLE_CMD(ConExec)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Execute a local script file. Usage: 'exec <script> <?>'.");
    return true;
  }
 
  if (argc < 2) return false;
 
  FILE *script_file = FioFOpenFile(argv[1], "r", BASE_DIR);
 
  if (script_file == nullptr) {
    if (argc == 2 || atoi(argv[2]) != 0) IConsolePrint(CC_ERROR, "Script file '{}' not found.", argv[1]);
    return true;
  }
 
  if (_script_current_depth == 11) {
    FioFCloseFile(script_file);
    IConsolePrint(CC_ERROR, "Maximum 'exec' depth reached; script A is calling script B is calling script C ... more than 10 times.");
    return true;
  }
 
  _script_current_depth++;
  uint script_depth = _script_current_depth;
 
  char cmdline[ICON_CMDLN_SIZE];
  while (fgets(cmdline, sizeof(cmdline), script_file) != nullptr) {
    /* Remove newline characters from the executing script */
    for (char *cmdptr = cmdline; *cmdptr != '\0'; cmdptr++) {
      if (*cmdptr == '\n' || *cmdptr == '\r') {
        *cmdptr = '\0';
        break;
      }
    }
    IConsoleCmdExec(cmdline);
    /* Ensure that we are still on the same depth or that we returned via 'return'. */
    assert(_script_current_depth == script_depth || _script_current_depth == script_depth - 1);
 
    /* The 'return' command was executed. */
    if (_script_current_depth == script_depth - 1) break;
  }
 
  if (ferror(script_file)) {
    IConsolePrint(CC_ERROR, "Encountered error while trying to read from script file '{}'.", argv[1]);
  }
 
  if (_script_current_depth == script_depth) _script_current_depth--;
  FioFCloseFile(script_file);
  return true;
}
 
DEF_CONSOLE_CMD(ConReturn)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Stop executing a running script. Usage: 'return'.");
    return true;
  }
 
  _script_current_depth--;
  return true;
}
 
/*****************************
 *  default console commands
 ******************************/
extern bool CloseConsoleLogIfActive();
 
DEF_CONSOLE_CMD(ConScript)
{
  extern FILE *_iconsole_output_file;
 
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Start or stop logging console output to a file. Usage: 'script <filename>'.");
    IConsolePrint(CC_HELP, "If filename is omitted, a running log is stopped if it is active.");
    return true;
  }
 
  if (!CloseConsoleLogIfActive()) {
    if (argc < 2) return false;
 
    _iconsole_output_file = fopen(argv[1], "ab");
    if (_iconsole_output_file == nullptr) {
      IConsolePrint(CC_ERROR, "Could not open console log file '{}'.", argv[1]);
    } else {
      IConsolePrint(CC_INFO, "Console log output started to '{}'.", argv[1]);
    }
  }
 
  return true;
}
 
 
DEF_CONSOLE_CMD(ConEcho)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Print back the first argument to the console. Usage: 'echo <arg>'.");
    return true;
  }
 
  if (argc < 2) return false;
  IConsolePrint(CC_DEFAULT, argv[1]);
  return true;
}
 
DEF_CONSOLE_CMD(ConEchoC)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Print back the first argument to the console in a given colour. Usage: 'echoc <colour> <arg2>'.");
    return true;
  }
 
  if (argc < 3) return false;
  IConsolePrint((TextColour)Clamp(atoi(argv[1]), TC_BEGIN, TC_END - 1), argv[2]);
  return true;
}
 
DEF_CONSOLE_CMD(ConNewGame)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Start a new game. Usage: 'newgame [seed]'.");
    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.");
    return true;
  }
 
  StartNewGameWithoutGUI((argc == 2) ? strtoul(argv[1], nullptr, 10) : GENERATE_NEW_SEED);
  return true;
}
 
DEF_CONSOLE_CMD(ConRestart)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Restart game. Usage: 'restart'.");
    IConsolePrint(CC_HELP, "Restarts a game. It tries to reproduce the exact same map as the game started with.");
    IConsolePrint(CC_HELP, "However:");
    IConsolePrint(CC_HELP, " * restarting games started in another version might create another map due to difference in map generation.");
    IConsolePrint(CC_HELP, " * restarting games based on scenarios, loaded games or heightmaps will start a new game based on the settings stored in the scenario/savegame.");
    return true;
  }
 
  /* Don't copy the _newgame pointers to the real pointers, so call SwitchToMode directly */
  _settings_game.game_creation.map_x = MapLogX();
  _settings_game.game_creation.map_y = FindFirstBit(MapSizeY());
  _switch_mode = SM_RESTARTGAME;
  return true;
}
 
DEF_CONSOLE_CMD(ConReload)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Reload game. Usage: 'reload'.");
    IConsolePrint(CC_HELP, "Reloads a game.");
    IConsolePrint(CC_HELP, " * if you started from a savegame / scenario / heightmap, that exact same savegame / scenario / heightmap will be loaded.");
    IConsolePrint(CC_HELP, " * if you started from a new game, this acts the same as 'restart'.");
    return true;
  }
 
  /* Don't copy the _newgame pointers to the real pointers, so call SwitchToMode directly */
  _settings_game.game_creation.map_x = MapLogX();
  _settings_game.game_creation.map_y = FindFirstBit(MapSizeY());
  _switch_mode = SM_RELOADGAME;
  return true;
}
 
static void PrintLineByLine(const std::string &full_string)
{
  std::istringstream in(full_string);
  std::string line;
  while (std::getline(in, line)) {
    IConsolePrint(CC_DEFAULT, line.c_str());
  }
}
 
DEF_CONSOLE_CMD(ConListAILibs)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List installed AI libraries. Usage: 'list_ai_libs'.");
    return true;
  }
 
  const std::string output_str = AI::GetConsoleLibraryList();
  PrintLineByLine(output_str);
 
  return true;
}
 
DEF_CONSOLE_CMD(ConListAI)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List installed AIs. Usage: 'list_ai'.");
    return true;
  }
 
  const std::string output_str = AI::GetConsoleList();
  PrintLineByLine(output_str);
 
  return true;
}
 
DEF_CONSOLE_CMD(ConListGameLibs)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List installed Game Script libraries. Usage: 'list_game_libs'.");
    return true;
  }
 
  const std::string output_str = Game::GetConsoleLibraryList();
  PrintLineByLine(output_str);
 
  return true;
}
 
DEF_CONSOLE_CMD(ConListGame)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List installed Game Scripts. Usage: 'list_game'.");
    return true;
  }
 
  const std::string output_str = Game::GetConsoleList();
  PrintLineByLine(output_str);
 
  return true;
}
 
DEF_CONSOLE_CMD(ConStartAI)
{
  if (argc == 0 || argc > 3) {
    IConsolePrint(CC_HELP, "Start a new AI. Usage: 'start_ai [<AI>] [<settings>]'.");
    IConsolePrint(CC_HELP, "Start a new AI. If <AI> is given, it starts that specific AI (if found).");
    IConsolePrint(CC_HELP, "If <settings> is given, it is parsed and the AI settings are set to that.");
    return true;
  }
 
  if (_game_mode != GM_NORMAL) {
    IConsolePrint(CC_ERROR, "AIs can only be managed in a game.");
    return true;
  }
 
  if (Company::GetNumItems() == CompanyPool::MAX_SIZE) {
    IConsolePrint(CC_ERROR, "Can't start a new AI (no more free slots).");
    return true;
  }
  if (_networking && !_network_server) {
    IConsolePrint(CC_ERROR, "Only the server can start a new AI.");
    return true;
  }
  if (_networking && !_settings_game.ai.ai_in_multiplayer) {
    IConsolePrint(CC_ERROR, "AIs are not allowed in multiplayer by configuration.");
    IConsolePrint(CC_ERROR, "Switch AI -> AI in multiplayer to True.");
    return true;
  }
  if (!AI::CanStartNew()) {
    IConsolePrint(CC_ERROR, "Can't start a new AI.");
    return true;
  }
 
  int n = 0;
  /* Find the next free slot */
  for (const Company *c : Company::Iterate()) {
    if (c->index != n) break;
    n++;
  }
 
  AIConfig *config = AIConfig::GetConfig((CompanyID)n);
  if (argc >= 2) {
    config->Change(argv[1], -1, false);
 
    /* If the name is not found, and there is a dot in the name,
     * try again with the assumption everything right of the dot is
     * the version the user wants to load. */
    if (!config->HasScript()) {
      char *name = stredup(argv[1]);
      char *e = strrchr(name, '.');
      if (e != nullptr) {
        *e = '\0';
        e++;
 
        int version = atoi(e);
        config->Change(name, version, true);
      }
      free(name);
    }
 
    if (!config->HasScript()) {
      IConsolePrint(CC_ERROR, "Failed to load the specified AI.");
      return true;
    }
    if (argc == 3) {
      config->StringToSettings(argv[2]);
    }
  }
 
  /* Start a new AI company */
  Command<CMD_COMPANY_CTRL>::Post(CCA_NEW_AI, INVALID_COMPANY, CRR_NONE, INVALID_CLIENT_ID);
 
  return true;
}
 
DEF_CONSOLE_CMD(ConReloadAI)
{
  if (argc != 2) {
    IConsolePrint(CC_HELP, "Reload an AI. Usage: 'reload_ai <company-id>'.");
    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.");
    return true;
  }
 
  if (_game_mode != GM_NORMAL) {
    IConsolePrint(CC_ERROR, "AIs can only be managed in a game.");
    return true;
  }
 
  if (_networking && !_network_server) {
    IConsolePrint(CC_ERROR, "Only the server can reload an AI.");
    return true;
  }
 
  CompanyID company_id = (CompanyID)(atoi(argv[1]) - 1);
  if (!Company::IsValidID(company_id)) {
    IConsolePrint(CC_ERROR, "Unknown company. Company range is between 1 and {}.", MAX_COMPANIES);
    return true;
  }
 
  /* In singleplayer mode the player can be in an AI company, after cheating or loading network save with an AI in first slot. */
  if (Company::IsHumanID(company_id) || company_id == _local_company) {
    IConsolePrint(CC_ERROR, "Company is not controlled by an AI.");
    return true;
  }
 
  /* First kill the company of the AI, then start a new one. This should start the current AI again */
  Command<CMD_COMPANY_CTRL>::Post(CCA_DELETE, company_id, CRR_MANUAL, INVALID_CLIENT_ID);
  Command<CMD_COMPANY_CTRL>::Post(CCA_NEW_AI, company_id, CRR_NONE, INVALID_CLIENT_ID);
  IConsolePrint(CC_DEFAULT, "AI reloaded.");
 
  return true;
}
 
DEF_CONSOLE_CMD(ConStopAI)
{
  if (argc != 2) {
    IConsolePrint(CC_HELP, "Stop an AI. Usage: 'stop_ai <company-id>'.");
    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.");
    return true;
  }
 
  if (_game_mode != GM_NORMAL) {
    IConsolePrint(CC_ERROR, "AIs can only be managed in a game.");
    return true;
  }
 
  if (_networking && !_network_server) {
    IConsolePrint(CC_ERROR, "Only the server can stop an AI.");
    return true;
  }
 
  CompanyID company_id = (CompanyID)(atoi(argv[1]) - 1);
  if (!Company::IsValidID(company_id)) {
    IConsolePrint(CC_ERROR, "Unknown company. Company range is between 1 and {}.", MAX_COMPANIES);
    return true;
  }
 
  /* In singleplayer mode the player can be in an AI company, after cheating or loading network save with an AI in first slot. */
  if (Company::IsHumanID(company_id) || company_id == _local_company) {
    IConsolePrint(CC_ERROR, "Company is not controlled by an AI.");
    return true;
  }
 
  /* Now kill the company of the AI. */
  Command<CMD_COMPANY_CTRL>::Post(CCA_DELETE, company_id, CRR_MANUAL, INVALID_CLIENT_ID);
  IConsolePrint(CC_DEFAULT, "AI stopped, company deleted.");
 
  return true;
}
 
DEF_CONSOLE_CMD(ConRescanAI)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Rescan the AI dir for scripts. Usage: 'rescan_ai'.");
    return true;
  }
 
  if (_networking && !_network_server) {
    IConsolePrint(CC_ERROR, "Only the server can rescan the AI dir for scripts.");
    return true;
  }
 
  AI::Rescan();
 
  return true;
}
 
DEF_CONSOLE_CMD(ConRescanGame)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Rescan the Game Script dir for scripts. Usage: 'rescan_game'.");
    return true;
  }
 
  if (_networking && !_network_server) {
    IConsolePrint(CC_ERROR, "Only the server can rescan the Game Script dir for scripts.");
    return true;
  }
 
  Game::Rescan();
 
  return true;
}
 
DEF_CONSOLE_CMD(ConRescanNewGRF)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Rescan the data dir for NewGRFs. Usage: 'rescan_newgrf'.");
    return true;
  }
 
  if (!RequestNewGRFScan()) {
    IConsolePrint(CC_ERROR, "NewGRF scanning is already running. Please wait until completed to run again.");
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConGetSeed)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Returns the seed used to create this game. Usage: 'getseed'.");
    IConsolePrint(CC_HELP, "The seed can be used to reproduce the exact same map as the game started with.");
    return true;
  }
 
  IConsolePrint(CC_DEFAULT, "Generation Seed: {}", _settings_game.game_creation.generation_seed);
  return true;
}
 
DEF_CONSOLE_CMD(ConGetDate)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Returns the current date (year-month-day) of the game. Usage: 'getdate'.");
    return true;
  }
 
  YearMonthDay ymd;
  ConvertDateToYMD(_date, &ymd);
  IConsolePrint(CC_DEFAULT, "Date: {:04d}-{:02d}-{:02d}", ymd.year, ymd.month + 1, ymd.day);
  return true;
}
 
DEF_CONSOLE_CMD(ConGetSysDate)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Returns the current date (year-month-day) of your system. Usage: 'getsysdate'.");
    return true;
  }
 
  char buffer[lengthof("2000-01-02 03:04:05")];
  LocalTime::Format(buffer, lastof(buffer), "%Y-%m-%d %H:%M:%S");
  IConsolePrint(CC_DEFAULT, "System Date: {}", buffer);
  return true;
}
 
 
DEF_CONSOLE_CMD(ConAlias)
{
  IConsoleAlias *alias;
 
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Add a new alias, or redefine the behaviour of an existing alias . Usage: 'alias <name> <command>'.");
    return true;
  }
 
  if (argc < 3) return false;
 
  alias = IConsole::AliasGet(argv[1]);
  if (alias == nullptr) {
    IConsole::AliasRegister(argv[1], argv[2]);
  } else {
    alias->cmdline = argv[2];
  }
  return true;
}
 
DEF_CONSOLE_CMD(ConScreenShot)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Create a screenshot of the game. Usage: 'screenshot [viewport | normal | big | giant | heightmap | minimap] [no_con] [size <width> <height>] [<filename>]'.");
    IConsolePrint(CC_HELP, "  'viewport' (default) makes a screenshot of the current viewport (including menus, windows).");
    IConsolePrint(CC_HELP, "  'normal' makes a screenshot of the visible area.");
    IConsolePrint(CC_HELP, "  'big' makes a zoomed-in screenshot of the visible area.");
    IConsolePrint(CC_HELP, "  'giant' makes a screenshot of the whole map.");
    IConsolePrint(CC_HELP, "  'heightmap' makes a heightmap screenshot of the map that can be loaded in as heightmap.");
    IConsolePrint(CC_HELP, "  'minimap' makes a top-viewed minimap screenshot of the whole world which represents one tile by one pixel.");
    IConsolePrint(CC_HELP, "  'no_con' hides the console to create the screenshot (only useful in combination with 'viewport').");
    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').");
    return true;
  }
 
  if (argc > 7) return false;
 
  ScreenshotType type = SC_VIEWPORT;
  uint32 width = 0;
  uint32 height = 0;
  std::string name{};
  uint32 arg_index = 1;
 
  if (argc > arg_index) {
    if (strcmp(argv[arg_index], "viewport") == 0) {
      type = SC_VIEWPORT;
      arg_index += 1;
    } else if (strcmp(argv[arg_index], "normal") == 0) {
      type = SC_DEFAULTZOOM;
      arg_index += 1;
    } else if (strcmp(argv[arg_index], "big") == 0) {
      type = SC_ZOOMEDIN;
      arg_index += 1;
    } else if (strcmp(argv[arg_index], "giant") == 0) {
      type = SC_WORLD;
      arg_index += 1;
    } else if (strcmp(argv[arg_index], "heightmap") == 0) {
      type = SC_HEIGHTMAP;
      arg_index += 1;
    } else if (strcmp(argv[arg_index], "minimap") == 0) {
      type = SC_MINIMAP;
      arg_index += 1;
    }
  }
 
  if (argc > arg_index && strcmp(argv[arg_index], "no_con") == 0) {
    if (type != SC_VIEWPORT) {
      IConsolePrint(CC_ERROR, "'no_con' can only be used in combination with 'viewport'.");
      return true;
    }
    IConsoleClose();
    arg_index += 1;
  }
 
  if (argc > arg_index + 2 && strcmp(argv[arg_index], "size") == 0) {
    /* size <width> <height> */
    if (type != SC_DEFAULTZOOM && type != SC_ZOOMEDIN) {
      IConsolePrint(CC_ERROR, "'size' can only be used in combination with 'normal' or 'big'.");
      return true;
    }
    GetArgumentInteger(&width, argv[arg_index + 1]);
    GetArgumentInteger(&height, argv[arg_index + 2]);
    arg_index += 3;
  }
 
  if (argc > arg_index) {
    /* Last parameter that was not one of the keywords must be the filename. */
    name = argv[arg_index];
    arg_index += 1;
  }
 
  if (argc > arg_index) {
    /* We have parameters we did not process; means we misunderstood any of the above. */
    return false;
  }
 
  MakeScreenshot(type, name, width, height);
  return true;
}
 
DEF_CONSOLE_CMD(ConInfoCmd)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Print out debugging information about a command. Usage: 'info_cmd <cmd>'.");
    return true;
  }
 
  if (argc < 2) return false;
 
  const IConsoleCmd *cmd = IConsole::CmdGet(argv[1]);
  if (cmd == nullptr) {
    IConsolePrint(CC_ERROR, "The given command was not found.");
    return true;
  }
 
  IConsolePrint(CC_DEFAULT, "Command name: '{}'", cmd->name);
 
  if (cmd->hook != nullptr) IConsolePrint(CC_DEFAULT, "Command is hooked.");
 
  return true;
}
 
DEF_CONSOLE_CMD(ConDebugLevel)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Get/set the default debugging level for the game. Usage: 'debug_level [<level>]'.");
    IConsolePrint(CC_HELP, "Level can be any combination of names, levels. Eg 'net=5 ms=4'. Remember to enclose it in \"'\"s.");
    return true;
  }
 
  if (argc > 2) return false;
 
  if (argc == 1) {
    IConsolePrint(CC_DEFAULT, "Current debug-level: '{}'", GetDebugString());
  } else {
    SetDebugString(argv[1], [](const char *err) { IConsolePrint(CC_ERROR, std::string(err)); });
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConExit)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Exit the game. Usage: 'exit'.");
    return true;
  }
 
  if (_game_mode == GM_NORMAL && _settings_client.gui.autosave_on_exit) DoExitSave();
 
  _exit_game = true;
  return true;
}
 
DEF_CONSOLE_CMD(ConPart)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Leave the currently joined/running game (only ingame). Usage: 'part'.");
    return true;
  }
 
  if (_game_mode != GM_NORMAL) return false;
 
  _switch_mode = SM_MENU;
  return true;
}
 
DEF_CONSOLE_CMD(ConHelp)
{
  if (argc == 2) {
    const IConsoleCmd *cmd;
    const IConsoleAlias *alias;
 
    cmd = IConsole::CmdGet(argv[1]);
    if (cmd != nullptr) {
      cmd->proc(0, nullptr);
      return true;
    }
 
    alias = IConsole::AliasGet(argv[1]);
    if (alias != nullptr) {
      cmd = IConsole::CmdGet(alias->cmdline);
      if (cmd != nullptr) {
        cmd->proc(0, nullptr);
        return true;
      }
      IConsolePrint(CC_ERROR, "Alias is of special type, please see its execution-line: '{}'.", alias->cmdline);
      return true;
    }
 
    IConsolePrint(CC_ERROR, "Command not found.");
    return true;
  }
 
  IConsolePrint(TC_LIGHT_BLUE, " ---- OpenTTD Console Help ---- ");
  IConsolePrint(CC_DEFAULT, " - commands: the command to list all commands is 'list_cmds'.");
  IConsolePrint(CC_DEFAULT, " call commands with '<command> <arg2> <arg3>...'");
  IConsolePrint(CC_DEFAULT, " - to assign strings, or use them as arguments, enclose it within quotes.");
  IConsolePrint(CC_DEFAULT, " like this: '<command> \"string argument with spaces\"'.");
  IConsolePrint(CC_DEFAULT, " - use 'help <command>' to get specific information.");
  IConsolePrint(CC_DEFAULT, " - scroll console output with shift + (up | down | pageup | pagedown).");
  IConsolePrint(CC_DEFAULT, " - scroll console input history with the up or down arrows.");
  IConsolePrint(CC_DEFAULT, "");
  return true;
}
 
DEF_CONSOLE_CMD(ConListCommands)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List all registered commands. Usage: 'list_cmds [<pre-filter>]'.");
    return true;
  }
 
  for (auto &it : IConsole::Commands()) {
    const IConsoleCmd *cmd = &it.second;
    if (argv[1] == nullptr || cmd->name.find(argv[1]) != std::string::npos) {
      if (cmd->hook == nullptr || cmd->hook(false) != CHR_HIDE) IConsolePrint(CC_DEFAULT, cmd->name);
    }
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConListAliases)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List all registered aliases. Usage: 'list_aliases [<pre-filter>]'.");
    return true;
  }
 
  for (auto &it : IConsole::Aliases()) {
    const IConsoleAlias *alias = &it.second;
    if (argv[1] == nullptr || alias->name.find(argv[1]) != std::string::npos) {
      IConsolePrint(CC_DEFAULT, "{} => {}", alias->name, alias->cmdline);
    }
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConCompanies)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List the details of all companies in the game. Usage 'companies'.");
    return true;
  }
 
  for (const Company *c : Company::Iterate()) {
    /* Grab the company name */
    char company_name[512];
    SetDParam(0, c->index);
    GetString(company_name, STR_COMPANY_NAME, lastof(company_name));
 
    const char *password_state = "";
    if (c->is_ai) {
      password_state = "AI";
    } else if (_network_server) {
      password_state = _network_company_states[c->index].password.empty() ? "unprotected" : "protected";
    }
 
    char colour[512];
    GetString(colour, STR_COLOUR_DARK_BLUE + _company_colours[c->index], lastof(colour));
    IConsolePrint(CC_INFO, "#:{}({}) Company Name: '{}'  Year Founded: {}  Money: {}  Loan: {}  Value: {}  (T:{}, R:{}, P:{}, S:{}) {}",
      c->index + 1, colour, company_name,
      c->inaugurated_year, (int64)c->money, (int64)c->current_loan, (int64)CalculateCompanyValue(c),
      c->group_all[VEH_TRAIN].num_vehicle,
      c->group_all[VEH_ROAD].num_vehicle,
      c->group_all[VEH_AIRCRAFT].num_vehicle,
      c->group_all[VEH_SHIP].num_vehicle,
      password_state);
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConSay)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Chat to your fellow players in a multiplayer game. Usage: 'say \"<msg>\"'.");
    return true;
  }
 
  if (argc != 2) return false;
 
  if (!_network_server) {
    NetworkClientSendChat(NETWORK_ACTION_CHAT, DESTTYPE_BROADCAST, 0 /* param does not matter */, argv[1]);
  } else {
    bool from_admin = (_redirect_console_to_admin < INVALID_ADMIN_ID);
    NetworkServerSendChat(NETWORK_ACTION_CHAT, DESTTYPE_BROADCAST, 0, argv[1], CLIENT_ID_SERVER, from_admin);
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConSayCompany)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Chat to a certain company in a multiplayer game. Usage: 'say_company <company-no> \"<msg>\"'.");
    IConsolePrint(CC_HELP, "CompanyNo is the company that plays as company <companyno>, 1 through max_companies.");
    return true;
  }
 
  if (argc != 3) return false;
 
  CompanyID company_id = (CompanyID)(atoi(argv[1]) - 1);
  if (!Company::IsValidID(company_id)) {
    IConsolePrint(CC_DEFAULT, "Unknown company. Company range is between 1 and {}.", MAX_COMPANIES);
    return true;
  }
 
  if (!_network_server) {
    NetworkClientSendChat(NETWORK_ACTION_CHAT_COMPANY, DESTTYPE_TEAM, company_id, argv[2]);
  } else {
    bool from_admin = (_redirect_console_to_admin < INVALID_ADMIN_ID);
    NetworkServerSendChat(NETWORK_ACTION_CHAT_COMPANY, DESTTYPE_TEAM, company_id, argv[2], CLIENT_ID_SERVER, from_admin);
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConSayClient)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Chat to a certain client in a multiplayer game. Usage: 'say_client <client-no> \"<msg>\"'.");
    IConsolePrint(CC_HELP, "For client-id's, see the command 'clients'.");
    return true;
  }
 
  if (argc != 3) return false;
 
  if (!_network_server) {
    NetworkClientSendChat(NETWORK_ACTION_CHAT_CLIENT, DESTTYPE_CLIENT, atoi(argv[1]), argv[2]);
  } else {
    bool from_admin = (_redirect_console_to_admin < INVALID_ADMIN_ID);
    NetworkServerSendChat(NETWORK_ACTION_CHAT_CLIENT, DESTTYPE_CLIENT, atoi(argv[1]), argv[2], CLIENT_ID_SERVER, from_admin);
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConCompanyPassword)
{
  if (argc == 0) {
    if (_network_dedicated) {
      IConsolePrint(CC_HELP, "Change the password of a company. Usage: 'company_pw <company-no> \"<password>\".");
    } else if (_network_server) {
      IConsolePrint(CC_HELP, "Change the password of your or any other company. Usage: 'company_pw [<company-no>] \"<password>\"'.");
    } else {
      IConsolePrint(CC_HELP, "Change the password of your company. Usage: 'company_pw \"<password>\"'.");
    }
 
    IConsolePrint(CC_HELP, "Use \"*\" to disable the password.");
    return true;
  }
 
  CompanyID company_id;
  std::string password;
  const char *errormsg;
 
  if (argc == 2) {
    company_id = _local_company;
    password = argv[1];
    errormsg = "You have to own a company to make use of this command.";
  } else if (argc == 3 && _network_server) {
    company_id = (CompanyID)(atoi(argv[1]) - 1);
    password = argv[2];
    errormsg = "You have to specify the ID of a valid human controlled company.";
  } else {
    return false;
  }
 
  if (!Company::IsValidHumanID(company_id)) {
    IConsolePrint(CC_ERROR, errormsg);
    return false;
  }
 
  password = NetworkChangeCompanyPassword(company_id, password);
 
  if (password.empty()) {
    IConsolePrint(CC_INFO, "Company password cleared.");
  } else {
    IConsolePrint(CC_INFO, "Company password changed to '{}'.", password);
  }
 
  return true;
}
 
/* Content downloading only is available with ZLIB */
#if defined(WITH_ZLIB)
#include "network/network_content.h"
 
static ContentType StringToContentType(const char *str)
{
  static const char * const inv_lookup[] = { "", "base", "newgrf", "ai", "ailib", "scenario", "heightmap" };
  for (uint i = 1 /* there is no type 0 */; i < lengthof(inv_lookup); i++) {
    if (strcasecmp(str, inv_lookup[i]) == 0) return (ContentType)i;
  }
  return CONTENT_TYPE_END;
}
 
struct ConsoleContentCallback : public ContentCallback {
  void OnConnect(bool success)
  {
    IConsolePrint(CC_DEFAULT, "Content server connection {}.", success ? "established" : "failed");
  }
 
  void OnDisconnect()
  {
    IConsolePrint(CC_DEFAULT, "Content server connection closed.");
  }
 
  void OnDownloadComplete(ContentID cid)
  {
    IConsolePrint(CC_DEFAULT, "Completed download of {}.", cid);
  }
};
 
static void OutputContentState(const ContentInfo *const ci)
{
  static const char * const types[] = { "Base graphics", "NewGRF", "AI", "AI library", "Scenario", "Heightmap", "Base sound", "Base music", "Game script", "GS library" };
  static_assert(lengthof(types) == CONTENT_TYPE_END - CONTENT_TYPE_BEGIN);
  static const char * const states[] = { "Not selected", "Selected", "Dep Selected", "Installed", "Unknown" };
  static const TextColour state_to_colour[] = { CC_COMMAND, CC_INFO, CC_INFO, CC_WHITE, CC_ERROR };
 
  char buf[sizeof(ci->md5sum) * 2 + 1];
  md5sumToString(buf, lastof(buf), ci->md5sum);
  IConsolePrint(state_to_colour[ci->state], "{}, {}, {}, {}, {:08X}, {}", ci->id, types[ci->type - 1], states[ci->state], ci->name, ci->unique_id, buf);
}
 
DEF_CONSOLE_CMD(ConContent)
{
  static ContentCallback *cb = nullptr;
  if (cb == nullptr) {
    cb = new ConsoleContentCallback();
    _network_content_client.AddCallback(cb);
  }
 
  if (argc <= 1) {
    IConsolePrint(CC_HELP, "Query, select and download content. Usage: 'content update|upgrade|select [id]|unselect [all|id]|state [filter]|download'.");
    IConsolePrint(CC_HELP, "  update: get a new list of downloadable content; must be run first.");
    IConsolePrint(CC_HELP, "  upgrade: select all items that are upgrades.");
    IConsolePrint(CC_HELP, "  select: select a specific item given by its id. If no parameter is given, all selected content will be listed.");
    IConsolePrint(CC_HELP, "  unselect: unselect a specific item given by its id or 'all' to unselect all.");
    IConsolePrint(CC_HELP, "  state: show the download/select state of all downloadable content. Optionally give a filter string.");
    IConsolePrint(CC_HELP, "  download: download all content you've selected.");
    return true;
  }
 
  if (strcasecmp(argv[1], "update") == 0) {
    _network_content_client.RequestContentList((argc > 2) ? StringToContentType(argv[2]) : CONTENT_TYPE_END);
    return true;
  }
 
  if (strcasecmp(argv[1], "upgrade") == 0) {
    _network_content_client.SelectUpgrade();
    return true;
  }
 
  if (strcasecmp(argv[1], "select") == 0) {
    if (argc <= 2) {
      /* List selected content */
      IConsolePrint(CC_WHITE, "id, type, state, name");
      for (ConstContentIterator iter = _network_content_client.Begin(); iter != _network_content_client.End(); iter++) {
        if ((*iter)->state != ContentInfo::SELECTED && (*iter)->state != ContentInfo::AUTOSELECTED) continue;
        OutputContentState(*iter);
      }
    } else if (strcasecmp(argv[2], "all") == 0) {
      /* The intention of this function was that you could download
       * everything after a filter was applied; but this never really
       * took off. Instead, a select few people used this functionality
       * to download every available package on BaNaNaS. This is not in
       * the spirit of this service. Additionally, these few people were
       * good for 70% of the consumed bandwidth of BaNaNaS. */
      IConsolePrint(CC_ERROR, "'select all' is no longer supported since 1.11.");
    } else {
      _network_content_client.Select((ContentID)atoi(argv[2]));
    }
    return true;
  }
 
  if (strcasecmp(argv[1], "unselect") == 0) {
    if (argc <= 2) {
      IConsolePrint(CC_ERROR, "You must enter the id.");
      return false;
    }
    if (strcasecmp(argv[2], "all") == 0) {
      _network_content_client.UnselectAll();
    } else {
      _network_content_client.Unselect((ContentID)atoi(argv[2]));
    }
    return true;
  }
 
  if (strcasecmp(argv[1], "state") == 0) {
    IConsolePrint(CC_WHITE, "id, type, state, name");
    for (ConstContentIterator iter = _network_content_client.Begin(); iter != _network_content_client.End(); iter++) {
      if (argc > 2 && strcasestr((*iter)->name.c_str(), argv[2]) == nullptr) continue;
      OutputContentState(*iter);
    }
    return true;
  }
 
  if (strcasecmp(argv[1], "download") == 0) {
    uint files;
    uint bytes;
    _network_content_client.DownloadSelectedContent(files, bytes);
    IConsolePrint(CC_DEFAULT, "Downloading {} file(s) ({} bytes).", files, bytes);
    return true;
  }
 
  return false;
}
#endif /* defined(WITH_ZLIB) */
 
DEF_CONSOLE_CMD(ConSetting)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Change setting for all clients. Usage: 'setting <name> [<value>]'.");
    IConsolePrint(CC_HELP, "Omitting <value> will print out the current value of the setting.");
    return true;
  }
 
  if (argc == 1 || argc > 3) return false;
 
  if (argc == 2) {
    IConsoleGetSetting(argv[1]);
  } else {
    IConsoleSetSetting(argv[1], argv[2]);
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConSettingNewgame)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Change setting for the next game. Usage: 'setting_newgame <name> [<value>]'.");
    IConsolePrint(CC_HELP, "Omitting <value> will print out the current value of the setting.");
    return true;
  }
 
  if (argc == 1 || argc > 3) return false;
 
  if (argc == 2) {
    IConsoleGetSetting(argv[1], true);
  } else {
    IConsoleSetSetting(argv[1], argv[2], true);
  }
 
  return true;
}
 
DEF_CONSOLE_CMD(ConListSettings)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "List settings. Usage: 'list_settings [<pre-filter>]'.");
    return true;
  }
 
  if (argc > 2) return false;
 
  IConsoleListSettings((argc == 2) ? argv[1] : nullptr);
  return true;
}
 
DEF_CONSOLE_CMD(ConGamelogPrint)
{
  GamelogPrintConsole();
  return true;
}
 
DEF_CONSOLE_CMD(ConNewGRFReload)
{
  if (argc == 0) {
    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!");
    return true;
  }
 
  ReloadNewGRFData();
  return true;
}
 
DEF_CONSOLE_CMD(ConListDirs)
{
  struct SubdirNameMap {
    Subdirectory subdir; 
    const char *name;    
    bool default_only;   
  };
  static const SubdirNameMap subdir_name_map[] = {
    /* Game data directories */
    { BASESET_DIR,      "baseset",    false },
    { NEWGRF_DIR,       "newgrf",     false },
    { AI_DIR,           "ai",         false },
    { AI_LIBRARY_DIR,   "ailib",      false },
    { GAME_DIR,         "gs",         false },
    { GAME_LIBRARY_DIR, "gslib",      false },
    { SCENARIO_DIR,     "scenario",   false },
    { HEIGHTMAP_DIR,    "heightmap",  false },
    /* Default save locations for user data */
    { SAVE_DIR,         "save",       true  },
    { AUTOSAVE_DIR,     "autosave",   true  },
    { SCREENSHOT_DIR,   "screenshot", true  },
  };
 
  if (argc != 2) {
    IConsolePrint(CC_HELP, "List all search paths or default directories for various categories.");
    IConsolePrint(CC_HELP, "Usage: list_dirs <category>");
    std::string cats = subdir_name_map[0].name;
    bool first = true;
    for (const SubdirNameMap &sdn : subdir_name_map) {
      if (!first) cats = cats + ", " + sdn.name;
      first = false;
    }
    IConsolePrint(CC_HELP, "Valid categories: {}", cats);
    return true;
  }
 
  std::set<std::string> seen_dirs;
  for (const SubdirNameMap &sdn : subdir_name_map) {
    if (strcasecmp(argv[1], sdn.name) != 0)  continue;
    bool found = false;
    for (Searchpath sp : _valid_searchpaths) {
      /* Get the directory */
      std::string path = FioGetDirectory(sp, sdn.subdir);
      /* Check it hasn't already been listed */
      if (seen_dirs.find(path) != seen_dirs.end()) continue;
      seen_dirs.insert(path);
      /* Check if exists and mark found */
      bool exists = FileExists(path);
      found |= exists;
      /* Print */
      if (!sdn.default_only || exists) {
        IConsolePrint(exists ? CC_DEFAULT : CC_INFO, "{} {}", path, exists ? "[ok]" : "[not found]");
        if (sdn.default_only) break;
      }
    }
    if (!found) {
      IConsolePrint(CC_ERROR, "No directories exist for category {}", argv[1]);
    }
    return true;
  }
 
  IConsolePrint(CC_ERROR, "Invalid category name: {}", argv[1]);
  return false;
}
 
DEF_CONSOLE_CMD(ConNewGRFProfile)
{
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Collect performance data about NewGRF sprite requests and callbacks. Sub-commands can be abbreviated.");
    IConsolePrint(CC_HELP, "Usage: 'newgrf_profile [list]':");
    IConsolePrint(CC_HELP, "  List all NewGRFs that can be profiled, and their status.");
    IConsolePrint(CC_HELP, "Usage: 'newgrf_profile select <grf-num>...':");
    IConsolePrint(CC_HELP, "  Select one or more GRFs for profiling.");
    IConsolePrint(CC_HELP, "Usage: 'newgrf_profile unselect <grf-num>...':");
    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.");
    IConsolePrint(CC_HELP, "Usage: 'newgrf_profile start [<num-days>]':");
    IConsolePrint(CC_HELP, "  Begin profiling all selected GRFs. If a number of days is provided, profiling stops after that many in-game days.");
    IConsolePrint(CC_HELP, "Usage: 'newgrf_profile stop':");
    IConsolePrint(CC_HELP, "  End profiling and write the collected data to CSV files.");
    IConsolePrint(CC_HELP, "Usage: 'newgrf_profile abort':");
    IConsolePrint(CC_HELP, "  End profiling and discard all collected data.");
    return true;
  }
 
  extern const std::vector<GRFFile *> &GetAllGRFFiles();
  const std::vector<GRFFile *> &files = GetAllGRFFiles();
 
  /* "list" sub-command */
  if (argc == 1 || strncasecmp(argv[1], "lis", 3) == 0) {
    IConsolePrint(CC_INFO, "Loaded GRF files:");
    int i = 1;
    for (GRFFile *grf : files) {
      auto profiler = std::find_if(_newgrf_profilers.begin(), _newgrf_profilers.end(), [&](NewGRFProfiler &pr) { return pr.grffile == grf; });
      bool selected = profiler != _newgrf_profilers.end();
      bool active = selected && profiler->active;
      TextColour tc = active ? TC_LIGHT_BLUE : selected ? TC_GREEN : CC_INFO;
      const char *statustext = active ? " (active)" : selected ? " (selected)" : "";
      IConsolePrint(tc, "{}: [{:08X}] {}{}", i, BSWAP32(grf->grfid), grf->filename, statustext);
      i++;
    }
    return true;
  }
 
  /* "select" sub-command */
  if (strncasecmp(argv[1], "sel", 3) == 0 && argc >= 3) {
    for (size_t argnum = 2; argnum < argc; ++argnum) {
      int grfnum = atoi(argv[argnum]);
      if (grfnum < 1 || grfnum > (int)files.size()) { // safe cast, files.size() should not be larger than a few hundred in the most extreme cases
        IConsolePrint(CC_WARNING, "GRF number {} out of range, not added.", grfnum);
        continue;
      }
      GRFFile *grf = files[grfnum - 1];
      if (std::any_of(_newgrf_profilers.begin(), _newgrf_profilers.end(), [&](NewGRFProfiler &pr) { return pr.grffile == grf; })) {
        IConsolePrint(CC_WARNING, "GRF number {} [{:08X}] is already selected for profiling.", grfnum, BSWAP32(grf->grfid));
        continue;
      }
      _newgrf_profilers.emplace_back(grf);
    }
    return true;
  }
 
  /* "unselect" sub-command */
  if (strncasecmp(argv[1], "uns", 3) == 0 && argc >= 3) {
    for (size_t argnum = 2; argnum < argc; ++argnum) {
      if (strcasecmp(argv[argnum], "all") == 0) {
        _newgrf_profilers.clear();
        break;
      }
      int grfnum = atoi(argv[argnum]);
      if (grfnum < 1 || grfnum > (int)files.size()) {
        IConsolePrint(CC_WARNING, "GRF number {} out of range, not removing.", grfnum);
        continue;
      }
      GRFFile *grf = files[grfnum - 1];
      auto pos = std::find_if(_newgrf_profilers.begin(), _newgrf_profilers.end(), [&](NewGRFProfiler &pr) { return pr.grffile == grf; });
      if (pos != _newgrf_profilers.end()) _newgrf_profilers.erase(pos);
    }
    return true;
  }
 
  /* "start" sub-command */
  if (strncasecmp(argv[1], "sta", 3) == 0) {
    std::string grfids;
    size_t started = 0;
    for (NewGRFProfiler &pr : _newgrf_profilers) {
      if (!pr.active) {
        pr.Start();
        started++;
 
        if (!grfids.empty()) grfids += ", ";
        char grfidstr[12]{ 0 };
        seprintf(grfidstr, lastof(grfidstr), "[%08X]", BSWAP32(pr.grffile->grfid));
        grfids += grfidstr;
      }
    }
    if (started > 0) {
      IConsolePrint(CC_DEBUG, "Started profiling for GRFID{} {}.", (started > 1) ? "s" : "", grfids);
      if (argc >= 3) {
        int days = std::max(atoi(argv[2]), 1);
        _newgrf_profile_end_date = _date + days;
 
        char datestrbuf[32]{ 0 };
        SetDParam(0, _newgrf_profile_end_date);
        GetString(datestrbuf, STR_JUST_DATE_ISO, lastof(datestrbuf));
        IConsolePrint(CC_DEBUG, "Profiling will automatically stop on game date {}.", datestrbuf);
      } else {
        _newgrf_profile_end_date = MAX_DAY;
      }
    } else if (_newgrf_profilers.empty()) {
      IConsolePrint(CC_ERROR, "No GRFs selected for profiling, did not start.");
    } else {
      IConsolePrint(CC_ERROR, "Did not start profiling for any GRFs, all selected GRFs are already profiling.");
    }
    return true;
  }
 
  /* "stop" sub-command */
  if (strncasecmp(argv[1], "sto", 3) == 0) {
    NewGRFProfiler::FinishAll();
    return true;
  }
 
  /* "abort" sub-command */
  if (strncasecmp(argv[1], "abo", 3) == 0) {
    for (NewGRFProfiler &pr : _newgrf_profilers) {
      pr.Abort();
    }
    _newgrf_profile_end_date = MAX_DAY;
    return true;
  }
 
  return false;
}
 
#ifdef _DEBUG
/******************
 *  debug commands
 ******************/
 
static void IConsoleDebugLibRegister()
{
  IConsole::CmdRegister("resettile",        ConResetTile);
  IConsole::AliasRegister("dbg_echo",       "echo %A; echo %B");
  IConsole::AliasRegister("dbg_echo2",      "echo %!");
}
#endif
 
DEF_CONSOLE_CMD(ConFramerate)
{
  extern void ConPrintFramerate(); // framerate_gui.cpp
 
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Show frame rate and game speed information.");
    return true;
  }
 
  ConPrintFramerate();
  return true;
}
 
DEF_CONSOLE_CMD(ConFramerateWindow)
{
  extern void ShowFramerateWindow();
 
  if (argc == 0) {
    IConsolePrint(CC_HELP, "Open the frame rate window.");
    return true;
  }
 
  if (_network_dedicated) {
    IConsolePrint(CC_ERROR, "Can not open frame rate window on a dedicated server.");
    return false;
  }
 
  ShowFramerateWindow();
  return true;
}
 
static void ConDumpRoadTypes()
{
  IConsolePrint(CC_DEFAULT, "  Flags:");
  IConsolePrint(CC_DEFAULT, "    c = catenary");
  IConsolePrint(CC_DEFAULT, "    l = no level crossings");
  IConsolePrint(CC_DEFAULT, "    X = no houses");
  IConsolePrint(CC_DEFAULT, "    h = hidden");
  IConsolePrint(CC_DEFAULT, "    T = buildable by towns");
 
  std::map<uint32, const GRFFile *> grfs;
  for (RoadType rt = ROADTYPE_BEGIN; rt < ROADTYPE_END; rt++) {
    const RoadTypeInfo *rti = GetRoadTypeInfo(rt);
    if (rti->label == 0) continue;
    uint32 grfid = 0;
    const GRFFile *grf = rti->grffile[ROTSG_GROUND];
    if (grf != nullptr) {
      grfid = grf->grfid;
      grfs.emplace(grfid, grf);
    }
    IConsolePrint(CC_DEFAULT, "  {:02d} {} {:c}{:c}{:c}{:c}, Flags: {}{}{}{}{}, GRF: {:08X}, {}",
        (uint)rt,
        RoadTypeIsTram(rt) ? "Tram" : "Road",
        rti->label >> 24, rti->label >> 16, rti->label >> 8, rti->label,
        HasBit(rti->flags, ROTF_CATENARY)          ? 'c' : '-',
        HasBit(rti->flags, ROTF_NO_LEVEL_CROSSING) ? 'l' : '-',
        HasBit(rti->flags, ROTF_NO_HOUSES)         ? 'X' : '-',
        HasBit(rti->flags, ROTF_HIDDEN)            ? 'h' : '-',
        HasBit(rti->flags, ROTF_TOWN_BUILD)        ? 'T' : '-',
        BSWAP32(grfid),
        GetStringPtr(rti->strings.name)
    );
  }
  for (const auto &grf : grfs) {
    IConsolePrint(CC_DEFAULT, "  GRF: {:08X} = {}", BSWAP32(grf.first), grf.second->filename);
  }
}
 
static void ConDumpRailTypes()
{
  IConsolePrint(CC_DEFAULT, "  Flags:");
  IConsolePrint(CC_DEFAULT, "    c = catenary");
  IConsolePrint(CC_DEFAULT, "    l = no level crossings");
  IConsolePrint(CC_DEFAULT, "    h = hidden");
  IConsolePrint(CC_DEFAULT, "    s = no sprite combine");
  IConsolePrint(CC_DEFAULT, "    a = always allow 90 degree turns");
  IConsolePrint(CC_DEFAULT, "    d = always disallow 90 degree turns");
 
  std::map<uint32, const GRFFile *> grfs;
  for (RailType rt = RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) {
    const RailtypeInfo *rti = GetRailTypeInfo(rt);
    if (rti->label == 0) continue;
    uint32 grfid = 0;
    const GRFFile *grf = rti->grffile[RTSG_GROUND];
    if (grf != nullptr) {
      grfid = grf->grfid;
      grfs.emplace(grfid, grf);
    }
    IConsolePrint(CC_DEFAULT, "  {:02d} {:c}{:c}{:c}{:c}, Flags: {}{}{}{}{}{}, GRF: {:08X}, {}",
        (uint)rt,
        rti->label >> 24, rti->label >> 16, rti->label >> 8, rti->label,
        HasBit(rti->flags, RTF_CATENARY)          ? 'c' : '-',
        HasBit(rti->flags, RTF_NO_LEVEL_CROSSING) ? 'l' : '-',
        HasBit(rti->flags, RTF_HIDDEN)            ? 'h' : '-',
        HasBit(rti->flags, RTF_NO_SPRITE_COMBINE) ? 's' : '-',
        HasBit(rti->flags, RTF_ALLOW_90DEG)       ? 'a' : '-',
        HasBit(rti->flags, RTF_DISALLOW_90DEG)    ? 'd' : '-',
        BSWAP32(grfid),
        GetStringPtr(rti->strings.name)
    );
  }
  for (const auto &grf : grfs) {
    IConsolePrint(CC_DEFAULT, "  GRF: {:08X} = {}", BSWAP32(grf.first), grf.second->filename);
  }
}
 
static void ConDumpCargoTypes()
{
  IConsolePrint(CC_DEFAULT, "  Cargo classes:");
  IConsolePrint(CC_DEFAULT, "    p = passenger");
  IConsolePrint(CC_DEFAULT, "    m = mail");
  IConsolePrint(CC_DEFAULT, "    x = express");
  IConsolePrint(CC_DEFAULT, "    a = armoured");
  IConsolePrint(CC_DEFAULT, "    b = bulk");
  IConsolePrint(CC_DEFAULT, "    g = piece goods");
  IConsolePrint(CC_DEFAULT, "    l = liquid");
  IConsolePrint(CC_DEFAULT, "    r = refrigerated");
  IConsolePrint(CC_DEFAULT, "    h = hazardous");
  IConsolePrint(CC_DEFAULT, "    c = covered/sheltered");
  IConsolePrint(CC_DEFAULT, "    S = special");
 
  std::map<uint32, const GRFFile *> grfs;
  for (CargoID i = 0; i < NUM_CARGO; i++) {
    const CargoSpec *spec = CargoSpec::Get(i);
    if (!spec->IsValid()) continue;
    uint32 grfid = 0;
    const GRFFile *grf = spec->grffile;
    if (grf != nullptr) {
      grfid = grf->grfid;
      grfs.emplace(grfid, grf);
    }
    IConsolePrint(CC_DEFAULT, "  {:02d} Bit: {:2d}, Label: {:c}{:c}{:c}{:c}, Callback mask: 0x{:02X}, Cargo class: {}{}{}{}{}{}{}{}{}{}{}, GRF: {:08X}, {}",
        (uint)i,
        spec->bitnum,
        spec->label >> 24, spec->label >> 16, spec->label >> 8, spec->label,
        spec->callback_mask,
        (spec->classes & CC_PASSENGERS)   != 0 ? 'p' : '-',
        (spec->classes & CC_MAIL)         != 0 ? 'm' : '-',
        (spec->classes & CC_EXPRESS)      != 0 ? 'x' : '-',
        (spec->classes & CC_ARMOURED)     != 0 ? 'a' : '-',
        (spec->classes & CC_BULK)         != 0 ? 'b' : '-',
        (spec->classes & CC_PIECE_GOODS)  != 0 ? 'g' : '-',
        (spec->classes & CC_LIQUID)       != 0 ? 'l' : '-',
        (spec->classes & CC_REFRIGERATED) != 0 ? 'r' : '-',
        (spec->classes & CC_HAZARDOUS)    != 0 ? 'h' : '-',
        (spec->classes & CC_COVERED)      != 0 ? 'c' : '-',
        (spec->classes & CC_SPECIAL)      != 0 ? 'S' : '-',
        BSWAP32(grfid),
        GetStringPtr(spec->name)
    );
  }
  for (const auto &grf : grfs) {
    IConsolePrint(CC_DEFAULT, "  GRF: {:08X} = {}", BSWAP32(grf.first), grf.second->filename);
  }
}
 
 
DEF_CONSOLE_CMD(ConDumpInfo)
{
  if (argc != 2) {
    IConsolePrint(CC_HELP, "Dump debugging information.");
    IConsolePrint(CC_HELP, "Usage: 'dump_info roadtypes|railtypes|cargotypes'.");
    IConsolePrint(CC_HELP, "  Show information about road/tram types, rail types or cargo types.");
    return true;
  }
 
  if (strcasecmp(argv[1], "roadtypes") == 0) {
    ConDumpRoadTypes();
    return true;
  }
 
  if (strcasecmp(argv[1], "railtypes") == 0) {
    ConDumpRailTypes();
    return true;
  }
 
  if (strcasecmp(argv[1], "cargotypes") == 0) {
    ConDumpCargoTypes();
    return true;
  }
 
  return false;
}
 
/*******************************
 * console command registration
 *******************************/
 
void IConsoleStdLibRegister()
{
  IConsole::CmdRegister("debug_level",             ConDebugLevel);
  IConsole::CmdRegister("echo",                    ConEcho);
  IConsole::CmdRegister("echoc",                   ConEchoC);
  IConsole::CmdRegister("exec",                    ConExec);
  IConsole::CmdRegister("exit",                    ConExit);
  IConsole::CmdRegister("part",                    ConPart);
  IConsole::CmdRegister("help",                    ConHelp);
  IConsole::CmdRegister("info_cmd",                ConInfoCmd);
  IConsole::CmdRegister("list_cmds",               ConListCommands);
  IConsole::CmdRegister("list_aliases",            ConListAliases);
  IConsole::CmdRegister("newgame",                 ConNewGame);
  IConsole::CmdRegister("restart",                 ConRestart);
  IConsole::CmdRegister("reload",                  ConReload);
  IConsole::CmdRegister("getseed",                 ConGetSeed);
  IConsole::CmdRegister("getdate",                 ConGetDate);
  IConsole::CmdRegister("getsysdate",              ConGetSysDate);
  IConsole::CmdRegister("quit",                    ConExit);
  IConsole::CmdRegister("resetengines",            ConResetEngines,     ConHookNoNetwork);
  IConsole::CmdRegister("reset_enginepool",        ConResetEnginePool,  ConHookNoNetwork);
  IConsole::CmdRegister("return",                  ConReturn);
  IConsole::CmdRegister("screenshot",              ConScreenShot);
  IConsole::CmdRegister("script",                  ConScript);
  IConsole::CmdRegister("zoomto",                  ConZoomToLevel);
  IConsole::CmdRegister("scrollto",                ConScrollToTile);
  IConsole::CmdRegister("alias",                   ConAlias);
  IConsole::CmdRegister("load",                    ConLoad);
  IConsole::CmdRegister("rm",                      ConRemove);
  IConsole::CmdRegister("save",                    ConSave);
  IConsole::CmdRegister("saveconfig",              ConSaveConfig);
  IConsole::CmdRegister("ls",                      ConListFiles);
  IConsole::CmdRegister("cd",                      ConChangeDirectory);
  IConsole::CmdRegister("pwd",                     ConPrintWorkingDirectory);
  IConsole::CmdRegister("clear",                   ConClearBuffer);
  IConsole::CmdRegister("setting",                 ConSetting);
  IConsole::CmdRegister("setting_newgame",         ConSettingNewgame);
  IConsole::CmdRegister("list_settings",           ConListSettings);
  IConsole::CmdRegister("gamelog",                 ConGamelogPrint);
  IConsole::CmdRegister("rescan_newgrf",           ConRescanNewGRF);
  IConsole::CmdRegister("list_dirs",               ConListDirs);
 
  IConsole::AliasRegister("dir",                   "ls");
  IConsole::AliasRegister("del",                   "rm %+");
  IConsole::AliasRegister("newmap",                "newgame");
  IConsole::AliasRegister("patch",                 "setting %+");
  IConsole::AliasRegister("set",                   "setting %+");
  IConsole::AliasRegister("set_newgame",           "setting_newgame %+");
  IConsole::AliasRegister("list_patches",          "list_settings %+");
  IConsole::AliasRegister("developer",             "setting developer %+");
 
  IConsole::CmdRegister("list_ai_libs",            ConListAILibs);
  IConsole::CmdRegister("list_ai",                 ConListAI);
  IConsole::CmdRegister("reload_ai",               ConReloadAI);
  IConsole::CmdRegister("rescan_ai",               ConRescanAI);
  IConsole::CmdRegister("start_ai",                ConStartAI);
  IConsole::CmdRegister("stop_ai",                 ConStopAI);
 
  IConsole::CmdRegister("list_game",               ConListGame);
  IConsole::CmdRegister("list_game_libs",          ConListGameLibs);
  IConsole::CmdRegister("rescan_game",             ConRescanGame);
 
  IConsole::CmdRegister("companies",               ConCompanies);
  IConsole::AliasRegister("players",               "companies");
 
  /* networking functions */
 
/* Content downloading is only available with ZLIB */
#if defined(WITH_ZLIB)
  IConsole::CmdRegister("content",                 ConContent);
#endif /* defined(WITH_ZLIB) */
 
  /*** Networking commands ***/
  IConsole::CmdRegister("say",                     ConSay,              ConHookNeedNetwork);
  IConsole::CmdRegister("say_company",             ConSayCompany,       ConHookNeedNetwork);
  IConsole::AliasRegister("say_player",            "say_company %+");
  IConsole::CmdRegister("say_client",              ConSayClient,        ConHookNeedNetwork);
 
  IConsole::CmdRegister("connect",                 ConNetworkConnect,   ConHookClientOnly);
  IConsole::CmdRegister("clients",                 ConNetworkClients,   ConHookNeedNetwork);
  IConsole::CmdRegister("status",                  ConStatus,           ConHookServerOnly);
  IConsole::CmdRegister("server_info",             ConServerInfo,       ConHookServerOnly);
  IConsole::AliasRegister("info",                  "server_info");
  IConsole::CmdRegister("reconnect",               ConNetworkReconnect, ConHookClientOnly);
  IConsole::CmdRegister("rcon",                    ConRcon,             ConHookNeedNetwork);
 
  IConsole::CmdRegister("join",                    ConJoinCompany,      ConHookNeedNetwork);
  IConsole::AliasRegister("spectate",              "join 255");
  IConsole::CmdRegister("move",                    ConMoveClient,       ConHookServerOnly);
  IConsole::CmdRegister("reset_company",           ConResetCompany,     ConHookServerOnly);
  IConsole::AliasRegister("clean_company",         "reset_company %A");
  IConsole::CmdRegister("client_name",             ConClientNickChange, ConHookServerOnly);
  IConsole::CmdRegister("kick",                    ConKick,             ConHookServerOnly);
  IConsole::CmdRegister("ban",                     ConBan,              ConHookServerOnly);
  IConsole::CmdRegister("unban",                   ConUnBan,            ConHookServerOnly);
  IConsole::CmdRegister("banlist",                 ConBanList,          ConHookServerOnly);
 
  IConsole::CmdRegister("pause",                   ConPauseGame,        ConHookServerOrNoNetwork);
  IConsole::CmdRegister("unpause",                 ConUnpauseGame,      ConHookServerOrNoNetwork);
 
  IConsole::CmdRegister("company_pw",              ConCompanyPassword,  ConHookNeedNetwork);
  IConsole::AliasRegister("company_password",      "company_pw %+");
 
  IConsole::AliasRegister("net_frame_freq",        "setting frame_freq %+");
  IConsole::AliasRegister("net_sync_freq",         "setting sync_freq %+");
  IConsole::AliasRegister("server_pw",             "setting server_password %+");
  IConsole::AliasRegister("server_password",       "setting server_password %+");
  IConsole::AliasRegister("rcon_pw",               "setting rcon_password %+");
  IConsole::AliasRegister("rcon_password",         "setting rcon_password %+");
  IConsole::AliasRegister("name",                  "setting client_name %+");
  IConsole::AliasRegister("server_name",           "setting server_name %+");
  IConsole::AliasRegister("server_port",           "setting server_port %+");
  IConsole::AliasRegister("max_clients",           "setting max_clients %+");
  IConsole::AliasRegister("max_companies",         "setting max_companies %+");
  IConsole::AliasRegister("max_join_time",         "setting max_join_time %+");
  IConsole::AliasRegister("pause_on_join",         "setting pause_on_join %+");
  IConsole::AliasRegister("autoclean_companies",   "setting autoclean_companies %+");
  IConsole::AliasRegister("autoclean_protected",   "setting autoclean_protected %+");
  IConsole::AliasRegister("autoclean_unprotected", "setting autoclean_unprotected %+");
  IConsole::AliasRegister("restart_game_year",     "setting restart_game_year %+");
  IConsole::AliasRegister("min_players",           "setting min_active_clients %+");
  IConsole::AliasRegister("reload_cfg",            "setting reload_cfg %+");
 
  /* debugging stuff */
#ifdef _DEBUG
  IConsoleDebugLibRegister();
#endif
  IConsole::CmdRegister("fps",                     ConFramerate);
  IConsole::CmdRegister("fps_wnd",                 ConFramerateWindow);
 
  /* NewGRF development stuff */
  IConsole::CmdRegister("reload_newgrfs",          ConNewGRFReload,     ConHookNewGRFDeveloperTool);
  IConsole::CmdRegister("newgrf_profile",          ConNewGRFProfile,    ConHookNewGRFDeveloperTool);
 
  IConsole::CmdRegister("dump_info",               ConDumpInfo);
}