1

/* $Id$ */

     2

     3

/** @file rail_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "bridge.h"

     9

#include "cmd_helper.h"

    10

#include "debug.h"

    11

#include "functions.h"

    12

#include "rail_map.h"

    13

#include "road_map.h"

    14

#include "table/sprites.h"

    15

#include "table/strings.h"

    16

#include "map.h"

    17

#include "landscape.h"

    18

#include "tile.h"

    19

#include "town_map.h"

    20

#include "tunnel_map.h"

    21

#include "vehicle.h"

    22

#include "viewport.h"

    23

#include "command.h"

    24

#include "pathfind.h"

    25

#include "engine.h"

    26

#include "town.h"

    27

#include "sound.h"

    28

#include "station.h"

    29

#include "sprite.h"

    30

#include "depot.h"

    31

#include "waypoint.h"

    32

#include "window.h"

    33

#include "rail.h"

    34

#include "railtypes.h" // include table for railtypes

    35

#include "newgrf.h"

    36

#include "yapf/yapf.h"

    37

#include "newgrf_callbacks.h"

    38

#include "newgrf_station.h"

    39

#include "train.h"

    40

    41

const byte _track_sloped_sprites[14] = {

    42

	14, 15, 22, 13,

    43

	 0, 21, 17, 12,

    44

	23,  0, 18, 20,

    45

	19, 16

    46

};

    47

    48

    49

/*         4

    50

 *     ---------

    51

 *    |\       /|

    52

 *    | \    1/ |

    53

 *    |  \   /  |

    54

 *    |   \ /   |

    55

 *  16|    \    |32

    56

 *    |   / \2  |

    57

 *    |  /   \  |

    58

 *    | /     \ |

    59

 *    |/       \|

    60

 *     ---------

    61

 *         8

    62

 */

    63

    64

    65

    66

/* MAP2 byte:    abcd???? => Signal On? Same coding as map3lo

    67

 * MAP3LO byte:  abcd???? => Signal Exists?

    68

 *               a and b are for diagonals, upper and left,

    69

 *               one for each direction. (ie a == NE->SW, b ==

    70

 *               SW->NE, or v.v., I don't know. b and c are

    71

 *               similar for lower and right.

    72

 * MAP2 byte:    ????abcd => Type of ground.

    73

 * MAP3LO byte:  ????abcd => Type of rail.

    74

 * MAP5:         00abcdef => rail

    75

 *               01abcdef => rail w/ signals

    76

 *               10uuuuuu => unused

    77

 *               11uuuudd => rail depot

    78

 */

    79

    80

static bool CheckTrackCombination(TileIndex tile, TrackBits to_build, uint flags)

    81

{

    82

	TrackBits current; // The current track layout

    83

	TrackBits future;  // The track layout we want to build

    84

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

    85

    86

	if (!IsPlainRailTile(tile)) return false;

    87

    88

	/* So, we have a tile with tracks on it (and possibly signals). Let's see

    89

	 * what tracks first */

    90

	current = GetTrackBits(tile);

    91

	future = current | to_build;

    92

    93

	/* Are we really building something new? */

    94

	if (current == future) {

    95

		/* Nothing new is being built */

    96

		_error_message = STR_1007_ALREADY_BUILT;

    97

		return false;

    98

	}

    99

   100

	/* Let's see if we may build this */

   101

	if (flags & DC_NO_RAIL_OVERLAP || HasSignals(tile)) {

   102

		/* If we are not allowed to overlap (flag is on for ai players or we have

   103

		 * signals on the tile), check that */

   104

		return future == TRACK_BIT_HORZ || future == TRACK_BIT_VERT;

   105

	} else {

   106

		/* Normally, we may overlap and any combination is valid */

   107

		return true;

   108

	}

   109

}

   110

   111

   112

