command.cpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include "landscape.h"
00014 #include "error.h"
00015 #include "gui.h"
00016 #include "command_func.h"
00017 #include "network/network_type.h"
00018 #include "network/network.h"
00019 #include "genworld.h"
00020 #include "strings_func.h"
00021 #include "texteff.hpp"
00022 #include "town.h"
00023 #include "date_func.h"
00024 #include "company_func.h"
00025 #include "company_base.h"
00026 #include "signal_func.h"
00027 #include "core/backup_type.hpp"
00028 #include "object_base.h"
00029 
00030 #include "table/strings.h"
00031 
00032 CommandProc CmdBuildRailroadTrack;
00033 CommandProc CmdRemoveRailroadTrack;
00034 CommandProc CmdBuildSingleRail;
00035 CommandProc CmdRemoveSingleRail;
00036 
00037 CommandProc CmdLandscapeClear;
00038 
00039 CommandProc CmdBuildBridge;
00040 
00041 CommandProc CmdBuildRailStation;
00042 CommandProc CmdRemoveFromRailStation;
00043 CommandProc CmdConvertRail;
00044 
00045 CommandProc CmdBuildSingleSignal;
00046 CommandProc CmdRemoveSingleSignal;
00047 
00048 CommandProc CmdTerraformLand;
00049 
00050 CommandProc CmdBuildObject;
00051 CommandProc CmdSellLandArea;
00052 
00053 CommandProc CmdBuildTunnel;
00054 
00055 CommandProc CmdBuildTrainDepot;
00056 CommandProc CmdBuildRailWaypoint;
00057 CommandProc CmdRenameWaypoint;
00058 CommandProc CmdRemoveFromRailWaypoint;
00059 
00060 CommandProc CmdBuildRoadStop;
00061 CommandProc CmdRemoveRoadStop;
00062 
00063 CommandProc CmdBuildLongRoad;
00064 CommandProc CmdRemoveLongRoad;
00065 CommandProc CmdBuildRoad;
00066 
00067 CommandProc CmdBuildRoadDepot;
00068 
00069 CommandProc CmdBuildAirport;
00070 
00071 CommandProc CmdBuildDock;
00072 
00073 CommandProc CmdBuildShipDepot;
00074 
00075 CommandProc CmdBuildBuoy;
00076 
00077 CommandProc CmdPlantTree;
00078 
00079 CommandProc CmdMoveRailVehicle;
00080 
00081 CommandProc CmdBuildVehicle;
00082 CommandProc CmdSellVehicle;
00083 CommandProc CmdRefitVehicle;
00084 CommandProc CmdSendVehicleToDepot;
00085 
00086 CommandProc CmdForceTrainProceed;
00087 CommandProc CmdReverseTrainDirection;
00088 
00089 CommandProc CmdClearOrderBackup;
00090 CommandProc CmdModifyOrder;
00091 CommandProc CmdSkipToOrder;
00092 CommandProc CmdDeleteOrder;
00093 CommandProc CmdInsertOrder;
00094 CommandProc CmdChangeServiceInt;
00095 
00096 CommandProc CmdBuildIndustry;
00097 
00098 CommandProc CmdSetCompanyManagerFace;
00099 CommandProc CmdSetCompanyColour;
00100 
00101 CommandProc CmdIncreaseLoan;
00102 CommandProc CmdDecreaseLoan;
00103 
00104 CommandProc CmdWantEnginePreview;
00105 
00106 CommandProc CmdRenameVehicle;
00107 CommandProc CmdRenameEngine;
00108 
00109 CommandProc CmdRenameCompany;
00110 CommandProc CmdRenamePresident;
00111 
00112 CommandProc CmdRenameStation;
00113 CommandProc CmdRenameDepot;
00114 
00115 CommandProc CmdPlaceSign;
00116 CommandProc CmdRenameSign;
00117 
00118 CommandProc CmdTurnRoadVeh;
00119 
00120 CommandProc CmdPause;
00121 
00122 CommandProc CmdBuyShareInCompany;
00123 CommandProc CmdSellShareInCompany;
00124 CommandProc CmdBuyCompany;
00125 
00126 CommandProc CmdFoundTown;
00127 CommandProc CmdRenameTown;
00128 CommandProc CmdDoTownAction;
00129 CommandProc CmdTownGrowthRate;
00130 CommandProc CmdTownCargoGoal;
00131 CommandProc CmdTownSetText;
00132 CommandProc CmdExpandTown;
00133 CommandProc CmdDeleteTown;
00134 
00135 CommandProc CmdChangeSetting;
00136 CommandProc CmdChangeCompanySetting;
00137 
00138 CommandProc CmdOrderRefit;
00139 CommandProc CmdCloneOrder;
00140 
00141 CommandProc CmdClearArea;
00142 
00143 CommandProc CmdGiveMoney;
00144 CommandProc CmdMoneyCheat;
00145 CommandProc CmdBuildCanal;
00146 CommandProc CmdBuildLock;
00147 
00148 CommandProc CmdCreateSubsidy;
00149 CommandProc CmdCompanyCtrl;
00150 CommandProc CmdCustomNewsItem;
00151 CommandProc CmdCreateGoal;
00152 CommandProc CmdRemoveGoal;
00153 CommandProc CmdSetGoalText;
00154 CommandProc CmdSetGoalProgress;
00155 CommandProc CmdSetGoalCompleted;
00156 CommandProc CmdGoalQuestion;
00157 CommandProc CmdGoalQuestionAnswer;
00158 
00159 CommandProc CmdLevelLand;
00160 
00161 CommandProc CmdBuildSignalTrack;
00162 CommandProc CmdRemoveSignalTrack;
00163 
00164 CommandProc CmdSetAutoReplace;
00165 
00166 CommandProc CmdCloneVehicle;
00167 CommandProc CmdStartStopVehicle;
00168 CommandProc CmdMassStartStopVehicle;
00169 CommandProc CmdAutoreplaceVehicle;
00170 CommandProc CmdDepotSellAllVehicles;
00171 CommandProc CmdDepotMassAutoReplace;
00172 
00173 CommandProc CmdCreateGroup;
00174 CommandProc CmdRenameGroup;
00175 CommandProc CmdDeleteGroup;
00176 CommandProc CmdAddVehicleGroup;
00177 CommandProc CmdAddSharedVehicleGroup;
00178 CommandProc CmdRemoveAllVehiclesGroup;
00179 CommandProc CmdSetGroupReplaceProtection;
00180 
00181 CommandProc CmdMoveOrder;
00182 CommandProc CmdChangeTimetable;
00183 CommandProc CmdSetVehicleOnTime;
00184 CommandProc CmdAutofillTimetable;
00185 CommandProc CmdSetTimetableStart;
00186 
00187 CommandProc CmdOpenCloseAirport;
00188 
00189 #define DEF_CMD(proc, flags, type) {proc, #proc, (CommandFlags)flags, type}
00190 
00198 static const Command _command_proc_table[] = {
00199   DEF_CMD(CmdBuildRailroadTrack,       CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAILROAD_TRACK
00200   DEF_CMD(CmdRemoveRailroadTrack,                     CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_RAILROAD_TRACK
00201   DEF_CMD(CmdBuildSingleRail,          CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SINGLE_RAIL
00202   DEF_CMD(CmdRemoveSingleRail,                        CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SINGLE_RAIL
00203   DEF_CMD(CmdLandscapeClear,                                 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_LANDSCAPE_CLEAR
00204   DEF_CMD(CmdBuildBridge,  CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BRIDGE
00205   DEF_CMD(CmdBuildRailStation,         CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_STATION
00206   DEF_CMD(CmdBuildTrainDepot,          CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TRAIN_DEPOT
00207   DEF_CMD(CmdBuildSingleSignal,                       CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNALS
00208   DEF_CMD(CmdRemoveSingleSignal,                      CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNALS
00209   DEF_CMD(CmdTerraformLand,           CMD_ALL_TILES | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_TERRAFORM_LAND
00210   DEF_CMD(CmdBuildObject,              CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_OBJECT
00211   DEF_CMD(CmdBuildTunnel,                 CMD_DEITY | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TUNNEL
00212   DEF_CMD(CmdRemoveFromRailStation,                          0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_STATION
00213   DEF_CMD(CmdConvertRail,                                    0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CONVERT_RAILD
00214   DEF_CMD(CmdBuildRailWaypoint,                              0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_WAYPOINT
00215   DEF_CMD(CmdRenameWaypoint,                      CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_WAYPOINT
00216   DEF_CMD(CmdRemoveFromRailWaypoint,                         0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_WAYPOINT
00217 
00218   DEF_CMD(CmdBuildRoadStop,            CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_STOP
00219   DEF_CMD(CmdRemoveRoadStop,                                 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_ROAD_STOP
00220   DEF_CMD(CmdBuildLongRoad,CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LONG_ROAD
00221   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.
00222   DEF_CMD(CmdBuildRoad,    CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD
00223   DEF_CMD(CmdBuildRoadDepot,           CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_DEPOT
00224 
00225   DEF_CMD(CmdBuildAirport,             CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_AIRPORT
00226   DEF_CMD(CmdBuildDock,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_DOCK
00227   DEF_CMD(CmdBuildShipDepot,                          CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SHIP_DEPOT
00228   DEF_CMD(CmdBuildBuoy,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BUOY
00229   DEF_CMD(CmdPlantTree,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_PLANT_TREE
00230 
00231   DEF_CMD(CmdBuildVehicle,                       CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_BUILD_VEHICLE
00232   DEF_CMD(CmdSellVehicle,                        CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_SELL_VEHICLE
00233   DEF_CMD(CmdRefitVehicle,                                   0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_REFIT_VEHICLE
00234   DEF_CMD(CmdSendVehicleToDepot,                             0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_SEND_VEHICLE_TO_DEPOT
00235 
00236   DEF_CMD(CmdMoveRailVehicle,                                0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_MOVE_RAIL_VEHICLE
00237   DEF_CMD(CmdForceTrainProceed,                              0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_FORCE_TRAIN_PROCEED
00238   DEF_CMD(CmdReverseTrainDirection,                          0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_REVERSE_TRAIN_DIRECTION
00239 
00240   DEF_CMD(CmdClearOrderBackup,                   CMD_CLIENT_ID, CMDT_ROUTE_MANAGEMENT      ), // CMD_CLEAR_ORDER_BACKUP
00241   DEF_CMD(CmdModifyOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_MODIFY_ORDER
00242   DEF_CMD(CmdSkipToOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SKIP_TO_ORDER
00243   DEF_CMD(CmdDeleteOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_DELETE_ORDER
00244   DEF_CMD(CmdInsertOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_INSERT_ORDER
00245 
00246   DEF_CMD(CmdChangeServiceInt,                               0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_CHANGE_SERVICE_INT
00247 
00248   DEF_CMD(CmdBuildIndustry,                          CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_INDUSTRY
00249   DEF_CMD(CmdSetCompanyManagerFace,                          0, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_COMPANY_MANAGER_FACE
00250   DEF_CMD(CmdSetCompanyColour,                               0, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_COMPANY_COLOUR
00251 
00252   DEF_CMD(CmdIncreaseLoan,                                   0, CMDT_MONEY_MANAGEMENT      ), // CMD_INCREASE_LOAN
00253   DEF_CMD(CmdDecreaseLoan,                                   0, CMDT_MONEY_MANAGEMENT      ), // CMD_DECREASE_LOAN
00254 
00255   DEF_CMD(CmdWantEnginePreview,                              0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_WANT_ENGINE_PREVIEW
00256 
00257   DEF_CMD(CmdRenameVehicle,                       CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_VEHICLE
00258   DEF_CMD(CmdRenameEngine,                        CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_ENGINE
00259 
00260   DEF_CMD(CmdRenameCompany,                       CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_COMPANY
00261   DEF_CMD(CmdRenamePresident,                     CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_PRESIDENT
00262 
00263   DEF_CMD(CmdRenameStation,                       CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_STATION
00264   DEF_CMD(CmdRenameDepot,                         CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_DEPOT
00265 
00266   DEF_CMD(CmdPlaceSign,               CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_PLACE_SIGN
00267   DEF_CMD(CmdRenameSign,              CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_SIGN
00268 
00269   DEF_CMD(CmdTurnRoadVeh,                                    0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_TURN_ROADVEH
00270 
00271   DEF_CMD(CmdPause,                                 CMD_SERVER, CMDT_SERVER_SETTING        ), // CMD_PAUSE
00272 
00273   DEF_CMD(CmdBuyShareInCompany,                              0, CMDT_MONEY_MANAGEMENT      ), // CMD_BUY_SHARE_IN_COMPANY
00274   DEF_CMD(CmdSellShareInCompany,                             0, CMDT_MONEY_MANAGEMENT      ), // CMD_SELL_SHARE_IN_COMPANY
00275   DEF_CMD(CmdBuyCompany,                                     0, CMDT_MONEY_MANAGEMENT      ), // CMD_BUY_COMANY
00276 
00277   DEF_CMD(CmdFoundTown,                            CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_FOUND_TOWN; founding random town can fail only in exec run
00278   DEF_CMD(CmdRenameTown,             CMD_STR_CTRL | CMD_SERVER, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_TOWN
00279   DEF_CMD(CmdDoTownAction,                                   0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DO_TOWN_ACTION
00280   DEF_CMD(CmdTownCargoGoal,                          CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_CARGO_GOAL
00281   DEF_CMD(CmdTownGrowthRate,                         CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_GROWTH_RATE
00282   DEF_CMD(CmdTownSetText,             CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_SET_TEXT
00283   DEF_CMD(CmdExpandTown,                             CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_EXPAND_TOWN
00284   DEF_CMD(CmdDeleteTown,                           CMD_OFFLINE, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DELETE_TOWN
00285 
00286   DEF_CMD(CmdOrderRefit,                                     0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ORDER_REFIT
00287   DEF_CMD(CmdCloneOrder,                                     0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CLONE_ORDER
00288 
00289   DEF_CMD(CmdClearArea,                            CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CLEAR_AREA; destroying multi-tile houses makes town rating differ between test and execution
00290 
00291   DEF_CMD(CmdMoneyCheat,                           CMD_OFFLINE, CMDT_CHEAT                 ), // CMD_MONEY_CHEAT
00292   DEF_CMD(CmdBuildCanal,                              CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_CANAL
00293   DEF_CMD(CmdCreateSubsidy,                          CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_SUBSIDY
00294   DEF_CMD(CmdCompanyCtrl,        CMD_SPECTATOR | CMD_CLIENT_ID, CMDT_SERVER_SETTING        ), // CMD_COMPANY_CTRL
00295   DEF_CMD(CmdCustomNewsItem,          CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CUSTOM_NEWS_ITEM
00296   DEF_CMD(CmdCreateGoal,              CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_GOAL
00297   DEF_CMD(CmdRemoveGoal,                             CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_REMOVE_GOAL
00298   DEF_CMD(CmdSetGoalText,             CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_GOAL_TEXT
00299   DEF_CMD(CmdSetGoalProgress,         CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_GOAL_PROGRESS
00300   DEF_CMD(CmdSetGoalCompleted,        CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_GOAL_COMPLETED
00301   DEF_CMD(CmdGoalQuestion,            CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_GOAL_QUESTION
00302   DEF_CMD(CmdGoalQuestionAnswer,                     CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_GOAL_QUESTION_ANSWER
00303 
00304   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
00305 
00306   DEF_CMD(CmdBuildLock,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LOCK
00307 
00308   DEF_CMD(CmdBuildSignalTrack,                        CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNAL_TRACK
00309   DEF_CMD(CmdRemoveSignalTrack,                       CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNAL_TRACK
00310 
00311   DEF_CMD(CmdGiveMoney,                                      0, CMDT_MONEY_MANAGEMENT      ), // CMD_GIVE_MONEY
00312   DEF_CMD(CmdChangeSetting,                         CMD_SERVER, CMDT_SERVER_SETTING        ), // CMD_CHANGE_SETTING
00313   DEF_CMD(CmdChangeCompanySetting,                           0, CMDT_COMPANY_SETTING       ), // CMD_CHANGE_COMPANY_SETTING
00314   DEF_CMD(CmdSetAutoReplace,                                 0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_SET_AUTOREPLACE
00315   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
00316   DEF_CMD(CmdStartStopVehicle,                               0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_START_STOP_VEHICLE
00317   DEF_CMD(CmdMassStartStopVehicle,                           0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_MASS_START_STOP
00318   DEF_CMD(CmdAutoreplaceVehicle,                             0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_AUTOREPLACE_VEHICLE
00319   DEF_CMD(CmdDepotSellAllVehicles,                           0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_DEPOT_SELL_ALL_VEHICLES
00320   DEF_CMD(CmdDepotMassAutoReplace,                           0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_DEPOT_MASS_AUTOREPLACE
00321   DEF_CMD(CmdCreateGroup,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CREATE_GROUP
00322   DEF_CMD(CmdDeleteGroup,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_DELETE_GROUP
00323   DEF_CMD(CmdRenameGroup,                         CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_GROUP
00324   DEF_CMD(CmdAddVehicleGroup,                                0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ADD_VEHICLE_GROUP
00325   DEF_CMD(CmdAddSharedVehicleGroup,                          0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ADD_SHARE_VEHICLE_GROUP
00326   DEF_CMD(CmdRemoveAllVehiclesGroup,                         0, CMDT_ROUTE_MANAGEMENT      ), // CMD_REMOVE_ALL_VEHICLES_GROUP
00327   DEF_CMD(CmdSetGroupReplaceProtection,                      0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_GROUP_REPLACE_PROTECTION
00328   DEF_CMD(CmdMoveOrder,                                      0, CMDT_ROUTE_MANAGEMENT      ), // CMD_MOVE_ORDER
00329   DEF_CMD(CmdChangeTimetable,                                0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CHANGE_TIMETABLE
00330   DEF_CMD(CmdSetVehicleOnTime,                               0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_VEHICLE_ON_TIME
00331   DEF_CMD(CmdAutofillTimetable,                              0, CMDT_ROUTE_MANAGEMENT      ), // CMD_AUTOFILL_TIMETABLE
00332   DEF_CMD(CmdSetTimetableStart,                              0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_TIMETABLE_START
00333 
00334   DEF_CMD(CmdOpenCloseAirport,                               0, CMDT_ROUTE_MANAGEMENT      ), // CMD_OPEN_CLOSE_AIRPORT
00335 };
00336 
00343 bool IsValidCommand(uint32 cmd)
00344 {
00345   cmd &= CMD_ID_MASK;
00346 
00347   return cmd < lengthof(_command_proc_table) && _command_proc_table[cmd].proc != NULL;
00348 }
00349 
00357 CommandFlags GetCommandFlags(uint32 cmd)
00358 {
00359   assert(IsValidCommand(cmd));
00360 
00361   return _command_proc_table[cmd & CMD_ID_MASK].flags;
00362 }
00363 
00371 const char *GetCommandName(uint32 cmd)
00372 {
00373   assert(IsValidCommand(cmd));
00374 
00375   return _command_proc_table[cmd & CMD_ID_MASK].name;
00376 }
00377 
00383 bool IsCommandAllowedWhilePaused(uint32 cmd)
00384 {
00385   /* Lookup table for the command types that are allowed for a given pause level setting. */
00386   static const int command_type_lookup[] = {
00387     CMDPL_ALL_ACTIONS,     
00388     CMDPL_NO_LANDSCAPING,  
00389     CMDPL_NO_LANDSCAPING,  
00390     CMDPL_NO_CONSTRUCTION, 
00391     CMDPL_NO_CONSTRUCTION, 
00392     CMDPL_NO_CONSTRUCTION, 
00393     CMDPL_NO_CONSTRUCTION, 
00394     CMDPL_NO_ACTIONS,      
00395     CMDPL_NO_ACTIONS,      
00396   };
00397   assert_compile(lengthof(command_type_lookup) == CMDT_END);
00398 
00399   assert(IsValidCommand(cmd));
00400   return _game_mode == GM_EDITOR || command_type_lookup[_command_proc_table[cmd & CMD_ID_MASK].type] <= _settings_game.construction.command_pause_level;
00401 }
00402 
00403 
00404 static int _docommand_recursive = 0;
00405 
00414 CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
00415 {
00416   return DoCommand(container->tile, container->p1, container->p2, flags, container->cmd & CMD_ID_MASK, container->text);
00417 }
00418 
00432 CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text)
00433 {
00434   CommandCost res;
00435 
00436   /* Do not even think about executing out-of-bounds tile-commands */
00437   if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (flags & DC_ALL_TILES) == 0))) return CMD_ERROR;
00438 
00439   /* Chop of any CMD_MSG or other flags; we don't need those here */
00440   CommandProc *proc = _command_proc_table[cmd & CMD_ID_MASK].proc;
00441 
00442   _docommand_recursive++;
00443 
00444   /* only execute the test call if it's toplevel, or we're not execing. */
00445   if (_docommand_recursive == 1 || !(flags & DC_EXEC) ) {
00446     if (_docommand_recursive == 1) _cleared_object_areas.Clear();
00447     SetTownRatingTestMode(true);
00448     res = proc(tile, flags & ~DC_EXEC, p1, p2, text);
00449     SetTownRatingTestMode(false);
00450     if (res.Failed()) {
00451       goto error;
00452     }
00453 
00454     if (_docommand_recursive == 1 &&
00455         !(flags & DC_QUERY_COST) &&
00456         !(flags & DC_BANKRUPT) &&
00457         !CheckCompanyHasMoney(res)) { // CheckCompanyHasMoney() modifies 'res' to an error if it fails.
00458       goto error;
00459     }
00460 
00461     if (!(flags & DC_EXEC)) {
00462       _docommand_recursive--;
00463       return res;
00464     }
00465   }
00466 
00467   /* Execute the command here. All cost-relevant functions set the expenses type
00468    * themselves to the cost object at some point */
00469   if (_docommand_recursive == 1) _cleared_object_areas.Clear();
00470   res = proc(tile, flags, p1, p2, text);
00471   if (res.Failed()) {
00472 error:
00473     _docommand_recursive--;
00474     return res;
00475   }
00476 
00477   /* if toplevel, subtract the money. */
00478   if (--_docommand_recursive == 0 && !(flags & DC_BANKRUPT)) {
00479     SubtractMoneyFromCompany(res);
00480   }
00481 
00482   return res;
00483 }
00484 
00492 Money GetAvailableMoneyForCommand()
00493 {
00494   CompanyID company = _current_company;
00495   if (!Company::IsValidID(company)) return INT64_MAX;
00496   return Company::Get(company)->money;
00497 }
00498 
00505 bool DoCommandP(const CommandContainer *container, bool my_cmd)
00506 {
00507   return DoCommandP(container->tile, container->p1, container->p2, container->cmd, container->callback, container->text, my_cmd);
00508 }
00509 
00525 bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd)
00526 {
00527   /* Cost estimation is generally only done when the
00528    * local user presses shift while doing somthing.
00529    * However, in case of incoming network commands,
00530    * map generation or the pause button we do want
00531    * to execute. */
00532   bool estimate_only = _shift_pressed && IsLocalCompany() &&
00533       !_generating_world &&
00534       !(cmd & CMD_NETWORK_COMMAND) &&
00535       (cmd & CMD_ID_MASK) != CMD_PAUSE;
00536 
00537   /* We're only sending the command, so don't do
00538    * fancy things for 'success'. */
00539   bool only_sending = _networking && !(cmd & CMD_NETWORK_COMMAND);
00540 
00541   /* Where to show the message? */
00542   int x = TileX(tile) * TILE_SIZE;
00543   int y = TileY(tile) * TILE_SIZE;
00544 
00545   if (_pause_mode != PM_UNPAUSED && !IsCommandAllowedWhilePaused(cmd)) {
00546     ShowErrorMessage(GB(cmd, 16, 16), STR_ERROR_NOT_ALLOWED_WHILE_PAUSED, WL_INFO, x, y);
00547     return false;
00548   }
00549 
00550 #ifdef ENABLE_NETWORK
00551   /* Only set p2 when the command does not come from the network. */
00552   if (!(cmd & CMD_NETWORK_COMMAND) && GetCommandFlags(cmd) & CMD_CLIENT_ID && p2 == 0) p2 = CLIENT_ID_SERVER;
00553 #endif
00554 
00555   CommandCost res = DoCommandPInternal(tile, p1, p2, cmd, callback, text, my_cmd, estimate_only);
00556   if (res.Failed()) {
00557     /* Only show the error when it's for us. */
00558     StringID error_part1 = GB(cmd, 16, 16);
00559     if (estimate_only || (IsLocalCompany() && error_part1 != 0 && my_cmd)) {
00560       ShowErrorMessage(error_part1, res.GetErrorMessage(), WL_INFO, x, y, res.GetTextRefStackSize(), res.GetTextRefStack());
00561     }
00562   } else if (estimate_only) {
00563     ShowEstimatedCostOrIncome(res.GetCost(), x, y);
00564   } else if (!only_sending && res.GetCost() != 0 && tile != 0 && IsLocalCompany() && _game_mode != GM_EDITOR) {
00565     /* Only show the cost animation when we did actually
00566      * execute the command, i.e. we're not sending it to
00567      * the server, when it has cost the local company
00568      * something. Furthermore in the editor there is no
00569      * concept of cost, so don't show it there either. */
00570     ShowCostOrIncomeAnimation(x, y, GetSlopePixelZ(x, y), res.GetCost());
00571   }
00572 
00573   if (!estimate_only && !only_sending && callback != NULL) {
00574     callback(res, tile, p1, p2);
00575   }
00576 
00577   return res.Succeeded();
00578 }
00579 
00580 
00586 #define return_dcpi(cmd, clear) { _docommand_recursive = 0; ClearStorageChanges(clear); return cmd; }
00587 
00601 CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only)
00602 {
00603   /* Prevent recursion; it gives a mess over the network */
00604   assert(_docommand_recursive == 0);
00605   _docommand_recursive = 1;
00606 
00607   /* Reset the state. */
00608   _additional_cash_required = 0;
00609 
00610   /* Get pointer to command handler */
00611   byte cmd_id = cmd & CMD_ID_MASK;
00612   assert(cmd_id < lengthof(_command_proc_table));
00613 
00614   CommandProc *proc = _command_proc_table[cmd_id].proc;
00615   /* Shouldn't happen, but you never know when someone adds
00616    * NULLs to the _command_proc_table. */
00617   assert(proc != NULL);
00618 
00619   /* Command flags are used internally */
00620   CommandFlags cmd_flags = GetCommandFlags(cmd);
00621   /* Flags get send to the DoCommand */
00622   DoCommandFlag flags = CommandFlagsToDCFlags(cmd_flags);
00623 
00624 #ifdef ENABLE_NETWORK
00625   /* Make sure p2 is properly set to a ClientID. */
00626   assert(!(cmd_flags & CMD_CLIENT_ID) || p2 != 0);
00627 #endif
00628 
00629   /* Do not even think about executing out-of-bounds tile-commands */
00630   if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (cmd_flags & CMD_ALL_TILES) == 0))) return_dcpi(CMD_ERROR, false);
00631 
00632   /* Always execute server and spectator commands as spectator */
00633   bool exec_as_spectator = (cmd_flags & (CMD_SPECTATOR | CMD_SERVER)) != 0;
00634 
00635   /* If the company isn't valid it may only do server command or start a new company!
00636    * The server will ditch any server commands a client sends to it, so effectively
00637    * this guards the server from executing functions for an invalid company. */
00638   if (_game_mode == GM_NORMAL && !exec_as_spectator && !Company::IsValidID(_current_company) && !(_current_company == OWNER_DEITY && (cmd_flags & CMD_DEITY) != 0)) {
00639     return_dcpi(CMD_ERROR, false);
00640   }
00641 
00642   Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
00643   if (exec_as_spectator) cur_company.Change(COMPANY_SPECTATOR);
00644 
00645   bool test_and_exec_can_differ = (cmd_flags & CMD_NO_TEST) != 0;
00646 
00647   /* Test the command. */
00648   _cleared_object_areas.Clear();
00649   SetTownRatingTestMode(true);
00650   ClearStorageChanges(false);
00651   CommandCost res = proc(tile, flags, p1, p2, text);
00652   SetTownRatingTestMode(false);
00653 
00654   /* Make sure we're not messing things up here. */
00655   assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
00656 
00657   /* If the command fails, we're doing an estimate
00658    * or the player does not have enough money
00659    * (unless it's a command where the test and
00660    * execution phase might return different costs)
00661    * we bail out here. */
00662   if (res.Failed() || estimate_only ||
00663       (!test_and_exec_can_differ && !CheckCompanyHasMoney(res))) {
00664     if (!_networking || _generating_world || (cmd & CMD_NETWORK_COMMAND) != 0) {
00665       /* Log the failed command as well. Just to be able to be find
00666        * causes of desyncs due to bad command test implementations. */
00667       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));
00668     }
00669     cur_company.Restore();
00670     return_dcpi(res, false);
00671   }
00672 
00673 #ifdef ENABLE_NETWORK
00674   /*
00675    * If we are in network, and the command is not from the network
00676    * send it to the command-queue and abort execution
00677    */
00678   if (_networking && !_generating_world && !(cmd & CMD_NETWORK_COMMAND)) {
00679     NetworkSendCommand(tile, p1, p2, cmd & ~CMD_FLAGS_MASK, callback, text, _current_company);
00680     cur_company.Restore();
00681 
00682     /* Don't return anything special here; no error, no costs.
00683      * This way it's not handled by DoCommand and only the
00684      * actual execution of the command causes messages. Also
00685      * reset the storages as we've not executed the command. */
00686     return_dcpi(CommandCost(), false);
00687   }
00688 #endif /* ENABLE_NETWORK */
00689   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));
00690 
00691   /* Actually try and execute the command. If no cost-type is given
00692    * use the construction one */
00693   _cleared_object_areas.Clear();
00694   ClearStorageChanges(false);
00695   CommandCost res2 = proc(tile, flags | DC_EXEC, p1, p2, text);
00696 
00697   if (cmd_id == CMD_COMPANY_CTRL) {
00698     cur_company.Trash();
00699     /* We are a new company                  -> Switch to new local company.
00700      * We were closed down                   -> Switch to spectator
00701      * Some other company opened/closed down -> The outside function will switch back */
00702     _current_company = _local_company;
00703   } else {
00704     /* Make sure nothing bad happened, like changing the current company. */
00705     assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
00706     cur_company.Restore();
00707   }
00708 
00709   /* If the test and execution can differ we have to check the
00710    * return of the command. Otherwise we can check whether the
00711    * test and execution have yielded the same result,
00712    * i.e. cost and error state are the same. */
00713   if (!test_and_exec_can_differ) {
00714     assert(res.GetCost() == res2.GetCost() && res.Failed() == res2.Failed()); // sanity check
00715   } else if (res2.Failed()) {
00716     return_dcpi(res2, false);
00717   }
00718 
00719   /* If we're needing more money and we haven't done
00720    * anything yet, ask for the money! */
00721   if (_additional_cash_required != 0 && res2.GetCost() == 0) {
00722     /* It could happen we removed rail, thus gained money, and deleted something else.
00723      * So make sure the signal buffer is empty even in this case */
00724     UpdateSignalsInBuffer();
00725     SetDParam(0, _additional_cash_required);
00726     return_dcpi(CommandCost(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY), false);
00727   }
00728 
00729   /* update last build coordinate of company. */
00730   if (tile != 0) {
00731     Company *c = Company::GetIfValid(_current_company);
00732     if (c != NULL) c->last_build_coordinate = tile;
00733   }
00734 
00735   SubtractMoneyFromCompany(res2);
00736 
00737   /* update signals if needed */
00738   UpdateSignalsInBuffer();
00739 
00740   return_dcpi(res2, true);
00741 }
00742 #undef return_dcpi
00743 
00744 
00750 void CommandCost::AddCost(const CommandCost &ret)
00751 {
00752   this->AddCost(ret.cost);
00753   if (this->success && !ret.success) {
00754     this->message = ret.message;
00755     this->success = false;
00756   }
00757 }
00758 
00764 uint32 CommandCost::textref_stack[16];
00765 
00770 void CommandCost::UseTextRefStack(uint num_registers)
00771 {
00772   extern TemporaryStorageArray<int32, 0x110> _temp_store;
00773 
00774   assert(num_registers < lengthof(textref_stack));
00775   this->textref_stack_size = num_registers;
00776   for (uint i = 0; i < num_registers; i++) {
00777     textref_stack[i] = _temp_store.GetValue(0x100 + i);
00778   }
00779 }