1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "table/sprites.h"

     8

#include "table/strings.h"

     9

#include "map.h"

    10

#include "tile.h"

    11

#include "vehicle.h"

    12

#include "viewport.h"

    13

#include "command.h"

    14

#include "pathfind.h"

    15

#include "engine.h"

    16

#include "town.h"

    17

#include "sound.h"

    18

#include "station.h"

    19

#include "sprite.h"

    20

#include "depot.h"

    21

#include "pbs.h"

    22

#include "waypoint.h"

    23

#include "npf.h"

    24

#include "rail.h"

    25

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

    26

    27

extern uint16 _custom_sprites_base;

    28

    29

const byte _track_sloped_sprites[14] = {

    30

	14, 15, 22, 13,

    31

	 0, 21, 17, 12,

    32

	23,  0, 18, 20,

    33

	19, 16

    34

};

    35

    36

void ShowTrainDepotWindow(TileIndex tile);

    37

    38

/* Format of rail map5 byte.

    39

 * 00 abcdef  => Normal rail

    40

 * 01 abcdef  => Rail with signals

    41

 * 10 ??????  => Unused

    42

 * 11 ????dd  => Depot

    43

 *

    44

 * abcdef is a bitmask, which contains ones for all present tracks. Below the

    45

 * value for each track is given.

    46

 */

    47

    48

/*         4

    49

 *     ---------

    50

 *    |\       /|

    51

 *    | \    1/ |

    52

 *    |  \   /  |

    53

 *    |   \ /   |

    54

 *  16|    \    |32

    55

 *    |   / \2  |

    56

 *    |  /   \  |

    57

 *    | /     \ |

    58

 *    |/       \|

    59

 *     ---------

    60

 *         8

    61

 */

    62

    63

    64

// Constants for lower part of Map2 byte.

    65

enum RailMap2Lower4 {

    66

	RAIL_MAP2LO_GROUND_MASK = 0xF,

    67

	RAIL_GROUND_BROWN = 0,

    68

	RAIL_GROUND_GREEN = 1,

    69

	RAIL_GROUND_FENCE_NW = 2,

    70

	RAIL_GROUND_FENCE_SE = 3,

    71

	RAIL_GROUND_FENCE_SENW = 4,

    72

	RAIL_GROUND_FENCE_NE = 5,

    73

	RAIL_GROUND_FENCE_SW = 6,

    74

	RAIL_GROUND_FENCE_NESW = 7,

    75

	RAIL_GROUND_FENCE_VERT1 = 8,

    76

	RAIL_GROUND_FENCE_VERT2 = 9,

    77

	RAIL_GROUND_FENCE_HORIZ1 = 10,

    78

	RAIL_GROUND_FENCE_HORIZ2 = 11,

    79

	RAIL_GROUND_ICE_DESERT = 12,

    80

};

    81

    82

    83

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

    84

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

    85

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

    86

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

    87

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

    88

 *				 similar for lower and right.

    89

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

    90

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

    91

 * MAP5:         00abcdef => rail

    92

 *               01abcdef => rail w/ signals

    93

 *               10uuuuuu => unused

    94

 *               11uuuudd => rail depot

    95

 */

    96

    97

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

    98

{

    99

	RailTileType type = GetRailTileType(tile);

   100

	TrackBits current; /* The current track layout */

   101

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

   102

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   103

   104

	if (type != RAIL_TYPE_NORMAL && type != RAIL_TYPE_SIGNALS)

   105

		return false; /* Cannot build anything on depots and checkpoints */

   106

   107

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

   108

	 * what tracks first */

   109

	current = GetTrackBits(tile);

   110

	future = current | to_build;

   111

   112

	/* Are we really building something new? */

   113

	if (current == future) {

   114

		/* Nothing new is being built */

   115

		_error_message = STR_1007_ALREADY_BUILT;

   116

		return false;

   117

	}

   118

   119

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

   120

	if ((flags & DC_NO_RAIL_OVERLAP) || type == RAIL_TYPE_SIGNALS) {

   121

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

   122

		 * signals on the tile), check that */

   123

		return

   124

			future == (TRACK_BIT_UPPER | TRACK_BIT_LOWER) ||

   125

			future == (TRACK_BIT_LEFT  | TRACK_BIT_RIGHT);

   126

	} else {

   127

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

   128

		return true;

   129

	}

   130

}

   131

   132

   133

