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

    26

extern uint16 _custom_sprites_base;

    27

    28

void ShowTrainDepotWindow(TileIndex tile);

    29

    30

/* Format of rail map5 byte.

    31

 * 00 abcdef  => Normal rail

    32

 * 01 abcdef  => Rail with signals

    33

 * 10 ??????  => Unused

    34

 * 11 ????dd  => Depot

    35

 *

    36

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

    37

 * value for each track is given.

    38

 */

    39

    40

/*         4

    41

 *     ---------

    42

 *    |\       /|

    43

 *    | \    1/ |

    44

 *    |  \   /  |

    45

 *    |   \ /   |

    46

 *  16|    \    |32

    47

 *    |   / \2  |

    48

 *    |  /   \  |

    49

 *    | /     \ |

    50

 *    |/       \|

    51

 *     ---------

    52

 *         8

    53

 */

    54

    55

    56

// Constants for lower part of Map2 byte.

    57

enum RailMap2Lower4 {

    58

	RAIL_MAP2LO_GROUND_MASK = 0xF,

    59

	RAIL_GROUND_BROWN = 0,

    60

	RAIL_GROUND_GREEN = 1,

    61

	RAIL_GROUND_FENCE_NW = 2,

    62

	RAIL_GROUND_FENCE_SE = 3,

    63

	RAIL_GROUND_FENCE_SENW = 4,

    64

	RAIL_GROUND_FENCE_NE = 5,

    65

	RAIL_GROUND_FENCE_SW = 6,

    66

	RAIL_GROUND_FENCE_NESW = 7,

    67

	RAIL_GROUND_FENCE_VERT1 = 8,

    68

	RAIL_GROUND_FENCE_VERT2 = 9,

    69

	RAIL_GROUND_FENCE_HORIZ1 = 10,

    70

	RAIL_GROUND_FENCE_HORIZ2 = 11,

    71

	RAIL_GROUND_ICE_DESERT = 12,

    72

};

    73

    74

    75

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

    76

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

    77

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

    78

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

    79

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

    80

 *				 similar for lower and right.

    81

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

    82

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

    83

 * MAP5:         00abcdef => rail

    84

 *               01abcdef => rail w/ signals

    85

 *               10uuuuuu => unused

    86

 *               11uuuudd => rail depot

    87

 */

    88

    89

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

    90

{

    91

	RailTileType type = GetRailTileType(tile);

    92

	TrackBits current; /* The current track layout */

    93

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

    94

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

    95

    96

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

    97

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

    98

    99

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

   100

	 * what tracks first */

   101

	current = GetTrackBits(tile);

   102

	future = current | to_build;

   103

   104

	/* Are we really building something new? */

   105

	if (current == future) {

   106

		/* Nothing new is being built */

   107

		_error_message = STR_1007_ALREADY_BUILT;

   108

		return false;

   109

	}

   110

   111

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

   112

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

   113

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

   114

		 * signals on the tile), check that */

   115

		return

   116

			future == (TRACK_BIT_UPPER | TRACK_BIT_LOWER) ||

   117

			future == (TRACK_BIT_LEFT  | TRACK_BIT_RIGHT);

   118

	} else {

   119

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

   120

		return true;

   121

	}

   122

}

   123

   124

   125

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

   126

   127

// set of normal ones

   128

{

   129

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

   130

	TRACK_BIT_RIGHT,

   131

	TRACK_BIT_UPPER,

   132

	TRACK_BIT_DIAG1,

   133

   134

	TRACK_BIT_LEFT,

   135

	0,

   136

	TRACK_BIT_DIAG2,

   137

	TRACK_BIT_LOWER,

   138

   139

	TRACK_BIT_LOWER,

   140

	TRACK_BIT_DIAG2,

   141

	0,

   142

	TRACK_BIT_LEFT,

   143

   144

	TRACK_BIT_DIAG1,

   145

	TRACK_BIT_UPPER,

   146

	TRACK_BIT_RIGHT,

   147

},

   148

   149

// allowed rail for an evenly raised platform

   150

