1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "table/strings.h"

     6

#include "functions.h"

     7

#include "map.h"

     8

#include "gui.h"

     9

#include "command.h"

    10

#include "player.h"

    11

#include "network.h"

    12

#include "variables.h"

    13

    14

const char* _cmd_text = NULL;

    15

    16

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

    17

    18

DEF_COMMAND(CmdBuildRailroadTrack);

    19

DEF_COMMAND(CmdRemoveRailroadTrack);

    20

DEF_COMMAND(CmdBuildSingleRail);

    21

DEF_COMMAND(CmdRemoveSingleRail);

    22

    23

DEF_COMMAND(CmdLandscapeClear);

    24

    25

DEF_COMMAND(CmdBuildBridge);

    26

    27

DEF_COMMAND(CmdBuildRailroadStation);

    28

DEF_COMMAND(CmdRemoveFromRailroadStation);

    29

DEF_COMMAND(CmdConvertRail);

    30

    31

DEF_COMMAND(CmdBuildSingleSignal);

    32

DEF_COMMAND(CmdRemoveSingleSignal);

    33

    34

DEF_COMMAND(CmdTerraformLand);

    35

    36

DEF_COMMAND(CmdPurchaseLandArea);

    37

DEF_COMMAND(CmdSellLandArea);

    38

    39

DEF_COMMAND(CmdBuildTunnel);

    40

    41

DEF_COMMAND(CmdBuildTrainDepot);

    42

DEF_COMMAND(CmdBuildTrainWaypoint);

    43

DEF_COMMAND(CmdRenameWaypoint);

    44

DEF_COMMAND(CmdRemoveTrainWaypoint);

    45

    46

DEF_COMMAND(CmdBuildRoadStop);

    47

    48

DEF_COMMAND(CmdBuildLongRoad);

    49

DEF_COMMAND(CmdRemoveLongRoad);

    50

DEF_COMMAND(CmdBuildRoad);

    51

DEF_COMMAND(CmdRemoveRoad);

    52

    53

DEF_COMMAND(CmdBuildRoadDepot);

    54

    55

DEF_COMMAND(CmdBuildAirport);

    56

    57

DEF_COMMAND(CmdBuildDock);

    58

    59

DEF_COMMAND(CmdBuildShipDepot);

    60

    61

DEF_COMMAND(CmdBuildBuoy);

    62

    63

DEF_COMMAND(CmdPlantTree);

    64

    65

DEF_COMMAND(CmdBuildRailVehicle);

    66

DEF_COMMAND(CmdMoveRailVehicle);

    67

    68

DEF_COMMAND(CmdStartStopTrain);

    69

    70

DEF_COMMAND(CmdSellRailWagon);

    71

    72

DEF_COMMAND(CmdSendTrainToDepot);

    73

DEF_COMMAND(CmdForceTrainProceed);

    74

DEF_COMMAND(CmdReverseTrainDirection);

    75

    76

DEF_COMMAND(CmdModifyOrder);

    77

DEF_COMMAND(CmdSkipOrder);

    78

DEF_COMMAND(CmdDeleteOrder);

    79

DEF_COMMAND(CmdInsertOrder);

    80

DEF_COMMAND(CmdChangeServiceInt);

    81

DEF_COMMAND(CmdRestoreOrderIndex);

    82

    83

DEF_COMMAND(CmdBuildIndustry);

    84

    85

DEF_COMMAND(CmdBuildCompanyHQ);

    86

DEF_COMMAND(CmdSetPlayerFace);

    87

DEF_COMMAND(CmdSetPlayerColor);

    88

    89

DEF_COMMAND(CmdIncreaseLoan);

    90

DEF_COMMAND(CmdDecreaseLoan);

    91

    92

DEF_COMMAND(CmdWantEnginePreview);

    93

    94

DEF_COMMAND(CmdNameVehicle);

    95

DEF_COMMAND(CmdRenameEngine);

    96

    97

DEF_COMMAND(CmdChangeCompanyName);

    98

DEF_COMMAND(CmdChangePresidentName);

    99

   100

DEF_COMMAND(CmdRenameStation);

   101

   102

DEF_COMMAND(CmdSellAircraft);

   103

DEF_COMMAND(CmdStartStopAircraft);

   104

DEF_COMMAND(CmdBuildAircraft);

   105

DEF_COMMAND(CmdSendAircraftToHangar);

   106

DEF_COMMAND(CmdRefitAircraft);

   107

   108

