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

void ShowTrainDepotWindow(TileIndex tile);

    30

    31

/* Format of rail map5 byte.

    32

 * 00 abcdef  => Normal rail

    33

 * 01 abcdef  => Rail with signals

    34

 * 10 ??????  => Unused

    35

 * 11 ????dd  => Depot

    36

 *

    37

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

    38

 * value for each track is given.

    39

 */

    40

    41

/*         4

    42

 *     ---------

    43

 *    |\       /|

    44

 *    | \    1/ |

    45

 *    |  \   /  |

    46

 *    |   \ /   |

    47

 *  16|    \    |32

    48

 *    |   / \2  |

    49

 *    |  /   \  |

    50

 *    | /     \ |

    51

 *    |/       \|

    52

 *     ---------

    53

 *         8

    54

 */

    55

    56

    57

// Constants for lower part of Map2 byte.

    58

enum RailMap2Lower4 {

    59

	RAIL_MAP2LO_GROUND_MASK = 0xF,

    60

	RAIL_GROUND_BROWN = 0,

    61

	RAIL_GROUND_GREEN = 1,

    62

	RAIL_GROUND_FENCE_NW = 2,

    63

	RAIL_GROUND_FENCE_SE = 3,

    64

	RAIL_GROUND_FENCE_SENW = 4,

    65

	RAIL_GROUND_FENCE_NE = 5,

    66

	RAIL_GROUND_FENCE_SW = 6,

    67

	RAIL_GROUND_FENCE_NESW = 7,

    68

	RAIL_GROUND_FENCE_VERT1 = 8,

    69

	RAIL_GROUND_FENCE_VERT2 = 9,

    70

	RAIL_GROUND_FENCE_HORIZ1 = 10,

    71

	RAIL_GROUND_FENCE_HORIZ2 = 11,

    72

	RAIL_GROUND_ICE_DESERT = 12,

    73

};

    74

    75

    76

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

    77

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

    78

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

    79

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

    80

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

    81

 *				 similar for lower and right.

    82

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

    83

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

    84

 * MAP5:         00abcdef => rail

    85

 *               01abcdef => rail w/ signals

    86

 *               10uuuuuu => unused

    87

 *               11uuuudd => rail depot

    88

 */

    89

    90

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

    91

{

    92

	RailTileType type = GetRailTileType(tile);

    93

	TrackBits current; /* The current track layout */

    94

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

    95

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

    96

    97

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

    98

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

    99

   100

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

   101

	 * what tracks first */

   102

	current = GetTrackBits(tile);

   103

	future = current | to_build;

   104

   105

	/* Are we really building something new? */

   106

	if (current == future) {

   107

		/* Nothing new is being built */

   108

		_error_message = STR_1007_ALREADY_BUILT;

   109

		return false;

   110

	}

   111

   112

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

   113

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

   114

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

   115

		 * signals on the tile), check that */

   116

		return

   117

			future == (TRACK_BIT_UPPER | TRACK_BIT_LOWER) ||

   118

			future == (TRACK_BIT_LEFT  | TRACK_BIT_RIGHT);

   119

	} else {

   120

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

   121

		return true;

   122

	}

   123

}

   124

   125

   126

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

   127

   128

// set of normal ones

   129

{

   130

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

   131

	TRACK_BIT_RIGHT,

   132

	TRACK_BIT_UPPER,

   133

	TRACK_BIT_DIAG1,

   134

   135

	TRACK_BIT_LEFT,

   136

	0,

   137

	TRACK_BIT_DIAG2,

   138

	TRACK_BIT_LOWER,

   139

   140

	TRACK_BIT_LOWER,

   141

	TRACK_BIT_DIAG2,

   142

	0,

   143

	TRACK_BIT_LEFT,

   144

   145

	TRACK_BIT_DIAG1,

   146

	TRACK_BIT_UPPER,

   147

	TRACK_BIT_RIGHT,

   148

},

   149

   150

// allowed rail for an evenly raised platform

   151

{

   152

	0,

   153

	TRACK_BIT_LEFT,

   154

	TRACK_BIT_LOWER,

   155

	TRACK_BIT_DIAG2 | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   156

   157

	TRACK_BIT_RIGHT,

   158

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

   159

	TRACK_BIT_DIAG1 | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   160

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

   161

   162

	TRACK_BIT_UPPER,

   163

	TRACK_BIT_DIAG1 | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   164

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

   165

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

   166

   167

	TRACK_BIT_DIAG2 | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   168

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

   169

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

   170

},

   171

   172

