1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "rail_map.h"

     8

#include "road.h"

     9

#include "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "map.h"

    12

#include "tile.h"

    13

#include "vehicle.h"

    14

#include "viewport.h"

    15

#include "command.h"

    16

#include "pathfind.h"

    17

#include "engine.h"

    18

#include "town.h"

    19

#include "sound.h"

    20

#include "station.h"

    21

#include "sprite.h"

    22

#include "depot.h"

    23

#include "waypoint.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_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   138

	TRACK_BIT_RIGHT,

   139

	TRACK_BIT_UPPER,

   140

	TRACK_BIT_X,

   141

   142

	TRACK_BIT_LEFT,

   143

	0,

   144

	TRACK_BIT_Y,

   145

	TRACK_BIT_LOWER,

   146

   147

	TRACK_BIT_LOWER,

   148

	TRACK_BIT_Y,

   149

	0,

   150

	TRACK_BIT_LEFT,

   151

   152

	TRACK_BIT_X,

   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_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   163

   164

	TRACK_BIT_RIGHT,

   165

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   166

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   167

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   168

   169

	TRACK_BIT_UPPER,

   170

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   171

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   172

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   173

   174

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   175

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   176

	TRACK_BIT_X|TRACK_BIT_Y|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_Y|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   185

   186

	TRACK_BIT_RIGHT,

   187

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   188

	TRACK_BIT_X|TRACK_BIT_RIGHT|TRACK_BIT_LOWER,

   189

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   190

   191

	TRACK_BIT_UPPER,

   192

	TRACK_BIT_X|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   193

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   194

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   195

   196

	TRACK_BIT_Y|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   197

	TRACK_BIT_X|TRACK_BIT_Y|TRACK_BIT_UPPER|TRACK_BIT_LOWER|TRACK_BIT_LEFT|TRACK_BIT_RIGHT,

   198

	TRACK_BIT_X|TRACK_BIT_Y|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 ((

   222

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

   223

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

   224

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

   225

				(i += 2, tileh == 8)

   226

			) && (

   227

				bits == TRACK_BIT_X ||

   228

				(i++, bits == TRACK_BIT_Y)

   229

			)) {

   230

		return i + 15;

   231

	} else {

   232

		return 0;

   233

	}

   234

}

   235

   236

   237

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

   238

{

   239

	// never allow building on top of steep tiles

   240

	if (!IsSteepTileh(tileh)) {

   241

		rail_bits |= existing;

   242

   243

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

   244

		if (IsTileType(tile, MP_WATER) &&

   245

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

   246

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   247

		}

   248

   249

		// no special foundation

   250

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

   251

			return 0;

   252

   253

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

   254

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

   255

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

   256

				)) { // partly up

   257

			if (existing != 0) {

   258

				return 0;

   259

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

   260

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   261

			} else {

   262

				return _price.terraform;

   263

			}

   264

		}

   265

	}

   266

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   267

}

   268

   269

/* Validate functions for rail building */

   270

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

   271

   272

/** Build a single piece of rail

   273

 * @param x,y coordinates on where to build

   274

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

   275

 * @param p2 rail track to build

   276

 */

   277

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

   278

