1

/* $Id$ */

     2

     3

/** @file command.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "landscape.h"

     9

#include "tile_map.h"

    10

#include "gui.h"

    11

#include "command_func.h"

    12

#include "player.h"

    13

#include "network/network.h"

    14

#include "variables.h"

    15

#include "genworld.h"

    16

#include "newgrf_storage.h"

    17

#include "strings_func.h"

    18

#include "gfx_func.h"

    19

#include "functions.h"

    21

    22

const char *_cmd_text = NULL;

    23

    24

/**

    25

 * Helper macro to define the header of all command handler macros.

    26

 *

    27

 * This macro create the function header for a given command handler function, as

    28

 * all command handler functions got the parameters from the #CommandProc callback

    29

 * type.

    30

 *

    31

 * @param yyyy The desired function name of the new command handler function.

    32

 */

    33

#define DEF_COMMAND(yyyy) CommandCost yyyy(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

    34

    35

DEF_COMMAND(CmdBuildRailroadTrack);

    36

DEF_COMMAND(CmdRemoveRailroadTrack);

    37

DEF_COMMAND(CmdBuildSingleRail);

    38

DEF_COMMAND(CmdRemoveSingleRail);

    39

    40

DEF_COMMAND(CmdLandscapeClear);

    41

    42

DEF_COMMAND(CmdBuildBridge);

    43

    44

DEF_COMMAND(CmdBuildRailroadStation);

    45

DEF_COMMAND(CmdRemoveFromRailroadStation);

    46

DEF_COMMAND(CmdConvertRail);

    47

    48

DEF_COMMAND(CmdBuildSingleSignal);

    49

DEF_COMMAND(CmdRemoveSingleSignal);

    50

    51

DEF_COMMAND(CmdTerraformLand);

    52

    53

DEF_COMMAND(CmdPurchaseLandArea);

    54

DEF_COMMAND(CmdSellLandArea);

    55

    56

DEF_COMMAND(CmdBuildTunnel);

    57

    58

DEF_COMMAND(CmdBuildTrainDepot);

    59

DEF_COMMAND(CmdBuildTrainWaypoint);

    60

DEF_COMMAND(CmdRenameWaypoint);

    61

DEF_COMMAND(CmdRemoveTrainWaypoint);

    62

    63

DEF_COMMAND(CmdBuildRoadStop);

    64

DEF_COMMAND(CmdRemoveRoadStop);

    65

    66

DEF_COMMAND(CmdBuildLongRoad);

    67

DEF_COMMAND(CmdRemoveLongRoad);

    68

DEF_COMMAND(CmdBuildRoad);

    69

DEF_COMMAND(CmdRemoveRoad);

    70

    71

DEF_COMMAND(CmdBuildRoadDepot);

    72

    73

DEF_COMMAND(CmdBuildAirport);

    74

    75

DEF_COMMAND(CmdBuildDock);

    76

    77

DEF_COMMAND(CmdBuildShipDepot);

    78

    79

DEF_COMMAND(CmdBuildBuoy);

    80

    81

DEF_COMMAND(CmdPlantTree);

    82

    83

DEF_COMMAND(CmdBuildRailVehicle);

    84

DEF_COMMAND(CmdMoveRailVehicle);

    85

    86

DEF_COMMAND(CmdStartStopTrain);

    87

    88

DEF_COMMAND(CmdSellRailWagon);

    89

    90

DEF_COMMAND(CmdSendTrainToDepot);

    91

DEF_COMMAND(CmdForceTrainProceed);

    92

DEF_COMMAND(CmdReverseTrainDirection);

    93

    94

DEF_COMMAND(CmdModifyOrder);

    95

DEF_COMMAND(CmdSkipToOrder);

    96

DEF_COMMAND(CmdDeleteOrder);

    97

DEF_COMMAND(CmdInsertOrder);

    98

DEF_COMMAND(CmdChangeServiceInt);

    99

DEF_COMMAND(CmdRestoreOrderIndex);

   100

   101

DEF_COMMAND(CmdBuildIndustry);

   102

   103

DEF_COMMAND(CmdBuildCompanyHQ);

   104

DEF_COMMAND(CmdSetPlayerFace);

   105