{

   151

	0,

   152

	TRACK_BIT_LEFT,

   153

	TRACK_BIT_LOWER,

   154

	TRACK_BIT_DIAG2 | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   155

   156

	TRACK_BIT_RIGHT,

   157

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

   158

	TRACK_BIT_DIAG1 | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   159

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

   160

   161

	TRACK_BIT_UPPER,

   162

	TRACK_BIT_DIAG1 | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   163

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

   164

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

   165

   166

	TRACK_BIT_DIAG2 | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   167

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

   168

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

   169

},

   170

   171

// allowed rail on coast tile

   172

{

   173

	0,

   174

	TRACK_BIT_LEFT,

   175

	TRACK_BIT_LOWER,

   176

	TRACK_BIT_DIAG2|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   177

   178

	TRACK_BIT_RIGHT,

   179

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

   180

	TRACK_BIT_DIAG1|TRACK_BIT_RIGHT|TRACK_BIT_LOWER,

   181

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

   182

   183

	TRACK_BIT_UPPER,

   184

	TRACK_BIT_DIAG1|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   185

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

   186

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

   187

   188

	TRACK_BIT_DIAG2|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   189

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

   190

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

   191

	},

   192

   193

	// valid railway crossings on slopes

   194

	{

   195

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

   196

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

   197

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

   198

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

   199

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

   200

	}

   201

};

   202

   203

uint GetRailFoundation(uint tileh, uint bits)

   204

{

   205

	int i;

   206

   207

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

   208

		return 0;

   209

   210

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

   211

		return tileh;

   212

   213

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

   214

		return i + 15;

   215

   216

	return 0;

   217

}

   218

   219

//

   220

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

   221

{

   222

	// never allow building on top of steep tiles

   223

	if (!IsSteepTileh(tileh)) {

   224

		rail_bits |= existing;

   225

   226

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

   227

		if (IsTileType(tile, MP_WATER) &&

   228

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

   229

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   230

		}

   231

   232

		// no special foundation

   233

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

   234

			return 0;

   235

   236

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

   237

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

   238

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

   239

				)) { // partly up

   240

			if (existing != 0) {

   241

				return 0;

   242

			} else if (!_patches.build_on_slopes ||

   243

					(_is_ai_player && !_patches.ainew_active)) {

   244

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   245

			} else {

   246

				return _price.terraform;

   247

			}

   248

		}

   249

	}

   250

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   251

}

   252

   253

/* Validate functions for rail building */

   254

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

   255

   256

/** Build a single piece of rail

   257

 * @param x,y coordinates on where to build

   258

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

   259

 * @param p2 rail track to build

   260

 */

   261

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

   262

{

   263

	TileIndex tile;

   264

	uint tileh;

   265

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

   266

	Track track = (Track)p2;

   267

	TrackBits trackbit;

   268

	int32 cost = 0;

   269

	int32 ret;

   270

   271

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

   272

   273

	tile = TileVirtXY(x, y);

   274

	tileh = GetTileSlope(tile, NULL);

   275

	m5 = _m[tile].m5;

   276

	trackbit = TrackToTrackBits(track);

   277

   278

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   279

   280

	switch (GetTileType(tile)) {

   281

		case MP_TUNNELBRIDGE:

   282

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

   283

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

   284

				// Get detailed error message

   285

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

   286

			}

   287

   288

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

   289

				case 0x00: // clear land

   290

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

   291

					if (CmdFailed(ret)) return ret;

   292

					cost += ret;

   293

   294

					if (flags & DC_EXEC) {

   295

						SetTileOwner(tile, _current_player);

   296

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

   297

						_m[tile].m3 |= p1;

   298

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

   299

					}

   300

					break;

   301

   302

				case 0x20: // rail already there

   303

					return_cmd_error(STR_1007_ALREADY_BUILT);

   304

   305

				default:

   306

					// Get detailed error message

   307

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

   308

			}

   309

			break;

   310

   311

		case MP_RAILWAY:

   312

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

   313

					!EnsureNoVehicle(tile)) {

   314

				return CMD_ERROR;

   315

			}

   316

			if (m5 & RAIL_TYPE_SPECIAL ||

   317

					!IsTileOwner(tile, _current_player) ||

   318

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

   319

				// Get detailed error message

   320

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

   321

			}

   322

   323

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

   324

			if (CmdFailed(ret)) return ret;

   325

			cost += ret;

   326

   327

			if (flags & DC_EXEC) {

   328

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

   329

				_m[tile].m5 = m5 | trackbit;

   330

			}

   331

			break;

   332

   333

		case MP_STREET:

   334

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

   335

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   336

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   337

   338

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

   339

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

   340

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

   341

					)) {

   342

				if (flags & DC_EXEC) {

   343

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

   344

					SetTileOwner(tile, _current_player);

   345

					_m[tile].m4 = p1;

   346

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

   347

				}

   348

				break;

   349

			}

   350

   351

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

   352

				return_cmd_error(STR_1007_ALREADY_BUILT);

   353

			/* FALLTHROUGH */

   354

   355

		default:

   356

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

   357

			if (CmdFailed(ret)) return ret;

   358

			cost += ret;

   359

   360

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

   361

			if (CmdFailed(ret)) return ret;

   362

			cost += ret;

   363

   364

			if (flags & DC_EXEC) {

   365

				SetTileType(tile, MP_RAILWAY);

   366

				SetTileOwner(tile, _current_player);

   367

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

   368

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

   369

				_m[tile].m5 = trackbit;

   370

			}

   371

			break;

   372

	}

   373

   374

	if (flags & DC_EXEC) {

   375

		MarkTileDirtyByTile(tile);

   376

		SetSignalsOnBothDir(tile, track);

   377

	}

   378

   379

	return cost + _price.build_rail;

   380

}

   381

   382

