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 CmdGoalQuestion;
00154 CommandProc CmdGoalQuestionAnswer;
00155 
00156 CommandProc CmdLevelLand;
00157 
00158 CommandProc CmdBuildSignalTrack;
00159 CommandProc CmdRemoveSignalTrack;
00160 
00161 CommandProc CmdSetAutoReplace;
00162 
00163 CommandProc CmdCloneVehicle;
00164 CommandProc CmdStartStopVehicle;
00165 CommandProc CmdMassStartStopVehicle;
00166 CommandProc CmdAutoreplaceVehicle;
00167 CommandProc CmdDepotSellAllVehicles;
00168 CommandProc CmdDepotMassAutoReplace;
00169 
00170 CommandProc CmdCreateGroup;
00171 CommandProc CmdRenameGroup;
00172 CommandProc CmdDeleteGroup;
00173 CommandProc CmdAddVehicleGroup;
00174 CommandProc CmdAddSharedVehicleGroup;
00175 CommandProc CmdRemoveAllVehiclesGroup;
00176 CommandProc CmdSetGroupReplaceProtection;
00177 
00178 CommandProc CmdMoveOrder;
00179 CommandProc CmdChangeTimetable;
00180 CommandProc CmdSetVehicleOnTime;
00181 CommandProc CmdAutofillTimetable;
00182 CommandProc CmdSetTimetableStart;
00183 
00184 CommandProc CmdOpenCloseAirport;
00185 
00186 #define DEF_CMD(proc, flags, type) {proc, #proc, (CommandFlags)flags, type}
00187 
00195 static const Command _command_proc_table[] = {
00196   DEF_CMD(CmdBuildRailroadTrack,       CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAILROAD_TRACK
00197   DEF_CMD(CmdRemoveRailroadTrack,                     CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_RAILROAD_TRACK
00198   DEF_CMD(CmdBuildSingleRail,          CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SINGLE_RAIL
00199   DEF_CMD(CmdRemoveSingleRail,                        CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SINGLE_RAIL
00200   DEF_CMD(CmdLandscapeClear,                                 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_LANDSCAPE_CLEAR
00201   DEF_CMD(CmdBuildBridge,  CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BRIDGE
00202   DEF_CMD(CmdBuildRailStation,         CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_STATION
00203   DEF_CMD(CmdBuildTrainDepot,          CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TRAIN_DEPOT
00204   DEF_CMD(CmdBuildSingleSignal,                       CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNALS
00205   DEF_CMD(CmdRemoveSingleSignal,                      CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNALS
00206   DEF_CMD(CmdTerraformLand,           CMD_ALL_TILES | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_TERRAFORM_LAND
00207   DEF_CMD(CmdBuildObject,              CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_OBJECT
00208   DEF_CMD(CmdBuildTunnel,                 CMD_DEITY | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TUNNEL
00209   DEF_CMD(CmdRemoveFromRailStation,                          0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_STATION
00210   DEF_CMD(CmdConvertRail,                                    0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CONVERT_RAILD
00211   DEF_CMD(CmdBuildRailWaypoint,                              0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_WAYPOINT
00212   DEF_CMD(CmdRenameWaypoint,                      CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_WAYPOINT
00213   DEF_CMD(CmdRemoveFromRailWaypoint,                         0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_WAYPOINT
00214 
00215   DEF_CMD(CmdBuildRoadStop,            CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_STOP
00216   DEF_CMD(CmdRemoveRoadStop,                                 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_ROAD_STOP
00217   DEF_CMD(CmdBuildLongRoad,CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LONG_ROAD
00218   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.
00219   DEF_CMD(CmdBuildRoad,    CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD
00220   DEF_CMD(CmdBuildRoadDepot,           CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_DEPOT
00221 
00222   DEF_CMD(CmdBuildAirport,             CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_AIRPORT
00223   DEF_CMD(CmdBuildDock,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_DOCK
00224   DEF_CMD(CmdBuildShipDepot,                          CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SHIP_DEPOT
00225   DEF_CMD(CmdBuildBuoy,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BUOY
00226   DEF_CMD(CmdPlantTree,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_PLANT_TREE
00227 
00228   DEF_CMD(CmdBuildVehicle,                       CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_BUILD_VEHICLE
00229   DEF_CMD(CmdSellVehicle,                        CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_SELL_VEHICLE
00230   DEF_CMD(CmdRefitVehicle,                                   0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_REFIT_VEHICLE
00231   DEF_CMD(CmdSendVehicleToDepot,                             0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_SEND_VEHICLE_TO_DEPOT
00232 
00233   DEF_CMD(CmdMoveRailVehicle,                                0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_MOVE_RAIL_VEHICLE
00234   DEF_CMD(CmdForceTrainProceed,                              0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_FORCE_TRAIN_PROCEED
00235   DEF_CMD(CmdReverseTrainDirection,                          0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_REVERSE_TRAIN_DIRECTION
00236 
00237   DEF_CMD(CmdClearOrderBackup,                   CMD_CLIENT_ID, CMDT_ROUTE_MANAGEMENT      ), // CMD_CLEAR_ORDER_BACKUP
00238   DEF_CMD(CmdModifyOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_MODIFY_ORDER
00239   DEF_CMD(CmdSkipToOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SKIP_TO_ORDER
00240   DEF_CMD(CmdDeleteOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_DELETE_ORDER
00241   DEF_CMD(CmdInsertOrder,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_INSERT_ORDER
00242 
00243   DEF_CMD(CmdChangeServiceInt,                               0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_CHANGE_SERVICE_INT
00244 
00245   DEF_CMD(CmdBuildIndustry,                          CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_INDUSTRY
00246   DEF_CMD(CmdSetCompanyManagerFace,                          0, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_COMPANY_MANAGER_FACE
00247   DEF_CMD(CmdSetCompanyColour,                               0, CMDT_OTHER_MANAGEMENT      ), // CMD_SET_COMPANY_COLOUR
00248 
00249   DEF_CMD(CmdIncreaseLoan,                                   0, CMDT_MONEY_MANAGEMENT      ), // CMD_INCREASE_LOAN
00250   DEF_CMD(CmdDecreaseLoan,                                   0, CMDT_MONEY_MANAGEMENT      ), // CMD_DECREASE_LOAN
00251 
00252   DEF_CMD(CmdWantEnginePreview,                              0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_WANT_ENGINE_PREVIEW
00253 
00254   DEF_CMD(CmdRenameVehicle,                       CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_VEHICLE
00255   DEF_CMD(CmdRenameEngine,                        CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_ENGINE
00256 
00257   DEF_CMD(CmdRenameCompany,                       CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_COMPANY
00258   DEF_CMD(CmdRenamePresident,                     CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_PRESIDENT
00259 
00260   DEF_CMD(CmdRenameStation,                       CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_STATION
00261   DEF_CMD(CmdRenameDepot,                         CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_DEPOT
00262 
00263   DEF_CMD(CmdPlaceSign,               CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_PLACE_SIGN
00264   DEF_CMD(CmdRenameSign,              CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_SIGN
00265 
00266   DEF_CMD(CmdTurnRoadVeh,                                    0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_TURN_ROADVEH
00267 
00268   DEF_CMD(CmdPause,                                 CMD_SERVER, CMDT_SERVER_SETTING        ), // CMD_PAUSE
00269 
00270   DEF_CMD(CmdBuyShareInCompany,                              0, CMDT_MONEY_MANAGEMENT      ), // CMD_BUY_SHARE_IN_COMPANY
00271   DEF_CMD(CmdSellShareInCompany,                             0, CMDT_MONEY_MANAGEMENT      ), // CMD_SELL_SHARE_IN_COMPANY
00272   DEF_CMD(CmdBuyCompany,                                     0, CMDT_MONEY_MANAGEMENT      ), // CMD_BUY_COMANY
00273 
00274   DEF_CMD(CmdFoundTown,                            CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_FOUND_TOWN; founding random town can fail only in exec run
00275   DEF_CMD(CmdRenameTown,             CMD_STR_CTRL | CMD_SERVER, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_TOWN
00276   DEF_CMD(CmdDoTownAction,                                   0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DO_TOWN_ACTION
00277   DEF_CMD(CmdTownCargoGoal,                          CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_CARGO_GOAL
00278   DEF_CMD(CmdTownGrowthRate,                         CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_GROWTH_RATE
00279   DEF_CMD(CmdTownSetText,             CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_TOWN_SET_TEXT
00280   DEF_CMD(CmdExpandTown,                             CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_EXPAND_TOWN
00281   DEF_CMD(CmdDeleteTown,                           CMD_OFFLINE, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DELETE_TOWN
00282 
00283   DEF_CMD(CmdOrderRefit,                                     0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ORDER_REFIT
00284   DEF_CMD(CmdCloneOrder,                                     0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CLONE_ORDER
00285 
00286   DEF_CMD(CmdClearArea,                            CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CLEAR_AREA; destroying multi-tile houses makes town rating differ between test and execution
00287 
00288   DEF_CMD(CmdMoneyCheat,                           CMD_OFFLINE, CMDT_CHEAT                 ), // CMD_MONEY_CHEAT
00289   DEF_CMD(CmdBuildCanal,                              CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_CANAL
00290   DEF_CMD(CmdCreateSubsidy,                          CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_SUBSIDY
00291   DEF_CMD(CmdCompanyCtrl,        CMD_SPECTATOR | CMD_CLIENT_ID, CMDT_SERVER_SETTING        ), // CMD_COMPANY_CTRL
00292   DEF_CMD(CmdCustomNewsItem,          CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CUSTOM_NEWS_ITEM
00293   DEF_CMD(CmdCreateGoal,              CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_CREATE_GOAL
00294   DEF_CMD(CmdRemoveGoal,                             CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_REMOVE_GOAL
00295   DEF_CMD(CmdGoalQuestion,            CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_GOAL_QUESTION
00296   DEF_CMD(CmdGoalQuestionAnswer,                     CMD_DEITY, CMDT_OTHER_MANAGEMENT      ), // CMD_GOAL_QUESTION_ANSWER
00297 
00298   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
00299 
00300   DEF_CMD(CmdBuildLock,                               CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LOCK
00301 
00302   DEF_CMD(CmdBuildSignalTrack,                        CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNAL_TRACK
00303   DEF_CMD(CmdRemoveSignalTrack,                       CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNAL_TRACK
00304 
00305   DEF_CMD(CmdGiveMoney,                                      0, CMDT_MONEY_MANAGEMENT      ), // CMD_GIVE_MONEY
00306   DEF_CMD(CmdChangeSetting,                         CMD_SERVER, CMDT_SERVER_SETTING        ), // CMD_CHANGE_SETTING
00307   DEF_CMD(CmdChangeCompanySetting,                           0, CMDT_COMPANY_SETTING       ), // CMD_CHANGE_COMPANY_SETTING
00308   DEF_CMD(CmdSetAutoReplace,                                 0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_SET_AUTOREPLACE
00309   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
00310   DEF_CMD(CmdStartStopVehicle,                               0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_START_STOP_VEHICLE
00311   DEF_CMD(CmdMassStartStopVehicle,                           0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_MASS_START_STOP
00312   DEF_CMD(CmdAutoreplaceVehicle,                             0, CMDT_VEHICLE_MANAGEMENT    ), // CMD_AUTOREPLACE_VEHICLE
00313   DEF_CMD(CmdDepotSellAllVehicles,                           0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_DEPOT_SELL_ALL_VEHICLES
00314   DEF_CMD(CmdDepotMassAutoReplace,                           0, CMDT_VEHICLE_CONSTRUCTION  ), // CMD_DEPOT_MASS_AUTOREPLACE
00315   DEF_CMD(CmdCreateGroup,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CREATE_GROUP
00316   DEF_CMD(CmdDeleteGroup,                                    0, CMDT_ROUTE_MANAGEMENT      ), // CMD_DELETE_GROUP
00317   DEF_CMD(CmdRenameGroup,                         CMD_STR_CTRL, CMDT_OTHER_MANAGEMENT      ), // CMD_RENAME_GROUP
00318   DEF_CMD(CmdAddVehicleGroup,                                0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ADD_VEHICLE_GROUP
00319   DEF_CMD(CmdAddSharedVehicleGroup,                          0, CMDT_ROUTE_MANAGEMENT      ), // CMD_ADD_SHARE_VEHICLE_GROUP
00320   DEF_CMD(CmdRemoveAllVehiclesGroup,                         0, CMDT_ROUTE_MANAGEMENT      ), // CMD_REMOVE_ALL_VEHICLES_GROUP
00321   DEF_CMD(CmdSetGroupReplaceProtection,                      0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_GROUP_REPLACE_PROTECTION
00322   DEF_CMD(CmdMoveOrder,                                      0, CMDT_ROUTE_MANAGEMENT      ), // CMD_MOVE_ORDER
00323   DEF_CMD(CmdChangeTimetable,                                0, CMDT_ROUTE_MANAGEMENT      ), // CMD_CHANGE_TIMETABLE
00324   DEF_CMD(CmdSetVehicleOnTime,                               0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_VEHICLE_ON_TIME
00325   DEF_CMD(CmdAutofillTimetable,                              0, CMDT_ROUTE_MANAGEMENT      ), // CMD_AUTOFILL_TIMETABLE
00326   DEF_CMD(CmdSetTimetableStart,                              0, CMDT_ROUTE_MANAGEMENT      ), // CMD_SET_TIMETABLE_START
00327 
00328   DEF_CMD(CmdOpenCloseAirport,                               0, CMDT_ROUTE_MANAGEMENT      ), // CMD_OPEN_CLOSE_AIRPORT
00329 };
00330 
00337 bool IsValidCommand(uint32 cmd)
00338 {
00339   cmd &= CMD_ID_MASK;
00340 
00341   return cmd < lengthof(_command_proc_table) && _command_proc_table[cmd].proc != NULL;
00342 }
00343 
00351 CommandFlags GetCommandFlags(uint32 cmd)
00352 {
00353   assert(IsValidCommand(cmd));
00354 
00355   return _command_proc_table[cmd & CMD_ID_MASK].flags;
00356 }
00357 
00365 const char *GetCommandName(uint32 cmd)
00366 {
00367   assert(IsValidCommand(cmd));
00368 
00369   return _command_proc_table[cmd & CMD_ID_MASK].name;
00370 }
00371 
00377 bool IsCommandAllowedWhilePaused(uint32 cmd)
00378 {
00379   /* Lookup table for the command types that are allowed for a given pause level setting. */
00380   static const int command_type_lookup[] = {
00381     CMDPL_ALL_ACTIONS,     
00382     CMDPL_NO_LANDSCAPING,  
00383     CMDPL_NO_LANDSCAPING,  
00384     CMDPL_NO_CONSTRUCTION, 
00385     CMDPL_NO_CONSTRUCTION, 
00386     CMDPL_NO_CONSTRUCTION, 
00387     CMDPL_NO_CONSTRUCTION, 
00388     CMDPL_NO_ACTIONS,      
00389     CMDPL_NO_ACTIONS,      
00390   };
00391   assert_compile(lengthof(command_type_lookup) == CMDT_END);
00392 
00393   assert(IsValidCommand(cmd));
00394   return _game_mode == GM_EDITOR || command_type_lookup[_command_proc_table[cmd & CMD_ID_MASK].type] <= _settings_game.construction.command_pause_level;
00395 }
00396 
00397 
00398 static int _docommand_recursive = 0;
00399 
00408 CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
00409 {
00410   return DoCommand(container->tile, container->p1, container->p2, flags, container->cmd & CMD_ID_MASK, container->text);
00411 }
00412 
00426 CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text)
00427 {
00428   CommandCost res;
00429 
00430   /* Do not even think about executing out-of-bounds tile-commands */
00431   if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (flags & DC_ALL_TILES) == 0))) return CMD_ERROR;
00432 
00433   /* Chop of any CMD_MSG or other flags; we don't need those here */
00434   CommandProc *proc = _command_proc_table[cmd & CMD_ID_MASK].proc;
00435 
00436   _docommand_recursive++;
00437 
00438   /* only execute the test call if it's toplevel, or we're not execing. */
00439   if (_docommand_recursive == 1 || !(flags & DC_EXEC) ) {
00440     if (_docommand_recursive == 1) _cleared_object_areas.Clear();
00441     SetTownRatingTestMode(true);
00442     res = proc(tile, flags & ~DC_EXEC, p1, p2, text);
00443     SetTownRatingTestMode(false);
00444     if (res.Failed()) {
00445       goto error;
00446     }
00447 
00448     if (_docommand_recursive == 1 &&
00449         !(flags & DC_QUERY_COST) &&
00450         !(flags & DC_BANKRUPT) &&
00451         !CheckCompanyHasMoney(res)) { // CheckCompanyHasMoney() modifies 'res' to an error if it fails.
00452       goto error;
00453     }
00454 
00455     if (!(flags & DC_EXEC)) {
00456       _docommand_recursive--;
00457       return res;
00458     }
00459   }
00460 
00461   /* Execute the command here. All cost-relevant functions set the expenses type
00462    * themselves to the cost object at some point */
00463   if (_docommand_recursive == 1) _cleared_object_areas.Clear();
00464   res = proc(tile, flags, p1, p2, text);
00465   if (res.Failed()) {
00466 error:
00467     _docommand_recursive--;
00468     return res;
00469   }
00470 
00471   /* if toplevel, subtract the money. */
00472   if (--_docommand_recursive == 0 && !(flags & DC_BANKRUPT)) {
00473     SubtractMoneyFromCompany(res);
00474   }
00475 
00476   return res;
00477 }
00478 
00486 Money GetAvailableMoneyForCommand()
00487 {
00488   CompanyID company = _current_company;
00489   if (!Company::IsValidID(company)) return INT64_MAX;
00490   return Company::Get(company)->money;
00491 }
00492 
00499 bool DoCommandP(const CommandContainer *container, bool my_cmd)
00500 {
00501   return DoCommandP(container->tile, container->p1, container->p2, container->cmd, container->callback, container->text, my_cmd);
00502 }
00503 
00519 bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd)
00520 {
00521   /* Cost estimation is generally only done when the
00522    * local user presses shift while doing somthing.
00523    * However, in case of incoming network commands,
00524    * map generation or the pause button we do want
00525    * to execute. */
00526   bool estimate_only = _shift_pressed && IsLocalCompany() &&
00527       !_generating_world &&
00528       !(cmd & CMD_NETWORK_COMMAND) &&
00529       (cmd & CMD_ID_MASK) != CMD_PAUSE;
00530 
00531   /* We're only sending the command, so don't do
00532    * fancy things for 'success'. */
00533   bool only_sending = _networking && !(cmd & CMD_NETWORK_COMMAND);
00534 
00535   /* Where to show the message? */
00536   int x = TileX(tile) * TILE_SIZE;
00537   int y = TileY(tile) * TILE_SIZE;
00538 
00539   if (_pause_mode != PM_UNPAUSED && !IsCommandAllowedWhilePaused(cmd)) {
00540     ShowErrorMessage(GB(cmd, 16, 16), STR_ERROR_NOT_ALLOWED_WHILE_PAUSED, WL_INFO, x, y);
00541     return false;
00542   }
00543 
00544 #ifdef ENABLE_NETWORK
00545   /* Only set p2 when the command does not come from the network. */
00546   if (!(cmd & CMD_NETWORK_COMMAND) && GetCommandFlags(cmd) & CMD_CLIENT_ID && p2 == 0) p2 = CLIENT_ID_SERVER;
00547 #endif
00548 
00549   CommandCost res = DoCommandPInternal(tile, p1, p2, cmd, callback, text, my_cmd, estimate_only);
00550   if (res.Failed()) {
00551     /* Only show the error when it's for us. */
00552     StringID error_part1 = GB(cmd, 16, 16);
00553     if (estimate_only || (IsLocalCompany() && error_part1 != 0 && my_cmd)) {
00554       ShowErrorMessage(error_part1, res.GetErrorMessage(), WL_INFO, x, y, res.GetTextRefStackSize(), res.GetTextRefStack());
00555     }
00556   } else if (estimate_only) {
00557     ShowEstimatedCostOrIncome(res.GetCost(), x, y);
00558   } else if (!only_sending && res.GetCost() != 0 && tile != 0 && IsLocalCompany() && _game_mode != GM_EDITOR) {
00559     /* Only show the cost animation when we did actually
00560      * execute the command, i.e. we're not sending it to
00561      * the server, when it has cost the local company
00562      * something. Furthermore in the editor there is no
00563      * concept of cost, so don't show it there either. */
00564     ShowCostOrIncomeAnimation(x, y, GetSlopePixelZ(x, y), res.GetCost());
00565   }
00566 
00567   if (!estimate_only && !only_sending && callback != NULL) {
00568     callback(res, tile, p1, p2);
00569   }
00570 
00571   return res.Succeeded();
00572 }
00573 
00574 
00580 #define return_dcpi(cmd, clear) { _docommand_recursive = 0; ClearStorageChanges(clear); return cmd; }
00581 
00595 CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only)
00596 {
00597   /* Prevent recursion; it gives a mess over the network */
00598   assert(_docommand_recursive == 0);
00599   _docommand_recursive = 1;
00600 
00601   /* Reset the state. */
00602   _additional_cash_required = 0;
00603 
00604   /* Get pointer to command handler */
00605   byte cmd_id = cmd & CMD_ID_MASK;
00606   assert(cmd_id < lengthof(_command_proc_table));
00607 
00608   CommandProc *proc = _command_proc_table[cmd_id].proc;
00609   /* Shouldn't happen, but you never know when someone adds
00610    * NULLs to the _command_proc_table. */
00611   assert(proc != NULL);
00612 
00613   /* Command flags are used internally */
00614   CommandFlags cmd_flags = GetCommandFlags(cmd);
00615   /* Flags get send to the DoCommand */
00616   DoCommandFlag flags = CommandFlagsToDCFlags(cmd_flags);
00617 
00618 #ifdef ENABLE_NETWORK
00619   /* Make sure p2 is properly set to a ClientID. */
00620   assert(!(cmd_flags & CMD_CLIENT_ID) || p2 != 0);
00621 #endif
00622 
00623   /* Do not even think about executing out-of-bounds tile-commands */
00624   if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (cmd_flags & CMD_ALL_TILES) == 0))) return_dcpi(CMD_ERROR, false);
00625 
00626   /* Always execute server and spectator commands as spectator */
00627   bool exec_as_spectator = (cmd_flags & (CMD_SPECTATOR | CMD_SERVER)) != 0;
00628 
00629   /* If the company isn't valid it may only do server command or start a new company!
00630    * The server will ditch any server commands a client sends to it, so effectively
00631    * this guards the server from executing functions for an invalid company. */
00632   if (_game_mode == GM_NORMAL && !exec_as_spectator && !Company::IsValidID(_current_company) && !(_current_company == OWNER_DEITY && (cmd_flags & CMD_DEITY) != 0)) {
00633     return_dcpi(CMD_ERROR, false);
00634   }
00635 
00636   Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
00637   if (exec_as_spectator) cur_company.Change(COMPANY_SPECTATOR);
00638 
00639   bool test_and_exec_can_differ = (cmd_flags & CMD_NO_TEST) != 0;
00640 
00641   /* Test the command. */
00642   _cleared_object_areas.Clear();
00643   SetTownRatingTestMode(true);
00644   ClearStorageChanges(false);
00645   CommandCost res = proc(tile, flags, p1, p2, text);
00646   SetTownRatingTestMode(false);
00647 
00648   /* Make sure we're not messing things up here. */
00649   assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
00650 
00651   /* If the command fails, we're doing an estimate
00652    * or the player does not have enough money
00653    * (unless it's a command where the test and
00654    * execution phase might return different costs)
00655    * we bail out here. */
00656   if (res.Failed() || estimate_only ||
00657       (!test_and_exec_can_differ && !CheckCompanyHasMoney(res))) {
00658     if (!_networking || _generating_world || (cmd & CMD_NETWORK_COMMAND) != 0) {
00659       /* Log the failed command as well. Just to be able to be find
00660        * causes of desyncs due to bad command test implementations. */
00661       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));
00662     }
00663     cur_company.Restore();
00664     return_dcpi(res, false);
00665   }
00666 
00667 #ifdef ENABLE_NETWORK
00668   /*
00669    * If we are in network, and the command is not from the network
00670    * send it to the command-queue and abort execution
00671    */
00672   if (_networking && !_generating_world && !(cmd & CMD_NETWORK_COMMAND)) {
00673     NetworkSendCommand(tile, p1, p2, cmd & ~CMD_FLAGS_MASK, callback, text, _current_company);
00674     cur_company.Restore();
00675 
00676     /* Don't return anything special here; no error, no costs.
00677      * This way it's not handled by DoCommand and only the
00678      * actual execution of the command causes messages. Also
00679      * reset the storages as we've not executed the command. */
00680     return_dcpi(CommandCost(), false);
00681   }
00682 #endif /* ENABLE_NETWORK */
00683   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));
00684 
00685   /* Actually try and execute the command. If no cost-type is given
00686    * use the construction one */
00687   _cleared_object_areas.Clear();
00688   ClearStorageChanges(false);
00689   CommandCost res2 = proc(tile, flags | DC_EXEC, p1, p2, text);
00690 
00691   if (cmd_id == CMD_COMPANY_CTRL) {
00692     cur_company.Trash();
00693     /* We are a new company                  -> Switch to new local company.
00694      * We were closed down                   -> Switch to spectator
00695      * Some other company opened/closed down -> The outside function will switch back */
00696     _current_company = _local_company;
00697   } else {
00698     /* Make sure nothing bad happened, like changing the current company. */
00699     assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
00700     cur_company.Restore();
00701   }
00702 
00703   /* If the test and execution can differ we have to check the
00704    * return of the command. Otherwise we can check whether the
00705    * test and execution have yielded the same result,
00706    * i.e. cost and error state are the same. */
00707   if (!test_and_exec_can_differ) {
00708     assert(res.GetCost() == res2.GetCost() && res.Failed() == res2.Failed()); // sanity check
00709   } else if (res2.Failed()) {
00710     return_dcpi(res2, false);
00711   }
00712 
00713   /* If we're needing more money and we haven't done
00714    * anything yet, ask for the money! */
00715   if (_additional_cash_required != 0 && res2.GetCost() == 0) {
00716     /* It could happen we removed rail, thus gained money, and deleted something else.
00717      * So make sure the signal buffer is empty even in this case */
00718     UpdateSignalsInBuffer();
00719     SetDParam(0, _additional_cash_required);
00720     return_dcpi(CommandCost(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY), false);
00721   }
00722 
00723   /* update last build coordinate of company. */
00724   if (tile != 0) {
00725     Company *c = Company::GetIfValid(_current_company);
00726     if (c != NULL) c->last_build_coordinate = tile;
00727   }
00728 
00729   SubtractMoneyFromCompany(res2);
00730 
00731   /* update signals if needed */
00732   UpdateSignalsInBuffer();
00733 
00734   return_dcpi(res2, true);
00735 }
00736 #undef return_dcpi
00737 
00738 
00744 void CommandCost::AddCost(const CommandCost &ret)
00745 {
00746   this->AddCost(ret.cost);
00747   if (this->success && !ret.success) {
00748     this->message = ret.message;
00749     this->success = false;
00750   }
00751 }
00752 
00758 uint32 CommandCost::textref_stack[16];
00759 
00764 void CommandCost::UseTextRefStack(uint num_registers)
00765 {
00766   extern TemporaryStorageArray<int32, 0x110> _temp_store;
00767 
00768   assert(num_registers < lengthof(textref_stack));
00769   this->textref_stack_size = num_registers;
00770   for (uint i = 0; i < num_registers; i++) {
00771     textref_stack[i] = _temp_store.GetValue(0x100 + i);
00772   }
00773 }