1

/* $Id$ */

     2

     3

/** @file command.h */

     4

     5

#ifndef COMMAND_H

     6

#define COMMAND_H

     7

     8

/**

     9

 * List of commands.

    10

 *

    11

 * This enum defines all possible commands which can be executed to the game

    12

 * engine. Observing the game like the query-tool or checking the profit of a

    13

 * vehicle don't result in a command which should be executed in the engine

    14

 * nor send to the server in a network game.

    15

 *

    16

 * @see _command_proc_table

    17

 */

    18

enum {

    19

	CMD_BUILD_RAILROAD_TRACK         =   0, ///< build a rail track

    20

	CMD_REMOVE_RAILROAD_TRACK        =   1, ///< remove a rail track

    21

	CMD_BUILD_SINGLE_RAIL            =   2, ///< build a single rail track

    22

	CMD_REMOVE_SINGLE_RAIL           =   3, ///< remove a single rail track

    23

	CMD_LANDSCAPE_CLEAR              =   4, ///< demolish a tile

    24

	CMD_BUILD_BRIDGE                 =   5, ///< build a bridge

    25

	CMD_BUILD_RAILROAD_STATION       =   6, ///< build a railroad station

    26

	CMD_BUILD_TRAIN_DEPOT            =   7, ///< build a train depot

    27

	CMD_BUILD_SIGNALS                =   8, ///< build a signal

    28

	CMD_REMOVE_SIGNALS               =   9, ///< remove a signal

    29

	CMD_TERRAFORM_LAND               =  10, ///< terraform a tile

    30

	CMD_PURCHASE_LAND_AREA           =  11, ///< purchase a tile

    31

	CMD_SELL_LAND_AREA               =  12, ///< sell a bought tile before

    32

	CMD_BUILD_TUNNEL                 =  13, ///< build a tunnel

    33

    34

	CMD_REMOVE_FROM_RAILROAD_STATION =  14, ///< remove a tile station

    35

	CMD_CONVERT_RAIL                 =  15, ///< convert a rail type

    36

    37

	CMD_BUILD_TRAIN_WAYPOINT         =  16, ///< build a waypoint

    38

	CMD_RENAME_WAYPOINT              =  17, ///< rename a waypoint

    39

	CMD_REMOVE_TRAIN_WAYPOINT        =  18, ///< remove a waypoint

    40

    41

	CMD_BUILD_ROAD_STOP              =  21, ///< build a road stop

    42

	CMD_REMOVE_ROAD_STOP             =  22, ///< remove a road stop

    43

	CMD_BUILD_LONG_ROAD              =  23, ///< build a complete road (not a "half" one)

    44

	CMD_REMOVE_LONG_ROAD             =  24, ///< remove a complete road (not a "half" one)

    45

	CMD_BUILD_ROAD                   =  25, ///< build a "half" road

    46

	CMD_REMOVE_ROAD                  =  26, ///< remove a "half" road

    47

	CMD_BUILD_ROAD_DEPOT             =  27, ///< build a road depot

    48

    49

	CMD_BUILD_AIRPORT                =  29, ///< build an airport

    50

    51

	CMD_BUILD_DOCK                   =  30, ///< build a dock

    52

    53

	CMD_BUILD_SHIP_DEPOT             =  31, ///< build a ship depot

    54

	CMD_BUILD_BUOY                   =  32, ///< build a buoy

    55

    56

	CMD_PLANT_TREE                   =  33, ///< plant a tree

    57

    58

	CMD_BUILD_RAIL_VEHICLE           =  34, ///< build a rail vehicle

    59

	CMD_MOVE_RAIL_VEHICLE            =  35, ///< move a rail vehicle (in the depot)

    60

    61

	CMD_START_STOP_TRAIN             =  36, ///< start or stop a train

    62

    63

	CMD_SELL_RAIL_WAGON              =  38, ///< sell a rail wagon

    64

    65

	CMD_SEND_TRAIN_TO_DEPOT          =  39, ///< send a train to a depot

    66

	CMD_FORCE_TRAIN_PROCEED          =  40, ///< proceed a train to pass a red signal

    67

	CMD_REVERSE_TRAIN_DIRECTION      =  41, ///< turn a train around

    68

    69

	CMD_MODIFY_ORDER                 =  42, ///< modify an order (like set full-load)

    70

	CMD_SKIP_TO_ORDER                =  43, ///< skip an order to the next of specific one

    71

	CMD_DELETE_ORDER                 =  44, ///< delete an order

    72

	CMD_INSERT_ORDER                 =  45, ///< insert a new order

    73

    74

	CMD_CHANGE_SERVICE_INT           =  46, ///< change the server interval of a vehicle

    75

    76

