1

/* $Id$ */

     2

     3

/** @file command_type.h Types related to commands. */

     4

     5

#ifndef COMMAND_TYPE_H

     6

#define COMMAND_TYPE_H

     7

     8

#include "economy_type.h"

     9

#include "strings_type.h"

    10

    11

/**

    12

 * Common return value for all commands. Wraps the cost and

    13

 * a possible error message/state together.

    14

 */

    15

class CommandCost {

    16

	Money cost;       ///< The cost of this action

    17

	StringID message; ///< Warning message for when success is unset

    18

	bool success;     ///< Whether the comment went fine up to this moment

    19

    20

public:

    21

	/**

    22

	 * Creates a command cost return with no cost and no error

    23

	 */

    24

	CommandCost() : cost(0), message(INVALID_STRING_ID), success(true) {}

    25

    26

	/**

    27

	 * Creates a command return value the is failed with the given message

    28

	 */

    29

	CommandCost(StringID msg) : cost(0), message(msg), success(false) {}

    30

    31

	/**

    32

	 * Creates a command return value with the given start cost

    33

	 * @param cst the initial cost of this command

    34

	 */

    35

	CommandCost(Money cst) : cost(cst), message(INVALID_STRING_ID), success(true) {}

    36

    37

	/**

    38

	 * Adds the cost of the given command return value to this cost.

    39

	 * Also takes a possible error message when it is set.

    40

	 * @param ret the command to add the cost of.

    41

	 * @return this class.

    42

	 */

    43

	CommandCost AddCost(CommandCost ret);

    44

    45

	/**

    46

	 * Adds the given cost to the cost of the command.

    47

	 * @param cost the cost to add

    48

	 * @return this class.

    49

	 */

    50

	CommandCost AddCost(Money cost);

    51

    52

	/**

    53

	 * Multiplies the cost of the command by the given factor.

    54

	 * @param cost factor to multiply the costs with

    55

	 * @return this class

    56

	 */

    57

	CommandCost MultiplyCost(int factor);

    58

    59

	/**

    60

	 * The costs as made up to this moment

    61

	 * @return the costs

    62

	 */

    63

	Money GetCost() const;

    64

    65

	/**

    66

	 * Sets the global error message *if* this class has one.

    67

	 */

    68

	void SetGlobalErrorMessage() const;

    69

    70

	/**

    71

	 * Did this command succeed?

    72

	 * @return true if and only if it succeeded

    73

	 */

    74

	bool Succeeded() const;

    75

    76

	/**

    77

	 * Did this command fail?

    78

	 * @return true if and only if it failed

    79

	 */

    80

	bool Failed() const;

    81

};

    82

    83

/**

    84

 * List of commands.

    85

 *

    86

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

    87

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

    88

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

    89

 * nor send to the server in a network game.

    90

 *

    91

 * @see _command_proc_table

    92

 */

    93

enum {

    94

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

    95

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

    96

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

    97

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

    98

	CMD_LANDSCAPE_CLEAR              =   4, ///< demolish a tile

    99

	CMD_BUILD_BRIDGE                 =   5, ///< build a bridge

   100

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

   101

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

   102

	CMD_BUILD_SIGNALS                =   8, ///< build a signal

   103

	CMD_REMOVE_SIGNALS               =   9, ///< remove a signal

   104

	CMD_TERRAFORM_LAND               =  10, ///< terraform a tile

   105

	CMD_PURCHASE_LAND_AREA           =  11, ///< purchase a tile

   106

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

   107

	CMD_BUILD_TUNNEL                 =  13, ///< build a tunnel

   108

   109

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

   110

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

   111

   112

	CMD_BUILD_TRAIN_WAYPOINT         =  16, ///< build a waypoint

   113

	CMD_RENAME_WAYPOINT              =  17, ///< rename a waypoint

   114

	CMD_REMOVE_TRAIN_WAYPOINT        =  18, ///< remove a waypoint

   115

   116

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

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

   124

	CMD_BUILD_AIRPORT                =  29, ///< build an airport

   125

   126

	CMD_BUILD_DOCK                   =  30, ///< build a dock

   127

   128

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

   129

	CMD_BUILD_BUOY                   =  32, ///< build a buoy

   130

   131

	CMD_PLANT_TREE                   =  33, ///< plant a tree