static const byte _signals_table[] = {

   383

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

   384

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

   385

};

   386

   387

static const byte _signals_table_other[] = {

   388

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

   389

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

   390

};

   391

   392

static const byte _signals_table_both[] = {

   393

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

   394

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

   395

};

   396

   397

   398

/** Remove a single piece of track

   399

 * @param x,y coordinates for removal of track

   400

 * @param p1 unused

   401

 * @param p2 rail orientation

   402

 */

   403

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

   404

{

   405

	Track track = (Track)p2;

   406

	TrackBits trackbit;

   407

	uint tileh;

   408

	TileIndex tile;

   409

	byte m5;

   410

	int32 cost = _price.remove_rail;

   411

   412

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   413

	trackbit = TrackToTrackBits(track);

   414

   415

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   416

   417

	tile = TileVirtXY(x, y);

   418

	tileh = GetTileSlope(tile, NULL);

   419

   420

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

   421

		return CMD_ERROR;

   422

   423

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

   424

		return CMD_ERROR;

   425

   426

	// allow building rail under bridge

   427

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

   428

		return CMD_ERROR;

   429

   430

	switch(GetTileType(tile))

   431

	{

   432

		case MP_TUNNELBRIDGE:

   433

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

   434

				return CMD_ERROR;

   435

   436

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

   437

				return CMD_ERROR;

   438

   439

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

   440

				return CMD_ERROR;

   441

   442

			if (!(flags & DC_EXEC))

   443

				return _price.remove_rail;

   444

   445

		SetTileOwner(tile, OWNER_NONE);

   446

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

   447

			break;

   448

		case MP_STREET:

   449

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

   450

				return CMD_ERROR;

   451

   452

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

   453

				return CMD_ERROR;

   454

   455

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

   456

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

   457

				m5 = 5;

   458

				if (track != TRACK_DIAG1)

   459

					return CMD_ERROR;

   460

			} else {

   461

				m5 = 10;

   462

				if (track != TRACK_DIAG2)

   463

					return CMD_ERROR;

   464

			}

   465

   466

			if (!(flags & DC_EXEC))

   467

				return _price.remove_rail;

   468

   469

			_m[tile].m5 = m5;

   470

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

   471

			_m[tile].m2 = 0;

   472

			break;

   473

		case MP_RAILWAY:

   474

   475

			if (!IsPlainRailTile(tile))

   476

				return CMD_ERROR;

   477

   478

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

   479

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

   480

				return CMD_ERROR;

   481

   482

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

   483

			if (HasSignalOnTrack(tile, track))

   484

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

   485

   486

			if (!(flags & DC_EXEC))

   487

				return cost;

   488

   489

			/* We remove the trackbit here. */

   490

			_m[tile].m5 &= ~trackbit;

   491

   492

			/* Unreserve track for PBS */

   493

			if (PBSTileReserved(tile) & trackbit)

   494

				PBSClearTrack(tile, track);