DEF_COMMAND(CmdSetPlayerColor);

   106

   107

DEF_COMMAND(CmdIncreaseLoan);

   108

DEF_COMMAND(CmdDecreaseLoan);

   109

   110

DEF_COMMAND(CmdWantEnginePreview);

   111

   112

DEF_COMMAND(CmdNameVehicle);

   113

DEF_COMMAND(CmdRenameEngine);

   114

   115

DEF_COMMAND(CmdChangeCompanyName);

   116

DEF_COMMAND(CmdChangePresidentName);

   117

   118

DEF_COMMAND(CmdRenameStation);

   119

   120

DEF_COMMAND(CmdSellAircraft);

   121

DEF_COMMAND(CmdStartStopAircraft);

   122

DEF_COMMAND(CmdBuildAircraft);

   123

DEF_COMMAND(CmdSendAircraftToHangar);

   124

DEF_COMMAND(CmdRefitAircraft);

   125

   126

DEF_COMMAND(CmdPlaceSign);

   127

DEF_COMMAND(CmdRenameSign);

   128

   129

DEF_COMMAND(CmdBuildRoadVeh);

   130

DEF_COMMAND(CmdStartStopRoadVeh);

   131

DEF_COMMAND(CmdSellRoadVeh);

   132

DEF_COMMAND(CmdSendRoadVehToDepot);

   133

DEF_COMMAND(CmdTurnRoadVeh);

   134

DEF_COMMAND(CmdRefitRoadVeh);

   135

   136

DEF_COMMAND(CmdPause);

   137

   138

DEF_COMMAND(CmdBuyShareInCompany);

   139

DEF_COMMAND(CmdSellShareInCompany);

   140

DEF_COMMAND(CmdBuyCompany);

   141

   142

DEF_COMMAND(CmdBuildTown);

   143

   144

DEF_COMMAND(CmdRenameTown);

   145

DEF_COMMAND(CmdDoTownAction);

   146

   147

DEF_COMMAND(CmdSetRoadDriveSide);

   148

   149

DEF_COMMAND(CmdChangeDifficultyLevel);

   150

DEF_COMMAND(CmdChangePatchSetting);

   151

   152

DEF_COMMAND(CmdStartStopShip);

   153

DEF_COMMAND(CmdSellShip);

   154

DEF_COMMAND(CmdBuildShip);

   155

DEF_COMMAND(CmdSendShipToDepot);

   156

DEF_COMMAND(CmdRefitShip);

   157

   158

DEF_COMMAND(CmdOrderRefit);

   159

DEF_COMMAND(CmdCloneOrder);

   160

   161

DEF_COMMAND(CmdClearArea);

   162

   163

DEF_COMMAND(CmdGiveMoney);

   164

DEF_COMMAND(CmdMoneyCheat);

   165

DEF_COMMAND(CmdBuildCanal);

   166

DEF_COMMAND(CmdBuildLock);

   167

   168

DEF_COMMAND(CmdPlayerCtrl);

   169

   170

DEF_COMMAND(CmdLevelLand);

   171

   172

DEF_COMMAND(CmdRefitRailVehicle);

   173

   174

DEF_COMMAND(CmdBuildSignalTrack);

   175

DEF_COMMAND(CmdRemoveSignalTrack);

   176

   177

DEF_COMMAND(CmdSetAutoReplace);

   178

   179

DEF_COMMAND(CmdCloneVehicle);

   180

DEF_COMMAND(CmdMassStartStopVehicle);

   181

DEF_COMMAND(CmdDepotSellAllVehicles);

   182

DEF_COMMAND(CmdDepotMassAutoReplace);

   183

   184

DEF_COMMAND(CmdCreateGroup);

   185

DEF_COMMAND(CmdRenameGroup);

   186

DEF_COMMAND(CmdDeleteGroup);

   187

DEF_COMMAND(CmdAddVehicleGroup);

   188

DEF_COMMAND(CmdAddSharedVehicleGroup);

   189

DEF_COMMAND(CmdRemoveAllVehiclesGroup);

   190

DEF_COMMAND(CmdSetGroupReplaceProtection);

   191

   192

