1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "road.h"

     8

#include "table/sprites.h"

     9

#include "table/strings.h"

    10

#include "map.h"

    11

#include "tile.h"

    12

#include "vehicle.h"

    13

#include "viewport.h"

    14

#include "command.h"

    15

#include "pathfind.h"

    16

#include "engine.h"

    17

#include "town.h"

    18

#include "sound.h"

    19

#include "station.h"

    20

#include "sprite.h"

    21

#include "depot.h"

    22

#include "waypoint.h"

    23

#include "rail.h"

    24

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

    25

    26

extern uint16 _custom_sprites_base;

    27

    28

const byte _track_sloped_sprites[14] = {

    29

	14, 15, 22, 13,

    30

	 0, 21, 17, 12,

    31

	23,  0, 18, 20,

    32

	19, 16

    33

};

    34

    35

void ShowTrainDepotWindow(TileIndex tile);

    36

    37

/* Format of rail map5 byte.

    38

 * 00 abcdef  => Normal rail

    39

 * 01 abcdef  => Rail with signals

    40

 * 10 ??????  => Unused

    41

 * 11 ????dd  => Depot

    42

 *

    43

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

    44

 * value for each track is given.

    45

 */

    46

    47

/*         4

    48

 *     ---------

    49

 *    |\       /|

    50

 *    | \    1/ |

    51

 *    |  \   /  |

    52

 *    |   \ /   |

    53

 *  16|    \    |32

    54

 *    |   / \2  |

    55

 *    |  /   \  |

    56

 *    | /     \ |

    57

 *    |/       \|

    58

 *     ---------

    59

 *         8

    60

 */

    61

    62

    63

// Constants for lower part of Map2 byte.

    64

enum RailMap2Lower4 {

    65

	RAIL_MAP2LO_GROUND_MASK = 0xF,

    66

	RAIL_GROUND_BROWN = 0,

    67

	RAIL_GROUND_GREEN = 1,

    68

	RAIL_GROUND_FENCE_NW = 2,

    69

	RAIL_GROUND_FENCE_SE = 3,

    70

	RAIL_GROUND_FENCE_SENW = 4,

    71

	RAIL_GROUND_FENCE_NE = 5,

    72

	RAIL_GROUND_FENCE_SW = 6,

    73

	RAIL_GROUND_FENCE_NESW = 7,

    74

	RAIL_GROUND_FENCE_VERT1 = 8,

    75

	RAIL_GROUND_FENCE_VERT2 = 9,

    76

	RAIL_GROUND_FENCE_HORIZ1 = 10,

    77

	RAIL_GROUND_FENCE_HORIZ2 = 11,

    78

	RAIL_GROUND_ICE_DESERT = 12,

    79

};

    80

    81

    82

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

    83

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

    84

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

    85

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

    86

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

    87

 *				 similar for lower and right.

    88

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

    89

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

    90

 * MAP5:         00abcdef => rail

    91

 *               01abcdef => rail w/ signals

    92

 *               10uuuuuu => unused

    93

 *               11uuuudd => rail depot

    94

 */

    95

    96

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

    97

{

    98

	RailTileType type = GetRailTileType(tile);

    99

	TrackBits current; /* The current track layout */

   100

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

   101

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   102

   103

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

   104

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

   105

   106

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

   107

	 * what tracks first */

   108

	current = GetTrackBits(tile);

   109

	future = current | to_build;

   110

   111

	/* Are we really building something new? */

   112

	if (current == future) {

   113

		/* Nothing new is being built */

   114

		_error_message = STR_1007_ALREADY_BUILT;

   115

		return false;

   116

	}

   117

   118

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

   119

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

   120

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

   121

		 * signals on the tile), check that */

   122

		return

   123

			future == (TRACK_BIT_UPPER | TRACK_BIT_LOWER) ||

   124

			future == (TRACK_BIT_LEFT  | TRACK_BIT_RIGHT);

   125

	} else {

   126

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

   127

		return true;

   128

	}

   129

}

   130

   131

   132

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

   133

   134

// set of normal ones

   135

{

   136

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

   137

	TRACK_BIT_RIGHT,

   138

	TRACK_BIT_UPPER,

   139

	TRACK_BIT_DIAG1,

   140

   141

	TRACK_BIT_LEFT,

   142

	0,

   143

	TRACK_BIT_DIAG2,

   144

	TRACK_BIT_LOWER,

   145

   146

	TRACK_BIT_LOWER,

   147

	TRACK_BIT_DIAG2,

   148

	0,

   149

	TRACK_BIT_LEFT,

   150

   151

	TRACK_BIT_DIAG1,

   152

	TRACK_BIT_UPPER,

   153

	TRACK_BIT_RIGHT,

   154

},

   155

   156

