OpenTTD
command.cpp
Go to the documentation of this file.
1 /* $Id$ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "landscape.h"
14 #include "error.h"
15 #include "gui.h"
16 #include "command_func.h"
17 #include "network/network_type.h"
18 #include "network/network.h"
19 #include "genworld.h"
20 #include "strings_func.h"
21 #include "texteff.hpp"
22 #include "town.h"
23 #include "date_func.h"
24 #include "company_func.h"
25 #include "company_base.h"
26 #include "signal_func.h"
27 #include "core/backup_type.hpp"
28 #include "object_base.h"
29 
30 #include "table/strings.h"
31 
32 #include "safeguards.h"
33 
38 
40 
42 
46 
49 
51 
53 CommandProc CmdSellLandArea;
54 
56 
61 
64 
68 
70 
72 
74 
76 
78 
80 
82 
88 
91 
98 
102 
105 
108 
110 
113 
116 
119 
122 
124 
126 
130 
139 
142 
145 
147 
153 
172 
174 
177 
179 
186 
194 
200 
202 
203 #define DEF_CMD(proc, flags, type) {proc, #proc, (CommandFlags)flags, type}
204 
212 static const Command _command_proc_table[] = {
213  DEF_CMD(CmdBuildRailroadTrack, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAILROAD_TRACK
214  DEF_CMD(CmdRemoveRailroadTrack, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_RAILROAD_TRACK
215  DEF_CMD(CmdBuildSingleRail, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SINGLE_RAIL
216  DEF_CMD(CmdRemoveSingleRail, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SINGLE_RAIL
217  DEF_CMD(CmdLandscapeClear, 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_LANDSCAPE_CLEAR
218  DEF_CMD(CmdBuildBridge, CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BRIDGE
219  DEF_CMD(CmdBuildRailStation, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_STATION
220  DEF_CMD(CmdBuildTrainDepot, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TRAIN_DEPOT
221  DEF_CMD(CmdBuildSingleSignal, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNALS
222  DEF_CMD(CmdRemoveSingleSignal, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNALS
223  DEF_CMD(CmdTerraformLand, CMD_ALL_TILES | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_TERRAFORM_LAND
224  DEF_CMD(CmdBuildObject, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_OBJECT
225  DEF_CMD(CmdBuildTunnel, CMD_DEITY | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_TUNNEL
226  DEF_CMD(CmdRemoveFromRailStation, 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_STATION
227  DEF_CMD(CmdConvertRail, 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CONVERT_RAILD
228  DEF_CMD(CmdBuildRailWaypoint, 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_RAIL_WAYPOINT
229  DEF_CMD(CmdRenameWaypoint, 0, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_WAYPOINT
230  DEF_CMD(CmdRemoveFromRailWaypoint, 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_FROM_RAIL_WAYPOINT
231 
232  DEF_CMD(CmdBuildRoadStop, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_STOP
233  DEF_CMD(CmdRemoveRoadStop, 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_ROAD_STOP
234  DEF_CMD(CmdBuildLongRoad,CMD_DEITY | CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LONG_ROAD
235  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.
237  DEF_CMD(CmdBuildRoadDepot, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_ROAD_DEPOT
238 
239  DEF_CMD(CmdBuildAirport, CMD_NO_WATER | CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_AIRPORT
240  DEF_CMD(CmdBuildDock, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_DOCK
241  DEF_CMD(CmdBuildShipDepot, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SHIP_DEPOT
242  DEF_CMD(CmdBuildBuoy, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_BUOY
243  DEF_CMD(CmdPlantTree, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_PLANT_TREE
244 
245  DEF_CMD(CmdBuildVehicle, CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION ), // CMD_BUILD_VEHICLE
246  DEF_CMD(CmdSellVehicle, CMD_CLIENT_ID, CMDT_VEHICLE_CONSTRUCTION ), // CMD_SELL_VEHICLE
247  DEF_CMD(CmdRefitVehicle, 0, CMDT_VEHICLE_CONSTRUCTION ), // CMD_REFIT_VEHICLE
248  DEF_CMD(CmdSendVehicleToDepot, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_SEND_VEHICLE_TO_DEPOT
249  DEF_CMD(CmdSetVehicleVisibility, 0, CMDT_COMPANY_SETTING ), // CMD_SET_VEHICLE_VISIBILITY
250 
251  DEF_CMD(CmdMoveRailVehicle, 0, CMDT_VEHICLE_CONSTRUCTION ), // CMD_MOVE_RAIL_VEHICLE
252  DEF_CMD(CmdForceTrainProceed, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_FORCE_TRAIN_PROCEED
253  DEF_CMD(CmdReverseTrainDirection, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_REVERSE_TRAIN_DIRECTION
254 
255  DEF_CMD(CmdClearOrderBackup, CMD_CLIENT_ID, CMDT_SERVER_SETTING ), // CMD_CLEAR_ORDER_BACKUP
256  DEF_CMD(CmdModifyOrder, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_MODIFY_ORDER
257  DEF_CMD(CmdSkipToOrder, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_SKIP_TO_ORDER
258  DEF_CMD(CmdDeleteOrder, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_DELETE_ORDER
259  DEF_CMD(CmdInsertOrder, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_INSERT_ORDER
260 
261  DEF_CMD(CmdChangeServiceInt, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_CHANGE_SERVICE_INT
262 
263  DEF_CMD(CmdBuildIndustry, CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_INDUSTRY
264  DEF_CMD(CmdIndustryGSEvent, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_INDUSTRY_GS_EVENT
265  DEF_CMD(CmdIndustryAreaGSEvent, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_INDUSTRY_GS_AREA_EVENT
266  DEF_CMD(CmdSetCompanyManagerFace, 0, CMDT_OTHER_MANAGEMENT ), // CMD_SET_COMPANY_MANAGER_FACE
267  DEF_CMD(CmdSetCompanyColour, 0, CMDT_OTHER_MANAGEMENT ), // CMD_SET_COMPANY_COLOUR
268 
269  DEF_CMD(CmdIncreaseLoan, 0, CMDT_MONEY_MANAGEMENT ), // CMD_INCREASE_LOAN
270  DEF_CMD(CmdDecreaseLoan, 0, CMDT_MONEY_MANAGEMENT ), // CMD_DECREASE_LOAN
271 
272  DEF_CMD(CmdWantEnginePreview, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_WANT_ENGINE_PREVIEW
273 
274  DEF_CMD(CmdRenameVehicle, 0, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_VEHICLE
275  DEF_CMD(CmdRenameEngine, CMD_SERVER, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_ENGINE
276 
277  DEF_CMD(CmdRenameCompany, 0, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_COMPANY
278  DEF_CMD(CmdRenamePresident, 0, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_PRESIDENT
279 
280  DEF_CMD(CmdRenameStation, 0, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_STATION
281  DEF_CMD(CmdRenameDepot, 0, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_DEPOT
282 
283  DEF_CMD(CmdPlaceSign, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_PLACE_SIGN
284  DEF_CMD(CmdRenameSign, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_SIGN
285 
286  DEF_CMD(CmdTurnRoadVeh, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_TURN_ROADVEH
287 
288  DEF_CMD(CmdPause, CMD_SERVER, CMDT_SERVER_SETTING ), // CMD_PAUSE
289 
290  DEF_CMD(CmdBuyShareInCompany, 0, CMDT_MONEY_MANAGEMENT ), // CMD_BUY_SHARE_IN_COMPANY
291  DEF_CMD(CmdSellShareInCompany, 0, CMDT_MONEY_MANAGEMENT ), // CMD_SELL_SHARE_IN_COMPANY
292  DEF_CMD(CmdBuyCompany, 0, CMDT_MONEY_MANAGEMENT ), // CMD_BUY_COMANY
293 
294  DEF_CMD(CmdFoundTown, CMD_DEITY | CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_FOUND_TOWN; founding random town can fail only in exec run
295  DEF_CMD(CmdRenameTown, CMD_DEITY | CMD_SERVER, CMDT_OTHER_MANAGEMENT ), // CMD_RENAME_TOWN
296  DEF_CMD(CmdDoTownAction, 0, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DO_TOWN_ACTION
297  DEF_CMD(CmdTownCargoGoal, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_TOWN_CARGO_GOAL
298  DEF_CMD(CmdTownGrowthRate, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_TOWN_GROWTH_RATE
299  DEF_CMD(CmdTownSetText, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_TOWN_SET_TEXT
300  DEF_CMD(CmdExpandTown, CMD_DEITY, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_EXPAND_TOWN
301  DEF_CMD(CmdDeleteTown, CMD_OFFLINE, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_DELETE_TOWN
302 
303  DEF_CMD(CmdOrderRefit, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_ORDER_REFIT
304  DEF_CMD(CmdCloneOrder, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_CLONE_ORDER
305 
306  DEF_CMD(CmdClearArea, CMD_NO_TEST, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_CLEAR_AREA; destroying multi-tile houses makes town rating differ between test and execution
307 
308  DEF_CMD(CmdMoneyCheat, CMD_OFFLINE, CMDT_CHEAT ), // CMD_MONEY_CHEAT
309  DEF_CMD(CmdChangeBankBalance, CMD_DEITY, CMDT_MONEY_MANAGEMENT ), // CMD_CHANGE_BANK_BALANCE
310  DEF_CMD(CmdBuildCanal, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_CANAL
311  DEF_CMD(CmdCreateSubsidy, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_CREATE_SUBSIDY
312  DEF_CMD(CmdCompanyCtrl, CMD_SPECTATOR | CMD_CLIENT_ID, CMDT_SERVER_SETTING ), // CMD_COMPANY_CTRL
313  DEF_CMD(CmdCustomNewsItem, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_CUSTOM_NEWS_ITEM
314  DEF_CMD(CmdCreateGoal, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_CREATE_GOAL
315  DEF_CMD(CmdRemoveGoal, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_REMOVE_GOAL
316  DEF_CMD(CmdSetGoalText, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_SET_GOAL_TEXT
317  DEF_CMD(CmdSetGoalProgress, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_SET_GOAL_PROGRESS
318  DEF_CMD(CmdSetGoalCompleted, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_SET_GOAL_COMPLETED
319  DEF_CMD(CmdGoalQuestion, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_GOAL_QUESTION
320  DEF_CMD(CmdGoalQuestionAnswer, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_GOAL_QUESTION_ANSWER
321  DEF_CMD(CmdCreateStoryPage, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_CREATE_STORY_PAGE
322  DEF_CMD(CmdCreateStoryPageElement, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_CREATE_STORY_PAGE_ELEMENT
323  DEF_CMD(CmdUpdateStoryPageElement, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_UPDATE_STORY_PAGE_ELEMENT
324  DEF_CMD(CmdSetStoryPageTitle, CMD_STR_CTRL | CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_SET_STORY_PAGE_TITLE
325  DEF_CMD(CmdSetStoryPageDate, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_SET_STORY_PAGE_DATE
326  DEF_CMD(CmdShowStoryPage, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_SHOW_STORY_PAGE
327  DEF_CMD(CmdRemoveStoryPage, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_REMOVE_STORY_PAGE
328  DEF_CMD(CmdRemoveStoryPageElement, CMD_DEITY, CMDT_OTHER_MANAGEMENT ), // CMD_REMOVE_STORY_ELEMENT_PAGE
329 
330  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
331 
332  DEF_CMD(CmdBuildLock, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_LOCK
333 
334  DEF_CMD(CmdBuildSignalTrack, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_BUILD_SIGNAL_TRACK
335  DEF_CMD(CmdRemoveSignalTrack, CMD_AUTO, CMDT_LANDSCAPE_CONSTRUCTION), // CMD_REMOVE_SIGNAL_TRACK
336 
337  DEF_CMD(CmdGiveMoney, 0, CMDT_MONEY_MANAGEMENT ), // CMD_GIVE_MONEY
338  DEF_CMD(CmdChangeSetting, CMD_SERVER, CMDT_SERVER_SETTING ), // CMD_CHANGE_SETTING
339  DEF_CMD(CmdChangeCompanySetting, 0, CMDT_COMPANY_SETTING ), // CMD_CHANGE_COMPANY_SETTING
340  DEF_CMD(CmdSetAutoReplace, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_SET_AUTOREPLACE
341  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
342  DEF_CMD(CmdStartStopVehicle, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_START_STOP_VEHICLE
343  DEF_CMD(CmdMassStartStopVehicle, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_MASS_START_STOP
344  DEF_CMD(CmdAutoreplaceVehicle, 0, CMDT_VEHICLE_MANAGEMENT ), // CMD_AUTOREPLACE_VEHICLE
345  DEF_CMD(CmdDepotSellAllVehicles, 0, CMDT_VEHICLE_CONSTRUCTION ), // CMD_DEPOT_SELL_ALL_VEHICLES
346  DEF_CMD(CmdDepotMassAutoReplace, 0, CMDT_VEHICLE_CONSTRUCTION ), // CMD_DEPOT_MASS_AUTOREPLACE
347  DEF_CMD(CmdCreateGroup, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_CREATE_GROUP
348  DEF_CMD(CmdDeleteGroup, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_DELETE_GROUP
349  DEF_CMD(CmdAlterGroup, 0, CMDT_OTHER_MANAGEMENT ), // CMD_ALTER_GROUP
350  DEF_CMD(CmdAddVehicleGroup, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_ADD_VEHICLE_GROUP
351  DEF_CMD(CmdAddSharedVehicleGroup, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_ADD_SHARE_VEHICLE_GROUP
352  DEF_CMD(CmdRemoveAllVehiclesGroup, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_REMOVE_ALL_VEHICLES_GROUP
353  DEF_CMD(CmdSetGroupReplaceProtection, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_SET_GROUP_REPLACE_PROTECTION
354  DEF_CMD(CmdMoveOrder, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_MOVE_ORDER
355  DEF_CMD(CmdChangeTimetable, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_CHANGE_TIMETABLE
356  DEF_CMD(CmdSetVehicleOnTime, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_SET_VEHICLE_ON_TIME
357  DEF_CMD(CmdAutofillTimetable, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_AUTOFILL_TIMETABLE
358  DEF_CMD(CmdSetTimetableStart, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_SET_TIMETABLE_START
359 
360  DEF_CMD(CmdOpenCloseAirport, 0, CMDT_ROUTE_MANAGEMENT ), // CMD_OPEN_CLOSE_AIRPORT
361 };
362 
369 bool IsValidCommand(uint32 cmd)
370 {
371  cmd &= CMD_ID_MASK;
372 
373  return cmd < lengthof(_command_proc_table) && _command_proc_table[cmd].proc != NULL;
374 }
375 
384 {
385  assert(IsValidCommand(cmd));
386 
387  return _command_proc_table[cmd & CMD_ID_MASK].flags;
388 }
389 
397 const char *GetCommandName(uint32 cmd)
398 {
399  assert(IsValidCommand(cmd));
400 
401  return _command_proc_table[cmd & CMD_ID_MASK].name;
402 }
403 
410 {
411  /* Lookup table for the command types that are allowed for a given pause level setting. */
412  static const int command_type_lookup[] = {
422  };
423  assert_compile(lengthof(command_type_lookup) == CMDT_END);
424 
425  assert(IsValidCommand(cmd));
426  return _game_mode == GM_EDITOR || command_type_lookup[_command_proc_table[cmd & CMD_ID_MASK].type] <= _settings_game.construction.command_pause_level;
427 }
428 
429 
430 static int _docommand_recursive = 0;
431 
441 {
442  return DoCommand(container->tile, container->p1, container->p2, flags, container->cmd & CMD_ID_MASK, container->text);
443 }
444 
458 CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text)
459 {
460  CommandCost res;
461 
462  /* Do not even think about executing out-of-bounds tile-commands */
463  if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (flags & DC_ALL_TILES) == 0))) return CMD_ERROR;
464 
465  /* Chop of any CMD_MSG or other flags; we don't need those here */
466  CommandProc *proc = _command_proc_table[cmd & CMD_ID_MASK].proc;
467 
468  _docommand_recursive++;
469 
470  /* only execute the test call if it's toplevel, or we're not execing. */
471  if (_docommand_recursive == 1 || !(flags & DC_EXEC) ) {
472  if (_docommand_recursive == 1) _cleared_object_areas.Clear();
473  SetTownRatingTestMode(true);
474  res = proc(tile, flags & ~DC_EXEC, p1, p2, text);
475  SetTownRatingTestMode(false);
476  if (res.Failed()) {
477  goto error;
478  }
479 
480  if (_docommand_recursive == 1 &&
481  !(flags & DC_QUERY_COST) &&
482  !(flags & DC_BANKRUPT) &&
483  !CheckCompanyHasMoney(res)) { // CheckCompanyHasMoney() modifies 'res' to an error if it fails.
484  goto error;
485  }
486 
487  if (!(flags & DC_EXEC)) {
488  _docommand_recursive--;
489  return res;
490  }
491  }
492 
493  /* Execute the command here. All cost-relevant functions set the expenses type
494  * themselves to the cost object at some point */
495  if (_docommand_recursive == 1) _cleared_object_areas.Clear();
496  res = proc(tile, flags, p1, p2, text);
497  if (res.Failed()) {
498 error:
499  _docommand_recursive--;
500  return res;
501  }
502 
503  /* if toplevel, subtract the money. */
504  if (--_docommand_recursive == 0 && !(flags & DC_BANKRUPT)) {
506  }
507 
508  return res;
509 }
510 
519 {
520  CompanyID company = _current_company;
521  if (!Company::IsValidID(company)) return INT64_MAX;
522  return Company::Get(company)->money;
523 }
524 
531 bool DoCommandP(const CommandContainer *container, bool my_cmd)
532 {
533  return DoCommandP(container->tile, container->p1, container->p2, container->cmd, container->callback, container->text, my_cmd);
534 }
535 
551 bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd)
552 {
553  /* Cost estimation is generally only done when the
554  * local user presses shift while doing somthing.
555  * However, in case of incoming network commands,
556  * map generation or the pause button we do want
557  * to execute. */
558  bool estimate_only = _shift_pressed && IsLocalCompany() &&
560  !(cmd & CMD_NETWORK_COMMAND) &&
561  (cmd & CMD_ID_MASK) != CMD_PAUSE;
562 
563  /* We're only sending the command, so don't do
564  * fancy things for 'success'. */
565  bool only_sending = _networking && !(cmd & CMD_NETWORK_COMMAND);
566 
567  /* Where to show the message? */
568  int x = TileX(tile) * TILE_SIZE;
569  int y = TileY(tile) * TILE_SIZE;
570 
572  ShowErrorMessage(GB(cmd, 16, 16), STR_ERROR_NOT_ALLOWED_WHILE_PAUSED, WL_INFO, x, y);
573  return false;
574  }
575 
576 #ifdef ENABLE_NETWORK
577  /* Only set p2 when the command does not come from the network. */
578  if (!(cmd & CMD_NETWORK_COMMAND) && GetCommandFlags(cmd) & CMD_CLIENT_ID && p2 == 0) p2 = CLIENT_ID_SERVER;
579 #endif
580 
581  CommandCost res = DoCommandPInternal(tile, p1, p2, cmd, callback, text, my_cmd, estimate_only);
582  if (res.Failed()) {
583  /* Only show the error when it's for us. */
584  StringID error_part1 = GB(cmd, 16, 16);
585  if (estimate_only || (IsLocalCompany() && error_part1 != 0 && my_cmd)) {
586  ShowErrorMessage(error_part1, res.GetErrorMessage(), WL_INFO, x, y, res.GetTextRefStackGRF(), res.GetTextRefStackSize(), res.GetTextRefStack());
587  }
588  } else if (estimate_only) {
589  ShowEstimatedCostOrIncome(res.GetCost(), x, y);
590  } else if (!only_sending && res.GetCost() != 0 && tile != 0 && IsLocalCompany() && _game_mode != GM_EDITOR) {
591  /* Only show the cost animation when we did actually
592  * execute the command, i.e. we're not sending it to
593  * the server, when it has cost the local company
594  * something. Furthermore in the editor there is no
595  * concept of cost, so don't show it there either. */
596  ShowCostOrIncomeAnimation(x, y, GetSlopePixelZ(x, y), res.GetCost());
597  }
598 
599  if (!estimate_only && !only_sending && callback != NULL) {
600  callback(res, tile, p1, p2);
601  }
602 
603  return res.Succeeded();
604 }
605 
606 
612 #define return_dcpi(cmd) { _docommand_recursive = 0; return cmd; }
613 
627 CommandCost DoCommandPInternal(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd, bool estimate_only)
628 {
629  /* Prevent recursion; it gives a mess over the network */
630  assert(_docommand_recursive == 0);
631  _docommand_recursive = 1;
632 
633  /* Reset the state. */
634  _additional_cash_required = 0;
635 
636  /* Get pointer to command handler */
637  byte cmd_id = cmd & CMD_ID_MASK;
638  assert(cmd_id < lengthof(_command_proc_table));
639 
640  CommandProc *proc = _command_proc_table[cmd_id].proc;
641  /* Shouldn't happen, but you never know when someone adds
642  * NULLs to the _command_proc_table. */
643  assert(proc != NULL);
644 
645  /* Command flags are used internally */
646  CommandFlags cmd_flags = GetCommandFlags(cmd);
647  /* Flags get send to the DoCommand */
648  DoCommandFlag flags = CommandFlagsToDCFlags(cmd_flags);
649 
650 #ifdef ENABLE_NETWORK
651  /* Make sure p2 is properly set to a ClientID. */
652  assert(!(cmd_flags & CMD_CLIENT_ID) || p2 != 0);
653 #endif
654 
655  /* Do not even think about executing out-of-bounds tile-commands */
656  if (tile != 0 && (tile >= MapSize() || (!IsValidTile(tile) && (cmd_flags & CMD_ALL_TILES) == 0))) return_dcpi(CMD_ERROR);
657 
658  /* Always execute server and spectator commands as spectator */
659  bool exec_as_spectator = (cmd_flags & (CMD_SPECTATOR | CMD_SERVER)) != 0;
660 
661  /* If the company isn't valid it may only do server command or start a new company!
662  * The server will ditch any server commands a client sends to it, so effectively
663  * this guards the server from executing functions for an invalid company. */
664  if (_game_mode == GM_NORMAL && !exec_as_spectator && !Company::IsValidID(_current_company) && !(_current_company == OWNER_DEITY && (cmd_flags & CMD_DEITY) != 0)) {
666  }
667 
668  Backup<CompanyByte> cur_company(_current_company, FILE_LINE);
669  if (exec_as_spectator) cur_company.Change(COMPANY_SPECTATOR);
670 
671  bool test_and_exec_can_differ = (cmd_flags & CMD_NO_TEST) != 0;
672 
673  /* Test the command. */
674  _cleared_object_areas.Clear();
675  SetTownRatingTestMode(true);
677  CommandCost res = proc(tile, flags, p1, p2, text);
679  SetTownRatingTestMode(false);
680 
681  /* Make sure we're not messing things up here. */
682  assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
683 
684  /* If the command fails, we're doing an estimate
685  * or the player does not have enough money
686  * (unless it's a command where the test and
687  * execution phase might return different costs)
688  * we bail out here. */
689  if (res.Failed() || estimate_only ||
690  (!test_and_exec_can_differ && !CheckCompanyHasMoney(res))) {
691  if (!_networking || _generating_world || (cmd & CMD_NETWORK_COMMAND) != 0) {
692  /* Log the failed command as well. Just to be able to be find
693  * causes of desyncs due to bad command test implementations. */
694  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));
695  }
696  cur_company.Restore();
697  return_dcpi(res);
698  }
699 
700 #ifdef ENABLE_NETWORK
701  /*
702  * If we are in network, and the command is not from the network
703  * send it to the command-queue and abort execution
704  */
705  if (_networking && !_generating_world && !(cmd & CMD_NETWORK_COMMAND)) {
706  NetworkSendCommand(tile, p1, p2, cmd & ~CMD_FLAGS_MASK, callback, text, _current_company);
707  cur_company.Restore();
708 
709  /* Don't return anything special here; no error, no costs.
710  * This way it's not handled by DoCommand and only the
711  * actual execution of the command causes messages. Also
712  * reset the storages as we've not executed the command. */
714  }
715 #endif /* ENABLE_NETWORK */
716  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));
717 
718  /* Actually try and execute the command. If no cost-type is given
719  * use the construction one */
720  _cleared_object_areas.Clear();
722  CommandCost res2 = proc(tile, flags | DC_EXEC, p1, p2, text);
724 
725  if (cmd_id == CMD_COMPANY_CTRL) {
726  cur_company.Trash();
727  /* We are a new company -> Switch to new local company.
728  * We were closed down -> Switch to spectator
729  * Some other company opened/closed down -> The outside function will switch back */
730  _current_company = _local_company;
731  } else {
732  /* Make sure nothing bad happened, like changing the current company. */
733  assert(exec_as_spectator ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
734  cur_company.Restore();
735  }
736 
737  /* If the test and execution can differ we have to check the
738  * return of the command. Otherwise we can check whether the
739  * test and execution have yielded the same result,
740  * i.e. cost and error state are the same. */
741  if (!test_and_exec_can_differ) {
742  assert(res.GetCost() == res2.GetCost() && res.Failed() == res2.Failed()); // sanity check
743  } else if (res2.Failed()) {
744  return_dcpi(res2);
745  }
746 
747  /* If we're needing more money and we haven't done
748  * anything yet, ask for the money! */
749  if (_additional_cash_required != 0 && res2.GetCost() == 0) {
750  /* It could happen we removed rail, thus gained money, and deleted something else.
751  * So make sure the signal buffer is empty even in this case */
753  SetDParam(0, _additional_cash_required);
754  return_dcpi(CommandCost(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY));
755  }
756 
757  /* update last build coordinate of company. */
758  if (tile != 0) {
759  Company *c = Company::GetIfValid(_current_company);
760  if (c != NULL) c->last_build_coordinate = tile;
761  }
762 
764 
765  /* update signals if needed */
767 
768  return_dcpi(res2);
769 }
770 #undef return_dcpi
771 
772 
779 {
780  this->AddCost(ret.cost);
781  if (this->success && !ret.success) {
782  this->message = ret.message;
783  this->success = false;
784  }
785 }
786 
792 uint32 CommandCost::textref_stack[16];
793 
799 void CommandCost::UseTextRefStack(const GRFFile *grffile, uint num_registers)
800 {
801  extern TemporaryStorageArray<int32, 0x110> _temp_store;
802 
803  assert(num_registers < lengthof(textref_stack));
804  this->textref_stack_grffile = grffile;
805  this->textref_stack_size = num_registers;
806  for (uint i = 0; i < num_registers; i++) {
807  textref_stack[i] = _temp_store.GetValue(0x100 + i);
808  }
809 }