// allowed rail on coast tile

   173

{

   174

	0,

   175

	TRACK_BIT_LEFT,

   176

	TRACK_BIT_LOWER,

   177

	TRACK_BIT_DIAG2|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   178

   179

	TRACK_BIT_RIGHT,

   180

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

   181

	TRACK_BIT_DIAG1|TRACK_BIT_RIGHT|TRACK_BIT_LOWER,

   182

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

   183

   184

	TRACK_BIT_UPPER,

   185

	TRACK_BIT_DIAG1|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   186

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

   187

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

   188

   189

	TRACK_BIT_DIAG2|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   190

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

   191

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

   192

	},

   193

   194

	// valid railway crossings on slopes

   195

	{

   196

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

   197

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

   198

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

   199

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

   200

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

   201

	}

   202

};

   203

   204

uint GetRailFoundation(uint tileh, uint bits)

   205

{

   206

	int i;

   207

   208

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

   209

		return 0;

   210

   211

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

   212

		return tileh;

   213

   214

	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)))

   215

		return i + 15;

   216

   217

	return 0;

   218

}

   219

   220

//

   221

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

   222

{

   223

	// never allow building on top of steep tiles

   224

	if (!IsSteepTileh(tileh)) {

   225

		rail_bits |= existing;

   226

   227

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

   228

		if (IsTileType(tile, MP_WATER) &&

   229

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

   230

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   231

		}

   232

   233

		// no special foundation

   234

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

   235

			return 0;

   236

   237

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

   238

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

   239

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

   240

				)) { // partly up

   241

			if (existing != 0) {

   242

				return 0;

   243

			} else if (!_patches.build_on_slopes ||

   244

					(_is_ai_player && !_patches.ainew_active)) {

   245

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   246

			} else {

   247

				return _price.terraform;

   248

			}

   249

		}

   250

	}

   251

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   252

}

   253

   254

/* Validate functions for rail building */

   255

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

   256

   257

/** Build a single piece of rail

   258

 * @param x,y coordinates on where to build

   259

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

   260

 * @param p2 rail track to build

   261

 */

   262

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

   263

{

   264

	TileIndex tile;

   265

	uint tileh;

   266

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

   267

	Track track = (Track)p2;

   268

	TrackBits trackbit;

   269

	int32 cost = 0;

   270

	int32 ret;

   271

   272

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

   273

   274

	tile = TileVirtXY(x, y);

   275

	tileh = GetTileSlope(tile, NULL);

   276

	m5 = _m[tile].m5;

   277

	trackbit = TrackToTrackBits(track);

   278

   279

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   280

   281

	switch (GetTileType(tile)) {

   282

		case MP_TUNNELBRIDGE:

   283

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

   284

					(m5 & 0x01 ? 1 : 2) != trackbit) { // wrong direction?

   285

				// Get detailed error message

   286

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

   287

			}

   288

   289

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

   290

				case 0x00: // clear land

   291

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

   292

					if (CmdFailed(ret)) return ret;

   293

					cost += ret;

   294

   295

					if (flags & DC_EXEC) {

   296

						SetTileOwner(tile, _current_player);

   297

						_m[tile].m3 &= ~0x0F;

   298

						_m[tile].m3 |= p1;

   299

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

   300

					}

   301

					break;

   302

   303

				case 0x20: // rail already there

   304

					return_cmd_error(STR_1007_ALREADY_BUILT);

   305

   306

				default:

   307

					// Get detailed error message

   308

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

   309

			}

   310

			break;

   311

   312

		case MP_RAILWAY:

   313

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

   314

					!EnsureNoVehicle(tile)) {

   315

				return CMD_ERROR;

   316

			}

   317

			if (m5 & RAIL_TYPE_SPECIAL ||

   318

					!IsTileOwner(tile, _current_player) ||

   319

					(_m[tile].m3 & 0xFU) != p1) {

   320

				// Get detailed error message

   321

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

   322

			}

   323

   324

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

   325

			if (CmdFailed(ret)) return ret;

   326

			cost += ret;

   327

   328

			if (flags & DC_EXEC) {

   329

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

   330

				_m[tile].m5 = m5 | trackbit;

   331

			}

   332

			break;

   333

   334

		case MP_STREET:

   335

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

   336

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   337

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   338

   339

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

   340

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

   341

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

   342

					)) {

   343

				if (flags & DC_EXEC) {

   344

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

   345

					SetTileOwner(tile, _current_player);

   346

					_m[tile].m4 = p1;

   347

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

   348

				}

   349

				break;

   350

			}

   351

   352

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

   353

				return_cmd_error(STR_1007_ALREADY_BUILT);

   354

			/* FALLTHROUGH */

   355

   356

		default:

   357

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

   358

			if (CmdFailed(ret)) return ret;

   359

			cost += ret;

   360

   361

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

   362

			if (CmdFailed(ret)) return ret;

   363

			cost += ret;

   364

   365

			if (flags & DC_EXEC) {

   366

				SetTileType(tile, MP_RAILWAY);

   367

				SetTileOwner(tile, _current_player);

   368

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

   369

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

   370

				_m[tile].m5 = trackbit;

   371

			}

   372

			break;

   373

	}

   374

   375

	if (flags & DC_EXEC) {

   376

		MarkTileDirtyByTile(tile);

   377

		SetSignalsOnBothDir(tile, track);

   378

	}

   379

   380

	return cost + _price.build_rail;

   381

}

   382

   383

