1

/* $Id$ */

     2

     3

/** @file command.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "functions.h"

     9

#include "landscape.h"

    10

#include "map.h"

    11

#include "gui.h"

    12

#include "command.h"

    13

#include "player.h"

    14

#include "network/network.h"

    15

#include "variables.h"

    16

#include "genworld.h"

    17

    18

const char* _cmd_text = NULL;

    19

    20

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

    21

    22

DEF_COMMAND(CmdBuildRailroadTrack);

    23

DEF_COMMAND(CmdRemoveRailroadTrack);

    24

DEF_COMMAND(CmdBuildSingleRail);

    25

DEF_COMMAND(CmdRemoveSingleRail);

    26

    27

DEF_COMMAND(CmdLandscapeClear);

    28

    29

DEF_COMMAND(CmdBuildBridge);

    30

    31

DEF_COMMAND(CmdBuildRailroadStation);

    32

DEF_COMMAND(CmdRemoveFromRailroadStation);

    33

DEF_COMMAND(CmdConvertRail);

    34

    35

DEF_COMMAND(CmdBuildSingleSignal);

    36

DEF_COMMAND(CmdRemoveSingleSignal);

    37

    38

DEF_COMMAND(CmdTerraformLand);

    39

    40

DEF_COMMAND(CmdPurchaseLandArea);

    41

DEF_COMMAND(CmdSellLandArea);

    42

    43

DEF_COMMAND(CmdBuildTunnel);

    44

    45

DEF_COMMAND(CmdBuildTrainDepot);

    46

DEF_COMMAND(CmdBuildTrainWaypoint);

    47

DEF_COMMAND(CmdRenameWaypoint);

    48

DEF_COMMAND(CmdRemoveTrainWaypoint);

    49

    50

DEF_COMMAND(CmdBuildRoadStop);

    51

DEF_COMMAND(CmdRemoveRoadStop);

    52

    53

DEF_COMMAND(CmdBuildLongRoad);

    54

DEF_COMMAND(CmdRemoveLongRoad);

    55

DEF_COMMAND(CmdBuildRoad);

    56

DEF_COMMAND(CmdRemoveRoad);

    57

    58

DEF_COMMAND(CmdBuildRoadDepot);

    59

    60

DEF_COMMAND(CmdBuildAirport);

    61

    62

DEF_COMMAND(CmdBuildDock);

    63

    64

DEF_COMMAND(CmdBuildShipDepot);

    65

    66

DEF_COMMAND(CmdBuildBuoy);

    67

    68

DEF_COMMAND(CmdPlantTree);

    69

    70

DEF_COMMAND(CmdBuildRailVehicle);

    71

DEF_COMMAND(CmdMoveRailVehicle);

    72

    73

DEF_COMMAND(CmdStartStopTrain);

    74

    75

DEF_COMMAND(CmdSellRailWagon);

    76

    77

DEF_COMMAND(CmdSendTrainToDepot);

    78

DEF_COMMAND(CmdForceTrainProceed);

    79

DEF_COMMAND(CmdReverseTrainDirection);

    80

    81

DEF_COMMAND(CmdModifyOrder);

    82

DEF_COMMAND(CmdSkipToOrder);

    83

DEF_COMMAND(CmdDeleteOrder);

    84

DEF_COMMAND(CmdInsertOrder);

    85

DEF_COMMAND(CmdChangeServiceInt);

    86

DEF_COMMAND(CmdRestoreOrderIndex);

    87

    88

DEF_COMMAND(CmdBuildIndustry);

    89

    90

DEF_COMMAND(CmdBuildCompanyHQ);

    91

DEF_COMMAND(CmdSetPlayerFace);

    92

DEF_COMMAND(CmdSetPlayerColor);

    93

    94

DEF_COMMAND(CmdIncreaseLoan);

    95

DEF_COMMAND(CmdDecreaseLoan);

    96

    97

DEF_COMMAND(CmdWantEnginePreview);

    98

    99

DEF_COMMAND(CmdNameVehicle);

   100

DEF_COMMAND(CmdRenameEngine);

   101

   102

DEF_COMMAND(CmdChangeCompanyName);

   103

DEF_COMMAND(CmdChangePresidentName);

   104

   105

DEF_COMMAND(CmdRenameStation);

   106

   107

DEF_COMMAND(CmdSellAircraft);

   108

DEF_COMMAND(CmdStartStopAircraft);

   109

DEF_COMMAND(CmdBuildAircraft);

   110

DEF_COMMAND(CmdSendAircraftToHangar);

   111

DEF_COMMAND(CmdRefitAircraft);

   112

   113

DEF_COMMAND(CmdPlaceSign);

   114

DEF_COMMAND(CmdRenameSign);

   115

   116

DEF_COMMAND(CmdBuildRoadVeh);

   117

DEF_COMMAND(CmdStartStopRoadVeh);

   118

DEF_COMMAND(CmdSellRoadVeh);

   119

DEF_COMMAND(CmdSendRoadVehToDepot);

   120

DEF_COMMAND(CmdTurnRoadVeh);

   121

DEF_COMMAND(CmdRefitRoadVeh);

   122

   123

DEF_COMMAND(CmdPause);

   124

   125

DEF_COMMAND(CmdBuyShareInCompany);

   126

DEF_COMMAND(CmdSellShareInCompany);

   127

DEF_COMMAND(CmdBuyCompany);

   128

   129

DEF_COMMAND(CmdBuildTown);

   130

   131

DEF_COMMAND(CmdRenameTown);

   132

DEF_COMMAND(CmdDoTownAction);

   133

   134

DEF_COMMAND(CmdSetRoadDriveSide);

   135

   136

DEF_COMMAND(CmdChangeDifficultyLevel);

   137

DEF_COMMAND(CmdChangePatchSetting);

   138

   139

DEF_COMMAND(CmdStartStopShip);

   140

DEF_COMMAND(CmdSellShip);

   141

DEF_COMMAND(CmdBuildShip);

   142

DEF_COMMAND(CmdSendShipToDepot);

   143

DEF_COMMAND(CmdRefitShip);

   144

   145

DEF_COMMAND(CmdOrderRefit);

   146

DEF_COMMAND(CmdCloneOrder);

   147

   148

DEF_COMMAND(CmdClearArea);

   149

   150

DEF_COMMAND(CmdGiveMoney);

   151

DEF_COMMAND(CmdMoneyCheat);

   152

DEF_COMMAND(CmdBuildCanal);

   153

DEF_COMMAND(CmdBuildLock);

   154

   155

DEF_COMMAND(CmdPlayerCtrl);

   156

   157

DEF_COMMAND(CmdLevelLand);

   158

   159

DEF_COMMAND(CmdRefitRailVehicle);

   160

   161

DEF_COMMAND(CmdBuildSignalTrack);

   162

DEF_COMMAND(CmdRemoveSignalTrack);

   163

   164

DEF_COMMAND(CmdSetAutoReplace);

   165

   166

DEF_COMMAND(CmdCloneVehicle);

   167

DEF_COMMAND(CmdMassStartStopVehicle);

   168

DEF_COMMAND(CmdDepotSellAllVehicles);

   169

DEF_COMMAND(CmdDepotMassAutoReplace);

   170

   171

DEF_COMMAND(CmdCreateGroup);

   172

DEF_COMMAND(CmdRenameGroup);

   173

DEF_COMMAND(CmdDeleteGroup);

   174

DEF_COMMAND(CmdAddVehicleGroup);

   175

DEF_COMMAND(CmdAddSharedVehicleGroup);

   176

DEF_COMMAND(CmdRemoveAllVehiclesGroup);

   177

DEF_COMMAND(CmdSetGroupReplaceProtection);

   178

   179

DEF_COMMAND(CmdMoveOrder);

   180

DEF_COMMAND(CmdChangeTimetable);

   181

DEF_COMMAND(CmdSetVehicleOnTime);

   183

   184

/* The master command table */

   185

