tron@2186: /* $Id$ */ tron@2186: rubidium@8612: /** @file command_type.h Types related to commands. */ belugas@6449: rubidium@8612: #ifndef COMMAND_TYPE_H rubidium@8612: #define COMMAND_TYPE_H rubidium@8612: rubidium@8612: #include "economy_type.h" rubidium@8612: #include "strings_type.h" rubidium@8619: #include "tile_type.h" rubidium@8612: rubidium@8612: /** rubidium@8612: * Common return value for all commands. Wraps the cost and rubidium@8612: * a possible error message/state together. rubidium@8612: */ rubidium@8612: class CommandCost { rubidium@8612: Money cost; ///< The cost of this action rubidium@8612: StringID message; ///< Warning message for when success is unset rubidium@8612: bool success; ///< Whether the comment went fine up to this moment rubidium@8612: rubidium@8612: public: rubidium@8612: /** rubidium@8612: * Creates a command cost return with no cost and no error rubidium@8612: */ rubidium@8612: CommandCost() : cost(0), message(INVALID_STRING_ID), success(true) {} rubidium@8612: rubidium@8612: /** rubidium@8612: * Creates a command return value the is failed with the given message rubidium@8612: */ rubidium@8612: CommandCost(StringID msg) : cost(0), message(msg), success(false) {} rubidium@8612: rubidium@8612: /** rubidium@8612: * Creates a command return value with the given start cost rubidium@8612: * @param cst the initial cost of this command rubidium@8612: */ rubidium@8612: CommandCost(Money cst) : cost(cst), message(INVALID_STRING_ID), success(true) {} rubidium@8612: rubidium@8612: /** rubidium@8612: * Adds the cost of the given command return value to this cost. rubidium@8612: * Also takes a possible error message when it is set. rubidium@8612: * @param ret the command to add the cost of. rubidium@8612: * @return this class. rubidium@8612: */ rubidium@8612: CommandCost AddCost(CommandCost ret); rubidium@8612: rubidium@8612: /** rubidium@8612: * Adds the given cost to the cost of the command. rubidium@8612: * @param cost the cost to add rubidium@8612: * @return this class. rubidium@8612: */ rubidium@8612: CommandCost AddCost(Money cost); rubidium@8612: rubidium@8612: /** rubidium@8612: * Multiplies the cost of the command by the given factor. rubidium@8612: * @param cost factor to multiply the costs with rubidium@8612: * @return this class rubidium@8612: */ rubidium@8612: CommandCost MultiplyCost(int factor); rubidium@8612: rubidium@8612: /** rubidium@8612: * The costs as made up to this moment rubidium@8612: * @return the costs rubidium@8612: */ rubidium@8612: Money GetCost() const; rubidium@8612: rubidium@8612: /** rubidium@8612: * Sets the global error message *if* this class has one. rubidium@8612: */ rubidium@8612: void SetGlobalErrorMessage() const; rubidium@8612: rubidium@8612: /** rubidium@8612: * Did this command succeed? rubidium@8612: * @return true if and only if it succeeded rubidium@8612: */ rubidium@8612: bool Succeeded() const; rubidium@8612: rubidium@8612: /** rubidium@8612: * Did this command fail? rubidium@8612: * @return true if and only if it failed rubidium@8612: */ rubidium@8612: bool Failed() const; rubidium@8612: }; truelight@0: rubidium@8055: /** rubidium@8055: * List of commands. rubidium@8055: * rubidium@8055: * This enum defines all possible commands which can be executed to the game rubidium@8055: * engine. Observing the game like the query-tool or checking the profit of a rubidium@8055: * vehicle don't result in a command which should be executed in the engine rubidium@8055: * nor send to the server in a network game. rubidium@8055: * rubidium@8055: * @see _command_proc_table rubidium@8055: */ truelight@0: enum { rubidium@8056: CMD_BUILD_RAILROAD_TRACK = 0, ///< build a rail track rubidium@8056: CMD_REMOVE_RAILROAD_TRACK = 1, ///< remove a rail track rubidium@8056: CMD_BUILD_SINGLE_RAIL = 2, ///< build a single rail track rubidium@8056: CMD_REMOVE_SINGLE_RAIL = 3, ///< remove a single rail track rubidium@8056: CMD_LANDSCAPE_CLEAR = 4, ///< demolish a tile rubidium@8056: CMD_BUILD_BRIDGE = 5, ///< build a bridge rubidium@8056: CMD_BUILD_RAILROAD_STATION = 6, ///< build a railroad station rubidium@8056: CMD_BUILD_TRAIN_DEPOT = 7, ///< build a train depot rubidium@8056: CMD_BUILD_SIGNALS = 8, ///< build a signal rubidium@8056: CMD_REMOVE_SIGNALS = 9, ///< remove a signal rubidium@8056: CMD_TERRAFORM_LAND = 10, ///< terraform a tile rubidium@8056: CMD_PURCHASE_LAND_AREA = 11, ///< purchase a tile rubidium@8056: CMD_SELL_LAND_AREA = 12, ///< sell a bought tile before rubidium@8056: CMD_BUILD_TUNNEL = 13, ///< build a tunnel rubidium@4344: rubidium@8056: CMD_REMOVE_FROM_RAILROAD_STATION = 14, ///< remove a tile station rubidium@8056: CMD_CONVERT_RAIL = 15, ///< convert a rail type rubidium@4344: rubidium@8056: CMD_BUILD_TRAIN_WAYPOINT = 16, ///< build a waypoint rubidium@8055: CMD_RENAME_WAYPOINT = 17, ///< rename a waypoint rubidium@8056: CMD_REMOVE_TRAIN_WAYPOINT = 18, ///< remove a waypoint rubidium@4344: rubidium@8055: CMD_BUILD_ROAD_STOP = 21, ///< build a road stop rubidium@8055: CMD_REMOVE_ROAD_STOP = 22, ///< remove a road stop rubidium@8055: CMD_BUILD_LONG_ROAD = 23, ///< build a complete road (not a "half" one) rubidium@8055: CMD_REMOVE_LONG_ROAD = 24, ///< remove a complete road (not a "half" one) rubidium@8055: CMD_BUILD_ROAD = 25, ///< build a "half" road rubidium@8055: CMD_REMOVE_ROAD = 26, ///< remove a "half" road rubidium@8055: CMD_BUILD_ROAD_DEPOT = 27, ///< build a road depot rubidium@4344: rubidium@8056: CMD_BUILD_AIRPORT = 29, ///< build an airport rubidium@4344: rubidium@8056: CMD_BUILD_DOCK = 30, ///< build a dock rubidium@4344: rubidium@8056: CMD_BUILD_SHIP_DEPOT = 31, ///< build a ship depot rubidium@8055: CMD_BUILD_BUOY = 32, ///< build a buoy rubidium@8055: rubidium@8055: CMD_PLANT_TREE = 33, ///< plant a tree rubidium@8055: rubidium@8055: CMD_BUILD_RAIL_VEHICLE = 34, ///< build a rail vehicle rubidium@8055: CMD_MOVE_RAIL_VEHICLE = 35, ///< move a rail vehicle (in the depot) rubidium@8055: rubidium@8055: CMD_START_STOP_TRAIN = 36, ///< start or stop a train rubidium@8055: rubidium@8055: CMD_SELL_RAIL_WAGON = 38, ///< sell a rail wagon rubidium@8055: rubidium@8055: CMD_SEND_TRAIN_TO_DEPOT = 39, ///< send a train to a depot rubidium@8055: CMD_FORCE_TRAIN_PROCEED = 40, ///< proceed a train to pass a red signal rubidium@8055: CMD_REVERSE_TRAIN_DIRECTION = 41, ///< turn a train around rubidium@8055: rubidium@8055: CMD_MODIFY_ORDER = 42, ///< modify an order (like set full-load) rubidium@8055: CMD_SKIP_TO_ORDER = 43, ///< skip an order to the next of specific one rubidium@8055: CMD_DELETE_ORDER = 44, ///< delete an order rubidium@8056: CMD_INSERT_ORDER = 45, ///< insert a new order rubidium@8055: rubidium@8056: CMD_CHANGE_SERVICE_INT = 46, ///< change the server interval of a vehicle rubidium@8055: rubidium@8055: CMD_BUILD_INDUSTRY = 47, ///< build a new industry rubidium@8055: rubidium@8056: CMD_BUILD_COMPANY_HQ = 48, ///< build the company headquarter rubidium@8056: CMD_SET_PLAYER_FACE = 49, ///< set the face of the player/company rubidium@8056: CMD_SET_PLAYER_COLOR = 50, ///< set the color of the player/company rubidium@8055: rubidium@8056: CMD_INCREASE_LOAN = 51, ///< increase the loan from the bank rubidium@8056: CMD_DECREASE_LOAN = 52, ///< decrease the loan from the bank rubidium@8055: rubidium@8056: CMD_WANT_ENGINE_PREVIEW = 53, ///< confirm the preview of an engine rubidium@8056: rubidium@8056: CMD_NAME_VEHICLE = 54, ///< rename a whole vehicle rubidium@8056: CMD_RENAME_ENGINE = 55, ///< rename a engine (in the engine list) rubidium@8056: CMD_CHANGE_COMPANY_NAME = 56, ///< change the company name rubidium@8056: CMD_CHANGE_PRESIDENT_NAME = 57, ///< change the president name rubidium@8056: CMD_RENAME_STATION = 58, ///< rename a station rubidium@8056: rubidium@8056: CMD_SELL_AIRCRAFT = 59, ///< sell an aircraft rubidium@8056: CMD_START_STOP_AIRCRAFT = 60, ///< start/stop an aircraft rubidium@8056: CMD_BUILD_AIRCRAFT = 61, ///< build an aircraft rubidium@8056: CMD_SEND_AIRCRAFT_TO_HANGAR = 62, ///< send an aircraft to a hanger rubidium@8056: CMD_REFIT_AIRCRAFT = 64, ///< refit the cargo space of an aircraft rubidium@8055: rubidium@8055: CMD_PLACE_SIGN = 65, ///< place a sign rubidium@8056: CMD_RENAME_SIGN = 66, ///< rename a sign rubidium@8055: rubidium@8056: CMD_BUILD_ROAD_VEH = 67, ///< build a road vehicle rubidium@8056: CMD_START_STOP_ROADVEH = 68, ///< start/stop a road vehicle rubidium@8056: CMD_SELL_ROAD_VEH = 69, ///< sell a road vehicle rubidium@8056: CMD_SEND_ROADVEH_TO_DEPOT = 70, ///< send a road vehicle to the depot rubidium@8056: CMD_TURN_ROADVEH = 71, ///< turn a road vehicle around rubidium@8056: CMD_REFIT_ROAD_VEH = 72, ///< refit the cargo space of a road vehicle rubidium@8055: rubidium@8056: CMD_PAUSE = 73, ///< pause the game rubidium@8055: rubidium@8056: CMD_BUY_SHARE_IN_COMPANY = 74, ///< buy a share from a company rubidium@8056: CMD_SELL_SHARE_IN_COMPANY = 75, ///< sell a share from a company rubidium@8056: CMD_BUY_COMPANY = 76, ///< buy a company which is bankrupt rubidium@8056: rubidium@8056: CMD_BUILD_TOWN = 77, ///< build a town rubidium@8056: rubidium@8056: CMD_RENAME_TOWN = 80, ///< rename a town rubidium@8056: CMD_DO_TOWN_ACTION = 81, ///< do a action from the town detail window (like advertises or bribe) rubidium@8056: rubidium@8056: CMD_SET_ROAD_DRIVE_SIDE = 82, ///< set the side where the road vehicles drive rubidium@8056: rubidium@8056: CMD_CHANGE_DIFFICULTY_LEVEL = 85, ///< change the difficult of a game (each setting for it own) rubidium@8056: rubidium@8056: CMD_START_STOP_SHIP = 86, ///< start/stop a ship rubidium@8056: CMD_SELL_SHIP = 87, ///< sell a ship rubidium@8056: CMD_BUILD_SHIP = 88, ///< build a new ship rubidium@8056: CMD_SEND_SHIP_TO_DEPOT = 89, ///< send a ship to a depot rubidium@8056: CMD_REFIT_SHIP = 91, ///< refit the cargo space of a ship rubidium@8055: rubidium@8055: CMD_ORDER_REFIT = 98, ///< change the refit informaction of an order (for "goto depot" ) rubidium@8055: CMD_CLONE_ORDER = 99, ///< clone (and share) an order rubidium@8056: CMD_CLEAR_AREA = 100, ///< clear an area rubidium@8055: rubidium@8056: CMD_MONEY_CHEAT = 102, ///< do the money cheat rubidium@8056: CMD_BUILD_CANAL = 103, ///< build a canal rubidium@4344: belugas@6449: CMD_PLAYER_CTRL = 104, ///< used in multiplayer to create a new player etc. belugas@6449: CMD_LEVEL_LAND = 105, ///< level land rubidium@4344: rubidium@8056: CMD_REFIT_RAIL_VEHICLE = 106, ///< refit the cargo space of a train rubidium@8056: CMD_RESTORE_ORDER_INDEX = 107, ///< restore vehicle order-index and service interval rubidium@8056: CMD_BUILD_LOCK = 108, ///< build a lock rubidium@8055: rubidium@8056: CMD_BUILD_SIGNAL_TRACK = 110, ///< add signals along a track (by dragging) rubidium@8056: CMD_REMOVE_SIGNAL_TRACK = 111, ///< remove signals along a track (by dragging) rubidium@8055: rubidium@8056: CMD_GIVE_MONEY = 113, ///< give money to an other player rubidium@8056: CMD_CHANGE_PATCH_SETTING = 114, ///< change a patch setting rubidium@8055: rubidium@8056: CMD_SET_AUTOREPLACE = 115, ///< set an autoreplace entry rubidium@8056: rubidium@8056: CMD_CLONE_VEHICLE = 116, ///< clone a vehicle rubidium@8056: CMD_MASS_START_STOP = 117, ///< start/stop all vehicles (in a depot) rubidium@8056: CMD_DEPOT_SELL_ALL_VEHICLES = 118, ///< sell all vehicles which are in a given depot rubidium@8056: CMD_DEPOT_MASS_AUTOREPLACE = 119, ///< force the autoreplace to take action in a given depot rubidium@8056: rubidium@8056: CMD_CREATE_GROUP = 120, ///< create a new group rubidium@8056: CMD_DELETE_GROUP = 121, ///< delete a group rubidium@8056: CMD_RENAME_GROUP = 122, ///< rename a group rubidium@8056: CMD_ADD_VEHICLE_GROUP = 123, ///< add a vehicle to a group rubidium@8056: CMD_ADD_SHARED_VEHICLE_GROUP = 124, ///< add all other shared vehicles to a group which are missing rubidium@8056: CMD_REMOVE_ALL_VEHICLES_GROUP = 125, ///< remove all vehicles from a group rubidium@8056: CMD_SET_GROUP_REPLACE_PROTECTION = 126, ///< set the autoreplace-protection for a group rubidium@8056: rubidium@8056: CMD_MOVE_ORDER = 127, ///< move an order rubidium@8056: CMD_CHANGE_TIMETABLE = 128, ///< change the timetable for a vehicle rubidium@8056: CMD_SET_VEHICLE_ON_TIME = 129, ///< set the vehicle on time feature (timetable) rubidium@8056: CMD_AUTOFILL_TIMETABLE = 130, ///< autofill the timetable truelight@0: }; truelight@0: rubidium@8055: /** rubidium@8055: * List of flags for a command. rubidium@8055: * rubidium@8055: * This enums defines some flags which can be used for the commands. rubidium@8055: */ truelight@0: enum { rubidium@8055: DC_EXEC = 0x01, ///< execute the given command belugas@6449: DC_AUTO = 0x02, ///< don't allow building on structures belugas@6449: DC_QUERY_COST = 0x04, ///< query cost only, don't build. belugas@6449: DC_NO_WATER = 0x08, ///< don't allow building on water belugas@6449: DC_NO_RAIL_OVERLAP = 0x10, ///< don't allow overlap of rails (used in buildrail) belugas@6449: DC_AI_BUILDING = 0x20, ///< special building rules for AI belugas@6449: DC_NO_TOWN_RATING = 0x40, ///< town rating does not disallow you from building belugas@6449: DC_FORCETEST = 0x80, ///< force test too. truelight@0: }; truelight@0: rubidium@8055: /** rubidium@8055: * Used to combine a StringID with the command. rubidium@8055: * rubidium@8055: * This macro can be used to add a StringID (the error message to show) on a command-id rubidium@8055: * (CMD_xxx). Use the binary or-operator "|" to combine the command with the result from rubidium@8055: * this macro. rubidium@8055: * rubidium@8055: * @param x The StringID to combine with a command-id rubidium@8055: */ rubidium@6987: #define CMD_MSG(x) ((x) << 16) truelight@0: rubidium@8055: /** rubidium@8055: * Defines some flags. rubidium@8055: * rubidium@8055: * This enumeration defines some flags which are binary-or'ed on a command. rubidium@8055: */ truelight@0: enum { rubidium@8055: CMD_NO_WATER = 0x0400, ///< dont build on water belugas@6449: CMD_NETWORK_COMMAND = 0x0800, ///< execute the command without sending it on the network belugas@6449: CMD_NO_TEST_IF_IN_NETWORK = 0x1000, ///< When enabled, the command will bypass the no-DC_EXEC round if in network rubidium@8055: CMD_SHOW_NO_ERROR = 0x2000, ///< do not show the error message truelight@0: }; truelight@0: rubidium@8055: /** rubidium@8055: * Command flags for the command table _command_proc_table. rubidium@8055: * rubidium@8055: * This enumeration defines flags for the _command_proc_table. rubidium@8055: */ Darkvater@1804: enum { belugas@6449: CMD_SERVER = 0x1, ///< the command can only be initiated by the server belugas@6449: CMD_OFFLINE = 0x2, ///< the command cannot be executed in a multiplayer game; single-player only rubidium@8017: CMD_AUTO = 0x4, ///< set the DC_AUTO flag on this command Darkvater@1804: }; Darkvater@1804: rubidium@8055: /** rubidium@8055: * Defines the callback type for all command handler functions. rubidium@8055: * rubidium@8055: * This type defines the function header for all functions which handles a CMD_* command. rubidium@8055: * A command handler use the parameters to act according to the meaning of the command. rubidium@8055: * The tile parameter defines the tile to perform an action on. rubidium@8055: * The flag parameter is filled with flags from the DC_* enumeration. The parameters rubidium@8055: * p1 and p2 are filled with parameters for the command like "which road type", "which rubidium@8055: * order" or "direction". Each function should mentioned in there doxygen comments rubidium@8055: * the usage of these parameters. rubidium@8055: * rubidium@8055: * @param tile The tile to apply a command on rubidium@8055: * @param flags Flags for the command, from the DC_* enumeration rubidium@8055: * @param p1 Additional data for the command rubidium@8055: * @param p2 Additional data for the command rubidium@8055: * @return The CommandCost of the command, which can be succeeded or failed. rubidium@8055: */ rubidium@7439: typedef CommandCost CommandProc(TileIndex tile, uint32 flags, uint32 p1, uint32 p2); tron@3491: rubidium@8055: /** rubidium@8055: * Define a command with the flags which belongs to it. rubidium@8055: * rubidium@8055: * This struct connect a command handler function with the flags created with rubidium@8055: * the #CMD_AUTO, #CMD_OFFLINE and #CMD_SERVER values. rubidium@8055: */ rubidium@6574: struct Command { Darkvater@1804: CommandProc *proc; Darkvater@1804: byte flags; rubidium@6574: }; Darkvater@1804: rubidium@8055: /** rubidium@8055: * Define a callback function for the client, after the command is finished. rubidium@8055: * rubidium@8055: * Functions of this type are called after the command is finished. The parameters rubidium@8055: * are from the #CommandProc callback type. The boolean parameter indicates if the rubidium@8055: * command succeeded or failed. rubidium@8055: * rubidium@8055: * @param success If the command succeeded or not. rubidium@8055: * @param tile The tile of the command action rubidium@8055: * @param p1 Additional data of the command rubidium@8055: * @param p1 Additional data of the command rubidium@8055: * @see CommandProc rubidium@8055: */ Darkvater@4828: typedef void CommandCallback(bool success, TileIndex tile, uint32 p1, uint32 p2); rubidium@8055: rubidium@8612: #endif /* COMMAND_TYPE_H */