1

/* $Id$ */

     2

     3

/** @file command.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "strings.h"

     9

#include "functions.h"

    10

#include "landscape.h"

    11

#include "map.h"

    12

#include "gui.h"

    13

#include "command.h"

    14

#include "player.h"

    15

#include "network/network.h"

    16

#include "variables.h"

    17

#include "genworld.h"

    18

#include "newgrf_storage.h"

    19

    20

const char *_cmd_text = NULL;

    21

    22

/**

    23

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

    24

 *

    25

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

    26

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

    27

 * type.

    28

 *

    29

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

    30

 */

    31

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

    32

    33

DEF_COMMAND(CmdBuildRailroadTrack);

    34

DEF_COMMAND(CmdRemoveRailroadTrack);

    35

DEF_COMMAND(CmdBuildSingleRail);

    36

DEF_COMMAND(CmdRemoveSingleRail);

    37

    38

DEF_COMMAND(CmdLandscapeClear);

    39

    40

DEF_COMMAND(CmdBuildBridge);

    41

    42

DEF_COMMAND(CmdBuildRailroadStation);

    43

DEF_COMMAND(CmdRemoveFromRailroadStation);

    44

DEF_COMMAND(CmdConvertRail);

    45

    46

DEF_COMMAND(CmdBuildSingleSignal);

    47

DEF_COMMAND(CmdRemoveSingleSignal);

    48

    49

DEF_COMMAND(CmdTerraformLand);

    50

    51

DEF_COMMAND(CmdPurchaseLandArea);

    52

DEF_COMMAND(CmdSellLandArea);

    53

    54

DEF_COMMAND(CmdBuildTunnel);

    55

    56

DEF_COMMAND(CmdBuildTrainDepot);

    57

DEF_COMMAND(CmdBuildTrainWaypoint);

    58

DEF_COMMAND(CmdRenameWaypoint);

    59

DEF_COMMAND(CmdRemoveTrainWaypoint);

    60

    61

DEF_COMMAND(CmdBuildRoadStop);

    62

DEF_COMMAND(CmdRemoveRoadStop);

    63

    64

DEF_COMMAND(CmdBuildLongRoad);

    65

DEF_COMMAND(CmdRemoveLongRoad);

    66

DEF_COMMAND(CmdBuildRoad);

    67

DEF_COMMAND(CmdRemoveRoad);

    68

    69

DEF_COMMAND(CmdBuildRoadDepot);

    70

    71

DEF_COMMAND(CmdBuildAirport);

    72

    73

DEF_COMMAND(CmdBuildDock);

    74

    75

DEF_COMMAND(CmdBuildShipDepot);

    76

    77

DEF_COMMAND(CmdBuildBuoy);

    78

    79

DEF_COMMAND(CmdPlantTree);

    80

    81

DEF_COMMAND(CmdBuildRailVehicle);

    82

DEF_COMMAND(CmdMoveRailVehicle);

    83

    84

DEF_COMMAND(CmdStartStopTrain);

    85

    86

DEF_COMMAND(CmdSellRailWagon);

    87

    88

DEF_COMMAND(CmdSendTrainToDepot);

    89

DEF_COMMAND(CmdForceTrainProceed);

    90

DEF_COMMAND(CmdReverseTrainDirection);

    91

    92

DEF_COMMAND(CmdModifyOrder);

    93

DEF_COMMAND(CmdSkipToOrder);

    94

DEF_COMMAND(CmdDeleteOrder);

    95

DEF_COMMAND(CmdInsertOrder);

    96

DEF_COMMAND(CmdChangeServiceInt);

    97

DEF_COMMAND(CmdRestoreOrderIndex);

    98

    99

DEF_COMMAND(CmdBuildIndustry);

   100

   101

DEF_COMMAND(CmdBuildCompanyHQ);

   102

DEF_COMMAND(CmdSetPlayerFace);

   103

DEF_COMMAND(CmdSetPlayerColor);

   104

   105

DEF_COMMAND(CmdIncreaseLoan);

   106

DEF_COMMAND(CmdDecreaseLoan);

   107

   108

DEF_COMMAND(CmdWantEnginePreview);

   109

   110

DEF_COMMAND(CmdNameVehicle);

   111

DEF_COMMAND(CmdRenameEngine);

   112

   113

DEF_COMMAND(CmdChangeCompanyName);

   114