	CMD_BUILD_INDUSTRY               =  47, ///< build a new industry

    77

    78

	CMD_BUILD_COMPANY_HQ             =  48, ///< build the company headquarter

    79

	CMD_SET_PLAYER_FACE              =  49, ///< set the face of the player/company

    80

	CMD_SET_PLAYER_COLOR             =  50, ///< set the color of the player/company

    81

    82

	CMD_INCREASE_LOAN                =  51, ///< increase the loan from the bank

    83

	CMD_DECREASE_LOAN                =  52, ///< decrease the loan from the bank

    84

    85

	CMD_WANT_ENGINE_PREVIEW          =  53, ///< confirm the preview of an engine

    86

    87

	CMD_NAME_VEHICLE                 =  54, ///< rename a whole vehicle

    88

	CMD_RENAME_ENGINE                =  55, ///< rename a engine (in the engine list)

    89

	CMD_CHANGE_COMPANY_NAME          =  56, ///< change the company name

    90

	CMD_CHANGE_PRESIDENT_NAME        =  57, ///< change the president name

    91

	CMD_RENAME_STATION               =  58, ///< rename a station

    92

    93

	CMD_SELL_AIRCRAFT                =  59, ///< sell an aircraft

    94

	CMD_START_STOP_AIRCRAFT          =  60, ///< start/stop an aircraft

    95

	CMD_BUILD_AIRCRAFT               =  61, ///< build an aircraft

    96

	CMD_SEND_AIRCRAFT_TO_HANGAR      =  62, ///< send an aircraft to a hanger

    97

	CMD_REFIT_AIRCRAFT               =  64, ///< refit the cargo space of an aircraft

    98

    99

	CMD_PLACE_SIGN                   =  65, ///< place a sign

   100

	CMD_RENAME_SIGN                  =  66, ///< rename a sign

   101

   102

	CMD_BUILD_ROAD_VEH               =  67, ///< build a road vehicle

   103

	CMD_START_STOP_ROADVEH           =  68, ///< start/stop a road vehicle

   104

	CMD_SELL_ROAD_VEH                =  69, ///< sell a road vehicle

   105

	CMD_SEND_ROADVEH_TO_DEPOT        =  70, ///< send a road vehicle to the depot

   106

	CMD_TURN_ROADVEH                 =  71, ///< turn a road vehicle around

   107

	CMD_REFIT_ROAD_VEH               =  72, ///< refit the cargo space of a road vehicle

   108

   109

	CMD_PAUSE                        =  73, ///< pause the game

   110

   111

	CMD_BUY_SHARE_IN_COMPANY         =  74, ///< buy a share from a company

   112

	CMD_SELL_SHARE_IN_COMPANY        =  75, ///< sell a share from a company

   113

	CMD_BUY_COMPANY                  =  76, ///< buy a company which is bankrupt

   114

   115

	CMD_BUILD_TOWN                   =  77, ///< build a town

   116

   117

	CMD_RENAME_TOWN                  =  80, ///< rename a town

   118

	CMD_DO_TOWN_ACTION               =  81, ///< do a action from the town detail window (like advertises or bribe)

   119

   120

	CMD_SET_ROAD_DRIVE_SIDE          =  82, ///< set the side where the road vehicles drive

   121

   122

	CMD_CHANGE_DIFFICULTY_LEVEL      =  85, ///< change the difficult of a game (each setting for it own)

   123

   124

	CMD_START_STOP_SHIP              =  86, ///< start/stop a ship

   125

	CMD_SELL_SHIP                    =  87, ///< sell a ship

   126

	CMD_BUILD_SHIP                   =  88, ///< build a new ship

   127

	CMD_SEND_SHIP_TO_DEPOT           =  89, ///< send a ship to a depot

   128

	CMD_REFIT_SHIP                   =  91, ///< refit the cargo space of a ship

   129

   130

	CMD_ORDER_REFIT                  =  98, ///< change the refit informaction of an order (for "goto depot" )

   131

	CMD_CLONE_ORDER                  =  99, ///< clone (and share) an order

   132

	CMD_CLEAR_AREA                   = 100, ///< clear an area

   133

   134

	CMD_MONEY_CHEAT                  = 102, ///< do the money cheat

   135

	CMD_BUILD_CANAL                  = 103, ///< build a canal

   136

   137

	CMD_PLAYER_CTRL                  = 104, ///< used in multiplayer to create a new player etc.

   138

	CMD_LEVEL_LAND                   = 105, ///< level land

   139

   140

	CMD_REFIT_RAIL_VEHICLE           = 106, ///< refit the cargo space of a train

   141

	CMD_RESTORE_ORDER_INDEX          = 107, ///< restore vehicle order-index and service interval

   142