DEF_COMMAND(CmdMoveOrder);

   193

DEF_COMMAND(CmdChangeTimetable);

   194

DEF_COMMAND(CmdSetVehicleOnTime);

   195

DEF_COMMAND(CmdAutofillTimetable);

   196

#undef DEF_COMMAND

   197

   198

/**

   199

 * The master command table

   200

 *

   201

 * This table contains all possible CommandProc functions with

   202

 * the flags which belongs to it. The indizes are the same

   203

 * as the value from the CMD_* enums.

   204

 */

   205

static const Command _command_proc_table[] = {

   206

	{CmdBuildRailroadTrack,           CMD_AUTO}, /*   0, CMD_BUILD_RAILROAD_TRACK */

   207

	{CmdRemoveRailroadTrack,          CMD_AUTO}, /*   1, CMD_REMOVE_RAILROAD_TRACK */

   208

	{CmdBuildSingleRail,              CMD_AUTO}, /*   2, CMD_BUILD_SINGLE_RAIL */

   209

	{CmdRemoveSingleRail,             CMD_AUTO}, /*   3, CMD_REMOVE_SINGLE_RAIL */

   210

	{CmdLandscapeClear,                      0}, /*   4, CMD_LANDSCAPE_CLEAR */

   211

	{CmdBuildBridge,                  CMD_AUTO}, /*   5, CMD_BUILD_BRIDGE */

   212

	{CmdBuildRailroadStation,         CMD_AUTO}, /*   6, CMD_BUILD_RAILROAD_STATION */

   213

	{CmdBuildTrainDepot,              CMD_AUTO}, /*   7, CMD_BUILD_TRAIN_DEPOT */

   214

	{CmdBuildSingleSignal,            CMD_AUTO}, /*   8, CMD_BUILD_SIGNALS */

   215

	{CmdRemoveSingleSignal,           CMD_AUTO}, /*   9, CMD_REMOVE_SIGNALS */

   216

	{CmdTerraformLand,                CMD_AUTO}, /*  10, CMD_TERRAFORM_LAND */

   217

	{CmdPurchaseLandArea,             CMD_AUTO}, /*  11, CMD_PURCHASE_LAND_AREA */

   218

	{CmdSellLandArea,                        0}, /*  12, CMD_SELL_LAND_AREA */

   219

	{CmdBuildTunnel,                  CMD_AUTO}, /*  13, CMD_BUILD_TUNNEL */

   220

	{CmdRemoveFromRailroadStation,           0}, /*  14, CMD_REMOVE_FROM_RAILROAD_STATION */

   221

	{CmdConvertRail,                         0}, /*  15, CMD_CONVERT_RAILD */

   222

	{CmdBuildTrainWaypoint,                  0}, /*  16, CMD_BUILD_TRAIN_WAYPOINT */

   223

	{CmdRenameWaypoint,                      0}, /*  17, CMD_RENAME_WAYPOINT */

   224

	{CmdRemoveTrainWaypoint,                 0}, /*  18, CMD_REMOVE_TRAIN_WAYPOINT */

   225

	{NULL,                                   0}, /*  19, unused */

   226

	{NULL,                                   0}, /*  20, unused */

   227

	{CmdBuildRoadStop,                CMD_AUTO}, /*  21, CMD_BUILD_ROAD_STOP */

   228

	{CmdRemoveRoadStop,                      0}, /*  22, CMD_REMOVE_ROAD_STOP */

   229

	{CmdBuildLongRoad,                CMD_AUTO}, /*  23, CMD_BUILD_LONG_ROAD */

   230

	{CmdRemoveLongRoad,               CMD_AUTO}, /*  24, CMD_REMOVE_LONG_ROAD */

   231

	{CmdBuildRoad,                           0}, /*  25, CMD_BUILD_ROAD */

   232

	{CmdRemoveRoad,                          0}, /*  26, CMD_REMOVE_ROAD */

   233

	{CmdBuildRoadDepot,               CMD_AUTO}, /*  27, CMD_BUILD_ROAD_DEPOT */

   234

	{NULL,                                   0}, /*  28, unused */

   235

	{CmdBuildAirport,                 CMD_AUTO}, /*  29, CMD_BUILD_AIRPORT */

   236

	{CmdBuildDock,                    CMD_AUTO}, /*  30, CMD_BUILD_DOCK */

   237

	{CmdBuildShipDepot,               CMD_AUTO}, /*  31, CMD_BUILD_SHIP_DEPOT */

   238

	{CmdBuildBuoy,                    CMD_AUTO}, /*  32, CMD_BUILD_BUOY */

   239

	{CmdPlantTree,                    CMD_AUTO}, /*  33, CMD_PLANT_TREE */

   240

	{CmdBuildRailVehicle,                    0}, /*  34, CMD_BUILD_RAIL_VEHICLE */

   241

	{CmdMoveRailVehicle,                     0}, /*  35, CMD_MOVE_RAIL_VEHICLE */

   242

	{CmdStartStopTrain,                      0}, /*  36, CMD_START_STOP_TRAIN */

   243

	{NULL,                                   0}, /*  37, unused */

   244

	{CmdSellRailWagon,                       0}, /*  38, CMD_SELL_RAIL_WAGON */

   245

	{CmdSendTrainToDepot,                    0}, /*  39, CMD_SEND_TRAIN_TO_DEPOT */

   246

	{CmdForceTrainProceed,                   0}, /*  40, CMD_FORCE_TRAIN_PROCEED */

   247

	{CmdReverseTrainDirection,               0}, /*  41, CMD_REVERSE_TRAIN_DIRECTION */

   248

   249

	{CmdModifyOrder,                         0}, /*  42, CMD_MODIFY_ORDER */

   250

	{CmdSkipToOrder,                         0}, /*  43, CMD_SKIP_TO_ORDER */

   251

	{CmdDeleteOrder,                         0}, /*  44, CMD_DELETE_ORDER */

   252

	{CmdInsertOrder,                         0}, /*  45, CMD_INSERT_ORDER */

   253

   254

	{CmdChangeServiceInt,                    0}, /*  46, CMD_CHANGE_SERVICE_INT */

   255

   256

	{CmdBuildIndustry,                       0}, /*  47, CMD_BUILD_INDUSTRY */

   257

	{CmdBuildCompanyHQ,               CMD_AUTO}, /*  48, CMD_BUILD_COMPANY_HQ */

   258

	{CmdSetPlayerFace,                       0}, /*  49, CMD_SET_PLAYER_FACE */

   259

	{CmdSetPlayerColor,                      0}, /*  50, CMD_SET_PLAYER_COLOR */

   260

   261

	{CmdIncreaseLoan,                        0}, /*  51, CMD_INCREASE_LOAN */

   262

	{CmdDecreaseLoan,                        0}, /*  52, CMD_DECREASE_LOAN */

   263

   264

	{CmdWantEnginePreview,                   0}, /*  53, CMD_WANT_ENGINE_PREVIEW */

   265

   266

	{CmdNameVehicle,                         0}, /*  54, CMD_NAME_VEHICLE */

   267

	{CmdRenameEngine,                        0}, /*  55, CMD_RENAME_ENGINE */

   268

   269

	{CmdChangeCompanyName,                   0}, /*  56, CMD_CHANGE_COMPANY_NAME */

   270

	{CmdChangePresidentName,                 0}, /*  57, CMD_CHANGE_PRESIDENT_NAME */

   271

   272

	{CmdRenameStation,                       0}, /*  58, CMD_RENAME_STATION */

   273

   274

	{CmdSellAircraft,                        0}, /*  59, CMD_SELL_AIRCRAFT */

   275

	{CmdStartStopAircraft,                   0}, /*  60, CMD_START_STOP_AIRCRAFT */

   276

   277

	{CmdBuildAircraft,                       0}, /*  61, CMD_BUILD_AIRCRAFT */

   278

	{CmdSendAircraftToHangar,                0}, /*  62, CMD_SEND_AIRCRAFT_TO_HANGAR */

   279

	{NULL,                                   0}, /*  63, unused */

   280

	{CmdRefitAircraft,                       0}, /*  64, CMD_REFIT_AIRCRAFT */

   281

   282

	{CmdPlaceSign,                           0}, /*  65, CMD_PLACE_SIGN */

   283

	{CmdRenameSign,                          0}, /*  66, CMD_RENAME_SIGN */

   284

   285

	{CmdBuildRoadVeh,                        0}, /*  67, CMD_BUILD_ROAD_VEH */

   286

	{CmdStartStopRoadVeh,                    0}, /*  68, CMD_START_STOP_ROADVEH */

   287

	{CmdSellRoadVeh,                         0}, /*  69, CMD_SELL_ROAD_VEH */

   288

	{CmdSendRoadVehToDepot,                  0}, /*  70, CMD_SEND_ROADVEH_TO_DEPOT */

   289

	{CmdTurnRoadVeh,                         0}, /*  71, CMD_TURN_ROADVEH */

   290

	{CmdRefitRoadVeh,                        0}, /*  72, CMD_REFIT_ROAD_VEH */

   291

   292

	{CmdPause,                      CMD_SERVER}, /*  73, CMD_PAUSE */

   293

   294

	{CmdBuyShareInCompany,                   0}, /*  74, CMD_BUY_SHARE_IN_COMPANY */

   295

	{CmdSellShareInCompany,                  0}, /*  75, CMD_SELL_SHARE_IN_COMPANY */

   296

	{CmdBuyCompany,                          0}, /*  76, CMD_BUY_COMANY */

   297

   298

	{CmdBuildTown,                 CMD_OFFLINE}, /*  77, CMD_BUILD_TOWN */

   299

	{NULL,                                   0}, /*  78, unused */

   300

	{NULL,                                   0}, /*  79, unused */

   301

	{CmdRenameTown,                 CMD_SERVER}, /*  80, CMD_RENAME_TOWN */

   302

	{CmdDoTownAction,                        0}, /*  81, CMD_DO_TOWN_ACTION */

   303

   304

	{CmdSetRoadDriveSide,           CMD_SERVER}, /*  82, CMD_SET_ROAD_DRIVE_SIDE */

   305

	{NULL,                                   0}, /*  83, unused */

   306

	{NULL,                                   0}, /*  84, unused */

   307

	{CmdChangeDifficultyLevel,      CMD_SERVER}, /*  85, CMD_CHANGE_DIFFICULTY_LEVEL */

   308

   309

	{CmdStartStopShip,                       0}, /*  86, CMD_START_STOP_SHIP */

   310

	{CmdSellShip,                            0}, /*  87, CMD_SELL_SHIP */

   311

	{CmdBuildShip,                           0}, /*  88, CMD_BUILD_SHIP */

   312

	{CmdSendShipToDepot,                     0}, /*  89, CMD_SEND_SHIP_TO_DEPOT */

   313

	{NULL,                                   0}, /*  90, unused */

   314

	{CmdRefitShip,                           0}, /*  91, CMD_REFIT_SHIP */

   315

   316

	{NULL,                                   0}, /*  92, unused */

   317

	{NULL,                                   0}, /*  93, unused */

   318

	{NULL,                                   0}, /*  94, unused */

   319

	{NULL,                                   0}, /*  95, unused */

   320

	{NULL,                                   0}, /*  96, unused */

   321

	{NULL,                                   0}, /*  97, unused */

   322

   323

	{CmdOrderRefit,                          0}, /*  98, CMD_ORDER_REFIT */

   324

	{CmdCloneOrder,                          0}, /*  99, CMD_CLONE_ORDER */

   325

   326

	{CmdClearArea,                           0}, /* 100, CMD_CLEAR_AREA */

   327

	{NULL,                                   0}, /* 101, unused */

   328

   329

	{CmdMoneyCheat,                CMD_OFFLINE}, /* 102, CMD_MONEY_CHEAT */

   330

	{CmdBuildCanal,                   CMD_AUTO}, /* 103, CMD_BUILD_CANAL */

   331

	{CmdPlayerCtrl,                          0}, /* 104, CMD_PLAYER_CTRL */

   332

   333

	{CmdLevelLand,                    CMD_AUTO}, /* 105, CMD_LEVEL_LAND */

   334

   335

	{CmdRefitRailVehicle,                    0}, /* 106, CMD_REFIT_RAIL_VEHICLE */

   336

	{CmdRestoreOrderIndex,                   0}, /* 107, CMD_RESTORE_ORDER_INDEX */

   337

	{CmdBuildLock,                    CMD_AUTO}, /* 108, CMD_BUILD_LOCK */

   338

	{NULL,                                   0}, /* 109, unused */

   339

	{CmdBuildSignalTrack,             CMD_AUTO}, /* 110, CMD_BUILD_SIGNAL_TRACK */

   340

	{CmdRemoveSignalTrack,            CMD_AUTO}, /* 111, CMD_REMOVE_SIGNAL_TRACK */

   341

	{NULL,                                   0}, /* 112, unused */

   342

	{CmdGiveMoney,                           0}, /* 113, CMD_GIVE_MONEY */

   343

	{CmdChangePatchSetting,         CMD_SERVER}, /* 114, CMD_CHANGE_PATCH_SETTING */

   344

	{CmdSetAutoReplace,                      0}, /* 115, CMD_SET_AUTOREPLACE */

   345

	{CmdCloneVehicle,                        0}, /* 116, CMD_CLONE_VEHICLE */

   346

	{CmdMassStartStopVehicle,                0}, /* 117, CMD_MASS_START_STOP */

   347

	{CmdDepotSellAllVehicles,                0}, /* 118, CMD_DEPOT_SELL_ALL_VEHICLES */

   348

	{CmdDepotMassAutoReplace,                0}, /* 119, CMD_DEPOT_MASS_AUTOREPLACE */

   349

	{CmdCreateGroup,                         0}, /* 120, CMD_CREATE_GROUP */

   350

	{CmdDeleteGroup,                         0}, /* 121, CMD_DELETE_GROUP */

   351

	{CmdRenameGroup,                         0}, /* 122, CMD_RENAME_GROUP */

   352

	{CmdAddVehicleGroup,                     0}, /* 123, CMD_ADD_VEHICLE_GROUP */

   353

	{CmdAddSharedVehicleGroup,               0}, /* 124, CMD_ADD_SHARE_VEHICLE_GROUP */

   354

	{CmdRemoveAllVehiclesGroup,              0}, /* 125, CMD_REMOVE_ALL_VEHICLES_GROUP */

   355

	{CmdSetGroupReplaceProtection,           0}, /* 126, CMD_SET_GROUP_REPLACE_PROTECTION */

   356

	{CmdMoveOrder,                           0}, /* 127, CMD_MOVE_ORDER */

   357

	{CmdChangeTimetable,                     0}, /* 128, CMD_CHANGE_TIMETABLE */

   358

	{CmdSetVehicleOnTime,                    0}, /* 129, CMD_SET_VEHICLE_ON_TIME */

   359

	{CmdAutofillTimetable,                   0}, /* 130, CMD_AUTOFILL_TIMETABLE */

   360

};

   361

   362