DEF_COMMAND(CmdChangePresidentName);

   115

   116

DEF_COMMAND(CmdRenameStation);

   117

   118

DEF_COMMAND(CmdSellAircraft);

   119

DEF_COMMAND(CmdStartStopAircraft);

   120

DEF_COMMAND(CmdBuildAircraft);

   121

DEF_COMMAND(CmdSendAircraftToHangar);

   122

DEF_COMMAND(CmdRefitAircraft);

   123

   124

DEF_COMMAND(CmdPlaceSign);

   125

DEF_COMMAND(CmdRenameSign);

   126

   127

DEF_COMMAND(CmdBuildRoadVeh);

   128

DEF_COMMAND(CmdStartStopRoadVeh);

   129

DEF_COMMAND(CmdSellRoadVeh);

   130

DEF_COMMAND(CmdSendRoadVehToDepot);

   131

DEF_COMMAND(CmdTurnRoadVeh);

   132

DEF_COMMAND(CmdRefitRoadVeh);

   133

   134

DEF_COMMAND(CmdPause);

   135

   136

DEF_COMMAND(CmdBuyShareInCompany);

   137

DEF_COMMAND(CmdSellShareInCompany);

   138

DEF_COMMAND(CmdBuyCompany);

   139

   140

DEF_COMMAND(CmdBuildTown);

   141

   142

DEF_COMMAND(CmdRenameTown);

   143

DEF_COMMAND(CmdDoTownAction);

   144

   145

DEF_COMMAND(CmdSetRoadDriveSide);

   146

   147

DEF_COMMAND(CmdChangeDifficultyLevel);

   148

DEF_COMMAND(CmdChangePatchSetting);

   149

   150

DEF_COMMAND(CmdStartStopShip);

   151

DEF_COMMAND(CmdSellShip);

   152

DEF_COMMAND(CmdBuildShip);

   153

DEF_COMMAND(CmdSendShipToDepot);

   154

DEF_COMMAND(CmdRefitShip);

   155

   156

DEF_COMMAND(CmdOrderRefit);

   157

DEF_COMMAND(CmdCloneOrder);

   158

   159

DEF_COMMAND(CmdClearArea);

   160

   161

DEF_COMMAND(CmdGiveMoney);

   162

DEF_COMMAND(CmdMoneyCheat);

   163

DEF_COMMAND(CmdBuildCanal);

   164

DEF_COMMAND(CmdBuildLock);

   165

   166

DEF_COMMAND(CmdPlayerCtrl);

   167

   168

DEF_COMMAND(CmdLevelLand);

   169

   170

DEF_COMMAND(CmdRefitRailVehicle);

   171

   172

DEF_COMMAND(CmdBuildSignalTrack);

   173

DEF_COMMAND(CmdRemoveSignalTrack);

   174

   175

DEF_COMMAND(CmdSetAutoReplace);

   176

   177

DEF_COMMAND(CmdCloneVehicle);

   178

DEF_COMMAND(CmdMassStartStopVehicle);

   179

DEF_COMMAND(CmdDepotSellAllVehicles);

   180

DEF_COMMAND(CmdDepotMassAutoReplace);

   181

   182

DEF_COMMAND(CmdCreateGroup);

   183

DEF_COMMAND(CmdRenameGroup);

   184

DEF_COMMAND(CmdDeleteGroup);

   185

DEF_COMMAND(CmdAddVehicleGroup);

   186

DEF_COMMAND(CmdAddSharedVehicleGroup);

   187

DEF_COMMAND(CmdRemoveAllVehiclesGroup);

   188

DEF_COMMAND(CmdSetGroupReplaceProtection);

   189

   190

DEF_COMMAND(CmdMoveOrder);

   191

DEF_COMMAND(CmdChangeTimetable);

   192

DEF_COMMAND(CmdSetVehicleOnTime);

   193

DEF_COMMAND(CmdAutofillTimetable);

   194

#undef DEF_COMMAND

   195

   196

/**

   197

 * The master command table

   198

 *

   199

 * This table contains all possible CommandProc functions with

   200

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

   201

 * as the value from the CMD_* enums.

   202

 */

   203