static const byte _signals_table[] = {

   384

	0x40, 0x40, 0x40, 0x10, 0x80, 0x20, 0, 0, // direction 1

   385

	0x80, 0x80, 0x80, 0x20, 0x40, 0x10, 0, 0  // direction 2

   386

};

   387

   388

static const byte _signals_table_other[] = {

   389

	0x80, 0x80, 0x80, 0x20, 0x40, 0x10, 0, 0, // direction 1

   390

	0x40, 0x40, 0x40, 0x10, 0x80, 0x20, 0, 0  // direction 2

   391

};

   392

   393

static const byte _signals_table_both[] = {

   394

	0xC0, 0xC0, 0xC0, 0x30, 0xC0, 0x30, 0, 0,	// both directions combined

   395

	0xC0, 0xC0, 0xC0, 0x30, 0xC0, 0x30, 0, 0

   396

};

   397

   398

   399

/** Remove a single piece of track

   400

 * @param x,y coordinates for removal of track

   401

 * @param p1 unused

   402

 * @param p2 rail orientation

   403

 */

   404

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

   405

{

   406

	Track track = (Track)p2;

   407

	TrackBits trackbit;

   408

	uint tileh;

   409

	TileIndex tile;

   410

	byte m5;

   411

	int32 cost = _price.remove_rail;

   412

   413

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   414

	trackbit = TrackToTrackBits(track);

   415

   416

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   417

   418

	tile = TileVirtXY(x, y);

   419

	tileh = GetTileSlope(tile, NULL);

   420

   421

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

   422

		return CMD_ERROR;

   423

   424

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

   425

		return CMD_ERROR;

   426

   427

	// allow building rail under bridge

   428

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

   429

		return CMD_ERROR;

   430

   431

	switch(GetTileType(tile))

   432

	{

   433

		case MP_TUNNELBRIDGE:

   434

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

   435

				return CMD_ERROR;

   436

   437

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

   438

				return CMD_ERROR;

   439

   440

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

   441

				return CMD_ERROR;

   442

   443

			if (!(flags & DC_EXEC))

   444

				return _price.remove_rail;

   445

   446

		SetTileOwner(tile, OWNER_NONE);

   447

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

   448

			break;

   449

		case MP_STREET:

   450

			if (!(_m[tile].m5 & 0xF0))

   451

				return CMD_ERROR;

   452

   453

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

   454

				return CMD_ERROR;

   455

   456

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

   457

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

   458

				m5 = 5;

   459

				if (track != TRACK_DIAG1)

   460

					return CMD_ERROR;

   461

			} else {

   462

				m5 = 10;

   463

				if (track != TRACK_DIAG2)

   464

					return CMD_ERROR;

   465

			}

   466

   467

			if (!(flags & DC_EXEC))

   468

				return _price.remove_rail;

   469

   470

			_m[tile].m5 = m5;

   471

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

   472

			_m[tile].m2 = 0;

   473

			break;

   474

		case MP_RAILWAY:

   475

   476

			if (!IsPlainRailTile(tile))

   477

				return CMD_ERROR;

   478

   479

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

   480

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

   481

				return CMD_ERROR;

   482

   483

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

   484

			if (HasSignalOnTrack(tile, track))

   485

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

   486

   487

			if (!(flags & DC_EXEC))

   488

				return cost;

   489

   490

			/* We remove the trackbit here. */

   491

			_m[tile].m5 &= ~trackbit;

   492

   493

			/* Unreserve track for PBS */

   494

			if (PBSTileReserved(tile) & trackbit)