/*!

   363

 * This function range-checks a cmd, and checks if the cmd is not NULL

   364

 *

   365

 * @param cmd The integervalue of a command

   366

 * @return true if the command is valid (and got a CommandProc function)

   367

 */

   368

bool IsValidCommand(uint cmd)

   369

{

   370

	cmd &= 0xFF;

   371

   372

	return

   373

		cmd < lengthof(_command_proc_table) &&

   374

		_command_proc_table[cmd].proc != NULL;

   375

}

   376

   377

/*!

   378

 * This function mask the parameter with 0xFF and returns

   379

 * the flags which belongs to the given command.

   380

 *

   381

 * @param cmd The integer value of the command

   382

 * @return The flags for this command

   383

 * @bug integervalues which are less equals 0xFF and greater than the

   384

 *      size of _command_proc_table can result in an index out of bounce

   385

 *      error (which doesn't happend anyway). Check function #IsValidCommand(). (Progman)

   386

 */

   387

byte GetCommandFlags(uint cmd)

   388

{

   389

	return _command_proc_table[cmd & 0xFF].flags;

   390

}

   391

   393

   394

/*!

   395

 * This function executes a given command with the parameters from the #CommandProc parameter list.

   396

 * Depending on the flags parameter it execute or test a command.

   397

 *

   398

 * @param tile The tile to apply the command on (for the #CommandProc)

   399

 * @param p1 Additional data for the command (for the #CommandProc)

   400

 * @param p2 Additional data for the command (for the #CommandProc)

   401

 * @param flags Flags for the command and how to execute the command

   402

 * @param procc The command-id to execute (a value of the CMD_* enums)

   403

 * @see CommandProc

   404

 */

   405

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

   406