DEF_COMMAND(CmdPlaceSign);

   109

DEF_COMMAND(CmdRenameSign);

   110

   111

DEF_COMMAND(CmdBuildRoadVeh);

   112

DEF_COMMAND(CmdStartStopRoadVeh);

   113

DEF_COMMAND(CmdSellRoadVeh);

   114

DEF_COMMAND(CmdSendRoadVehToDepot);

   115

DEF_COMMAND(CmdTurnRoadVeh);

   116

DEF_COMMAND(CmdRefitRoadVeh);

   117

   118

DEF_COMMAND(CmdPause);

   119

   120

DEF_COMMAND(CmdBuyShareInCompany);

   121

DEF_COMMAND(CmdSellShareInCompany);

   122

DEF_COMMAND(CmdBuyCompany);

   123

   124

DEF_COMMAND(CmdBuildTown);

   125

   126

DEF_COMMAND(CmdRenameTown);

   127

DEF_COMMAND(CmdDoTownAction);

   128

   129

DEF_COMMAND(CmdSetRoadDriveSide);

   130

   131

DEF_COMMAND(CmdChangeDifficultyLevel);

   132

DEF_COMMAND(CmdChangePatchSetting);

   133

   134

DEF_COMMAND(CmdStartStopShip);

   135

DEF_COMMAND(CmdSellShip);

   136

DEF_COMMAND(CmdBuildShip);

   137

DEF_COMMAND(CmdSendShipToDepot);

   138

DEF_COMMAND(CmdRefitShip);

   139

   140

DEF_COMMAND(CmdCloneOrder);

   141

   142

DEF_COMMAND(CmdClearArea);

   143

   144

DEF_COMMAND(CmdGiveMoney);

   145

DEF_COMMAND(CmdMoneyCheat);

   146

DEF_COMMAND(CmdBuildCanal);

   147

DEF_COMMAND(CmdBuildLock);

   148

   149

DEF_COMMAND(CmdPlayerCtrl);

   150

   151

DEF_COMMAND(CmdLevelLand);

   152

   153

DEF_COMMAND(CmdRefitRailVehicle);

   154

   155

DEF_COMMAND(CmdBuildSignalTrack);

   156

DEF_COMMAND(CmdRemoveSignalTrack);

   157

   158

DEF_COMMAND(CmdReplaceVehicle);

   159

   160

DEF_COMMAND(CmdCloneVehicle);

   161

   162

   163

/* The master command table */

   164