static const TrackBits _valid_tileh_slopes[][15] = {

   113

   114

/* set of normal ones */

   115

{

   116

	TRACK_BIT_ALL,

   117

	TRACK_BIT_RIGHT,

   118

	TRACK_BIT_UPPER,

   119

	TRACK_BIT_X,

   120

   121

	TRACK_BIT_LEFT,

   122

	TRACK_BIT_NONE,

   123

	TRACK_BIT_Y,

   124

	TRACK_BIT_LOWER,

   125

   126

	TRACK_BIT_LOWER,

   127

	TRACK_BIT_Y,

   128

	TRACK_BIT_NONE,

   129

	TRACK_BIT_LEFT,

   130

   131

	TRACK_BIT_X,

   132

	TRACK_BIT_UPPER,

   133

	TRACK_BIT_RIGHT,

   134

},

   135

   136

/* allowed rail for an evenly raised platform */

   137

{

   138

	TRACK_BIT_NONE,

   139

	TRACK_BIT_LEFT,

   140

	TRACK_BIT_LOWER,

   141

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   142

   143

	TRACK_BIT_RIGHT,

   144

	TRACK_BIT_ALL,

   145

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   146

	TRACK_BIT_ALL,

   147

   148

	TRACK_BIT_UPPER,

   149

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   150

	TRACK_BIT_ALL,

   151

	TRACK_BIT_ALL,

   152

   153

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   154

	TRACK_BIT_ALL,

   155

	TRACK_BIT_ALL

   156

}

   157

};

   158

   159

uint GetRailFoundation(Slope tileh, TrackBits bits)

   160

{

   161

	uint i;

   162

   163

	if (!IsSteepSlope(tileh)) {

   164

		if ((~_valid_tileh_slopes[0][tileh] & bits) == 0) return 0;

   165

		if ((~_valid_tileh_slopes[1][tileh] & bits) == 0) return tileh;

   166

	}

   167

   168

	switch (bits) {

   169

		default: NOT_REACHED();

   170

		case TRACK_BIT_X: i = 0; break;

   171

		case TRACK_BIT_Y: i = 1; break;

   172

		case TRACK_BIT_LEFT:  return 15 + 8 + (tileh == SLOPE_STEEP_W ? 4 : 0);

   173

		case TRACK_BIT_LOWER: return 15 + 8 + (tileh == SLOPE_STEEP_S ? 5 : 1);

   174

		case TRACK_BIT_RIGHT: return 15 + 8 + (tileh == SLOPE_STEEP_E ? 6 : 2);

   175

		case TRACK_BIT_UPPER: return 15 + 8 + (tileh == SLOPE_STEEP_N ? 7 : 3);

   176

	}

   177

	switch (tileh) {

   178

		case SLOPE_W:

   179

		case SLOPE_STEEP_W: i += 0; break;

   180

		case SLOPE_S:

   181

		case SLOPE_STEEP_S: i += 2; break;

   182

		case SLOPE_E:

   183

		case SLOPE_STEEP_E: i += 4; break;

   184

		case SLOPE_N:

   185

		case SLOPE_STEEP_N: i += 6; break;

   186

		default: return 0;

   187

	}

   188

	return i + 15;

   189

}

   190

   191

   192

static CommandCost CheckRailSlope(Slope tileh, TrackBits rail_bits, TrackBits existing, TileIndex tile)

   193

