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