static const Command _command_proc_table[] = {

   165

	{CmdBuildRailroadTrack,                  0}, /*   0 */

   166

	{CmdRemoveRailroadTrack,                 0}, /*   1 */

   167

	{CmdBuildSingleRail,                     0}, /*   2 */

   168

	{CmdRemoveSingleRail,                    0}, /*   3 */

   169

	{CmdLandscapeClear,                      0}, /*   4 */

   170

	{CmdBuildBridge,                         0}, /*   5 */

   171

	{CmdBuildRailroadStation,                0}, /*   6 */

   172

	{CmdBuildTrainDepot,                     0}, /*   7 */

   173

	{CmdBuildSingleSignal,                   0}, /*   8 */

   174

	{CmdRemoveSingleSignal,                  0}, /*   9 */

   175

	{CmdTerraformLand,                       0}, /*  10 */

   176

	{CmdPurchaseLandArea,                    0}, /*  11 */

   177

	{CmdSellLandArea,                        0}, /*  12 */

   178

	{CmdBuildTunnel,                         0}, /*  13 */

   179

	{CmdRemoveFromRailroadStation,           0}, /*  14 */

   180

	{CmdConvertRail,                         0}, /*  15 */

   181

	{CmdBuildTrainWaypoint,                  0}, /*  16 */

   182

	{CmdRenameWaypoint,                      0}, /*  17 */

   183

	{CmdRemoveTrainWaypoint,                 0}, /*  18 */

   184

	{NULL,                                   0}, /*  19 */

   185

	{NULL,                                   0}, /*  20 */

   186

	{CmdBuildRoadStop,                       0}, /*  21 */

   187

	{NULL,                                   0}, /*  22 */

   188

	{CmdBuildLongRoad,                       0}, /*  23 */

   189

	{CmdRemoveLongRoad,                      0}, /*  24 */

   190

	{CmdBuildRoad,                           0}, /*  25 */

   191

	{CmdRemoveRoad,                          0}, /*  26 */

   192

	{CmdBuildRoadDepot,                      0}, /*  27 */

   193

	{NULL,                                   0}, /*  28 */

   194

	{CmdBuildAirport,                        0}, /*  29 */

   195

	{CmdBuildDock,                           0}, /*  30 */

   196

	{CmdBuildShipDepot,                      0}, /*  31 */

   197

	{CmdBuildBuoy,                           0}, /*  32 */

   198

	{CmdPlantTree,                           0}, /*  33 */

   199

	{CmdBuildRailVehicle,                    0}, /*  34 */

   200

	{CmdMoveRailVehicle,                     0}, /*  35 */

   201

	{CmdStartStopTrain,                      0}, /*  36 */

   202

	{NULL,                                   0}, /*  37 */

   203

	{CmdSellRailWagon,                       0}, /*  38 */

   204

	{CmdSendTrainToDepot,                    0}, /*  39 */

   205

	{CmdForceTrainProceed,                   0}, /*  40 */

   206

	{CmdReverseTrainDirection,               0}, /*  41 */

   207

   208

	{CmdModifyOrder,                         0}, /*  42 */

   209

	{CmdSkipOrder,                           0}, /*  43 */

   210

	{CmdDeleteOrder,                         0}, /*  44 */

   211

	{CmdInsertOrder,                         0}, /*  45 */

   212

   213

	{CmdChangeServiceInt,                    0}, /*  46 */

   214

   215

	{CmdBuildIndustry,                       0}, /*  47 */

   216

	{CmdBuildCompanyHQ,                      0}, /*  48 */

   217

	{CmdSetPlayerFace,                       0}, /*  49 */

   218

	{CmdSetPlayerColor,                      0}, /*  50 */

   219

   220

	{CmdIncreaseLoan,                        0}, /*  51 */

   221

	{CmdDecreaseLoan,                        0}, /*  52 */

   222

   223

	{CmdWantEnginePreview,                   0}, /*  53 */

   224

   225

	{CmdNameVehicle,                         0}, /*  54 */

   226

	{CmdRenameEngine,                        0}, /*  55 */

   227

   228

	{CmdChangeCompanyName,                   0}, /*  56 */

   229

	{CmdChangePresidentName,                 0}, /*  57 */

   230

   231

	{CmdRenameStation,                       0}, /*  58 */

   232

   233

	{CmdSellAircraft,                        0}, /*  59 */

   234

	{CmdStartStopAircraft,                   0}, /*  60 */

   235

   236

	{CmdBuildAircraft,                       0}, /*  61 */

   237

	{CmdSendAircraftToHangar,                0}, /*  62 */

   238

	{NULL,                                   0}, /*  63 */

   239

	{CmdRefitAircraft,                       0}, /*  64 */

   240

   241

	{CmdPlaceSign,                           0}, /*  65 */

   242

	{CmdRenameSign,                          0}, /*  66 */

   243

   244

	{CmdBuildRoadVeh,                        0}, /*  67 */

   245

	{CmdStartStopRoadVeh,                    0}, /*  68 */

   246

	{CmdSellRoadVeh,                         0}, /*  69 */

   247

	{CmdSendRoadVehToDepot,                  0}, /*  70 */

   248

	{CmdTurnRoadVeh,                         0}, /*  71 */

   249

	{CmdRefitRoadVeh,                        0}, /*  72 */

   250

   251

	{CmdPause,                      CMD_SERVER}, /*  73 */

   252

   253

	{CmdBuyShareInCompany,                   0}, /*  74 */

   254

	{CmdSellShareInCompany,                  0}, /*  75 */

   255

	{CmdBuyCompany,                          0}, /*  76 */

   256

   257

	{CmdBuildTown,                 CMD_OFFLINE}, /*  77 */

   258

	{NULL,                                   0}, /*  78 */

   259

	{NULL,                                   0}, /*  79 */

   260

	{CmdRenameTown,                 CMD_SERVER}, /*  80 */

   261

	{CmdDoTownAction,                        0}, /*  81 */

   262

   263

	{CmdSetRoadDriveSide,           CMD_SERVER}, /*  82 */

   264

	{NULL,                                   0}, /*  83 */

   265

	{NULL,                                   0}, /*  84 */

   266

	{CmdChangeDifficultyLevel,      CMD_SERVER}, /*  85 */

   267

   268

	{CmdStartStopShip,                       0}, /*  86 */

   269

	{CmdSellShip,                            0}, /*  87 */

   270

	{CmdBuildShip,                           0}, /*  88 */

   271

	{CmdSendShipToDepot,                     0}, /*  89 */

   272

	{NULL,                                   0}, /*  90 */

   273

	{CmdRefitShip,                           0}, /*  91 */

   274

   275

	{NULL,                                   0}, /*  92 */

   276

	{NULL,                                   0}, /*  93 */

   277

	{NULL,                                   0}, /*  94 */

   278

	{NULL,                                   0}, /*  95 */

   279

	{NULL,                                   0}, /*  96 */

   280

	{NULL,                                   0}, /*  97 */

   281

	{NULL,                                   0}, /*  98 */

   282

   283

	{CmdCloneOrder,                          0}, /*  99 */

   284

   285

	{CmdClearArea,                           0}, /* 100 */

   286

	{NULL,                                   0}, /* 101 */

   287

   288

	{CmdMoneyCheat,                CMD_OFFLINE}, /* 102 */

   289

	{CmdBuildCanal,                          0}, /* 103 */

   290

	{CmdPlayerCtrl,                          0}, /* 104 */

   291

   292

	{CmdLevelLand,                           0}, /* 105 */

   293

   294

	{CmdRefitRailVehicle,                    0}, /* 106 */

   295

	{CmdRestoreOrderIndex,                   0}, /* 107 */

   296

	{CmdBuildLock,                           0}, /* 108 */

   297

	{NULL,                                   0}, /* 109 */

   298

	{CmdBuildSignalTrack,                    0}, /* 110 */

   299

	{CmdRemoveSignalTrack,                   0}, /* 111 */

   300

	{NULL,                                   0}, /* 112 */

   301

	{CmdGiveMoney,                           0}, /* 113 */

   302

	{CmdChangePatchSetting,         CMD_SERVER}, /* 114 */

   303

	{CmdReplaceVehicle,                      0}, /* 115 */

   304

	{CmdCloneVehicle,                        0}, /* 116 */

   305

};

   306

   307

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

   308

