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@8726: ExpensesType expense_type; ///< the type of expence as shown on the finances view 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@8726: CommandCost() : expense_type(INVALID_EXPENSES), 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@8726: CommandCost(StringID msg) : expense_type(INVALID_EXPENSES), cost(0), message(msg), success(false) {} rubidium@8612: rubidium@8612: /** rubidium@8726: * Creates a command cost with given expense type and start cost of 0 rubidium@8726: * @param ex_t the expense type rubidium@8726: */ rubidium@8726: CommandCost(ExpensesType ex_t) : expense_type(ex_t), cost(0), message(INVALID_STRING_ID), success(true) {} rubidium@8726: rubidium@8726: /** rubidium@8726: * Creates a command return value with the given start cost and expense type rubidium@8726: * @param ex_t the expense type rubidium@8612: * @param cst the initial cost of this command rubidium@8612: */ rubidium@8726: CommandCost(ExpensesType ex_t, Money cst) : expense_type(ex_t), 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: */ smatz@9337: CommandCost AddCost(CommandCost ret) smatz@9337: { smatz@9337: this->AddCost(ret.cost); smatz@9337: if (this->success && !ret.success) { smatz@9337: this->message = ret.message; smatz@9337: this->success = false; smatz@9337: } smatz@9337: return *this; smatz@9337: } 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: */ smatz@9337: CommandCost AddCost(Money cost) smatz@9337: { smatz@9337: this->cost += cost; smatz@9337: return *this; smatz@9337: } 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: */ smatz@9337: CommandCost MultiplyCost(int factor) smatz@9337: { smatz@9337: this->cost *= factor; smatz@9337: return *this; smatz@9337: } rubidium@8612: rubidium@8612: /** rubidium@8612: * The costs as made up to this moment rubidium@8612: * @return the costs rubidium@8612: */ smatz@9337: Money GetCost() const smatz@9337: { smatz@9337: return this->cost; smatz@9337: } rubidium@8612: rubidium@8612: /** rubidium@8726: * The expense type of the cost rubidium@8726: * @return the expense type rubidium@8726: */ smatz@9337: ExpensesType GetExpensesType() const smatz@9337: { smatz@9337: return this->expense_type; smatz@9337: } rubidium@8726: rubidium@8726: /** rubidium@8612: * Sets the global error message *if* this class has one. rubidium@8612: */ smatz@9337: void SetGlobalErrorMessage() const smatz@9337: { smatz@9337: extern StringID _error_message; smatz@9337: if (this->message != INVALID_STRING_ID) _error_message = this->message; smatz@9337: } rubidium@8612: rubidium@8612: /** rubidium@8612: * Did this command succeed? rubidium@8612: * @return true if and only if it succeeded rubidium@8612: */ smatz@9337: bool Succeeded() const smatz@9337: { smatz@9337: return this->success; smatz@9337: } rubidium@8612: rubidium@8612: /** rubidium@8612: * Did this command fail? rubidium@8612: * @return true if and only if it failed rubidium@8612: */ smatz@9337: bool Failed() const smatz@9337: { smatz@9337: return !this->success; smatz@9337: } 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 { peter1138@8996: CMD_BUILD_RAILROAD_TRACK, ///< build a rail track peter1138@8996: CMD_REMOVE_RAILROAD_TRACK, ///< remove a rail track peter1138@8996: CMD_BUILD_SINGLE_RAIL, ///< build a single rail track peter1138@8996: CMD_REMOVE_SINGLE_RAIL, ///< remove a single rail track peter1138@8996: CMD_LANDSCAPE_CLEAR, ///< demolish a tile peter1138@8996: CMD_BUILD_BRIDGE, ///< build a bridge peter1138@8996: CMD_BUILD_RAILROAD_STATION, ///< build a railroad station peter1138@8996: CMD_BUILD_TRAIN_DEPOT, ///< build a train depot peter1138@8996: CMD_BUILD_SIGNALS, ///< build a signal peter1138@8996: CMD_REMOVE_SIGNALS, ///< remove a signal peter1138@8996: CMD_TERRAFORM_LAND, ///< terraform a tile peter1138@8996: CMD_PURCHASE_LAND_AREA, ///< purchase a tile peter1138@8996: CMD_SELL_LAND_AREA, ///< sell a bought tile before peter1138@8996: CMD_BUILD_TUNNEL, ///< build a tunnel rubidium@8056: peter1138@8996: CMD_REMOVE_FROM_RAILROAD_STATION, ///< remove a tile station peter1138@8996: CMD_CONVERT_RAIL, ///< convert a rail type rubidium@8055: peter1138@8996: CMD_BUILD_TRAIN_WAYPOINT, ///< build a waypoint peter1138@8996: CMD_RENAME_WAYPOINT, ///< rename a waypoint peter1138@8996: CMD_REMOVE_TRAIN_WAYPOINT, ///< remove a waypoint rubidium@8055: peter1138@8996: CMD_BUILD_ROAD_STOP, ///< build a road stop peter1138@8996: CMD_REMOVE_ROAD_STOP, ///< remove a road stop peter1138@8996: CMD_BUILD_LONG_ROAD, ///< build a complete road (not a "half" one) peter1138@8996: CMD_REMOVE_LONG_ROAD, ///< remove a complete road (not a "half" one) peter1138@8996: CMD_BUILD_ROAD, ///< build a "half" road peter1138@8996: CMD_REMOVE_ROAD, ///< remove a "half" road peter1138@8996: CMD_BUILD_ROAD_DEPOT, ///< build a road depot rubidium@8056: peter1138@8996: CMD_BUILD_AIRPORT, ///< build an airport rubidium@8056: peter1138@8996: CMD_BUILD_DOCK, ///< build a dock peter1138@8996: peter1138@8996: CMD_BUILD_SHIP_DEPOT, ///< build a ship depot peter1138@8996: CMD_BUILD_BUOY, ///< build a buoy peter1138@8996: peter1138@8996: CMD_PLANT_TREE, ///< plant a tree peter1138@8996: peter1138@8996: CMD_BUILD_RAIL_VEHICLE, ///< build a rail vehicle peter1138@8996: CMD_MOVE_RAIL_VEHICLE, ///< move a rail vehicle (in the depot) peter1138@8996: peter1138@8996: CMD_START_STOP_TRAIN, ///< start or stop a train peter1138@8996: peter1138@8996: CMD_SELL_RAIL_WAGON, ///< sell a rail wagon peter1138@8996: peter1138@8996: CMD_SEND_TRAIN_TO_DEPOT, ///< send a train to a depot peter1138@8996: CMD_FORCE_TRAIN_PROCEED, ///< proceed a train to pass a red signal peter1138@8996: CMD_REVERSE_TRAIN_DIRECTION, ///< turn a train around peter1138@8996: peter1138@8996: CMD_MODIFY_ORDER, ///< modify an order (like set full-load) peter1138@8996: CMD_SKIP_TO_ORDER, ///< skip an order to the next of specific one peter1138@8996: CMD_DELETE_ORDER, ///< delete an order peter1138@8996: CMD_INSERT_ORDER, ///< insert a new order peter1138@8996: peter1138@8996: CMD_CHANGE_SERVICE_INT, ///< change the server interval of a vehicle peter1138@8996: peter1138@8996: CMD_BUILD_INDUSTRY, ///< build a new industry peter1138@8996: peter1138@8996: CMD_BUILD_COMPANY_HQ, ///< build the company headquarter peter1138@8996: CMD_SET_PLAYER_FACE, ///< set the face of the player/company peter1138@8996: CMD_SET_PLAYER_COLOR, ///< set the color of the player/company peter1138@8996: peter1138@8996: CMD_INCREASE_LOAN, ///< increase the loan from the bank peter1138@8996: CMD_DECREASE_LOAN, ///< decrease the loan from the bank peter1138@8996: peter1138@8996: CMD_WANT_ENGINE_PREVIEW, ///< confirm the preview of an engine peter1138@8996: peter1138@8996: CMD_NAME_VEHICLE, ///< rename a whole vehicle peter1138@8996: CMD_RENAME_ENGINE, ///< rename a engine (in the engine list) peter1138@8996: CMD_CHANGE_COMPANY_NAME, ///< change the company name peter1138@8996: CMD_CHANGE_PRESIDENT_NAME, ///< change the president name peter1138@8996: CMD_RENAME_STATION, ///< rename a station peter1138@8996: peter1138@8996: CMD_SELL_AIRCRAFT, ///< sell an aircraft peter1138@8996: CMD_START_STOP_AIRCRAFT, ///< start/stop an aircraft peter1138@8996: CMD_BUILD_AIRCRAFT, ///< build an aircraft peter1138@8996: CMD_SEND_AIRCRAFT_TO_HANGAR, ///< send an aircraft to a hanger peter1138@8996: CMD_REFIT_AIRCRAFT, ///< refit the cargo space of an aircraft peter1138@8996: peter1138@8996: CMD_PLACE_SIGN, ///< place a sign peter1138@8996: CMD_RENAME_SIGN, ///< rename a sign peter1138@8996: peter1138@8996: CMD_BUILD_ROAD_VEH, ///< build a road vehicle peter1138@8996: CMD_START_STOP_ROADVEH, ///< start/stop a road vehicle peter1138@8996: CMD_SELL_ROAD_VEH, ///< sell a road vehicle peter1138@8996: CMD_SEND_ROADVEH_TO_DEPOT, ///< send a road vehicle to the depot peter1138@8996: CMD_TURN_ROADVEH, ///< turn a road vehicle around peter1138@8996: CMD_REFIT_ROAD_VEH, ///< refit the cargo space of a road vehicle peter1138@8996: peter1138@8996: CMD_PAUSE, ///< pause the game peter1138@8996: peter1138@8996: CMD_BUY_SHARE_IN_COMPANY, ///< buy a share from a company peter1138@8996: CMD_SELL_SHARE_IN_COMPANY, ///< sell a share from a company peter1138@8996: CMD_BUY_COMPANY, ///< buy a company which is bankrupt peter1138@8996: peter1138@8996: CMD_BUILD_TOWN, ///< build a town peter1138@8996: peter1138@8996: CMD_RENAME_TOWN, ///< rename a town peter1138@8996: CMD_DO_TOWN_ACTION, ///< do a action from the town detail window (like advertises or bribe) peter1138@8996: peter1138@8996: CMD_SET_ROAD_DRIVE_SIDE, ///< set the side where the road vehicles drive peter1138@8996: peter1138@8996: CMD_CHANGE_DIFFICULTY_LEVEL, ///< change the difficult of a game (each setting for it own) peter1138@8996: peter1138@8996: CMD_START_STOP_SHIP, ///< start/stop a ship peter1138@8996: CMD_SELL_SHIP, ///< sell a ship peter1138@8996: CMD_BUILD_SHIP, ///< build a new ship peter1138@8996: CMD_SEND_SHIP_TO_DEPOT, ///< send a ship to a depot peter1138@8996: CMD_REFIT_SHIP, ///< refit the cargo space of a ship peter1138@8996: peter1138@8996: CMD_ORDER_REFIT, ///< change the refit informaction of an order (for "goto depot" ) peter1138@8996: CMD_CLONE_ORDER, ///< clone (and share) an order peter1138@8996: CMD_CLEAR_AREA, ///< clear an area peter1138@8996: peter1138@8996: CMD_MONEY_CHEAT, ///< do the money cheat peter1138@8996: CMD_BUILD_CANAL, ///< build a canal peter1138@8996: peter1138@8996: CMD_PLAYER_CTRL, ///< used in multiplayer to create a new player etc. peter1138@8996: CMD_LEVEL_LAND, ///< level land peter1138@8996: peter1138@8996: CMD_REFIT_RAIL_VEHICLE, ///< refit the cargo space of a train peter1138@8996: CMD_RESTORE_ORDER_INDEX, ///< restore vehicle order-index and service interval peter1138@8996: CMD_BUILD_LOCK, ///< build a lock peter1138@8996: peter1138@8996: CMD_BUILD_SIGNAL_TRACK, ///< add signals along a track (by dragging) peter1138@8996: CMD_REMOVE_SIGNAL_TRACK, ///< remove signals along a track (by dragging) peter1138@8996: peter1138@8996: CMD_GIVE_MONEY, ///< give money to an other player peter1138@8996: CMD_CHANGE_PATCH_SETTING, ///< change a patch setting peter1138@8996: peter1138@8996: CMD_SET_AUTOREPLACE, ///< set an autoreplace entry peter1138@8996: peter1138@8996: CMD_CLONE_VEHICLE, ///< clone a vehicle peter1138@8996: CMD_MASS_START_STOP, ///< start/stop all vehicles (in a depot) peter1138@8996: CMD_DEPOT_SELL_ALL_VEHICLES, ///< sell all vehicles which are in a given depot peter1138@8996: CMD_DEPOT_MASS_AUTOREPLACE, ///< force the autoreplace to take action in a given depot peter1138@8996: peter1138@8996: CMD_CREATE_GROUP, ///< create a new group peter1138@8996: CMD_DELETE_GROUP, ///< delete a group peter1138@8996: CMD_RENAME_GROUP, ///< rename a group peter1138@8996: CMD_ADD_VEHICLE_GROUP, ///< add a vehicle to a group peter1138@8996: CMD_ADD_SHARED_VEHICLE_GROUP, ///< add all other shared vehicles to a group which are missing peter1138@8996: CMD_REMOVE_ALL_VEHICLES_GROUP, ///< remove all vehicles from a group peter1138@8996: CMD_SET_GROUP_REPLACE_PROTECTION, ///< set the autoreplace-protection for a group peter1138@8996: peter1138@8996: CMD_MOVE_ORDER, ///< move an order peter1138@8996: CMD_CHANGE_TIMETABLE, ///< change the timetable for a vehicle peter1138@8996: CMD_SET_VEHICLE_ON_TIME, ///< set the vehicle on time feature (timetable) peter1138@8996: CMD_AUTOFILL_TIMETABLE, ///< 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 smatz@9015: DC_BANKRUPT = 0x80, ///< company bankrupts, skip money check, skip vehicle on tile check in some cases 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 */