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