{

   407

	CommandCost res;

   408

	CommandProc *proc;

   409

   410

	/* Do not even think about executing out-of-bounds tile-commands */

   411

	if (tile >= MapSize() || IsTileType(tile, MP_VOID)) {

   412

		_cmd_text = NULL;

   413

		return CMD_ERROR;

   414

	}

   415

   416

	proc = _command_proc_table[procc].proc;

   417

   418

	if (_docommand_recursive == 0) _error_message = INVALID_STRING_ID;

   419

   420

	_docommand_recursive++;

   421

   422

	/* only execute the test call if it's toplevel, or we're not execing. */

   423

	if (_docommand_recursive == 1 || !(flags & DC_EXEC) || (flags & DC_FORCETEST) ) {

   425

		res = proc(tile, flags & ~DC_EXEC, p1, p2);

   427

		if (CmdFailed(res)) {

   428

			res.SetGlobalErrorMessage();

   429

			goto error;

   430

		}

   431

   432

		if (_docommand_recursive == 1 &&

   433

				!(flags & DC_QUERY_COST) &&

   434

				res.GetCost() != 0 &&

   435

				!CheckPlayerHasMoney(res)) {

   436

			goto error;

   437

		}

   438

   439

		if (!(flags & DC_EXEC)) {

   440

			_docommand_recursive--;

   441

			_cmd_text = NULL;

   442

			return res;

   443

		}

   444

	}

   445

   446

	/* Execute the command here. All cost-relevant functions set the expenses type

   447

	 * themselves to the cost object at some point */

   448

	res = proc(tile, flags, p1, p2);

   449

	if (CmdFailed(res)) {

   450

		res.SetGlobalErrorMessage();

   451

error:

   452

		_docommand_recursive--;

   453

		_cmd_text = NULL;

   454

		return CMD_ERROR;

   455

	}

   456

   457

	/* if toplevel, subtract the money. */

   458

	if (--_docommand_recursive == 0) {

   459

		SubtractMoneyFromPlayer(res);

   460

		/* XXX - Old AI hack which doesn't use DoCommandDP; update last build coord of player */

   461

		if (tile != 0 && IsValidPlayer(_current_player)) {

   462

			GetPlayer(_current_player)->last_build_coordinate = tile;

   463

		}

   464

	}

   465

   466

	_cmd_text = NULL;

   467

	return res;

   468

}

   469

   470