{

   279

	TileIndex tile;

   280

	uint tileh;

   281

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

   282

	Track track = (Track)p2;

   283

	TrackBits trackbit;

   284

	int32 cost = 0;

   285

	int32 ret;

   286

   287

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

   288

   289

	tile = TileVirtXY(x, y);

   290

	tileh = GetTileSlope(tile, NULL);

   291

	m5 = _m[tile].m5;

   292

	trackbit = TrackToTrackBits(track);

   293

   294

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   295

   296

	switch (GetTileType(tile)) {

   297

		case MP_TUNNELBRIDGE:

   298

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

   299

					(m5 & 0x01 ? TRACK_BIT_X : TRACK_BIT_Y) != trackbit) { // wrong direction?

   300

				// Get detailed error message

   301

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

   302

			}

   303

   304

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

   305

				case 0x00: // clear land

   306

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

   307

					if (CmdFailed(ret)) return ret;

   308

					cost += ret;

   309

   310

					if (flags & DC_EXEC) {

   311

						SetTileOwner(tile, _current_player);

   312

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

   313

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

   314

					}

   315

					break;

   316

   317

				case 0x20: // rail already there

   318

					return_cmd_error(STR_1007_ALREADY_BUILT);

   319

   320

				default:

   321

					// Get detailed error message

   322

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

   323

			}

   324

			break;

   325

   326

		case MP_RAILWAY:

   327

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

   328

					!EnsureNoVehicle(tile)) {

   329

				return CMD_ERROR;

   330

			}

   331

			if (m5 & RAIL_TYPE_SPECIAL ||

   332

					!IsTileOwner(tile, _current_player) ||

   333

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

   334

				// Get detailed error message

   335

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

   336

			}

   337

   338

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

   339

			if (CmdFailed(ret)) return ret;

   340

			cost += ret;

   341

   342

			if (flags & DC_EXEC) {

   343

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

   344

				_m[tile].m5 = m5 | trackbit;

   345

			}

   346

			break;

   347

   348

		case MP_STREET:

   349

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

   350

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   351

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   352

   353

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

   354

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

   355

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

   356

					)) {

   357

				if (flags & DC_EXEC) {

   358

					MakeRoadCrossing(tile, GetTileOwner(tile), _current_player, (track == TRACK_X ? AXIS_Y : AXIS_X), p1, _m[tile].m2);

   359

				}

   360

				break;

   361

			}

   362

   363

			if (IsLevelCrossing(tile) && (m5 & 0x08 ? TRACK_X : TRACK_Y) == track)

   364

				return_cmd_error(STR_1007_ALREADY_BUILT);

   365

			/* FALLTHROUGH */

   366

   367

		default:

   368

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

   369

			if (CmdFailed(ret)) return ret;

   370

			cost += ret;

   371

   372

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

   373

			if (CmdFailed(ret)) return ret;

   374

			cost += ret;

   375

   376

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

   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

	int32 cost = _price.remove_rail;

   399

   400

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   401

	trackbit = TrackToTrackBits(track);

   402

   403

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   404

   405

	tile = TileVirtXY(x, y);

   406

   407

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

   408

		return CMD_ERROR;

   409

   410

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

   411

		return CMD_ERROR;

   412

   413

	// allow building rail under bridge

   414

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

   415

		return CMD_ERROR;

   416

   417

	switch (GetTileType(tile))

   418

	{

   419

		case MP_TUNNELBRIDGE:

   420

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

   421

				return CMD_ERROR;

   422

   423

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

   424

				return CMD_ERROR;

   425

   426

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

   427

				return CMD_ERROR;

   428

   429

			if (!(flags & DC_EXEC))

   430

				return _price.remove_rail;

   431

   432

			SetTileOwner(tile, OWNER_NONE);

   433

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

   434

			break;

   435

   436

		case MP_STREET: {

   437

			if (!IsLevelCrossing(tile)) return CMD_ERROR;

   438

   439

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

   440

			if (GetCrossingRailBits(tile) != trackbit) return CMD_ERROR;

   441

   442

			if (!(flags & DC_EXEC))

   443

				return _price.remove_rail;

   444

   445

			MakeRoadNormal(tile, _m[tile].m3, GetCrossingRoadBits(tile), 0);

   446

			break;

   447

		}

   448

   449

		case MP_RAILWAY:

   450

			if (!IsPlainRailTile(tile))

   451

				return CMD_ERROR;

   452

   453

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

   454

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

   455

				return CMD_ERROR;

   456

   457

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

   458

			if (HasSignalOnTrack(tile, track))

   459

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

   460

   461

			if (!(flags & DC_EXEC))

   462

				return cost;

   463

   464

			/* We remove the trackbit here. */

   465

			_m[tile].m5 &= ~trackbit;

   466

   467

			if (GetTrackBits(tile)  == 0) {

   468

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

   469

				DoClearSquare(tile);

   470

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

   471

				goto skip_mark_dirty;

   472

			}

   473

			break;

   474

   475

		default:

   476

			assert(0);

   477

	}

   478

   479

	/* mark_dirty */

   480

	MarkTileDirtyByTile(tile);

   481

   482

skip_mark_dirty:;

   483

   484

	SetSignalsOnBothDir(tile, track);

   485

   486

	return cost;

   487

}

   488

   489

static const struct {

   490

	int8 xinc[16];

   491

	int8 yinc[16];

   492

} _railbit = {{