bool IsValidCommand(uint cmd)

   309

{

   310

	cmd &= 0xFF;

   311

   312

	return

   313

		cmd < lengthof(_command_proc_table) &&

   314

		_command_proc_table[cmd].proc != NULL;

   315

}

   316

   317

byte GetCommandFlags(uint cmd)

   318

{

   319

	return _command_proc_table[cmd & 0xFF].flags;

   320

}

   321

   322

   323

static int _docommand_recursive;

   324

   325

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

   326

{

   327

	int32 res;

   328

	CommandProc *proc;

   329

   330

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

   331

	if (tile >= MapSize()) {

   332

		_cmd_text = NULL;

   333

		return CMD_ERROR;

   334

	}

   335

   336

	proc = _command_proc_table[procc].proc;

   337

   338

	if (_docommand_recursive == 0) _error_message = INVALID_STRING_ID;

   339

   340

	_docommand_recursive++;

   341

   342

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

   343

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

   344

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

   345

		if (CmdFailed(res)) {

   346

			if (res & 0xFFFF) _error_message = res & 0xFFFF;

   347

			goto error;

   348

		}

   349

   350

		if (_docommand_recursive == 1 &&

   351

				!(flags & DC_QUERY_COST) &&

   352

				res != 0 &&

   353

				!CheckPlayerHasMoney(res)) {

   354

			goto error;

   355

		}

   356

   357

		if (!(flags & DC_EXEC)) {

   358

			_docommand_recursive--;

   359

			_cmd_text = NULL;

   360

			return res;

   361

		}

   362

	}

   363

   364

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

   365

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

   366

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

   367

	if (CmdFailed(res)) {

   368

		if (res & 0xFFFF) _error_message = res & 0xFFFF;

   369

error:

   370

		_docommand_recursive--;

   371

		_cmd_text = NULL;

   372

		return CMD_ERROR;

   373

	}

   374

   375

	// if toplevel, subtract the money.

   376

	if (--_docommand_recursive == 0) {

   377

		SubtractMoneyFromPlayer(res);

   378

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

   379

		if (tile != 0 && _current_player < MAX_PLAYERS) {

   380

			GetPlayer(_current_player)->last_build_coordinate = tile;

   381

		}

   382

	}

   383

   384

	_cmd_text = NULL;

   385

	return res;

   386

}

   387

   388