   132

   133

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

   134

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

   135

   136

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

   137

   138

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

   139

   140

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

   141

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

   142

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

   143

   144

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

   145

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

   146

	CMD_DELETE_ORDER                 =  44, ///< delete an order

   147

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

   148

   149

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

   150

   151

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

   152

   153

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

   154

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

   155

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

   156

   157

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

   158

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

   159

   160

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

   161

   162

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

   163

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

   164

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

   165

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

   166

	CMD_RENAME_STATION               =  58, ///< rename a station

   167

   168

	CMD_SELL_AIRCRAFT                =  59, ///< sell an aircraft

   169

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

   170

	CMD_BUILD_AIRCRAFT               =  61, ///< build an aircraft

   171

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

   172

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

   173

   174

	CMD_PLACE_SIGN                   =  65, ///< place a sign

   175

	CMD_RENAME_SIGN                  =  66, ///< rename a sign

   176

   177

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

   178

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

   179

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

   180

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

   181

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

   182

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

   183

   184

	CMD_PAUSE                        =  73, ///< pause the game

   185

   186

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

   187

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

   188

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

   189

   190

	CMD_BUILD_TOWN                   =  77, ///< build a town

   191

   192

	CMD_RENAME_TOWN                  =  80, ///< rename a town

   193

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

   194

   195

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

   196

   197

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

   198

   199

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

   200

	CMD_SELL_SHIP                    =  87, ///< sell a ship

   201

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

   202

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

   203

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

   204

   205

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

   206

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

   207

	CMD_CLEAR_AREA                   = 100, ///< clear an area

   208

   209

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

   210

	CMD_BUILD_CANAL                  = 103, ///< build a canal

   211

   212

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

   213

	CMD_LEVEL_LAND                   = 105, ///< level land

   214

   215

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

   216

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

   217

	CMD_BUILD_LOCK                   = 108, ///< build a lock

   218

   219

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

   220

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

   221

   222

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

   223

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

   224

   225

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

   226

   227

	CMD_CLONE_VEHICLE                = 116, ///< clone a vehicle

   228

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

   229

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

   230

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

   231

   232

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

   233

	CMD_DELETE_GROUP                 = 121, ///< delete a group

   234

	CMD_RENAME_GROUP                 = 122, ///< rename a group

   235

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

   236

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

   237

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

   238

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

   239

   240

	CMD_MOVE_ORDER                   = 127, ///< move an order

   241

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

   242

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

   243

	CMD_AUTOFILL_TIMETABLE           = 130, ///< autofill the timetable

   244

};

   245

   246

/**

   247

 * List of flags for a command.

   248

 *

   249

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

   250

 */

   251

enum {

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

};

   261

   262

/**

   263

 * Used to combine a StringID with the command.

   264

 *

   265

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

   266

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

   267

 * this macro.

   268

 *

   269

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

   270

 */

   271

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

   272

   273

/**

   274

 * Defines some flags.

   275

 *

   276

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

   277

 */

   278

enum {

   279

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

   280

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

   281

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

   282

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

   283

};

   284

   285

/**

   286

 * Command flags for the command table _command_proc_table.

   287

 *

   288

 * This enumeration defines flags for the _command_proc_table.

   289

 */

   290

enum {

   291

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

   292

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

   293

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

   294

};

   295

   296

/**

   297

 * Defines the callback type for all command handler functions.

   298

 *

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

 * the usage of these parameters.

   306

 *

   307

 * @param tile The tile to apply a command on

   308

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

   309

 * @param p1 Additional data for the command

   310

 * @param p2 Additional data for the command

   311

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

   312

 */

   313

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

   314

   315

/**

   316

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

   317

 *

   318

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

   319

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

   320

 */

   321

struct Command {

   322

	CommandProc *proc;

   323

	byte flags;

   324

};

   325

   326

/**

   327

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

   328

 *

   329

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

   330

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

   331

 * command succeeded or failed.

   332

 *

   333

 * @param success If the command succeeded or not.

   334

 * @param tile The tile of the command action

   335

 * @param p1 Additional data of the command

   336

 * @param p1 Additional data of the command

   337

 * @see CommandProc

   338

 */

   339

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

   340

   341

#endif /* COMMAND_TYPE_H */