static const Command _command_proc_table[] = {

   204

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

   205

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

   206

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

   207

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

   208

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

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

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

   228

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

   229

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

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

   247

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

   248

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

   249

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

   250

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

   251

   252

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

   253

   254

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

   255

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

   256

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

   257

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

   258

   259

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

   260

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

   261

   262

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

   263

   264

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

   265

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

   266

   267

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

   268

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

   269

   270

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

   271

   272

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

   273

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

   274

   275

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

   276

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

   277

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

   278

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

   279

   280

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

   281

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

   282

   283

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

   284

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

   285

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

   286

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

   287

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

   288

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

   289

   290

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

   291

   292

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

   293

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

   294

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

   295

   296

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

   297

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

   298

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

   299

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

   300

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

   301

   302

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

   303

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

   304

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

   305

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

   306

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

   321

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

   322

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

   323

   324

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

   325

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

   326

   327

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

   328

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

   329

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

   330

   331

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

   332

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

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

   355

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

   356

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

   357

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

   358

};

   359

   360

/*!

   361

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

   362

 *

   363

 * @param cmd The integervalue of a command

   364

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

   365

 */

   366

bool IsValidCommand(uint cmd)

   367

{

   368

	cmd &= 0xFF;

   369

   370

	return

   371

		cmd < lengthof(_command_proc_table) &&

   372

		_command_proc_table[cmd].proc != NULL;

   373

}

   374

   375

/*!

   376

 * This function mask the parameter with 0xFF and returns

   377

 * the flags which belongs to the given command.

   378

 *

   379

 * @param cmd The integer value of the command

   380

 * @return The flags for this command

   381

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

   382

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

   383

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

   384

 */

   385

byte GetCommandFlags(uint cmd)

   386

{

   387

	return _command_proc_table[cmd & 0xFF].flags;

   388

}

   389

   390

static int _docommand_recursive;

   391

   392

/*!

   393

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

   394

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

   395

 *

   396

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

   397

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

   398

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

   399

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

   400

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

   401

 * @see CommandProc

   402

 */

   403

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

   404

{

   405

	CommandCost res;

   406

	CommandProc *proc;

   407

   408

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

   409

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

   410

		_cmd_text = NULL;

   411

		return CMD_ERROR;

   412

	}

   413

   414

	proc = _command_proc_table[procc].proc;

   415

   416

	if (_docommand_recursive == 0) _error_message = INVALID_STRING_ID;

   417

   418

	_docommand_recursive++;

   419

   420

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

   421

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

   422

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

   423

		if (CmdFailed(res)) {

   424

			res.SetGlobalErrorMessage();

   425

			goto error;

   426

		}

   427

   428

		if (_docommand_recursive == 1 &&

   429

				!(flags & DC_QUERY_COST) &&

   430

				res.GetCost() != 0 &&

   431

				!CheckPlayerHasMoney(res)) {

   432

			goto error;

   433

		}

   434

   435

		if (!(flags & DC_EXEC)) {

   436

			_docommand_recursive--;

   437

			_cmd_text = NULL;

   438

			return res;

   439

		}

   440

	}

   441

   442

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

   443

	 * themselves with "SET_EXPENSES_TYPE(...);" at the beginning of the function */

   444

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

   445

	if (CmdFailed(res)) {

   446

		res.SetGlobalErrorMessage();

   447

error:

   448

		_docommand_recursive--;

   449

		_cmd_text = NULL;

   450

		return CMD_ERROR;

   451

	}

   452

   453

	/* if toplevel, subtract the money. */

   454

	if (--_docommand_recursive == 0) {

   455

		SubtractMoneyFromPlayer(res);

   456

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

   457

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

   458

			GetPlayer(_current_player)->last_build_coordinate = tile;

   459

		}

   460

	}

   461

   462

	_cmd_text = NULL;

   463

	return res;

   464

}

   465

   466

/*!

   467

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

   468

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

   469

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

   470

 *

   471

 * @return The available money of a player or INT64_MAX

   472

 */

   473

Money GetAvailableMoneyForCommand()

   474

{

   475

	PlayerID pid = _current_player;

   476

	if (!IsValidPlayer(pid)) return INT64_MAX;

   477

	return GetPlayer(pid)->player_money;

   478

}

   479

   480

/*!

   481

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

   482

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

   483

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

   484

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

   485

 *

   486

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

   487

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

   488

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

   489

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

   490

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

   491

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

   492

 * @return true if the command succeeded, else false

   493

 */

   494

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

   495

{

   496

	CommandCost res, res2;

   497

	CommandProc *proc;

   498

	uint32 flags;

   499

	bool notest;