{

   194

	if (IsSteepSlope(tileh)) {

   195

		if (_patches.build_on_slopes && existing == 0) {

   196

			TrackBits valid = TRACK_BIT_CROSS | (HASBIT(1 << SLOPE_STEEP_W | 1 << SLOPE_STEEP_E, tileh) ? TRACK_BIT_VERT : TRACK_BIT_HORZ);

   197

			if (valid & rail_bits) return _price.terraform;

   198

		}

   199

	} else {

   200

		rail_bits |= existing;

   201

   202

		/* don't allow building on the lower side of a coast */

   203

		if (IsTileType(tile, MP_WATER) &&

   204

				~_valid_tileh_slopes[1][tileh] & rail_bits) {

   205

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   206

		}

   207

   208

		/* no special foundation */

   209

		if ((~_valid_tileh_slopes[0][tileh] & rail_bits) == 0) {

   210

			return CommandCost();

   211

		} else if (!_patches.build_on_slopes) {

   212

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   213

		}

   214

   215

		if ((~_valid_tileh_slopes[1][tileh] & rail_bits) == 0 || ( // whole tile is leveled up

   216

					(rail_bits == TRACK_BIT_X || rail_bits == TRACK_BIT_Y) &&

   217

					(tileh == SLOPE_W || tileh == SLOPE_S || tileh == SLOPE_E || tileh == SLOPE_N)

   218

				)) { // partly up

   219

			return CommandCost((existing != 0) ? 0 : _price.terraform);

   220

		}

   221

	}

   222

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   223

}

   224

   225

/* Validate functions for rail building */

   226

static inline bool ValParamTrackOrientation(Track track) {return IsValidTrack(track);}

   227

   228

/** Build a single piece of rail

   229

 * @param tile tile  to build on

   230

 * @param flags operation to perform

   231

 * @param p1 railtype of being built piece (normal, mono, maglev)

   232

 * @param p2 rail track to build

   233

 */

   234

CommandCost CmdBuildSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   235

{

   236

	Slope tileh;

   237

	RailType railtype;

   238

	Track track;

   239

	TrackBits trackbit;

   240

	CommandCost cost;

   241

	CommandCost ret;

   242

   243

	if (!ValParamRailtype(p1) || !ValParamTrackOrientation((Track)p2)) return CMD_ERROR;

   244

	railtype = (RailType)p1;

   245

	track = (Track)p2;

   246

   247

	tileh = GetTileSlope(tile, NULL);

   248

	trackbit = TrackToTrackBits(track);

   249

   250

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   251

   252

	switch (GetTileType(tile)) {

   253

		case MP_RAILWAY:

   254

			if (!CheckTrackCombination(tile, trackbit, flags) ||

   255

					!EnsureNoVehicleOnGround(tile)) {

   256

				return CMD_ERROR;

   257

			}

   258

			if (!IsTileOwner(tile, _current_player) ||

   259

					!IsCompatibleRail(GetRailType(tile), railtype)) {

   260

				/* Get detailed error message */

   261

				return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   262

			}

   263

   264

			ret = CheckRailSlope(tileh, trackbit, GetTrackBits(tile), tile);

   265

			if (CmdFailed(ret)) return ret;

   266

			cost.AddCost(ret);

   267

   268

			/* If the rail types don't match, try to convert only if engines of

   269

			 * the present rail type are powered on the new rail type. */

   270

			if (GetRailType(tile) != railtype && HasPowerOnRail(GetRailType(tile), railtype)) {

   271

				ret = DoCommand(tile, tile, railtype, flags, CMD_CONVERT_RAIL);

   272

				if (CmdFailed(ret)) return ret;

   273

				cost.AddCost(ret);

   274

			}

   275

   276

			if (flags & DC_EXEC) {

   277

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   278

				SetTrackBits(tile, GetTrackBits(tile) | trackbit);

   279

			}

   280

			break;

   281

   282

		case MP_STREET:

   283

#define M(x) (1 << (x))

   284

			/* Level crossings may only be built on these slopes */

   285

			if (!HASBIT(M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT), tileh)) {

   286

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   287

			}

   288

#undef M

   289

   290

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   291

   292

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   293

				if (HasRoadWorks(tile)) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   294

   295

				RoadTypes roadtypes = GetRoadTypes(tile);

   296

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   297

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   298

				switch (roadtypes) {

   299

					default: break;

   300

					case ROADTYPES_TRAM:

   301

						/* Tram crossings must always have road. */

   302

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   303

						roadtypes |= ROADTYPES_ROAD;

   304

						break;

   305

   306

					case ROADTYPES_ROADTRAM: if (road == tram) break;

   307

						/* FALL THROUGH */

   308

					case ROADTYPES_ROADHWAY: // Road and highway are incompatible in this case

   309

					case ROADTYPES_TRAMHWAY: // Tram and highway are incompatible in this case

   310

					case ROADTYPES_ALL:      // Also incompatible

   311

						return CMD_ERROR;

   312

				}

   313

   314

				road |= tram | GetRoadBits(tile, ROADTYPE_HWAY);

   315

   316

				if ((track == TRACK_X && road == ROAD_Y) ||

   317

						(track == TRACK_Y && road == ROAD_X)) {

   318

					if (flags & DC_EXEC) {

   319

						MakeRoadCrossing(tile, GetRoadOwner(tile, ROADTYPE_ROAD), GetRoadOwner(tile, ROADTYPE_TRAM), GetRoadOwner(tile, ROADTYPE_HWAY), _current_player, (track == TRACK_X ? AXIS_Y : AXIS_X), railtype, roadtypes, GetTownIndex(tile));

   320

					}

   321

					break;

   322

				}

   323

			}

   324

   325

			if (IsLevelCrossing(tile) && GetCrossingRailBits(tile) == trackbit) {

   326

				return_cmd_error(STR_1007_ALREADY_BUILT);

   327

			}

   328

			/* FALLTHROUGH */

   329

   330

		default:

   331

			ret = CheckRailSlope(tileh, trackbit, TRACK_BIT_NONE, tile);

   332

			if (CmdFailed(ret)) return ret;

   333

			cost.AddCost(ret);

   334

   335

			ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   336

			if (CmdFailed(ret)) return ret;

   337

			cost.AddCost(ret);

   338

   339

			if (flags & DC_EXEC) MakeRailNormal(tile, _current_player, trackbit, railtype);

   340

			break;

   341

	}

   342

   343

	if (flags & DC_EXEC) {

   344

		MarkTileDirtyByTile(tile);

   345

		SetSignalsOnBothDir(tile, track);

   346

		YapfNotifyTrackLayoutChange(tile, track);

   347

	}

   348

   349

	return cost.AddCost(_price.build_rail);

   350

}

   351

   352

