src/command_type.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file command_type.h Types related to commands. */
  11
  12 #ifndef COMMAND_TYPE_H
  13 #define COMMAND_TYPE_H
  14
  15 #include "economy_type.h"
  16 #include "strings_type.h"
  17 #include "tile_type.h"
  18
  19 struct GRFFile;
  20
  21 /**
  22  * Common return value for all commands. Wraps the cost and
  23  * a possible error message/state together.
  24  */
  25 class CommandCost {
  26         ExpensesType expense_type; ///< the type of expence as shown on the finances view
  27         Money cost;       ///< The cost of this action
  28         StringID message; ///< Warning message for when success is unset
  29         bool success;     ///< Whether the comment went fine up to this moment
  30         const GRFFile *textref_stack_grffile; ///< NewGRF providing the #TextRefStack content.
  31         uint textref_stack_size;   ///< Number of uint32 values to put on the #TextRefStack for the error message.
  32
  33         static uint32 textref_stack[16];
  34
  35 public:
  36         /**
  37          * Creates a command cost return with no cost and no error
  38          */
  39         CommandCost() : expense_type(INVALID_EXPENSES), cost(0), message(INVALID_STRING_ID), success(true), textref_stack_grffile(NULL), textref_stack_size(0) {}
  40
  41         /**
  42          * Creates a command return value the is failed with the given message
  43          */
  44         explicit CommandCost(StringID msg) : expense_type(INVALID_EXPENSES), cost(0), message(msg), success(false), textref_stack_grffile(NULL), textref_stack_size(0) {}
  45
  46         /**
  47          * Creates a command cost with given expense type and start cost of 0
  48          * @param ex_t the expense type
  49          */
  50         explicit CommandCost(ExpensesType ex_t) : expense_type(ex_t), cost(0), message(INVALID_STRING_ID), success(true), textref_stack_grffile(NULL), textref_stack_size(0) {}
  51
  52         /**
  53          * Creates a command return value with the given start cost and expense type
  54          * @param ex_t the expense type
  55          * @param cst the initial cost of this command
  56          */
  57         CommandCost(ExpensesType ex_t, const Money &cst) : expense_type(ex_t), cost(cst), message(INVALID_STRING_ID), success(true), textref_stack_grffile(NULL), textref_stack_size(0) {}
  58
  59
  60         /**
  61          * Adds the given cost to the cost of the command.
  62          * @param cost the cost to add
  63          */
  64         inline void AddCost(const Money &cost)
  65         {
  66                 this->cost += cost;
  67         }
  68
  69         void AddCost(const CommandCost &cmd_cost);
  70
  71         /**
  72          * Multiplies the cost of the command by the given factor.
  73          * @param factor factor to multiply the costs with
  74          */
  75         inline void MultiplyCost(int factor)
  76         {
  77                 this->cost *= factor;
  78         }
  79
  80         /**
  81          * The costs as made up to this moment
  82          * @return the costs
  83          */
  84         inline Money GetCost() const
  85         {
  86                 return this->cost;
  87         }
  88
  89         /**
  90          * The expense type of the cost
  91          * @return the expense type
  92          */
  93         inline ExpensesType GetExpensesType() const
  94         {
  95                 return this->expense_type;
  96         }
  97
  98         /**
  99          * Makes this #CommandCost behave like an error command.
 100          * @param message The error message.
 101          */
 102         void MakeError(StringID message)
 103         {
 104                 assert(message != INVALID_STRING_ID);
 105                 this->success = false;
 106                 this->message = message;
 107         }
 108
 109         void UseTextRefStack(const GRFFile *grffile, uint num_registers);
 110
 111         /**
 112          * Returns the NewGRF providing the #TextRefStack of the error message.
 113          * @return the NewGRF.
 114          */
 115         const GRFFile *GetTextRefStackGRF() const
 116         {
 117                 return this->textref_stack_grffile;
 118         }
 119
 120         /**
 121          * Returns the number of uint32 values for the #TextRefStack of the error message.
 122          * @return number of uint32 values.
 123          */
 124         uint GetTextRefStackSize() const
 125         {
 126                 return this->textref_stack_size;
 127         }
 128
 129         /**
 130          * Returns a pointer to the values for the #TextRefStack of the error message.
 131          * @return uint32 values for the #TextRefStack
 132          */
 133         const uint32 *GetTextRefStack() const
 134         {
 135                 return textref_stack;
 136         }
 137
 138         /**
 139          * Returns the error message of a command
 140          * @return the error message, if succeeded #INVALID_STRING_ID
 141          */
 142         StringID GetErrorMessage() const
 143         {
 144                 if (this->success) return INVALID_STRING_ID;
 145                 return this->message;
 146         }
 147
 148         /**
 149          * Did this command succeed?
 150          * @return true if and only if it succeeded
 151          */
 152         inline bool Succeeded() const
 153         {
 154                 return this->success;
 155         }
 156
 157         /**
 158          * Did this command fail?
 159          * @return true if and only if it failed
 160          */
 161         inline bool Failed() const
 162         {
 163                 return !this->success;
 164         }
 165 };
 166
 167 /**
 168  * List of commands.
 169  *
 170  * This enum defines all possible commands which can be executed to the game
 171  * engine. Observing the game like the query-tool or checking the profit of a
 172  * vehicle don't result in a command which should be executed in the engine
 173  * nor send to the server in a network game.
 174  *
 175  * @see _command_proc_table
 176  */
 177 enum Commands {
 178         CMD_BUILD_RAILROAD_TRACK,         ///< build a rail track
 179         CMD_REMOVE_RAILROAD_TRACK,        ///< remove a rail track
 180         CMD_BUILD_SINGLE_RAIL,            ///< build a single rail track
 181         CMD_REMOVE_SINGLE_RAIL,           ///< remove a single rail track
 182         CMD_LANDSCAPE_CLEAR,              ///< demolish a tile
 183         CMD_BUILD_BRIDGE,                 ///< build a bridge
 184         CMD_BUILD_RAIL_STATION,           ///< build a rail station
 185         CMD_BUILD_TRAIN_DEPOT,            ///< build a train depot
 186         CMD_BUILD_SIGNALS,                ///< build a signal
 187         CMD_REMOVE_SIGNALS,               ///< remove a signal
 188         CMD_TERRAFORM_LAND,               ///< terraform a tile
 189         CMD_BUILD_OBJECT,                 ///< build an object
 190         CMD_BUILD_TUNNEL,                 ///< build a tunnel
 191
 192         CMD_REMOVE_FROM_RAIL_STATION,     ///< remove a (rectangle of) tiles from a rail station
 193         CMD_CONVERT_RAIL,                 ///< convert a rail type
 194
 195         CMD_BUILD_RAIL_WAYPOINT,          ///< build a waypoint
 196         CMD_RENAME_WAYPOINT,              ///< rename a waypoint
 197         CMD_REMOVE_FROM_RAIL_WAYPOINT,    ///< remove a (rectangle of) tiles from a rail waypoint
 198
 199         CMD_BUILD_ROAD_STOP,              ///< build a road stop
 200         CMD_REMOVE_ROAD_STOP,             ///< remove a road stop
 201         CMD_BUILD_LONG_ROAD,              ///< build a complete road (not a "half" one)
 202         CMD_REMOVE_LONG_ROAD,             ///< remove a complete road (not a "half" one)
 203         CMD_BUILD_ROAD,                   ///< build a "half" road
 204         CMD_BUILD_ROAD_DEPOT,             ///< build a road depot
 205
 206         CMD_BUILD_AIRPORT,                ///< build an airport
 207
 208         CMD_BUILD_DOCK,                   ///< build a dock
 209
 210         CMD_BUILD_SHIP_DEPOT,             ///< build a ship depot
 211         CMD_BUILD_BUOY,                   ///< build a buoy
 212
 213         CMD_PLANT_TREE,                   ///< plant a tree
 214
 215         CMD_BUILD_VEHICLE,                ///< build a vehicle
 216         CMD_SELL_VEHICLE,                 ///< sell a vehicle
 217         CMD_REFIT_VEHICLE,                ///< refit the cargo space of a vehicle
 218         CMD_SEND_VEHICLE_TO_DEPOT,        ///< send a vehicle to a depot
 219         CMD_SET_VEHICLE_VISIBILITY,       ///< hide or unhide a vehicle in the build vehicle and autoreplace GUIs
 220
 221         CMD_MOVE_RAIL_VEHICLE,            ///< move a rail vehicle (in the depot)
 222         CMD_FORCE_TRAIN_PROCEED,          ///< proceed a train to pass a red signal
 223         CMD_REVERSE_TRAIN_DIRECTION,      ///< turn a train around
 224
 225         CMD_CLEAR_ORDER_BACKUP,           ///< clear the order backup of a given user/tile
 226         CMD_MODIFY_ORDER,                 ///< modify an order (like set full-load)
 227         CMD_SKIP_TO_ORDER,                ///< skip an order to the next of specific one
 228         CMD_DELETE_ORDER,                 ///< delete an order
 229         CMD_INSERT_ORDER,                 ///< insert a new order
 230
 231         CMD_CHANGE_SERVICE_INT,           ///< change the server interval of a vehicle
 232
 233         CMD_BUILD_INDUSTRY,               ///< build a new industry
 234
 235         CMD_SET_COMPANY_MANAGER_FACE,     ///< set the manager's face of the company
 236         CMD_SET_COMPANY_COLOUR,           ///< set the colour of the company
 237
 238         CMD_INCREASE_LOAN,                ///< increase the loan from the bank
 239         CMD_DECREASE_LOAN,                ///< decrease the loan from the bank
 240
 241         CMD_WANT_ENGINE_PREVIEW,          ///< confirm the preview of an engine
 242
 243         CMD_RENAME_VEHICLE,               ///< rename a whole vehicle
 244         CMD_RENAME_ENGINE,                ///< rename a engine (in the engine list)
 245         CMD_RENAME_COMPANY,               ///< change the company name
 246         CMD_RENAME_PRESIDENT,             ///< change the president name
 247         CMD_RENAME_STATION,               ///< rename a station
 248         CMD_RENAME_DEPOT,                 ///< rename a depot
 249
 250         CMD_PLACE_SIGN,                   ///< place a sign
 251         CMD_RENAME_SIGN,                  ///< rename a sign
 252
 253         CMD_TURN_ROADVEH,                 ///< turn a road vehicle around
 254
 255         CMD_PAUSE,                        ///< pause the game
 256
 257         CMD_BUY_SHARE_IN_COMPANY,         ///< buy a share from a company
 258         CMD_SELL_SHARE_IN_COMPANY,        ///< sell a share from a company
 259         CMD_BUY_COMPANY,                  ///< buy a company which is bankrupt
 260
 261         CMD_FOUND_TOWN,                   ///< found a town
 262         CMD_RENAME_TOWN,                  ///< rename a town
 263         CMD_DO_TOWN_ACTION,               ///< do a action from the town detail window (like advertises or bribe)
 264         CMD_TOWN_CARGO_GOAL,              ///< set the goal of a cargo for a town
 265         CMD_TOWN_GROWTH_RATE,             ///< set the town growth rate
 266         CMD_TOWN_SET_TEXT,                ///< set the custom text of a town
 267         CMD_EXPAND_TOWN,                  ///< expand a town
 268         CMD_DELETE_TOWN,                  ///< delete a town
 269
 270         CMD_ORDER_REFIT,                  ///< change the refit information of an order (for "goto depot" )
 271         CMD_CLONE_ORDER,                  ///< clone (and share) an order
 272         CMD_CLEAR_AREA,                   ///< clear an area
 273
 274         CMD_MONEY_CHEAT,                  ///< do the money cheat
 275         CMD_CHANGE_BANK_BALANCE,          ///< change bank balance to charge costs or give money from a GS
 276         CMD_BUILD_CANAL,                  ///< build a canal
 277
 278         CMD_CREATE_SUBSIDY,               ///< create a new subsidy
 279         CMD_COMPANY_CTRL,                 ///< used in multiplayer to create a new companies etc.
 280         CMD_CUSTOM_NEWS_ITEM,             ///< create a custom news message
 281         CMD_CREATE_GOAL,                  ///< create a new goal
 282         CMD_REMOVE_GOAL,                  ///< remove a goal
 283         CMD_SET_GOAL_TEXT,                ///< update goal text of a goal
 284         CMD_SET_GOAL_PROGRESS,            ///< update goal progress text of a goal
 285         CMD_SET_GOAL_COMPLETED,           ///< update goal completed status of a goal
 286         CMD_GOAL_QUESTION,                ///< ask a goal related question
 287         CMD_GOAL_QUESTION_ANSWER,         ///< answer(s) to CMD_GOAL_QUESTION
 288         CMD_CREATE_STORY_PAGE,            ///< create a new story page
 289         CMD_CREATE_STORY_PAGE_ELEMENT,    ///< create a new story page element
 290         CMD_UPDATE_STORY_PAGE_ELEMENT,    ///< update a story page element
 291         CMD_SET_STORY_PAGE_TITLE,         ///< update title of a story page
 292         CMD_SET_STORY_PAGE_DATE,          ///< update date of a story page
 293         CMD_SHOW_STORY_PAGE,              ///< show a story page
 294         CMD_REMOVE_STORY_PAGE,            ///< remove a story page
 295         CMD_REMOVE_STORY_PAGE_ELEMENT,    ///< remove a story page element
 296         CMD_LEVEL_LAND,                   ///< level land
 297
 298         CMD_BUILD_LOCK,                   ///< build a lock
 299
 300         CMD_BUILD_SIGNAL_TRACK,           ///< add signals along a track (by dragging)
 301         CMD_REMOVE_SIGNAL_TRACK,          ///< remove signals along a track (by dragging)
 302
 303         CMD_GIVE_MONEY,                   ///< give money to another company
 304         CMD_CHANGE_SETTING,               ///< change a setting
 305         CMD_CHANGE_COMPANY_SETTING,       ///< change a company setting
 306
 307         CMD_SET_AUTOREPLACE,              ///< set an autoreplace entry
 308
 309         CMD_CLONE_VEHICLE,                ///< clone a vehicle
 310         CMD_START_STOP_VEHICLE,           ///< start or stop a vehicle
 311         CMD_MASS_START_STOP,              ///< start/stop all vehicles (in a depot)
 312         CMD_AUTOREPLACE_VEHICLE,          ///< replace/renew a vehicle while it is in a depot
 313         CMD_DEPOT_SELL_ALL_VEHICLES,      ///< sell all vehicles which are in a given depot
 314         CMD_DEPOT_MASS_AUTOREPLACE,       ///< force the autoreplace to take action in a given depot
 315
 316         CMD_CREATE_GROUP,                 ///< create a new group
 317         CMD_DELETE_GROUP,                 ///< delete a group
 318         CMD_ALTER_GROUP,                  ///< alter a group
 319         CMD_ADD_VEHICLE_GROUP,            ///< add a vehicle to a group
 320         CMD_ADD_SHARED_VEHICLE_GROUP,     ///< add all other shared vehicles to a group which are missing
 321         CMD_REMOVE_ALL_VEHICLES_GROUP,    ///< remove all vehicles from a group
 322         CMD_SET_GROUP_REPLACE_PROTECTION, ///< set the autoreplace-protection for a group
 323
 324         CMD_MOVE_ORDER,                   ///< move an order
 325         CMD_CHANGE_TIMETABLE,             ///< change the timetable for a vehicle
 326         CMD_SET_VEHICLE_ON_TIME,          ///< set the vehicle on time feature (timetable)
 327         CMD_AUTOFILL_TIMETABLE,           ///< autofill the timetable
 328         CMD_SET_TIMETABLE_START,          ///< set the date that a timetable should start
 329
 330         CMD_OPEN_CLOSE_AIRPORT,           ///< open/close an airport to incoming aircraft
 331
 332         CMD_END,                          ///< Must ALWAYS be on the end of this list!! (period)
 333 };
 334
 335 /**
 336  * List of flags for a command.
 337  *
 338  * This enums defines some flags which can be used for the commands.
 339  */
 340 enum DoCommandFlag {
 341         DC_NONE                  = 0x000, ///< no flag is set
 342         DC_EXEC                  = 0x001, ///< execute the given command
 343         DC_AUTO                  = 0x002, ///< don't allow building on structures
 344         DC_QUERY_COST            = 0x004, ///< query cost only,  don't build.
 345         DC_NO_WATER              = 0x008, ///< don't allow building on water
 346         DC_NO_RAIL_OVERLAP       = 0x010, ///< don't allow overlap of rails (used in buildrail)
 347         DC_NO_TEST_TOWN_RATING   = 0x020, ///< town rating does not disallow you from building
 348         DC_BANKRUPT              = 0x040, ///< company bankrupts, skip money check, skip vehicle on tile check in some cases
 349         DC_AUTOREPLACE           = 0x080, ///< autoreplace/autorenew is in progress, this shall disable vehicle limits when building, and ignore certain restrictions when undoing things (like vehicle attach callback)
 350         DC_NO_CARGO_CAP_CHECK    = 0x100, ///< when autoreplace/autorenew is in progress, this shall prevent truncating the amount of cargo in the vehicle to prevent testing the command to remove cargo
 351         DC_ALL_TILES             = 0x200, ///< allow this command also on MP_VOID tiles
 352         DC_NO_MODIFY_TOWN_RATING = 0x400, ///< do not change town rating
 353         DC_FORCE_CLEAR_TILE      = 0x800, ///< do not only remove the object on the tile, but also clear any water left on it
 354 };
 355 DECLARE_ENUM_AS_BIT_SET(DoCommandFlag)
 356
 357 /**
 358  * Used to combine a StringID with the command.
 359  *
 360  * This macro can be used to add a StringID (the error message to show) on a command-id
 361  * (CMD_xxx). Use the binary or-operator "|" to combine the command with the result from
 362  * this macro.
 363  *
 364  * @param x The StringID to combine with a command-id
 365  */
 366 #define CMD_MSG(x) ((x) << 16)
 367
 368 /**
 369  * Defines some flags.
 370  *
 371  * This enumeration defines some flags which are binary-or'ed on a command.
 372  */
 373 enum FlaggedCommands {
 374         CMD_NETWORK_COMMAND       = 0x0100, ///< execute the command without sending it on the network
 375         CMD_FLAGS_MASK            = 0xFF00, ///< mask for all command flags
 376         CMD_ID_MASK               = 0x00FF, ///< mask for the command ID
 377 };
 378
 379 /**
 380  * Command flags for the command table _command_proc_table.
 381  *
 382  * This enumeration defines flags for the _command_proc_table.
 383  */
 384 enum CommandFlags {
 385         CMD_SERVER    = 0x001, ///< the command can only be initiated by the server
 386         CMD_SPECTATOR = 0x002, ///< the command may be initiated by a spectator
 387         CMD_OFFLINE   = 0x004, ///< the command cannot be executed in a multiplayer game; single-player only
 388         CMD_AUTO      = 0x008, ///< set the DC_AUTO flag on this command
 389         CMD_ALL_TILES = 0x010, ///< allow this command also on MP_VOID tiles
 390         CMD_NO_TEST   = 0x020, ///< the command's output may differ between test and execute due to town rating changes etc.
 391         CMD_NO_WATER  = 0x040, ///< set the DC_NO_WATER flag on this command
 392         CMD_CLIENT_ID = 0x080, ///< set p2 with the ClientID of the sending client.
 393         CMD_DEITY     = 0x100, ///< the command may be executed by COMPANY_DEITY
 394         CMD_STR_CTRL  = 0x200, ///< the command's string may contain control strings
 395 };
 396 DECLARE_ENUM_AS_BIT_SET(CommandFlags)
 397
 398 /** Types of commands we have. */
 399 enum CommandType {
 400         CMDT_LANDSCAPE_CONSTRUCTION, ///< Construction and destruction of objects on the map.
 401         CMDT_VEHICLE_CONSTRUCTION,   ///< Construction, modification (incl. refit) and destruction of vehicles.
 402         CMDT_MONEY_MANAGEMENT,       ///< Management of money, i.e. loans and shares.
 403         CMDT_VEHICLE_MANAGEMENT,     ///< Stopping, starting, sending to depot, turning around, replace orders etc.
 404         CMDT_ROUTE_MANAGEMENT,       ///< Modifications to route management (orders, groups, etc).
 405         CMDT_OTHER_MANAGEMENT,       ///< Renaming stuff, changing company colours, placing signs, etc.
 406         CMDT_COMPANY_SETTING,        ///< Changing settings related to a company.
 407         CMDT_SERVER_SETTING,         ///< Pausing/removing companies/server settings.
 408         CMDT_CHEAT,                  ///< A cheat of some sorts.
 409
 410         CMDT_END,                    ///< Magic end marker.
 411 };
 412
 413 /** Different command pause levels. */
 414 enum CommandPauseLevel {
 415         CMDPL_NO_ACTIONS,      ///< No user actions may be executed.
 416         CMDPL_NO_CONSTRUCTION, ///< No construction actions may be executed.
 417         CMDPL_NO_LANDSCAPING,  ///< No landscaping actions may be executed.
 418         CMDPL_ALL_ACTIONS,     ///< All actions may be executed.
 419 };
 420
 421 /**
 422  * Defines the callback type for all command handler functions.
 423  *
 424  * This type defines the function header for all functions which handles a CMD_* command.
 425  * A command handler use the parameters to act according to the meaning of the command.
 426  * The tile parameter defines the tile to perform an action on.
 427  * The flag parameter is filled with flags from the DC_* enumeration. The parameters
 428  * p1 and p2 are filled with parameters for the command like "which road type", "which
 429  * order" or "direction". Each function should mentioned in there doxygen comments
 430  * the usage of these parameters.
 431  *
 432  * @param tile The tile to apply a command on
 433  * @param flags Flags for the command, from the DC_* enumeration
 434  * @param p1 Additional data for the command
 435  * @param p2 Additional data for the command
 436  * @param text Additional text
 437  * @return The CommandCost of the command, which can be succeeded or failed.
 438  */
 439 typedef CommandCost CommandProc(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text);
 440
 441 /**
 442  * Define a command with the flags which belongs to it.
 443  *
 444  * This struct connect a command handler function with the flags created with
 445  * the #CMD_AUTO, #CMD_OFFLINE and #CMD_SERVER values.
 446  */
 447 struct Command {
 448         CommandProc *proc;  ///< The procedure to actually executing
 449         const char *name;   ///< A human readable name for the procedure
 450         CommandFlags flags; ///< The (command) flags to that apply to this command
 451         CommandType type;   ///< The type of command.
 452 };
 453
 454 /**
 455  * Define a callback function for the client, after the command is finished.
 456  *
 457  * Functions of this type are called after the command is finished. The parameters
 458  * are from the #CommandProc callback type. The boolean parameter indicates if the
 459  * command succeeded or failed.
 460  *
 461  * @param result The result of the executed command
 462  * @param tile The tile of the command action
 463  * @param p1 Additional data of the command
 464  * @param p1 Additional data of the command
 465  * @see CommandProc
 466  */
 467 typedef void CommandCallback(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2);
 468
 469 /**
 470  * Structure for buffering the build command when selecting a station to join.
 471  */
 472 struct CommandContainer {
 473         TileIndex tile;                  ///< tile command being executed on.
 474         uint32 p1;                       ///< parameter p1.
 475         uint32 p2;                       ///< parameter p2.
 476         uint32 cmd;                      ///< command being executed.
 477         CommandCallback *callback;       ///< any callback function executed upon successful completion of the command.
 478         char text[32 * MAX_CHAR_LENGTH]; ///< possible text sent for name changes etc, in bytes including '\0'.
 479 };
 480
 481 #endif /* COMMAND_TYPE_H */