	CMD_BUILD_LOCK                   = 108, ///< build a lock

   143

   144

	CMD_BUILD_SIGNAL_TRACK           = 110, ///< add signals along a track (by dragging)

   145

	CMD_REMOVE_SIGNAL_TRACK          = 111, ///< remove signals along a track (by dragging)

   146

   147

	CMD_GIVE_MONEY                   = 113, ///< give money to an other player

   148

	CMD_CHANGE_PATCH_SETTING         = 114, ///< change a patch setting

   149

   150

	CMD_SET_AUTOREPLACE              = 115, ///< set an autoreplace entry

   151

   152

	CMD_CLONE_VEHICLE                = 116, ///< clone a vehicle

   153

	CMD_MASS_START_STOP              = 117, ///< start/stop all vehicles (in a depot)

   154

	CMD_DEPOT_SELL_ALL_VEHICLES      = 118, ///< sell all vehicles which are in a given depot

   155

	CMD_DEPOT_MASS_AUTOREPLACE       = 119, ///< force the autoreplace to take action in a given depot

   156

   157

	CMD_CREATE_GROUP                 = 120, ///< create a new group

   158

	CMD_DELETE_GROUP                 = 121, ///< delete a group

   159

	CMD_RENAME_GROUP                 = 122, ///< rename a group

   160

	CMD_ADD_VEHICLE_GROUP            = 123, ///< add a vehicle to a group

   161

	CMD_ADD_SHARED_VEHICLE_GROUP     = 124, ///< add all other shared vehicles to a group which are missing

   162

	CMD_REMOVE_ALL_VEHICLES_GROUP    = 125, ///< remove all vehicles from a group

   163

	CMD_SET_GROUP_REPLACE_PROTECTION = 126, ///< set the autoreplace-protection for a group

   164

   165

	CMD_MOVE_ORDER                   = 127, ///< move an order

   166

	CMD_CHANGE_TIMETABLE             = 128, ///< change the timetable for a vehicle

   167

	CMD_SET_VEHICLE_ON_TIME          = 129, ///< set the vehicle on time feature (timetable)

   168

	CMD_AUTOFILL_TIMETABLE           = 130, ///< autofill the timetable

   169

};

   170

   171

/**

   172

 * List of flags for a command.

   173

 *

   174

 * This enums defines some flags which can be used for the commands.

   175

 */

   176

enum {

   177

	DC_EXEC            = 0x01, ///< execute the given command

   178

	DC_AUTO            = 0x02, ///< don't allow building on structures

   179

	DC_QUERY_COST      = 0x04, ///< query cost only,  don't build.

   180

	DC_NO_WATER        = 0x08, ///< don't allow building on water

   181

	DC_NO_RAIL_OVERLAP = 0x10, ///< don't allow overlap of rails (used in buildrail)

   182

	DC_AI_BUILDING     = 0x20, ///< special building rules for AI

   183

	DC_NO_TOWN_RATING  = 0x40, ///< town rating does not disallow you from building

   184

	DC_FORCETEST       = 0x80, ///< force test too.

   185

};

   186

   187

/**

   188

 * Used to combine a StringID with the command.

   189

 *

   190

 * This macro can be used to add a StringID (the error message to show) on a command-id

   191

 * (CMD_xxx). Use the binary or-operator "|" to combine the command with the result from

   192

 * this macro.

   193

 *

   194

 * @param x The StringID to combine with a command-id

   195

 */

   196

#define CMD_MSG(x) ((x) << 16)

   197

   198

/**

   199

 * Defines some flags.

   200

 *

   201

 * This enumeration defines some flags which are binary-or'ed on a command.

   202

 */

   203

enum {

   204

	CMD_NO_WATER              = 0x0400, ///< dont build on water

   205

	CMD_NETWORK_COMMAND       = 0x0800, ///< execute the command without sending it on the network

   206

	CMD_NO_TEST_IF_IN_NETWORK = 0x1000, ///< When enabled, the command will bypass the no-DC_EXEC round if in network

   207

	CMD_SHOW_NO_ERROR         = 0x2000, ///< do not show the error message

   208

};

   209

   210

/**

   211

 * Command flags for the command table _command_proc_table.

   212

 *

   213

 * This enumeration defines flags for the _command_proc_table.

   214

 */

   215

enum {

   216

	CMD_SERVER  = 0x1, ///< the command can only be initiated by the server

   217

	CMD_OFFLINE = 0x2, ///< the command cannot be executed in a multiplayer game; single-player only

   218

	CMD_AUTO    = 0x4, ///< set the DC_AUTO flag on this command

   219

};

   220

   221