/*!

   471

 * This functions returns the money which can be used to execute a command.

   472

 * This is either the money of the current player or INT64_MAX if there

   473

 * is no such a player "at the moment" like the server itself.

   474

 *

   475

 * @return The available money of a player or INT64_MAX

   476

 */

   477

Money GetAvailableMoneyForCommand()

   478

{

   479

	PlayerID pid = _current_player;

   480

	if (!IsValidPlayer(pid)) return INT64_MAX;

   481

	return GetPlayer(pid)->player_money;

   482

}

   483

   484

/*!

   485

 * Toplevel network safe docommand function for the current player. Must not be called recursively.

   486

 * The callback is called when the command succeeded or failed. The parameters

   487

 * tile, p1 and p2 are from the #CommandProc function. The paramater cmd is the command to execute.

   488

 * The parameter my_cmd is used to indicate if the command is from a player or the server.

   489

 *

   490

 * @param tile The tile to perform a command on (see #CommandProc)

   491

 * @param p1 Additional data for the command (see #CommandProc)

   492

 * @param p2 Additional data for the command (see #CommandProc)

   493

 * @param callback A callback function to call after the command is finished

   494

 * @param cmd The command to execute (a CMD_* value)

   495

 * @param my_cmd indicator if the command is from a player or server (to display error messages for a user)

   496

 * @return true if the command succeeded, else false

   497

 */

   498

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