static const byte _valid_tileh_slopes[4][15] = {

   134

   135

// set of normal ones

   136

{

   137

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   138

	TRACK_BIT_RIGHT,

   139

	TRACK_BIT_UPPER,

   140

	TRACK_BIT_DIAG1,

   141

   142

	TRACK_BIT_LEFT,

   143

	0,

   144

	TRACK_BIT_DIAG2,

   145

	TRACK_BIT_LOWER,

   146

   147

	TRACK_BIT_LOWER,

   148

	TRACK_BIT_DIAG2,

   149

	0,

   150

	TRACK_BIT_LEFT,

   151

   152

	TRACK_BIT_DIAG1,

   153

	TRACK_BIT_UPPER,

   154

	TRACK_BIT_RIGHT,

   155

},

   156

   157

// allowed rail for an evenly raised platform

   158

{

   159

	0,

   160

	TRACK_BIT_LEFT,

   161

	TRACK_BIT_LOWER,

   162

	TRACK_BIT_DIAG2 | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   163

   164

	TRACK_BIT_RIGHT,

   165

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   166

	TRACK_BIT_DIAG1 | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   167

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   168

   169

	TRACK_BIT_UPPER,

   170

	TRACK_BIT_DIAG1 | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   171

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   172

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   173

   174

	TRACK_BIT_DIAG2 | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   175

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   176

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   177

},

   178

   179

// allowed rail on coast tile

   180

{

   181

	0,

   182

	TRACK_BIT_LEFT,

   183

	TRACK_BIT_LOWER,

   184

	TRACK_BIT_DIAG2|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   185

   186

	TRACK_BIT_RIGHT,

   187

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   188

	TRACK_BIT_DIAG1|TRACK_BIT_RIGHT|TRACK_BIT_LOWER,

   189

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   190

   191

	TRACK_BIT_UPPER,

   192

	TRACK_BIT_DIAG1|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   193

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   194

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   195

   196

	TRACK_BIT_DIAG2|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   197

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   198

	TRACK_BIT_DIAG1|TRACK_BIT_DIAG2|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   199

	},

   200

   201

	// valid railway crossings on slopes

   202

	{

   203

		1, 0, 0, // 0, 1, 2

   204

		0, 0, 1, // 3, 4, 5

   205

		0, 1, 0, // 6, 7, 8

   206

		0, 1, 1, // 9, 10, 11

   207

		0, 1, 1, // 12, 13, 14

   208

	}

   209

};

   210

   211

uint GetRailFoundation(uint tileh, uint bits)

   212

{

   213

	int i;

   214

   215

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

   216

		return 0;

   217

   218

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

   219

		return tileh;

   220

   221

	if ( ((i=0, tileh == 1) || (i+=2, tileh == 2) || (i+=2, tileh == 4) || (i+=2, tileh == 8)) && (bits == TRACK_BIT_DIAG1 || (i++, bits == TRACK_BIT_DIAG2)))

   222

		return i + 15;

   223

   224

	return 0;

   225

}

   226

   227

   228

static uint32 CheckRailSlope(uint tileh, TrackBits rail_bits, TrackBits existing, TileIndex tile)

   229

{

   230

	// never allow building on top of steep tiles

   231

	if (!IsSteepTileh(tileh)) {

   232

		rail_bits |= existing;

   233

   234

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

   235

		if (IsTileType(tile, MP_WATER) &&

   236

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

   237

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   238

		}

   239

   240

		// no special foundation

   241

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

   242

			return 0;

   243

   244

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

   245

					(rail_bits == TRACK_BIT_DIAG1 || rail_bits == TRACK_BIT_DIAG2) &&

   246

					(tileh == 1 || tileh == 2 || tileh == 4 || tileh == 8)

   247

				)) { // partly up

   248

			if (existing != 0) {

   249

				return 0;

   250

			} else if (!_patches.build_on_slopes || _is_old_ai_player) {

   251

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   252

			} else {

   253

				return _price.terraform;

   254

			}

   255

		}

   256

	}

   257

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   258

}

   259

   260

/* Validate functions for rail building */

   261

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

   262

   263

/** Build a single piece of rail

   264

 * @param x,y coordinates on where to build

   265

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

   266

 * @param p2 rail track to build

   267

 */

   268

