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

#include "tile_type.h"

    11

    12

/**

    13

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

    14

 * a possible error message/state together.

    15

 */

    16

class CommandCost {

    17

	ExpensesType expense_type; ///< the type of expence as shown on the finances view

    18

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

    19

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

    20

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

    21

    22

public:

    23

	/**

    24

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

    25

	 */

    26

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

    27

    28

	/**

    29

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

    30

	 */

    31

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

    32

    33

	/**

    34

	 * Creates a command cost with given expense type and start cost of 0

    35

	 * @param ex_t the expense type

    36

	 */

    37

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

    38

    39

	/**

    40

	 * Creates a command return value with the given start cost and expense type

    41

	 * @param ex_t the expense type

    42

	 * @param cst the initial cost of this command

    43

	 */

    44

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

    45

    46

	/**

    47

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

    48

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

    49

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

    50

	 * @return this class.

    51

	 */

    52

	CommandCost AddCost(CommandCost ret);

    53

    54

	/**

    55

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

    56

	 * @param cost the cost to add

    57

	 * @return this class.

    58

	 */

    59

	CommandCost AddCost(Money cost);

    60

    61

	/**

    62

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

    63

	 * @param cost factor to multiply the costs with

    64

	 * @return this class

    65

	 */

    66

	CommandCost MultiplyCost(int factor);

    67

    68

	/**

    69

	 * The costs as made up to this moment

    70

	 * @return the costs

    71

	 */

    72

	Money GetCost() const;

    73

    74

	/**

    75

	 * The expense type of the cost

    76

	 * @return the expense type

    77

	 */

    78

	ExpensesType GetExpensesType() const;

    79

    80

	/**

    81

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

    82

	 */

    83

	void SetGlobalErrorMessage() const;

    84

    85

	/**

    86

	 * Did this command succeed?

    87

	 * @return true if and only if it succeeded

    88

	 */

    89

	bool Succeeded() const;

    90

    91

	/**

    92

	 * Did this command fail?

    93

	 * @return true if and only if it failed

    94

	 */

    95

	bool Failed() const;

    96

};

    97

    98

/**

    99

 * List of commands.

   100

 *

   101

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

   102

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

   103

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

   104

 * nor send to the server in a network game.

   105

 *

   106

 * @see _command_proc_table

   107

 */

   108

enum {

   109

	CMD_BUILD_RAILROAD_TRACK,         ///< build a rail track

   110

	CMD_REMOVE_RAILROAD_TRACK,        ///< remove a rail track

   111

	CMD_BUILD_SINGLE_RAIL,            ///< build a single rail track

   112

	CMD_REMOVE_SINGLE_RAIL,           ///< remove a single rail track

   113

	CMD_LANDSCAPE_CLEAR,              ///< demolish a tile

   114

	CMD_BUILD_BRIDGE,                 ///< build a bridge

   115

	CMD_BUILD_RAILROAD_STATION,       ///< build a railroad station

   116

	CMD_BUILD_TRAIN_DEPOT,            ///< build a train depot

   117

	CMD_BUILD_SIGNALS,                ///< build a signal

   118

	CMD_REMOVE_SIGNALS,               ///< remove a signal

   119

	CMD_TERRAFORM_LAND,               ///< terraform a tile

   120

	CMD_PURCHASE_LAND_AREA,           ///< purchase a tile

   121

	CMD_SELL_LAND_AREA,               ///< sell a bought tile before

   122

	CMD_BUILD_TUNNEL,                 ///< build a tunnel

   123

   124

	CMD_REMOVE_FROM_RAILROAD_STATION, ///< remove a tile station

   125

	CMD_CONVERT_RAIL,                 ///< convert a rail type

   126

   127

	CMD_BUILD_TRAIN_WAYPOINT,         ///< build a waypoint

   128

	CMD_RENAME_WAYPOINT,              ///< rename a waypoint

   129

	CMD_REMOVE_TRAIN_WAYPOINT,        ///< remove a waypoint

   130

   131

	CMD_BUILD_ROAD_STOP,              ///< build a road stop

   132

	CMD_REMOVE_ROAD_STOP,             ///< remove a road stop

   133

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

   134

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

   135

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

   136

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

   137

	CMD_BUILD_ROAD_DEPOT,             ///< build a road depot

   138

   139

	CMD_BUILD_AIRPORT,                ///< build an airport

   140

   141

	CMD_BUILD_DOCK,                   ///< build a dock

   142

   143

	CMD_BUILD_SHIP_DEPOT,             ///< build a ship depot

   144

	CMD_BUILD_BUOY,                   ///< build a buoy

   145

   146

	CMD_PLANT_TREE,                   ///< plant a tree

   147

   148

	CMD_BUILD_RAIL_VEHICLE,           ///< build a rail vehicle

   149

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

   150

   151

	CMD_START_STOP_TRAIN,             ///< start or stop a train

   152

   153

	CMD_SELL_RAIL_WAGON,              ///< sell a rail wagon

   154

   155

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

   156

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

   157

	CMD_REVERSE_TRAIN_DIRECTION,      ///< turn a train around

   158

   159

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

   160

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

   161

	CMD_DELETE_ORDER,                 ///< delete an order