// allowed rail for an evenly raised platform

   157

{

   158

	0,

   159

	TRACK_BIT_LEFT,

   160

	TRACK_BIT_LOWER,

   161

	TRACK_BIT_DIAG2 | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   162

   163

	TRACK_BIT_RIGHT,

   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_LOWER | TRACK_BIT_RIGHT,

   166

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

   167

   168

	TRACK_BIT_UPPER,

   169

	TRACK_BIT_DIAG1 | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   170

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

   171

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

   172

   173

	TRACK_BIT_DIAG2 | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   174

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

   175

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

   176

},

   177

   178

// allowed rail on coast tile

   179

{

   180

	0,

   181

	TRACK_BIT_LEFT,

   182

	TRACK_BIT_LOWER,

   183

	TRACK_BIT_DIAG2|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   184

   185

	TRACK_BIT_RIGHT,

   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_RIGHT|TRACK_BIT_LOWER,

   188

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

   189

   190

	TRACK_BIT_UPPER,

   191

	TRACK_BIT_DIAG1|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   192

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

   193

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

   194

   195

	TRACK_BIT_DIAG2|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   196

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

   197

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

   198

	},

   199

   200

	// valid railway crossings on slopes

   201

	{

   202

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

   203

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

   204

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

   205

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

   206

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

   207

	}

   208

};

   209

   210

uint GetRailFoundation(uint tileh, uint bits)

   211

{

   212

	int i;

   213

   214

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

   215

		return 0;

   216

   217

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

   218

		return tileh;

   219

   220

	if ((

   221

				(i  = 0, tileh == 1) ||

   222

				(i += 2, tileh == 2) ||

   223

				(i += 2, tileh == 4) ||

   224

				(i += 2, tileh == 8)

   225

			) && (

   226

				bits == TRACK_BIT_DIAG1 ||

   227

				(i++, bits == TRACK_BIT_DIAG2)

   228

			)) {

   229

		return i + 15;

   230

	} else {

   231

		return 0;

   232

	}

   233

}

   234

   235

   236

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

   237

{

   238

	// never allow building on top of steep tiles

   239

	if (!IsSteepTileh(tileh)) {

   240

		rail_bits |= existing;

   241

   242

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

   243

		if (IsTileType(tile, MP_WATER) &&

   244

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

   245

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   246

		}

   247

   248

		// no special foundation

   249

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

   250

			return 0;

   251

   252

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

   253

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

   254

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

   255

				)) { // partly up

   256

			if (existing != 0) {

   257

				return 0;

   258

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

   259

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   260

			} else {

   261

				return _price.terraform;

   262

			}

   263

		}

   264

	}

   265

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   266

}

   267

   268

/* Validate functions for rail building */

   269

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

   270

   271

/** Build a single piece of rail

   272

 * @param x,y coordinates on where to build

   273

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

   274

 * @param p2 rail track to build

   275

 */

   276

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

   277