int32 CmdBuildSingleRail(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   269

{

   270

	TileIndex tile;

   271

	uint tileh;

   272

	uint m5; /* XXX: Used only as a cache, should probably be removed? */

   273

	Track track = (Track)p2;

   274

	TrackBits trackbit;

   275

	int32 cost = 0;

   276

	int32 ret;

   277

   278

	if (!ValParamRailtype(p1) || !ValParamTrackOrientation(track)) return CMD_ERROR;

   279

   280

	tile = TileVirtXY(x, y);

   281

	tileh = GetTileSlope(tile, NULL);

   282

	m5 = _m[tile].m5;

   283

	trackbit = TrackToTrackBits(track);

   284

   285

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   286

   287

	switch (GetTileType(tile)) {

   288

		case MP_TUNNELBRIDGE:

   289

			if ((m5 & 0xC0) != 0xC0 || // not bridge middle part?

   290

					(m5 & 0x01 ? TRACK_BIT_DIAG1 : TRACK_BIT_DIAG2) != trackbit) { // wrong direction?

   291

				// Get detailed error message

   292

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

   293

			}

   294

   295

			switch (m5 & 0x38) { // what's under the bridge?

   296

				case 0x00: // clear land

   297

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

   298

					if (CmdFailed(ret)) return ret;

   299

					cost += ret;

   300

   301

					if (flags & DC_EXEC) {

   302

						SetTileOwner(tile, _current_player);

   303

						SB(_m[tile].m3, 0, 4, p1);

   304

						_m[tile].m5 = (m5 & 0xC7) | 0x20; // railroad under bridge

   305

					}

   306

					break;

   307

   308

				case 0x20: // rail already there

   309

					return_cmd_error(STR_1007_ALREADY_BUILT);

   310

   311

				default:

   312

					// Get detailed error message

   313

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

   314

			}

   315

			break;

   316

   317

		case MP_RAILWAY:

   318

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

   319

					!EnsureNoVehicle(tile)) {

   320

				return CMD_ERROR;

   321

			}

   322

			if (m5 & RAIL_TYPE_SPECIAL ||

   323

					!IsTileOwner(tile, _current_player) ||

   324

					GB(_m[tile].m3, 0, 4) != p1) {

   325

				// Get detailed error message

   326

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

   327

			}

   328

   329

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

   330

			if (CmdFailed(ret)) return ret;

   331

			cost += ret;

   332

   333

			if (flags & DC_EXEC) {

   334

				_m[tile].m2 &= ~RAIL_MAP2LO_GROUND_MASK; // Bare land

   335

				_m[tile].m5 = m5 | trackbit;

   336

			}

   337

			break;

   338

   339

		case MP_STREET:

   340

			if (!_valid_tileh_slopes[3][tileh]) // prevent certain slopes

   341

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   342

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   343

   344

			if ((m5 & 0xF0) == 0 && ( // normal road?

   345

						(track == TRACK_DIAG1 && m5 == 0x05) ||

   346

						(track == TRACK_DIAG2 && m5 == 0x0A) // correct direction?

   347

					)) {

   348

				if (flags & DC_EXEC) {

   349

					_m[tile].m3 = GetTileOwner(tile);

   350

					SetTileOwner(tile, _current_player);

   351

					_m[tile].m4 = p1;

   352

					_m[tile].m5 = 0x10 | (track == TRACK_DIAG1 ? 0x08 : 0x00); // level crossing

   353

				}

   354

				break;

   355

			}

   356

   357

			if (IsLevelCrossing(tile) && (m5 & 0x08 ? TRACK_DIAG1 : TRACK_DIAG2) == track)

   358

				return_cmd_error(STR_1007_ALREADY_BUILT);

   359

			/* FALLTHROUGH */

   360

   361

		default:

   362

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

   363

			if (CmdFailed(ret)) return ret;

   364

			cost += ret;

   365

   366

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

   367

			if (CmdFailed(ret)) return ret;

   368

			cost += ret;

   369

   370

			if (flags & DC_EXEC) {

   371

				SetTileType(tile, MP_RAILWAY);

   372

				SetTileOwner(tile, _current_player);

   373

				_m[tile].m2 = 0; // Bare land

   374

				_m[tile].m3 = p1; // No signals, rail type

   375

				_m[tile].m5 = trackbit;

   376

			}

   377

			break;

   378

	}

   379

   380

	if (flags & DC_EXEC) {

   381

		MarkTileDirtyByTile(tile);

   382

		SetSignalsOnBothDir(tile, track);

   383

	}

   384

   385

	return cost + _price.build_rail;

   386

}

   387

   388