/** Remove a single piece of track

   353

 * @param tile tile to remove track from

   354

 * @param flags operation to perform

   355

 * @param p1 unused

   356

 * @param p2 rail orientation

   357

 */

   358

CommandCost CmdRemoveSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   359

{

   360

	Track track = (Track)p2;

   361

	TrackBits trackbit;

   362

	CommandCost cost(_price.remove_rail);

   363

	bool crossing = false;

   364

   365

	if (!ValParamTrackOrientation((Track)p2)) return CMD_ERROR;

   366

	trackbit = TrackToTrackBits(track);

   367

   368

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   369

   370

	switch (GetTileType(tile)) {

   371

		case MP_STREET: {

   372

			if (!IsLevelCrossing(tile) ||

   373

					GetCrossingRailBits(tile) != trackbit ||

   374

					(_current_player != OWNER_WATER && !CheckTileOwnership(tile)) ||

   375

					!EnsureNoVehicleOnGround(tile)) {

   376

				return CMD_ERROR;

   377

			}

   378

   379

			if (flags & DC_EXEC) {

   380

				MakeRoadNormal(tile, GetCrossingRoadBits(tile), GetRoadTypes(tile), GetTownIndex(tile), GetRoadOwner(tile, ROADTYPE_ROAD), GetRoadOwner(tile, ROADTYPE_TRAM), GetRoadOwner(tile, ROADTYPE_HWAY));

   381

			}

   382

			break;

   383

		}

   384

   385

		case MP_RAILWAY: {

   386

			TrackBits present;

   387

   388

			if (!IsPlainRailTile(tile) ||

   389

					(_current_player != OWNER_WATER && !CheckTileOwnership(tile)) ||

   390

					!EnsureNoVehicleOnGround(tile)) {

   391

				return CMD_ERROR;

   392

			}

   393

   394

			present = GetTrackBits(tile);

   395

			if ((present & trackbit) == 0) return CMD_ERROR;

   396

			if (present == (TRACK_BIT_X | TRACK_BIT_Y)) crossing = true;

   397

   398

			/* Charge extra to remove signals on the track, if they are there */

   399

			if (HasSignalOnTrack(tile, track))

   400

				cost.AddCost(DoCommand(tile, track, 0, flags, CMD_REMOVE_SIGNALS));

   401

   402

			if (flags & DC_EXEC) {

   403

				present ^= trackbit;

   404

				if (present == 0) {

   405

					DoClearSquare(tile);

   406

				} else {

   407

					SetTrackBits(tile, present);

   408

				}

   409

			}

   410

			break;

   411

		}

   412

   413

		default: return CMD_ERROR;

   414

	}

   415

   416

	if (flags & DC_EXEC) {

   417

		MarkTileDirtyByTile(tile);

   418

		if (crossing) {

   419

			/* crossing is set when only TRACK_BIT_X and TRACK_BIT_Y are set. As we

   420

			 * are removing one of these pieces, we'll need to update signals for

   421

			 * both directions explicitly, as after the track is removed it won't

   422

			 * 'connect' with the other piece. */

   423

			SetSignalsOnBothDir(tile, TRACK_X);

   424

			SetSignalsOnBothDir(tile, TRACK_Y);

   425

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   426

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   427

		} else {

   428

			SetSignalsOnBothDir(tile, track);

   429

			YapfNotifyTrackLayoutChange(tile, track);

   430

		}

   431

	}

   432

   433

	return cost;

   434

}

   435

   436

   437