static const Command _command_proc_table[] = {

   186

	{CmdBuildRailroadTrack,                  0}, /*   0 */

   187

	{CmdRemoveRailroadTrack,                 0}, /*   1 */

   188

	{CmdBuildSingleRail,                     0}, /*   2 */

   189

	{CmdRemoveSingleRail,                    0}, /*   3 */

   190

	{CmdLandscapeClear,                      0}, /*   4 */

   191

	{CmdBuildBridge,                         0}, /*   5 */

   192

	{CmdBuildRailroadStation,                0}, /*   6 */

   193

	{CmdBuildTrainDepot,                     0}, /*   7 */

   194

	{CmdBuildSingleSignal,                   0}, /*   8 */

   195

	{CmdRemoveSingleSignal,                  0}, /*   9 */

   196

	{CmdTerraformLand,                       0}, /*  10 */

   197

	{CmdPurchaseLandArea,                    0}, /*  11 */

   198

	{CmdSellLandArea,                        0}, /*  12 */

   199

	{CmdBuildTunnel,                         0}, /*  13 */

   200

	{CmdRemoveFromRailroadStation,           0}, /*  14 */

   201

	{CmdConvertRail,                         0}, /*  15 */

   202

	{CmdBuildTrainWaypoint,                  0}, /*  16 */

   203

	{CmdRenameWaypoint,                      0}, /*  17 */

   204

	{CmdRemoveTrainWaypoint,                 0}, /*  18 */

   205

	{NULL,                                   0}, /*  19 */

   206

	{NULL,                                   0}, /*  20 */

   207

	{CmdBuildRoadStop,                       0}, /*  21 */

   208

	{CmdRemoveRoadStop,                      0}, /*  22 */

   209

	{CmdBuildLongRoad,                       0}, /*  23 */

   210

	{CmdRemoveLongRoad,                      0}, /*  24 */

   211

	{CmdBuildRoad,                           0}, /*  25 */

   212

	{CmdRemoveRoad,                          0}, /*  26 */

   213

	{CmdBuildRoadDepot,                      0}, /*  27 */

   214

	{NULL,                                   0}, /*  28 */

   215

	{CmdBuildAirport,                        0}, /*  29 */

   216

	{CmdBuildDock,                           0}, /*  30 */

   217

	{CmdBuildShipDepot,                      0}, /*  31 */

   218

	{CmdBuildBuoy,                           0}, /*  32 */

   219

	{CmdPlantTree,                           0}, /*  33 */

   220

	{CmdBuildRailVehicle,                    0}, /*  34 */

   221

	{CmdMoveRailVehicle,                     0}, /*  35 */

   222

	{CmdStartStopTrain,                      0}, /*  36 */

   223

	{NULL,                                   0}, /*  37 */

   224

	{CmdSellRailWagon,                       0}, /*  38 */

   225

	{CmdSendTrainToDepot,                    0}, /*  39 */

   226

	{CmdForceTrainProceed,                   0}, /*  40 */

   227

	{CmdReverseTrainDirection,               0}, /*  41 */

   228

   229

	{CmdModifyOrder,                         0}, /*  42 */

   230

	{CmdSkipToOrder,                         0}, /*  43 */

   231

	{CmdDeleteOrder,                         0}, /*  44 */

   232

	{CmdInsertOrder,                         0}, /*  45 */

   233

   234

	{CmdChangeServiceInt,                    0}, /*  46 */

   235

   236

	{CmdBuildIndustry,                       0}, /*  47 */

   237

	{CmdBuildCompanyHQ,                      0}, /*  48 */

   238

	{CmdSetPlayerFace,                       0}, /*  49 */

   239

	{CmdSetPlayerColor,                      0}, /*  50 */

   240

   241

	{CmdIncreaseLoan,                        0}, /*  51 */

   242

	{CmdDecreaseLoan,                        0}, /*  52 */

   243

   244

	{CmdWantEnginePreview,                   0}, /*  53 */

   245

   246

	{CmdNameVehicle,                         0}, /*  54 */

   247

	{CmdRenameEngine,                        0}, /*  55 */

   248

   249

	{CmdChangeCompanyName,                   0}, /*  56 */

   250

	{CmdChangePresidentName,                 0}, /*  57 */

   251

   252

	{CmdRenameStation,                       0}, /*  58 */

   253

   254

	{CmdSellAircraft,                        0}, /*  59 */

   255

	{CmdStartStopAircraft,                   0}, /*  60 */

   256

   257

	{CmdBuildAircraft,                       0}, /*  61 */

   258

	{CmdSendAircraftToHangar,                0}, /*  62 */

   259

	{NULL,                                   0}, /*  63 */

   260

	{CmdRefitAircraft,                       0}, /*  64 */

   261

   262

	{CmdPlaceSign,                           0}, /*  65 */

   263

	{CmdRenameSign,                          0}, /*  66 */

   264

   265

	{CmdBuildRoadVeh,                        0}, /*  67 */

   266

	{CmdStartStopRoadVeh,                    0}, /*  68 */

   267

	{CmdSellRoadVeh,                         0}, /*  69 */

   268

	{CmdSendRoadVehToDepot,                  0}, /*  70 */

   269

	{CmdTurnRoadVeh,                         0}, /*  71 */

   270

	{CmdRefitRoadVeh,                        0}, /*  72 */

   271

   272

	{CmdPause,                      CMD_SERVER}, /*  73 */

   273

   274

	{CmdBuyShareInCompany,                   0}, /*  74 */

   275

	{CmdSellShareInCompany,                  0}, /*  75 */

   276

	{CmdBuyCompany,                          0}, /*  76 */

   277

   278

	{CmdBuildTown,                 CMD_OFFLINE}, /*  77 */

   279

	{NULL,                                   0}, /*  78 */

   280

	{NULL,                                   0}, /*  79 */

   281

	{CmdRenameTown,                 CMD_SERVER}, /*  80 */

   282

	{CmdDoTownAction,                        0}, /*  81 */

   283

   284

	{CmdSetRoadDriveSide,           CMD_SERVER}, /*  82 */

   285

	{NULL,                                   0}, /*  83 */

   286

	{NULL,                                   0}, /*  84 */

   287

	{CmdChangeDifficultyLevel,      CMD_SERVER}, /*  85 */

   288

   289

	{CmdStartStopShip,                       0}, /*  86 */

   290

	{CmdSellShip,                            0}, /*  87 */

   291

	{CmdBuildShip,                           0}, /*  88 */

   292

	{CmdSendShipToDepot,                     0}, /*  89 */

   293

	{NULL,                                   0}, /*  90 */

   294

	{CmdRefitShip,                           0}, /*  91 */

   295

   296

	{NULL,                                   0}, /*  92 */

   297

	{NULL,                                   0}, /*  93 */

   298

	{NULL,                                   0}, /*  94 */

   299

	{NULL,                                   0}, /*  95 */

   300

	{NULL,                                   0}, /*  96 */

   301

	{NULL,                                   0}, /*  97 */

   302

   303

	{CmdOrderRefit,                          0}, /*  98 */

   304

	{CmdCloneOrder,                          0}, /*  99 */

   305

   306

	{CmdClearArea,                           0}, /* 100 */

   307

	{NULL,                                   0}, /* 101 */

   308

   309

	{CmdMoneyCheat,                CMD_OFFLINE}, /* 102 */

   310

	{CmdBuildCanal,                          0}, /* 103 */

   311

	{CmdPlayerCtrl,                          0}, /* 104 */

   312

   313

	{CmdLevelLand,                           0}, /* 105 */

   314

   315

	{CmdRefitRailVehicle,                    0}, /* 106 */

   316

	{CmdRestoreOrderIndex,                   0}, /* 107 */

   317

	{CmdBuildLock,                           0}, /* 108 */

   318

	{NULL,                                   0}, /* 109 */

   319

	{CmdBuildSignalTrack,                    0}, /* 110 */

   320

	{CmdRemoveSignalTrack,                   0}, /* 111 */

   321

	{NULL,                                   0}, /* 112 */

   322

	{CmdGiveMoney,                           0}, /* 113 */

   323

	{CmdChangePatchSetting,         CMD_SERVER}, /* 114 */

   324

	{CmdSetAutoReplace,                      0}, /* 115 */

   325

	{CmdCloneVehicle,                        0}, /* 116 */

   326

	{CmdMassStartStopVehicle,                0}, /* 117 */

   327

	{CmdDepotSellAllVehicles,                0}, /* 118 */

   328

	{CmdDepotMassAutoReplace,                0}, /* 119 */

   329

	{CmdCreateGroup,                         0}, /* 120 */

   330

	{CmdDeleteGroup,                         0}, /* 121 */

   331

	{CmdRenameGroup,                         0}, /* 122 */

   332

	{CmdAddVehicleGroup,                     0}, /* 123 */

   333

	{CmdAddSharedVehicleGroup,               0}, /* 124 */

   334

	{CmdRemoveAllVehiclesGroup,              0}, /* 125 */

   335

	{CmdSetGroupReplaceProtection,           0}, /* 126 */

   336

	{CmdMoveOrder,                           0}, /* 127 */

   337

	{CmdChangeTimetable,                     0}, /* 128 */

   338

	{CmdSetVehicleOnTime,                    0}, /* 129 */

   340

};

   341

   342

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

   343