   162

	CMD_INSERT_ORDER,                 ///< insert a new order

   163

   164

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

   165

   166

	CMD_BUILD_INDUSTRY,               ///< build a new industry

   167

   168

	CMD_BUILD_COMPANY_HQ,             ///< build the company headquarter

   169

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

   170

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

   171

   172

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

   173

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

   174

   175

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

   176

   177

	CMD_NAME_VEHICLE,                 ///< rename a whole vehicle

   178

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

   179

	CMD_CHANGE_COMPANY_NAME,          ///< change the company name

   180

	CMD_CHANGE_PRESIDENT_NAME,        ///< change the president name

   181

	CMD_RENAME_STATION,               ///< rename a station

   182

   183

	CMD_SELL_AIRCRAFT,                ///< sell an aircraft

   184

	CMD_START_STOP_AIRCRAFT,          ///< start/stop an aircraft

   185

	CMD_BUILD_AIRCRAFT,               ///< build an aircraft

   186

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

   187

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

   188

   189

	CMD_PLACE_SIGN,                   ///< place a sign

   190

	CMD_RENAME_SIGN,                  ///< rename a sign

   191

   192

	CMD_BUILD_ROAD_VEH,               ///< build a road vehicle

   193

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

   194

	CMD_SELL_ROAD_VEH,                ///< sell a road vehicle

   195

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

   196

	CMD_TURN_ROADVEH,                 ///< turn a road vehicle around

   197

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

   198

   199

	CMD_PAUSE,                        ///< pause the game

   200

   201

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

   202

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

   203

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

   204

   205

	CMD_BUILD_TOWN,                   ///< build a town

   206

   207

	CMD_RENAME_TOWN,                  ///< rename a town

   208

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

   209

   210

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

   211

   212

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

   213

   214

	CMD_START_STOP_SHIP,              ///< start/stop a ship

   215

	CMD_SELL_SHIP,                    ///< sell a ship

   216

	CMD_BUILD_SHIP,                   ///< build a new ship

   217

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

   218

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

   219

   220

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

   221

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

   222

	CMD_CLEAR_AREA,                   ///< clear an area

   223

   224

	CMD_MONEY_CHEAT,                  ///< do the money cheat

   225

	CMD_BUILD_CANAL,                  ///< build a canal

   226

   227

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

   228

	CMD_LEVEL_LAND,                   ///< level land

   229

   230

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

   231

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

   232

	CMD_BUILD_LOCK,                   ///< build a lock

   233

   234

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

   235

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

   236

   237

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

   238

	CMD_CHANGE_PATCH_SETTING,         ///< change a patch setting

   239

   240

	CMD_SET_AUTOREPLACE,              ///< set an autoreplace entry

   241

   242

	CMD_CLONE_VEHICLE,                ///< clone a vehicle

   243

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

   244

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

   245

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

   246

   247

	CMD_CREATE_GROUP,                 ///< create a new group

   248

	CMD_DELETE_GROUP,                 ///< delete a group

   249

	CMD_RENAME_GROUP,                 ///< rename a group

   250

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

   251

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

   252

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

   253

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

   254

   255

	CMD_MOVE_ORDER,                   ///< move an order

   256

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

   257

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

   258

	CMD_AUTOFILL_TIMETABLE,           ///< autofill the timetable

   259

};

   260

   261

/**

   262

 * List of flags for a command.

   263

 *

   264

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

   265

 */

   266

enum {

   267

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

   268

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

   269

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

   270

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

   271

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

   272

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

   273

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

   274

	DC_BANKRUPT        = 0x80, ///< company bankrupts, skip money check, skip vehicle on tile check in some cases

   275

};

   276

   277

/**

   278

 * Used to combine a StringID with the command.

   279

 *

   280

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

   281

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

   282

 * this macro.

   283

 *

   284

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

   285

 */

   286

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

   287

   288

/**

   289

 * Defines some flags.

   290

 *

   291

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

   292

 */

   293

enum {

   294

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

   295

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

   296

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

   297

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

   298

};

   299

   300

/**

   301

 * Command flags for the command table _command_proc_table.

   302

 *

   303

 * This enumeration defines flags for the _command_proc_table.

   304

 */

   305

enum {

   306

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

   307

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

   308

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

   309

};

   310

   311

/**

   312

 * Defines the callback type for all command handler functions.

   313

 *

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

 * the usage of these parameters.

   321

 *

   322

 * @param tile The tile to apply a command on

   323

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

   324

 * @param p1 Additional data for the command

   325

 * @param p2 Additional data for the command

   326

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

   327

 */

   328

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

   329

   330

/**

   331

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

   332

 *

   333

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

   334

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

   335

 */

   336

struct Command {

   337

	CommandProc *proc;

   338

	byte flags;

   339

};

   340

   341

/**

   342

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

   343

 *

   344

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

   345

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

   346

 * command succeeded or failed.

   347

 *

   348

 * @param success If the command succeeded or not.

   349

 * @param tile The tile of the command action

   350

 * @param p1 Additional data of the command

   351

 * @param p1 Additional data of the command

   352

 * @see CommandProc

   353

 */

   354

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

   355

   356

#endif /* COMMAND_TYPE_H */