int32 GetAvailableMoneyForCommand(void)

   389

{

   390

	PlayerID pid = _current_player;

   391

	if (pid >= MAX_PLAYERS) return 0x7FFFFFFF; // max int

   392

	return GetPlayer(pid)->player_money;

   393

}

   394

   395

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

   396

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

   397

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

   398

{

   399

	int32 res = 0,res2;

   400

	CommandProc *proc;

   401

	uint32 flags;

   402

	bool notest;

   403

	StringID error_part1;

   404

   405

	int x = TileX(tile) * TILE_SIZE;

   406

	int y = TileY(tile) * TILE_SIZE;

   407

   408

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

   409

	if (tile >= MapSize()) {

   410

		_cmd_text = NULL;

   411

		return false;

   412

	}

   413

   414

	assert(_docommand_recursive == 0);

   415

   416

	_error_message = INVALID_STRING_ID;

   417

	error_part1 = GB(cmd, 16, 16);

   418

	_additional_cash_required = 0;

   419

   420

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

   421

	 * is a spectator but is the server, so can do anything */

   422

	if (_current_player == OWNER_SPECTATOR && !_network_dedicated) {

   423

		ShowErrorMessage(_error_message, error_part1, x, y);

   424

		_cmd_text = NULL;

   425

		return false;

   426

	}

   427

   428

	flags = 0;

   429

	if (cmd & CMD_AUTO) flags |= DC_AUTO;

   430

	if (cmd & CMD_NO_WATER) flags |= DC_NO_WATER;

   431

   432

	// get pointer to command handler

   433

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

   434

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

   435

	if (proc == NULL) {

   436

		_cmd_text = NULL;

   437

		return false;

   438

	}

   439

   440

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

   441

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

   442

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

   443

	//  it will fail. so res and res2 are different

   444

	// CMD_REMOVE_ROAD: This command has special local authority

   445

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

   446

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

   447

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

   448

	// fact will trigger an assertion failure. --pasky

   449

	notest =

   450

		(cmd & 0xFF) == CMD_CLEAR_AREA ||

   451

		(cmd & 0xFF) == CMD_CONVERT_RAIL ||

   452

		(cmd & 0xFF) == CMD_LEVEL_LAND ||

   453

		(cmd & 0xFF) == CMD_REMOVE_ROAD ||

   454

		(cmd & 0xFF) == CMD_REMOVE_LONG_ROAD;

   455

   456

	_docommand_recursive = 1;

   457

   458

	// cost estimation only?

   459

	if (_shift_pressed && IsLocalPlayer() && !(cmd & (CMD_NETWORK_COMMAND | CMD_SHOW_NO_ERROR))) {

   460

		// estimate the cost.

   461

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

   462

		if (CmdFailed(res)) {

   463

			if (res & 0xFFFF) _error_message = res & 0xFFFF;

   464

			ShowErrorMessage(_error_message, error_part1, x, y);

   465

		} else {

   466

			ShowEstimatedCostOrIncome(res, x, y);

   467

		}

   468

   469

		_docommand_recursive = 0;

   470

		_cmd_text = NULL;

   471

		return false;

   472

	}

   473

   474

   475

	if (!((cmd & CMD_NO_TEST_IF_IN_NETWORK) && _networking)) {

   476

		// first test if the command can be executed.

   477

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

   478

		if (CmdFailed(res)) {

   479

			if (res & 0xFFFF) _error_message = res & 0xFFFF;

   480

			goto show_error;

   481

		}

   482

		// no money? Only check if notest is off

   483

		if (!notest && res != 0 && !CheckPlayerHasMoney(res)) goto show_error;

   484

	}

   485

   486

#ifdef ENABLE_NETWORK

   487

	/** If we are in network, and the command is not from the network

   488

	 * send it to the command-queue and abort execution

   489

	 * If we are a dedicated server temporarily switch local player, otherwise

   490

	 * the other parties won't be able to execute our command and will desync.

   491

	 * @todo Rewrite dedicated server to something more than a dirty hack!

   492

	 */

   493

	if (_networking && !(cmd & CMD_NETWORK_COMMAND)) {

   494

		if (_network_dedicated) _local_player = 0;

   495

		NetworkSend_Command(tile, p1, p2, cmd, callback);

   496

		if (_network_dedicated) _local_player = OWNER_SPECTATOR;

   497

		_docommand_recursive = 0;

   498

		_cmd_text = NULL;

   499

		return true;

   500

	}