bool IsValidCommand(uint cmd)

   344

{

   345

	cmd &= 0xFF;

   346

   347

	return

   348

		cmd < lengthof(_command_proc_table) &&

   349

		_command_proc_table[cmd].proc != NULL;

   350

}

   351

   352

byte GetCommandFlags(uint cmd)

   353

{

   354

	return _command_proc_table[cmd & 0xFF].flags;

   355

}

   356

   357

   358

static int _docommand_recursive;

   359

   360

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

   361

{

   362

	CommandCost res;

   363

	CommandProc *proc;

   364

   365

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

   366

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

   367

		_cmd_text = NULL;

   368

		return CMD_ERROR;

   369

	}

   370

   371

	proc = _command_proc_table[procc].proc;

   372

   373

	if (_docommand_recursive == 0) _error_message = INVALID_STRING_ID;

   374

   375

	_docommand_recursive++;

   376

   377

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

   378

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

   379

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

   380

		if (CmdFailed(res)) {

   381

			res.SetGlobalErrorMessage();

   382

			goto error;

   383

		}

   384

   385

		if (_docommand_recursive == 1 &&

   386

				!(flags & DC_QUERY_COST) &&

   387

				res.GetCost() != 0 &&

   388

				!CheckPlayerHasMoney(res)) {

   389

			goto error;

   390

		}

   391

   392

		if (!(flags & DC_EXEC)) {

   393

			_docommand_recursive--;

   394

			_cmd_text = NULL;

   395

			return res;

   396

		}

   397

	}

   398

   399

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

   400

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

   401

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

   402

	if (CmdFailed(res)) {

   403

		res.SetGlobalErrorMessage();

   404

error:

   405

		_docommand_recursive--;

   406

		_cmd_text = NULL;

   407

		return CMD_ERROR;

   408

	}

   409

   410

	/* if toplevel, subtract the money. */

   411

	if (--_docommand_recursive == 0) {

   412

		SubtractMoneyFromPlayer(res);

   413

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

   414

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

   415

			GetPlayer(_current_player)->last_build_coordinate = tile;

   416

		}

   417

	}

   418

   419

	_cmd_text = NULL;

   420

	return res;

   421

}

   422

   423