static const TileIndexDiffC _trackdelta[] = {

   438

	{ -1,  0 }, {  0,  1 }, { -1,  0 }, {  0,  1 }, {  1,  0 }, {  0,  1 },

   439

	{  0,  0 },

   440

	{  0,  0 },

   441

	{  1,  0 }, {  0, -1 }, {  0, -1 }, {  1,  0 }, {  0, -1 }, { -1,  0 },

   442

	{  0,  0 },

   443

	{  0,  0 }

   444

};

   445

   446

   447

static CommandCost ValidateAutoDrag(Trackdir *trackdir, TileIndex start, TileIndex end)

   448

{

   449

	int x = TileX(start);

   450

	int y = TileY(start);

   451

	int ex = TileX(end);

   452

	int ey = TileY(end);

   453

	int dx, dy, trdx, trdy;

   454

   455

	if (!ValParamTrackOrientation(TrackdirToTrack(*trackdir))) return CMD_ERROR;

   456

   457

	/* calculate delta x,y from start to end tile */

   458

	dx = ex - x;

   459

	dy = ey - y;

   460

   461

	/* calculate delta x,y for the first direction */

   462

	trdx = _trackdelta[*trackdir].x;

   463

	trdy = _trackdelta[*trackdir].y;

   464

   465

	if (!IsDiagonalTrackdir(*trackdir)) {

   466

		trdx += _trackdelta[*trackdir ^ 1].x;

   467

		trdy += _trackdelta[*trackdir ^ 1].y;

   468

	}

   469

   470

	/* validate the direction */

   471

	while (

   472

		(trdx <= 0 && dx > 0) ||

   473

		(trdx >= 0 && dx < 0) ||

   474

		(trdy <= 0 && dy > 0) ||

   475

		(trdy >= 0 && dy < 0)

   476

	) {

   477

		if (!HASBIT(*trackdir, 3)) { // first direction is invalid, try the other

   478

			SetBitT(*trackdir, 3); // reverse the direction

   479

			trdx = -trdx;

   480

			trdy = -trdy;

   481

		} else { // other direction is invalid too, invalid drag

   482

			return CMD_ERROR;

   483

		}