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