/**

   222

 * Defines the callback type for all command handler functions.

   223

 *

   224

 * This type defines the function header for all functions which handles a CMD_* command.

   225

 * A command handler use the parameters to act according to the meaning of the command.

   226

 * The tile parameter defines the tile to perform an action on.

   227

 * The flag parameter is filled with flags from the DC_* enumeration. The parameters

   228

 * p1 and p2 are filled with parameters for the command like "which road type", "which

   229

 * order" or "direction". Each function should mentioned in there doxygen comments

   230

 * the usage of these parameters.

   231

 *

   232

 * @param tile The tile to apply a command on

   233

 * @param flags Flags for the command, from the DC_* enumeration

   234

 * @param p1 Additional data for the command

   235

 * @param p2 Additional data for the command

   236

 * @return The CommandCost of the command, which can be succeeded or failed.

   237

 */

   238

typedef CommandCost CommandProc(TileIndex tile, uint32 flags, uint32 p1, uint32 p2);

   239

   240

/**

   241

 * Define a command with the flags which belongs to it.

   242

 *

   243

 * This struct connect a command handler function with the flags created with

   244

 * the #CMD_AUTO, #CMD_OFFLINE and #CMD_SERVER values.

   245

 */

   246

struct Command {

   247

	CommandProc *proc;

   248

	byte flags;

   249

};

   250

   251

/**

   252

 * Checks if a command failes.

   253

 *

   254

 * As you see the parameter is not a command but the return value of a command,

   255

 * the CommandCost class. This function checks if the command executed by

   256

 * the CommandProc function failed and returns true if it does.

   257

 *

   258

 * @param cost The return value of a CommandProc call

   259

 * @return true if the command failes

   260

 * @see CmdSucceded

   261

 */

   262

static inline bool CmdFailed(CommandCost cost) { return cost.Failed(); }

   263

   264

/**

   265

 * Checks if a command succeeded.

   266

 *

   267

 * As #CmdFailed this function checks if a command succeeded

   268

 *

   269

 * @param cost The return value of a CommandProc call

   270

 * @return true if the command succeeded

   271

 * @see CmdSucceeded

   272

 */

   273

static inline bool CmdSucceeded(CommandCost cost) { return cost.Succeeded(); }

   274

   275

/**

   276

 * Define a default return value for a failed command.

   277

 *

   278

 * This variable contains a CommandCost object with is declared as "failed".

   279

 * Other functions just need to return this error if there is an error,

   280

 * which doesn't need to specific by a StringID.

   281

 */

   282

static const CommandCost CMD_ERROR = CommandCost(INVALID_STRING_ID);

   283

   284

/**

   285

 * Returns from a function with a specific StringID as error.

   286

 *

   287

 * This macro is used to return from a function. The parameter contains the

   288

 * StringID which will be returned.

   289

 *

   290

 * @param errcode The StringID to return

   291

 */

   292

#define return_cmd_error(errcode) return CommandCost(errcode);

   293

   294

/* command.cpp */

   295

/**

   296

 * Define a callback function for the client, after the command is finished.

   297

 *

   298

 * Functions of this type are called after the command is finished. The parameters

   299

 * are from the #CommandProc callback type. The boolean parameter indicates if the

   300

 * command succeeded or failed.

   301

 *

   302

 * @param success If the command succeeded or not.

   303

 * @param tile The tile of the command action

   304

 * @param p1 Additional data of the command

   305

 * @param p1 Additional data of the command

   306

 * @see CommandProc

   307

 */

   308

typedef void CommandCallback(bool success, TileIndex tile, uint32 p1, uint32 p2);

   309

   310

/**

   311

 * Execute a command

   312

 */

   313

CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, uint32 flags, uint procc);

   314

   315

/**

   316

 * Execute a network safe DoCommand function

   317

 */

   318

bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, CommandCallback *callback, uint32 cmd, bool my_cmd = true);

   319

   320

#ifdef ENABLE_NETWORK

   321

   322

/**

   323

 * Send a command over the network

   324

 */

   325

void NetworkSend_Command(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback);

   326

#endif /* ENABLE_NETWORK */

   327

   328

/**

   329

 * Text, which gets sent with a command

   330

 *

   331

 * This variable contains a string (be specific a pointer of the first

   332

 * char of this string) which will be send with a command. This is

   333

 * used for user input data like names or chat messages.

   334

 */

   335

extern const char *_cmd_text;

   336

   337

/**

   338

 * Checks if a integer value belongs to a command.

   339

 */

   340

bool IsValidCommand(uint cmd);

   341

/**

   342

 * Returns the flags from a given command.

   343

 */

   344

byte GetCommandFlags(uint cmd);

   345

/**

   346

 * Returns the current money available which can be used for a command.

   347

 */

   348

Money GetAvailableMoneyForCommand();

   349

   350

#endif /* COMMAND_H */