{

   278

	TileIndex tile;

   279

	uint tileh;

   280

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

   281

	Track track = (Track)p2;

   282

	TrackBits trackbit;

   283

	int32 cost = 0;

   284

	int32 ret;

   285

   286

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

   287

   288

	tile = TileVirtXY(x, y);

   289

	tileh = GetTileSlope(tile, NULL);

   290

	m5 = _m[tile].m5;

   291

	trackbit = TrackToTrackBits(track);

   292

   293

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   294

   295

	switch (GetTileType(tile)) {

   296

		case MP_TUNNELBRIDGE:

   297

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

   298

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

   299

				// Get detailed error message

   300

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

   301

			}

   302

   303

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

   304

				case 0x00: // clear land

   305

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

   306

					if (CmdFailed(ret)) return ret;

   307

					cost += ret;

   308

   309

					if (flags & DC_EXEC) {

   310

						SetTileOwner(tile, _current_player);

   311

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

   312

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

   313

					}

   314

					break;

   315

   316

				case 0x20: // rail already there

   317

					return_cmd_error(STR_1007_ALREADY_BUILT);

   318

   319

				default:

   320

					// Get detailed error message

   321

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

   322

			}

   323

			break;

   324

   325

		case MP_RAILWAY:

   326

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

   327

					!EnsureNoVehicle(tile)) {

   328

				return CMD_ERROR;

   329

			}

   330

			if (m5 & RAIL_TYPE_SPECIAL ||

   331

					!IsTileOwner(tile, _current_player) ||

   332

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

   333

				// Get detailed error message

   334

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

   335

			}

   336

   337

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

   338

			if (CmdFailed(ret)) return ret;

   339

			cost += ret;

   340

   341

			if (flags & DC_EXEC) {

   342

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

   343

				_m[tile].m5 = m5 | trackbit;

   344

			}

   345

			break;

   346

   347

		case MP_STREET:

   348

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

   349

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   350

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   351

   352

			if (GetRoadType(tile) == ROAD_NORMAL && (

   353

						(track == TRACK_DIAG1 && m5 == ROAD_Y) ||

   354

						(track == TRACK_DIAG2 && m5 == ROAD_X) // correct direction?

   355

					)) {

   356

				if (flags & DC_EXEC) {

   357

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

   358

					SetTileOwner(tile, _current_player);

   359

					_m[tile].m4 = p1;

   360

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

   361

				}

   362

				break;

   363

			}

   364

   365

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

   366

				return_cmd_error(STR_1007_ALREADY_BUILT);

   367

			/* FALLTHROUGH */

   368

   369

		default:

   370

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

   371

			if (CmdFailed(ret)) return ret;

   372

			cost += ret;

   373

   374

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

   375

			if (CmdFailed(ret)) return ret;

   376

			cost += ret;

   377

   378

			if (flags & DC_EXEC) {

   379

				SetTileType(tile, MP_RAILWAY);

   380

				SetTileOwner(tile, _current_player);

   381

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

   382

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

   383

				_m[tile].m5 = trackbit;

   384

			}

   385

			break;

   386

	}

   387

   388

	if (flags & DC_EXEC) {

   389

		MarkTileDirtyByTile(tile);

   390

		SetSignalsOnBothDir(tile, track);

   391

	}

   392

   393

	return cost + _price.build_rail;

   394

}

   395

   396

/** Remove a single piece of track

   397

 * @param x,y coordinates for removal of track

   398

 * @param p1 unused

   399

 * @param p2 rail orientation

   400

 */

   401

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

   402

{

   403

	Track track = (Track)p2;

   404

	TrackBits trackbit;

   405

	TileIndex tile;

   406

	int32 cost = _price.remove_rail;

   407

   408

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   409

	trackbit = TrackToTrackBits(track);

   410

   411

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   412

   413

	tile = TileVirtXY(x, y);

   414

   415

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

   416

		return CMD_ERROR;

   417

   418

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

   419

		return CMD_ERROR;

   420

   421

	// allow building rail under bridge

   422

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

   423

		return CMD_ERROR;

   424

   425

	switch (GetTileType(tile))

   426

	{

   427

		case MP_TUNNELBRIDGE:

   428

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

   429

				return CMD_ERROR;

   430

   431

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

   432

				return CMD_ERROR;

   433

   434

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

   435

				return CMD_ERROR;

   436

   437

			if (!(flags & DC_EXEC))

   438

				return _price.remove_rail;

   439

   440

			SetTileOwner(tile, OWNER_NONE);

   441

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

   442

			break;

   443

   444

		case MP_STREET: {

   445

			RoadBits bits;

   446

   447

			if (!IsLevelCrossing(tile)) return CMD_ERROR;

   448

   449

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

   450

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

   451

				if (track != TRACK_DIAG1)

   452

					return CMD_ERROR;

   453

				bits = ROAD_Y;

   454

			} else {

   455

				if (track != TRACK_DIAG2)

   456

					return CMD_ERROR;

   457

				bits = ROAD_X;

   458

			}

   459

   460

			if (!(flags & DC_EXEC))

   461

				return _price.remove_rail;

   462

   463

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

   464

			_m[tile].m2 = 0;

   465

			_m[tile].m5 = (ROAD_NORMAL << 4) | bits;

   466

			break;

   467

		}

   468

   469

		case MP_RAILWAY:

   470

			if (!IsPlainRailTile(tile))

   471

				return CMD_ERROR;

   472

   473

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

   474

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

   475

				return CMD_ERROR;

   476

   477

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

   478

			if (HasSignalOnTrack(tile, track))

   479

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

   480

   481

			if (!(flags & DC_EXEC))

   482

				return cost;

   483

   484

			/* We remove the trackbit here. */

   485

			_m[tile].m5 &= ~trackbit;

   486

   487

			if (GetTrackBits(tile)  == 0) {

   488

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

   489

				DoClearSquare(tile);

   490

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

   491

				goto skip_mark_dirty;

   492

			}