Money GetAvailableMoneyForCommand()

   424

{

   425

	PlayerID pid = _current_player;

   426

	if (!IsValidPlayer(pid)) return INT64_MAX;

   427

	return GetPlayer(pid)->player_money;

   428

}

   429

   430

/* toplevel network safe docommand function for the current player. must not be called recursively.

   431

 * the callback is called when the command succeeded or failed. */

   432

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

   433

{

   434

	CommandCost res, res2;

   435

	CommandProc *proc;

   436

	uint32 flags;

   437

	bool notest;

   438

	StringID error_part1;

   439

   440

	int x = TileX(tile) * TILE_SIZE;

   441

	int y = TileY(tile) * TILE_SIZE;

   442

   443

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

   444

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

   445

		_cmd_text = NULL;

   446

		return false;

   447

	}

   448

   449

	assert(_docommand_recursive == 0);

   450

   451

	_error_message = INVALID_STRING_ID;

   452

	error_part1 = GB(cmd, 16, 16);

   453

	_additional_cash_required = 0;

   454

   455

	/** Spectator has no rights except for the (dedicated) server which

   456

	 * is/can be a spectator but as the server it can do anything */

   457

	if (_current_player == PLAYER_SPECTATOR && !_network_server) {

   458

		ShowErrorMessage(_error_message, error_part1, x, y);

   459

		_cmd_text = NULL;

   460

		return false;

   461

	}

   462

   463

	flags = 0;

   464

	if (cmd & CMD_AUTO) flags |= DC_AUTO;

   465

	if (cmd & CMD_NO_WATER) flags |= DC_NO_WATER;

   466

   467

	/* get pointer to command handler */

   468

	assert((cmd & 0xFF) < lengthof(_command_proc_table));

   469

	proc = _command_proc_table[cmd & 0xFF].proc;

   470

	if (proc == NULL) {

   471

		_cmd_text = NULL;

   472

		return false;

   473

	}

   474

   475

	/* Some commands have a different output in dryrun than the realrun

   476

	 *  e.g.: if you demolish a whole town, the dryrun would say okay.

   477

	 *  but by really destroying, your rating drops and at a certain point

   478

	 *  it will fail. so res and res2 are different

   479

	 * CMD_REMOVE_ROAD: This command has special local authority

   480

	 * restrictions which may cause the test run to fail (the previous

   481

	 * road fragments still stay there and the town won't let you

   482

	 * disconnect the road system), but the exec will succeed and this

   483

	 * fact will trigger an assertion failure. --pasky

   484

	 * CMD_CLONE_VEHICLE: Both building new vehicles and refitting them can be

   485

	 * influenced by newgrf callbacks, which makes it impossible to accurately

   486

	 * estimate the cost of cloning a vehicle. */

   487

	notest =

   488

		(cmd & 0xFF) == CMD_CLEAR_AREA ||

   489

		(cmd & 0xFF) == CMD_CONVERT_RAIL ||

   490

		(cmd & 0xFF) == CMD_LEVEL_LAND ||

   491

		(cmd & 0xFF) == CMD_REMOVE_ROAD ||

   492

		(cmd & 0xFF) == CMD_REMOVE_LONG_ROAD ||

   493

		(cmd & 0xFF) == CMD_CLONE_VEHICLE;

   494

   495

	_docommand_recursive = 1;

   496

   497

	/* cost estimation only? */