/** Remove a single piece of track

   389

 * @param x,y coordinates for removal of track

   390

 * @param p1 unused

   391

 * @param p2 rail orientation

   392

 */

   393

int32 CmdRemoveSingleRail(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   394

{

   395

	Track track = (Track)p2;

   396

	TrackBits trackbit;

   397

	TileIndex tile;

   398

	byte m5;

   399

	int32 cost = _price.remove_rail;

   400

   401

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   402

	trackbit = TrackToTrackBits(track);

   403

   404

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   405

   406

	tile = TileVirtXY(x, y);

   407

   408

	if (!IsTileType(tile, MP_TUNNELBRIDGE) && !IsTileType(tile, MP_STREET) && !IsTileType(tile, MP_RAILWAY))

   409

		return CMD_ERROR;

   410

   411

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

   412

		return CMD_ERROR;

   413

   414

	// allow building rail under bridge

   415

	if (!IsTileType(tile, MP_TUNNELBRIDGE) && !EnsureNoVehicle(tile))

   416

		return CMD_ERROR;

   417

   418

	switch(GetTileType(tile))

   419

	{

   420

		case MP_TUNNELBRIDGE:

   421

			if (!EnsureNoVehicleZ(tile, TilePixelHeight(tile)))

   422

				return CMD_ERROR;

   423

   424

			if ((_m[tile].m5 & 0xF8) != 0xE0)

   425

				return CMD_ERROR;

   426

   427

			if ((_m[tile].m5 & 1 ? TRACK_BIT_DIAG1 : TRACK_BIT_DIAG2) != trackbit)

   428

				return CMD_ERROR;

   429

   430

			if (!(flags & DC_EXEC))

   431

				return _price.remove_rail;

   432

   433

			SetTileOwner(tile, OWNER_NONE);

   434

			_m[tile].m5 = _m[tile].m5 & 0xC7;

   435

			break;

   436

   437

		case MP_STREET:

   438

			if (!IsLevelCrossing(tile)) return CMD_ERROR;

   439

   440

			/* This is a crossing, let's check if the direction is correct */

   441

			if (_m[tile].m5 & 8) {

   442

				m5 = 5;

   443

				if (track != TRACK_DIAG1)

   444

					return CMD_ERROR;

   445

			} else {

   446

				m5 = 10;

   447

				if (track != TRACK_DIAG2)

   448

					return CMD_ERROR;

   449

			}

   450

   451

			if (!(flags & DC_EXEC))

   452

				return _price.remove_rail;

   453

   454

			_m[tile].m5 = m5;

   455

			SetTileOwner(tile, _m[tile].m3);

   456

			_m[tile].m2 = 0;

   457

			break;

   458

   459

		case MP_RAILWAY:

   460

			if (!IsPlainRailTile(tile))

   461

				return CMD_ERROR;

   462

   463

			/* See if the track to remove is actually there */

   464

			if (!(GetTrackBits(tile) & trackbit))

   465

				return CMD_ERROR;

   466

   467

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

   468

			if (HasSignalOnTrack(tile, track))

   469

				cost += DoCommand(x, y, track, 0, flags, CMD_REMOVE_SIGNALS);

   470

   471

			if (!(flags & DC_EXEC))

   472

				return cost;

   473

   474

			/* We remove the trackbit here. */

   475

			_m[tile].m5 &= ~trackbit;

   476

   477

			/* Unreserve track for PBS */

   478

			if (PBSTileReserved(tile) & trackbit)

   479

				PBSClearTrack(tile, track);

   480

   481

			if (GetTrackBits(tile)  == 0) {

   482

				/* The tile has no tracks left, it is no longer a rail tile */

   483

				DoClearSquare(tile);

   484

				/* XXX: This is an optimisation, right? Is it really worth the ugly goto? */

   485

				goto skip_mark_dirty;

   486

			}

   487

			break;

   488

   489

		default:

   490

			assert(0);

   491

	}

   492