src/command.cpp

   1 /* $Id$ */
   2
   3 /*
   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/>.
   8  */
   9
  10 /** @file command.cpp Handling of commands. */
  11
  12 #include "stdafx.h"
  13 #include "landscape.h"
  14 #include "error.h"
  15 #include "gui.h"
  16 #include "command_func.h"
  17 #include "network/network_type.h"
  18 #include "network/network.h"
  19 #include "genworld.h"
  20 #include "strings_func.h"
  21 #include "texteff.hpp"
  22 #include "town.h"
  23 #include "date_func.h"
  24 #include "company_func.h"
  25 #include "company_base.h"
  26 #include "signal_func.h"
  27 #include "core/backup_type.hpp"
  28 #include "object_base.h"
  29
  30 #include "table/strings.h"
  31
  32 CommandProc CmdBuildRailroadTrack;
  33 CommandProc CmdRemoveRailroadTrack;
  34 CommandProc CmdBuildSingleRail;
  35 CommandProc CmdRemoveSingleRail;
  36
  37 CommandProc CmdLandscapeClear;
  38
  39 CommandProc CmdBuildBridge;
  40
  41 CommandProc CmdBuildRailStation;
  42 CommandProc CmdRemoveFromRailStation;
  43 CommandProc CmdConvertRail;
  44
  45 CommandProc CmdBuildSingleSignal;
  46 CommandProc CmdRemoveSingleSignal;
  47
  48 CommandProc CmdTerraformLand;
  49
  50 CommandProc CmdBuildObject;
  51 CommandProc CmdSellLandArea;
  52
  53 CommandProc CmdBuildTunnel;
  54
  55 CommandProc CmdBuildTrainDepot;
  56 CommandProc CmdBuildRailWaypoint;
  57 CommandProc CmdRenameWaypoint;
  58 CommandProc CmdRemoveFromRailWaypoint;
  59
  60 CommandProc CmdBuildRoadStop;
  61 CommandProc CmdRemoveRoadStop;
  62
  63 CommandProc CmdBuildLongRoad;
  64 CommandProc CmdRemoveLongRoad;
  65 CommandProc CmdBuildRoad;
  66
  67 CommandProc CmdBuildRoadDepot;
  68
  69 CommandProc CmdBuildAirport;
  70
  71 CommandProc CmdBuildDock;
  72
  73 CommandProc CmdBuildShipDepot;
  74
  75 CommandProc CmdBuildBuoy;
  76
  77 CommandProc CmdPlantTree;
  78
  79 CommandProc CmdMoveRailVehicle;
  80
  81 CommandProc CmdBuildVehicle;
  82 CommandProc CmdSellVehicle;
  83 CommandProc CmdRefitVehicle;
  84 CommandProc CmdSendVehicleToDepot;
  85
  86 CommandProc CmdForceTrainProceed;
  87 CommandProc CmdReverseTrainDirection;
  88
  89 CommandProc CmdClearOrderBackup;
  90 CommandProc CmdModifyOrder;
  91 CommandProc CmdSkipToOrder;
  92 CommandProc CmdDeleteOrder;
  93 CommandProc CmdInsertOrder;
  94 CommandProc CmdChangeServiceInt;
  95
  96 CommandProc CmdBuildIndustry;
  97
  98 CommandProc CmdSetCompanyManagerFace;
  99 CommandProc CmdSetCompanyColour;
 100
 101 CommandProc CmdIncreaseLoan;
 102 CommandProc CmdDecreaseLoan;
 103
 104 CommandProc CmdWantEnginePreview;
 105
 106 CommandProc CmdRenameVehicle;
 107 CommandProc CmdRenameEngine;
 108
 109 CommandProc CmdRenameCompany;
 110 CommandProc CmdRenamePresident;
 111
 112 CommandProc CmdRenameStation;
 113 CommandProc CmdRenameDepot;
 114
 115 CommandProc CmdPlaceSign;
 116 CommandProc CmdRenameSign;
 117
 118 CommandProc CmdTurnRoadVeh;
 119
 120 CommandProc CmdPause;
 121
 122 CommandProc CmdBuyShareInCompany;
 123 CommandProc CmdSellShareInCompany;
 124 CommandProc CmdBuyCompany;
 125
 126 CommandProc CmdFoundTown;
 127 CommandProc CmdRenameTown;
 128 CommandProc CmdDoTownAction;
 129 CommandProc CmdTownGrowthRate;
 130 CommandProc CmdTownCargoGoal;
 131 CommandProc CmdTownSetText;
 132 CommandProc CmdExpandTown;
 133 CommandProc CmdDeleteTown;
 134
 135 CommandProc CmdChangeSetting;
 136 CommandProc CmdChangeCompanySetting;
 137
 138 CommandProc CmdOrderRefit;
 139 CommandProc CmdCloneOrder;
 140
 141 CommandProc CmdClearArea;
 142
 143 CommandProc CmdGiveMoney;
 144 CommandProc CmdMoneyCheat;
 145 CommandProc CmdChangeBankBalance;
 146 CommandProc CmdBuildCanal;
 147 CommandProc CmdBuildLock;
 148
 149 CommandProc CmdCreateSubsidy;
 150 CommandProc CmdCompanyCtrl;
 151 CommandProc CmdCustomNewsItem;
 152 CommandProc CmdCreateGoal;
 153 CommandProc CmdRemoveGoal;
 154 CommandProc CmdSetGoalText;
 155 CommandProc CmdSetGoalProgress;
 156 CommandProc CmdSetGoalCompleted;
 157 CommandProc CmdGoalQuestion;
 158 CommandProc CmdGoalQuestionAnswer;
 159 CommandProc CmdCreateStoryPage;
 160 CommandProc CmdCreateStoryPageElement;
 161 CommandProc CmdUpdateStoryPageElement;
 162 CommandProc CmdSetStoryPageTitle;
 163 CommandProc CmdSetStoryPageDate;
 164 CommandProc CmdShowStoryPage;
 165 CommandProc CmdRemoveStoryPage;
 166 CommandProc CmdRemoveStoryPageElement;
 167
 168 CommandProc CmdLevelLand;
 169
 170 CommandProc CmdBuildSignalTrack;
 171 CommandProc CmdRemoveSignalTrack;
 172
 173 CommandProc CmdSetAutoReplace;
 174
 175 CommandProc CmdCloneVehicle;
 176 CommandProc CmdStartStopVehicle;
 177 CommandProc CmdMassStartStopVehicle;
 178 CommandProc CmdAutoreplaceVehicle;
 179 CommandProc CmdDepotSellAllVehicles;
 180 CommandProc CmdDepotMassAutoReplace;
 181
 182 CommandProc CmdCreateGroup;
 183 CommandProc CmdRenameGroup;
 184 CommandProc CmdDeleteGroup;
 185 CommandProc CmdAddVehicleGroup;
 186 CommandProc CmdAddSharedVehicleGroup;
 187 CommandProc CmdRemoveAllVehiclesGroup;
 188 CommandProc CmdSetGroupReplaceProtection;
 189
 190 CommandProc CmdMoveOrder;
 191 CommandProc CmdChangeTimetable;
 192 CommandProc CmdSetVehicleOnTime;
 193 CommandProc CmdAutofillTimetable;
 194 CommandProc CmdSetTimetableStart;
 195
 196 CommandProc CmdOpenCloseAirport;
 197
 198 #define DEF_CMD(proc, flags, type) {proc, #proc, (CommandFlags)flags, type}
 199
 200 /**
 201  * The master command table
 202  *
 203  * This table contains all possible CommandProc functions with
 204  * the flags which belongs to it. The indices are the same
 205  * as the value from the CMD_* enums.
 206  */
 207 static const Command _command_proc_table[] = {
 208         DEF_CMD(CmdBuildRailroadTrack,       CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAILROAD_TRACK
 209         DEF_CMD(CmdRemoveRailroadTrack,                     CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_RAILROAD_TRACK
 210         DEF_CMD(CmdBuildSingleRail,          CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SINGLE_RAIL
 211         DEF_CMD(CmdRemoveSingleRail,                        CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SINGLE_RAIL
 212         DEF_CMD(CmdLandscapeClear,                                 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_LANDSCAPE_CLEAR
 213         DEF_CMD(CmdBuildBridge,  CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BRIDGE
 214         DEF_CMD(CmdBuildRailStation,         CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_STATION
 215         DEF_CMD(CmdBuildTrainDepot,          CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TRAIN_DEPOT
 216         DEF_CMD(CmdBuildSingleSignal,                       CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNALS
 217         DEF_CMD(CmdRemoveSingleSignal,                      CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNALS
 218         DEF_CMD(CmdTerraformLand,           CMD_ALL_TILES | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_TERRAFORM_LAND
 219         DEF_CMD(CmdBuildObject,              CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_OBJECT
 220         DEF_CMD(CmdBuildTunnel,                 CMD_DEITY | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TUNNEL
 221         DEF_CMD(CmdRemoveFromRailStation,                          0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_STATION
 222         DEF_CMD(CmdConvertRail,                                    0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CONVERT_RAILD
 223         DEF_CMD(CmdBuildRailWaypoint,                              0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_WAYPOINT
 224         DEF_CMD(CmdRenameWaypoint,                                 0, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_WAYPOINT
 225         DEF_CMD(CmdRemoveFromRailWaypoint,                         0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_WAYPOINT
 226
 227         DEF_CMD(CmdBuildRoadStop,            CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_STOP
 228         DEF_CMD(CmdRemoveRoadStop,                                 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_ROAD_STOP
 229         DEF_CMD(CmdBuildLongRoad,CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LONG_ROAD
 230         DEF_CMD(CmdRemoveLongRoad,            CMD_NO_TEST | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_LONG_ROAD; towns may disallow removing road bits (as they are connected) in test, but in exec they're removed and thus removing is allowed.
 231         DEF_CMD(CmdBuildRoad,    CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD
 232         DEF_CMD(CmdBuildRoadDepot,           CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_DEPOT
 233
 234         DEF_CMD(CmdBuildAirport,             CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_AIRPORT
 235         DEF_CMD(CmdBuildDock,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_DOCK
 236         DEF_CMD(CmdBuildShipDepot,                          CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SHIP_DEPOT
 237         DEF_CMD(CmdBuildBuoy,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BUOY
 238         DEF_CMD(CmdPlantTree,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_PLANT_TREE
 239
 240         DEF_CMD(CmdBuildVehicle,                       CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_BUILD_VEHICLE
 241         DEF_CMD(CmdSellVehicle,                        CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_SELL_VEHICLE
 242         DEF_CMD(CmdRefitVehicle,                                   0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_REFIT_VEHICLE
 243         DEF_CMD(CmdSendVehicleToDepot,                             0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_SEND_VEHICLE_TO_DEPOT
 244
 245         DEF_CMD(CmdMoveRailVehicle,                                0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_MOVE_RAIL_VEHICLE
 246         DEF_CMD(CmdForceTrainProceed,                              0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_FORCE_TRAIN_PROCEED
 247         DEF_CMD(CmdReverseTrainDirection,                          0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_REVERSE_TRAIN_DIRECTION
 248
 249         DEF_CMD(CmdClearOrderBackup,                   CMD_CLIENT_ID, CMDT_ROUTE_MANAGEMENT      ), // CMD_CLEAR_ORDER_BACKUP
 250         DEF_CMD(CmdModifyOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_MODIFY_ORDER
 251         DEF_CMD(CmdSkipToOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SKIP_TO_ORDER
 252         DEF_CMD(CmdDeleteOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_DELETE_ORDER
 253         DEF_CMD(CmdInsertOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_INSERT_ORDER
 254
 255         DEF_CMD(CmdChangeServiceInt,                               0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_CHANGE_SERVICE_INT
 256
 257         DEF_CMD(CmdBuildIndustry,                          CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_INDUSTRY
 258         DEF_CMD(CmdSetCompanyManagerFace,                          0, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_COMPANY_MANAGER_FACE
 259         DEF_CMD(CmdSetCompanyColour,                               0, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_COMPANY_COLOUR
 260
 261         DEF_CMD(CmdIncreaseLoan,                                   0, CMDT_MONEY_MANAGEMENT      ), // CMD_INCREASE_LOAN
 262         DEF_CMD(CmdDecreaseLoan,                                   0, CMDT_MONEY_MANAGEMENT      ), // CMD_DECREASE_LOAN
 263
 264         DEF_CMD(CmdWantEnginePreview,                              0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_WANT_ENGINE_PREVIEW
 265
 266         DEF_CMD(CmdRenameVehicle,                                  0, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_VEHICLE
 267         DEF_CMD(CmdRenameEngine,                          CMD_SERVER, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_ENGINE
 268
 269         DEF_CMD(CmdRenameCompany,                                  0, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_COMPANY
 270         DEF_CMD(CmdRenamePresident,                                0, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_PRESIDENT
 271
 272         DEF_CMD(CmdRenameStation,                                  0, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_STATION
 273         DEF_CMD(CmdRenameDepot,                                    0, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_DEPOT
 274
 275         DEF_CMD(CmdPlaceSign,                              CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_PLACE_SIGN
 276         DEF_CMD(CmdRenameSign,                             CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_SIGN
 277
 278         DEF_CMD(CmdTurnRoadVeh,                                    0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_TURN_ROADVEH
 279
 280         DEF_CMD(CmdPause,                                 CMD_SERVER, CMDT_SERVER_SETTING        ), // CMD_PAUSE
 281
 282         DEF_CMD(CmdBuyShareInCompany,                              0, CMDT_MONEY_MANAGEMENT      ), // CMD_BUY_SHARE_IN_COMPANY
 283         DEF_CMD(CmdSellShareInCompany,                             0, CMDT_MONEY_MANAGEMENT      ), // CMD_SELL_SHARE_IN_COMPANY
 284         DEF_CMD(CmdBuyCompany,                                     0, CMDT_MONEY_MANAGEMENT      ), // CMD_BUY_COMANY
 285
 286         DEF_CMD(CmdFoundTown,                CMD_DEITY | CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_FOUND_TOWN; founding random town can fail only in exec run
 287         DEF_CMD(CmdRenameTown,                CMD_DEITY | CMD_SERVER, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_TOWN
 288         DEF_CMD(CmdDoTownAction,                                   0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DO_TOWN_ACTION
 289         DEF_CMD(CmdTownCargoGoal,                          CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_CARGO_GOAL
 290         DEF_CMD(CmdTownGrowthRate,                         CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_GROWTH_RATE
 291         DEF_CMD(CmdTownSetText,             CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_SET_TEXT
 292         DEF_CMD(CmdExpandTown,                             CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_EXPAND_TOWN
 293         DEF_CMD(CmdDeleteTown,                           CMD_OFFLINE, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DELETE_TOWN
 294
 295         DEF_CMD(CmdOrderRefit,                                     0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ORDER_REFIT
 296         DEF_CMD(CmdCloneOrder,                                     0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CLONE_ORDER
 297
 298         DEF_CMD(CmdClearArea,                            CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CLEAR_AREA; destroying multi-tile houses makes town rating differ between test and execution
 299
 300         DEF_CMD(CmdMoneyCheat,                           CMD_OFFLINE, CMDT_CHEAT                 ), // CMD_MONEY_CHEAT
 301         DEF_CMD(CmdChangeBankBalance,                      CMD_DEITY, CMDT_MONEY_MANAGEMENT      ), // CMD_CHANGE_BANK_BALANCE
 302         DEF_CMD(CmdBuildCanal,                              CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_CANAL
 303         DEF_CMD(CmdCreateSubsidy,                          CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_SUBSIDY
 304         DEF_CMD(CmdCompanyCtrl,        CMD_SPECTATOR | CMD_CLIENT_ID, CMDT_SERVER_SETTING        ), // CMD_COMPANY_CTRL
 305         DEF_CMD(CmdCustomNewsItem,          CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CUSTOM_NEWS_ITEM
 306         DEF_CMD(CmdCreateGoal,              CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_GOAL
 307         DEF_CMD(CmdRemoveGoal,                             CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_REMOVE_GOAL
 308         DEF_CMD(CmdSetGoalText,             CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_GOAL_TEXT
 309         DEF_CMD(CmdSetGoalProgress,         CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_GOAL_PROGRESS
 310         DEF_CMD(CmdSetGoalCompleted,        CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_GOAL_COMPLETED
 311         DEF_CMD(CmdGoalQuestion,            CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_GOAL_QUESTION
 312         DEF_CMD(CmdGoalQuestionAnswer,                     CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_GOAL_QUESTION_ANSWER
 313         DEF_CMD(CmdCreateStoryPage,         CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_STORY_PAGE
 314         DEF_CMD(CmdCreateStoryPageElement,  CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_STORY_PAGE_ELEMENT
 315         DEF_CMD(CmdUpdateStoryPageElement,  CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_UPDATE_STORY_PAGE_ELEMENT
 316         DEF_CMD(CmdSetStoryPageTitle,       CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_STORY_PAGE_TITLE
 317         DEF_CMD(CmdSetStoryPageDate,                       CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_STORY_PAGE_DATE
 318         DEF_CMD(CmdShowStoryPage,                          CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SHOW_STORY_PAGE
 319         DEF_CMD(CmdRemoveStoryPage,                        CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_REMOVE_STORY_PAGE
 320         DEF_CMD(CmdRemoveStoryPageElement,                 CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_REMOVE_STORY_ELEMENT_PAGE
 321
 322         DEF_CMD(CmdLevelLand, CMD_ALL_TILES | CMD_NO_TEST | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_LEVEL_LAND; test run might clear tiles multiple times, in execution that only happens once
 323
 324         DEF_CMD(CmdBuildLock,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LOCK
 325
 326         DEF_CMD(CmdBuildSignalTrack,                        CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNAL_TRACK
 327         DEF_CMD(CmdRemoveSignalTrack,                       CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNAL_TRACK
 328
 329         DEF_CMD(CmdGiveMoney,                                      0, CMDT_MONEY_MANAGEMENT      ), // CMD_GIVE_MONEY
 330         DEF_CMD(CmdChangeSetting,                         CMD_SERVER, CMDT_SERVER_SETTING        ), // CMD_CHANGE_SETTING
 331         DEF_CMD(CmdChangeCompanySetting,                           0, CMDT_COMPANY_SETTING       ), // CMD_CHANGE_COMPANY_SETTING
 332         DEF_CMD(CmdSetAutoReplace,                                 0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_SET_AUTOREPLACE
 333         DEF_CMD(CmdCloneVehicle,                         CMD_NO_TEST, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_CLONE_VEHICLE; NewGRF callbacks influence building and refitting making it impossible to correctly estimate the cost
 334         DEF_CMD(CmdStartStopVehicle,                               0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_START_STOP_VEHICLE
 335         DEF_CMD(CmdMassStartStopVehicle,                           0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_MASS_START_STOP
 336         DEF_CMD(CmdAutoreplaceVehicle,                             0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_AUTOREPLACE_VEHICLE
 337         DEF_CMD(CmdDepotSellAllVehicles,                           0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_DEPOT_SELL_ALL_VEHICLES
 338         DEF_CMD(CmdDepotMassAutoReplace,                           0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_DEPOT_MASS_AUTOREPLACE
 339         DEF_CMD(CmdCreateGroup,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CREATE_GROUP
 340         DEF_CMD(CmdDeleteGroup,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_DELETE_GROUP
 341         DEF_CMD(CmdRenameGroup,                                    0, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_GROUP
 342         DEF_CMD(CmdAddVehicleGroup,                                0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ADD_VEHICLE_GROUP
 343         DEF_CMD(CmdAddSharedVehicleGroup,                          0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ADD_SHARE_VEHICLE_GROUP
 344         DEF_CMD(CmdRemoveAllVehiclesGroup,                         0, CMDT_ROUTE_MANAGEMENT      ), // CMD_REMOVE_ALL_VEHICLES_GROUP
 345         DEF_CMD(CmdSetGroupReplaceProtection,                      0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_GROUP_REPLACE_PROTECTION
 346         DEF_CMD(CmdMoveOrder,                                      0, CMDT_ROUTE_MANAGEMENT      ), // CMD_MOVE_ORDER
 347         DEF_CMD(CmdChangeTimetable,                                0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CHANGE_TIMETABLE
 348         DEF_CMD(CmdSetVehicleOnTime,                               0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_VEHICLE_ON_TIME
 349         DEF_CMD(CmdAutofillTimetable,                              0, CMDT_ROUTE_MANAGEMENT      ), // CMD_AUTOFILL_TIMETABLE
 350         DEF_CMD(CmdSetTimetableStart,                              0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_TIMETABLE_START
 351
 352         DEF_CMD(CmdOpenCloseAirport,                               0, CMDT_ROUTE_MANAGEMENT      ), // CMD_OPEN_CLOSE_AIRPORT
 353 };
 354
 355 /*!
 356  * This function range-checks a cmd, and checks if the cmd is not NULL
 357  *
 358  * @param cmd The integer value of a command
 359  * @return true if the command is valid (and got a CommandProc function)
 360  */
 361 bool IsValidCommand(uint32 cmd)
 362 {
 363         cmd &= CMD_ID_MASK;
 364
 365         return cmd < lengthof(_command_proc_table) && _command_proc_table[cmd].proc != NULL;
 366 }
 367
 368 /*!
 369  * This function mask the parameter with CMD_ID_MASK and returns
 370  * the flags which belongs to the given command.
 371  *
 372  * @param cmd The integer value of the command
 373  * @return The flags for this command
 374  */
 375 CommandFlags GetCommandFlags(uint32 cmd)
 376 {
 377         assert(IsValidCommand(cmd));
 378
 379         return _command_proc_table[cmd & CMD_ID_MASK].flags;
 380 }
 381
 382 /*!
 383  * This function mask the parameter with CMD_ID_MASK and returns
 384  * the name which belongs to the given command.
 385  *
 386  * @param cmd The integer value of the command
 387  * @return The name for this command
 388  */
 389 const char *GetCommandName(uint32 cmd)
 390 {
 391         assert(IsValidCommand(cmd));
 392
 393         return _command_proc_table[cmd & CMD_ID_MASK].name;
 394 }
 395
 396 /**
 397  * Returns whether the command is allowed while the game is paused.
 398  * @param cmd The command to check.
 399  * @return True if the command is allowed while paused, false otherwise.
 400  */
 401 bool IsCommandAllowedWhilePaused(uint32 cmd)
 402 {
 403         /* Lookup table for the command types that are allowed for a given pause level setting. */
 404         static const int command_type_lookup[] = {
 405                 CMDPL_ALL_ACTIONS,     ///< CMDT_LANDSCAPE_CONSTRUCTION
 406                 CMDPL_NO_LANDSCAPING,  ///< CMDT_VEHICLE_CONSTRUCTION
 407                 CMDPL_NO_LANDSCAPING,  ///< CMDT_MONEY_MANAGEMENT
 408                 CMDPL_NO_CONSTRUCTION, ///< CMDT_VEHICLE_MANAGEMENT
 409                 CMDPL_NO_CONSTRUCTION, ///< CMDT_ROUTE_MANAGEMENT
 410                 CMDPL_NO_CONSTRUCTION, ///< CMDT_OTHER_MANAGEMENT
 411                 CMDPL_NO_CONSTRUCTION, ///< CMDT_COMPANY_SETTING
 412                 CMDPL_NO_ACTIONS,      ///< CMDT_SERVER_SETTING
 413                 CMDPL_NO_ACTIONS,      ///< CMDT_CHEAT
 414         };
 415         assert_compile(lengthof(command_type_lookup) == CMDT_END);
 416
 417         assert(IsValidCommand(cmd));
 418         return _game_mode == GM_EDITOR || command_type_lookup[_command_proc_table[cmd & CMD_ID_MASK].type] <= _settings_game.construction.command_pause_level;
 419 }
 420
 421
 422 static int _docommand_recursive = 0;
 423
 424 /**
 425  * Shorthand for calling the long DoCommand with a container.
 426  *
 427  * @param container Container with (almost) all information
 428  * @param flags Flags for the command and how to execute the command
 429  * @see CommandProc
 430  * @return the cost
 431  */
 432 CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
 433 {
 434         return DoCommand(container->tile, container->p1, container->p2, flags, container->cmd & CMD_ID_MASK, container->text);
 435 }
 436
 437 /*!
 438  * This function executes a given command with the parameters from the #CommandProc parameter list.
 439  * Depending on the flags parameter it execute or test a command.
 440  *
 441  * @param tile The tile to apply the command on (for the #CommandProc)
 442  * @param p1 Additional data for the command (for the #CommandProc)
 443  * @param p2 Additional data for the command (for the #CommandProc)
 444  * @param flags Flags for the command and how to execute the command
 445  * @param cmd The command-id to execute (a value of the CMD_* enums)
 446  * @param text The text to pass
 447  * @see CommandProc
 448  * @return the cost
 449  */
 450 CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text)
 451 {
 452         CommandCost res;
 453
 454         /* Do not even think about executing out-of-bounds tile-commands */
 455         if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (flags & DC_ALL_TILES) == 0))) return CMD_ERROR;
 456
 457         /* Chop of any CMD_MSG or other flags; we don't need those here */
 458         CommandProc *proc = _command_proc_table[cmd & CMD_ID_MASK].proc;
 459
 460         _docommand_recursive++;
 461
 462         /* only execute the test call if it's toplevel, or we're not execing. */
 463         if (_docommand_recursive == 1 || !(flags & DC_EXEC) ) {
 464                 if (_docommand_recursive == 1) _cleared_object_areas.Clear();
 465                 SetTownRatingTestMode(true);
 466                 res = proc(tile, flags & ~DC_EXEC, p1, p2, text);
 467                 SetTownRatingTestMode(false);
 468                 if (res.Failed()) {
 469                         goto error;
 470                 }
 471
 472                 if (_docommand_recursive == 1 &&
 473                                 !(flags & DC_QUERY_COST) &&
 474                                 !(flags & DC_BANKRUPT) &&
 475                                 !CheckCompanyHasMoney(res)) { // CheckCompanyHasMoney() modifies 'res' to an error if it fails.
 476                         goto error;
 477                 }
 478
 479                 if (!(flags & DC_EXEC)) {
 480                         _docommand_recursive--;
 481                         return res;
 482                 }
 483         }
 484
 485         /* Execute the command here. All cost-relevant functions set the expenses type
 486          * themselves to the cost object at some point */
 487         if (_docommand_recursive == 1) _cleared_object_areas.Clear();
 488         res = proc(tile, flags, p1, p2, text);
 489         if (res.Failed()) {
 490 error:
 491                 _docommand_recursive--;
 492                 return res;
 493         }
 494
 495         /* if toplevel, subtract the money. */
 496         if (--_docommand_recursive == 0 && !(flags & DC_BANKRUPT)) {
 497                 SubtractMoneyFromCompany(res);
 498         }
 499
 500         return res;
 501 }
 502
 503 /*!
 504  * This functions returns the money which can be used to execute a command.
 505  * This is either the money of the current company or INT64_MAX if there
 506  * is no such a company "at the moment" like the server itself.
 507  *
 508  * @return The available money of a company or INT64_MAX
 509  */
 510 Money GetAvailableMoneyForCommand()
 511 {
 512         CompanyID company = _current_company;
 513         if (!Company::IsValidID(company)) return INT64_MAX;
 514         return Company::Get(company)->money;
 515 }
 516
 517 /**
 518  * Shortcut for the long DoCommandP when having a container with the data.
 519  * @param container the container with information.
 520  * @param my_cmd indicator if the command is from a company or server (to display error messages for a user)
 521  * @return true if the command succeeded, else false
 522  */
 523 bool DoCommandP(const CommandContainer *container, bool my_cmd)
 524 {
 525         return DoCommandP(container->tile, container->p1, container->p2, container->cmd, container->callback, container->text, my_cmd);
 526 }
 527
 528 /*!
 529  * Toplevel network safe docommand function for the current company. Must not be called recursively.
 530  * The callback is called when the command succeeded or failed. The parameters
 531  * \a tile, \a p1, and \a p2 are from the #CommandProc function. The parameter \a cmd is the command to execute.
 532  * The parameter \a my_cmd is used to indicate if the command is from a company or the server.
 533  *
 534  * @param tile The tile to perform a command on (see #CommandProc)
 535  * @param p1 Additional data for the command (see #CommandProc)
 536  * @param p2 Additional data for the command (see #CommandProc)
 537  * @param cmd The command to execute (a CMD_* value)
 538  * @param callback A callback function to call after the command is finished
 539  * @param text The text to pass
 540  * @param my_cmd indicator if the command is from a company or server (to display error messages for a user)
 541  * @return \c true if the command succeeded, else \c false.
 542  */
 543 bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd)
 544 {
 545         /* Cost estimation is generally only done when the
 546          * local user presses shift while doing somthing.
 547          * However, in case of incoming network commands,
 548          * map generation or the pause button we do want
 549          * to execute. */
 550         bool estimate_only = _shift_pressed && IsLocalCompany() &&
 551                         !_generating_world &&
 552                         !(cmd & CMD_NETWORK_COMMAND) &&
 553                         (cmd & CMD_ID_MASK) != CMD_PAUSE;
 554
 555         /* We're only sending the command, so don't do
 556          * fancy things for 'success'. */
 557         bool only_sending = _networking && !(cmd & CMD_NETWORK_COMMAND);
 558
 559         /* Where to show the message? */
 560         int x = TileX(tile) * TILE_SIZE;
 561         int y = TileY(tile) * TILE_SIZE;
 562
 563         if (_pause_mode != PM_UNPAUSED && !IsCommandAllowedWhilePaused(cmd)) {
 564                 ShowErrorMessage(GB(cmd, 16, 16), STR_ERROR_NOT_ALLOWED_WHILE_PAUSED, WL_INFO, x, y);
 565                 return false;
 566         }
 567
 568 #ifdef ENABLE_NETWORK
 569         /* Only set p2 when the command does not come from the network. */
 570         if (!(cmd & CMD_NETWORK_COMMAND) && GetCommandFlags(cmd) & CMD_CLIENT_ID && p2 == 0) p2 = CLIENT_ID_SERVER;
 571 #endif
 572
 573         CommandCost res = DoCommandPInternal(tile, p1, p2, cmd, callback, text, my_cmd, estimate_only);
 574         if (res.Failed()) {
 575                 /* Only show the error when it's for us. */
 576                 StringID error_part1 = GB(cmd, 16, 16);
 577                 if (estimate_only || (IsLocalCompany() && error_part1 != 0 && my_cmd)) {
 578                         ShowErrorMessage(error_part1, res.GetErrorMessage(), WL_INFO, x, y, res.GetTextRefStackGRF(), res.GetTextRefStackSize(), res.GetTextRefStack());
 579                 }
 580         } else if (estimate_only) {
 581                 ShowEstimatedCostOrIncome(res.GetCost(), x, y);
 582         } else if (!only_sending && res.GetCost() != 0 && tile != 0 && IsLocalCompany() && _game_mode != GM_EDITOR) {
 583                 /* Only show the cost animation when we did actually
 584                  * execute the command, i.e. we're not sending it to
 585                  * the server, when it has cost the local company
 586                  * something. Furthermore in the editor there is no
 587                  * concept of cost, so don't show it there either. */
 588                 ShowCostOrIncomeAnimation(x, y, GetSlopePixelZ(x, y), res.GetCost());
 589         }
 590
 591         if (!estimate_only && !only_sending && callback != NULL) {
 592                 callback(res, tile, p1, p2);
 593         }
 594
 595         return res.Succeeded();
 596 }
 597
 598
 599 /**
 600  * Helper to deduplicate the code for returning.
 601  * @param cmd   the command cost to return.
 602  * @param clear whether to keep the storage changes or not.
 603  */
 604 #define return_dcpi(cmd, clear) { _docommand_recursive = 0; ClearPersistentStorageChanges(clear); return cmd; }
 605
 606 /*!
 607  * Helper function for the toplevel network safe docommand function for the current company.
 608  *
 609  * @param tile The tile to perform a command on (see #CommandProc)
 610  * @param p1 Additional data for the command (see #CommandProc)
 611  * @param p2 Additional data for the command (see #CommandProc)
 612  * @param cmd The command to execute (a CMD_* value)
 613  * @param callback A callback function to call after the command is finished
 614  * @param text The text to pass
 615  * @param my_cmd indicator if the command is from a company or server (to display error messages for a user)
 616  * @param estimate_only whether to give only the estimate or also execute the command
 617  * @return the command cost of this function.
 618  */
 619 CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only)
 620 {
 621         /* Prevent recursion; it gives a mess over the network */
 622         assert(_docommand_recursive == 0);
 623         _docommand_recursive = 1;
 624
 625         /* Reset the state. */
 626         _additional_cash_required = 0;
 627
 628         /* Get pointer to command handler */
 629         byte cmd_id = cmd & CMD_ID_MASK;
 630         assert(cmd_id < lengthof(_command_proc_table));
 631
 632         CommandProc *proc = _command_proc_table[cmd_id].proc;
 633         /* Shouldn't happen, but you never know when someone adds
 634          * NULLs to the _command_proc_table. */
 635         assert(proc != NULL);
 636
 637         /* Command flags are used internally */
 638         CommandFlags cmd_flags = GetCommandFlags(cmd);
 639         /* Flags get send to the DoCommand */
 640         DoCommandFlag flags = CommandFlagsToDCFlags(cmd_flags);
 641
 642 #ifdef ENABLE_NETWORK
 643         /* Make sure p2 is properly set to a ClientID. */
 644         assert(!(cmd_flags & CMD_CLIENT_ID) || p2 != 0);
 645 #endif
 646
 647         /* Do not even think about executing out-of-bounds tile-commands */
 648         if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (cmd_flags & CMD_ALL_TILES) == 0))) return_dcpi(CMD_ERROR, false);
 649
 650         /* Always execute server and spectator commands as spectator */
 651         bool exec_as_spectator = (cmd_flags & (CMD_SPECTATOR | CMD_SERVER)) != 0;
 652
 653         /* If the company isn't valid it may only do server command or start a new company!
 654          * The server will ditch any server commands a client sends to it, so effectively
 655          * this guards the server from executing functions for an invalid company. */
 656         if (_game_mode == GM_NORMAL && !exec_as_spectator && !Company::IsValidID(_current_company) && !(_current_company == OWNER_DEITY && (cmd_flags & CMD_DEITY) != 0)) {
 657                 return_dcpi(CMD_ERROR, false);
 658         }
 659
 660         Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
 661         if (exec_as_spectator) cur_company.Change(COMPANY_SPECTATOR);
 662
 663         bool test_and_exec_can_differ = (cmd_flags & CMD_NO_TEST) != 0;
 664
 665         /* Test the command. */
 666         _cleared_object_areas.Clear();
 667         SetTownRatingTestMode(true);
 668         ClearPersistentStorageChanges(false);
 669         CommandCost res = proc(tile, flags, p1, p2, text);
 670         SetTownRatingTestMode(false);
 671
 672         /* Make sure we're not messing things up here. */
 673         assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
 674
 675         /* If the command fails, we're doing an estimate
 676          * or the player does not have enough money
 677          * (unless it's a command where the test and
 678          * execution phase might return different costs)
 679          * we bail out here. */
 680         if (res.Failed() || estimate_only ||
 681                         (!test_and_exec_can_differ && !CheckCompanyHasMoney(res))) {
 682                 if (!_networking || _generating_world || (cmd & CMD_NETWORK_COMMAND) != 0) {
 683                         /* Log the failed command as well. Just to be able to be find
 684                          * causes of desyncs due to bad command test implementations. */
 685                         DEBUG(desync, 1, "cmdf: %08x; %02x; %02x; %06x; %08x; %08x; %08x; \"%s\" (%s)", _date, _date_fract, (int)_current_company, tile, p1, p2, cmd & ~CMD_NETWORK_COMMAND, text, GetCommandName(cmd));
 686                 }
 687                 cur_company.Restore();
 688                 return_dcpi(res, false);
 689         }
 690
 691 #ifdef ENABLE_NETWORK
 692         /*
 693          * If we are in network, and the command is not from the network
 694          * send it to the command-queue and abort execution
 695          */
 696         if (_networking && !_generating_world && !(cmd & CMD_NETWORK_COMMAND)) {
 697                 NetworkSendCommand(tile, p1, p2, cmd & ~CMD_FLAGS_MASK, callback, text, _current_company);
 698                 cur_company.Restore();
 699
 700                 /* Don't return anything special here; no error, no costs.
 701                  * This way it's not handled by DoCommand and only the
 702                  * actual execution of the command causes messages. Also
 703                  * reset the storages as we've not executed the command. */
 704                 return_dcpi(CommandCost(), false);
 705         }
 706 #endif /* ENABLE_NETWORK */
 707         DEBUG(desync, 1, "cmd: %08x; %02x; %02x; %06x; %08x; %08x; %08x; \"%s\" (%s)", _date, _date_fract, (int)_current_company, tile, p1, p2, cmd & ~CMD_NETWORK_COMMAND, text, GetCommandName(cmd));
 708
 709         /* Actually try and execute the command. If no cost-type is given
 710          * use the construction one */
 711         _cleared_object_areas.Clear();
 712         ClearPersistentStorageChanges(false);
 713         CommandCost res2 = proc(tile, flags | DC_EXEC, p1, p2, text);
 714
 715         if (cmd_id == CMD_COMPANY_CTRL) {
 716                 cur_company.Trash();
 717                 /* We are a new company                  -> Switch to new local company.
 718                  * We were closed down                   -> Switch to spectator
 719                  * Some other company opened/closed down -> The outside function will switch back */
 720                 _current_company = _local_company;
 721         } else {
 722                 /* Make sure nothing bad happened, like changing the current company. */
 723                 assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
 724                 cur_company.Restore();
 725         }
 726
 727         /* If the test and execution can differ we have to check the
 728          * return of the command. Otherwise we can check whether the
 729          * test and execution have yielded the same result,
 730          * i.e. cost and error state are the same. */
 731         if (!test_and_exec_can_differ) {
 732                 assert(res.GetCost() == res2.GetCost() && res.Failed() == res2.Failed()); // sanity check
 733         } else if (res2.Failed()) {
 734                 return_dcpi(res2, false);
 735         }
 736
 737         /* If we're needing more money and we haven't done
 738          * anything yet, ask for the money! */
 739         if (_additional_cash_required != 0 && res2.GetCost() == 0) {
 740                 /* It could happen we removed rail, thus gained money, and deleted something else.
 741                  * So make sure the signal buffer is empty even in this case */
 742                 UpdateSignalsInBuffer();
 743                 SetDParam(0, _additional_cash_required);
 744                 return_dcpi(CommandCost(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY), false);
 745         }
 746
 747         /* update last build coordinate of company. */
 748         if (tile != 0) {
 749                 Company *c = Company::GetIfValid(_current_company);
 750                 if (c != NULL) c->last_build_coordinate = tile;
 751         }
 752
 753         SubtractMoneyFromCompany(res2);
 754
 755         /* update signals if needed */
 756         UpdateSignalsInBuffer();
 757
 758         return_dcpi(res2, true);
 759 }
 760 #undef return_dcpi
 761
 762
 763 /**
 764  * Adds the cost of the given command return value to this cost.
 765  * Also takes a possible error message when it is set.
 766  * @param ret The command to add the cost of.
 767  */
 768 void CommandCost::AddCost(const CommandCost &ret)
 769 {
 770         this->AddCost(ret.cost);
 771         if (this->success && !ret.success) {
 772                 this->message = ret.message;
 773                 this->success = false;
 774         }
 775 }
 776
 777 /**
 778  * Values to put on the #TextRefStack for the error message.
 779  * There is only one static instance of the array, just like there is only one
 780  * instance of normal DParams.
 781  */
 782 uint32 CommandCost::textref_stack[16];
 783
 784 /**
 785  * Activate usage of the NewGRF #TextRefStack for the error message.
 786  * @param grffile NewGRF that provides the #TextRefStack
 787  * @param num_registers number of entries to copy from the temporary NewGRF registers
 788  */
 789 void CommandCost::UseTextRefStack(const GRFFile *grffile, uint num_registers)
 790 {
 791         extern TemporaryStorageArray<int32, 0x110> _temp_store;
 792
 793         assert(num_registers < lengthof(textref_stack));
 794         this->textref_stack_grffile = grffile;
 795         this->textref_stack_size = num_registers;
 796         for (uint i = 0; i < num_registers; i++) {
 797                 textref_stack[i] = _temp_store.GetValue(0x100 + i);
 798         }
 799 }