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_map.h"

     9

#include "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "map.h"

    12

#include "tile.h"

    13

#include "tunnel_map.h"

    14

#include "vehicle.h"

    15

#include "viewport.h"

    16

#include "command.h"

    17

#include "pathfind.h"

    18

#include "engine.h"

    19

#include "town.h"

    20

#include "sound.h"

    21

#include "station.h"

    22

#include "sprite.h"

    23

#include "depot.h"

    24

#include "waypoint.h"

    25

#include "rail.h"

    26

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

    27

    28

extern uint16 _custom_sprites_base;

    29

    30

const byte _track_sloped_sprites[14] = {

    31

	14, 15, 22, 13,

    32

	 0, 21, 17, 12,

    33

	23,  0, 18, 20,

    34

	19, 16

    35

};

    36

    37

void ShowTrainDepotWindow(TileIndex tile);

    38

    39

/* Format of rail map5 byte.

    40

 * 00 abcdef  => Normal rail

    41

 * 01 abcdef  => Rail with signals

    42

 * 10 ??????  => Unused

    43

 * 11 ????dd  => Depot

    44

 *

    45

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

    46

 * value for each track is given.

    47

 */

    48

    49

/*         4

    50

 *     ---------

    51

 *    |\       /|

    52

 *    | \    1/ |

    53

 *    |  \   /  |

    54

 *    |   \ /   |

    55

 *  16|    \    |32

    56

 *    |   / \2  |

    57

 *    |  /   \  |

    58

 *    | /     \ |

    59

 *    |/       \|

    60

 *     ---------

    61

 *         8

    62

 */

    63

    64

    65

// Constants for lower part of Map2 byte.

    66

enum RailMap2Lower4 {

    67

	RAIL_MAP2LO_GROUND_MASK = 0xF,

    68

	RAIL_GROUND_BROWN = 0,

    69

	RAIL_GROUND_GREEN = 1,

    70

	RAIL_GROUND_FENCE_NW = 2,

    71

	RAIL_GROUND_FENCE_SE = 3,

    72

	RAIL_GROUND_FENCE_SENW = 4,

    73

	RAIL_GROUND_FENCE_NE = 5,

    74

	RAIL_GROUND_FENCE_SW = 6,

    75

	RAIL_GROUND_FENCE_NESW = 7,

    76

	RAIL_GROUND_FENCE_VERT1 = 8,

    77

	RAIL_GROUND_FENCE_VERT2 = 9,

    78

	RAIL_GROUND_FENCE_HORIZ1 = 10,

    79

	RAIL_GROUND_FENCE_HORIZ2 = 11,

    80

	RAIL_GROUND_ICE_DESERT = 12,

    81

};

    82

    83

    84

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

    85

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

    86

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

    87

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

    88

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

    89

 *				 similar for lower and right.

    90

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

    91

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

    92

 * MAP5:         00abcdef => rail

    93

 *               01abcdef => rail w/ signals

    94

 *               10uuuuuu => unused

    95

 *               11uuuudd => rail depot

    96

 */

    97

    98

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

    99

{

   100

	RailTileType type = GetRailTileType(tile);

   101

	TrackBits current; /* The current track layout */

   102

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

   103

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   104

   105

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

   106

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

   107

   108

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

   109

	 * what tracks first */

   110

	current = GetTrackBits(tile);

   111

	future = current | to_build;

   112

   113

	/* Are we really building something new? */

   114

	if (current == future) {

   115

		/* Nothing new is being built */

   116

		_error_message = STR_1007_ALREADY_BUILT;

   117

		return false;

   118

	}

   119

   120

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

   121

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

   122

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

   123

		 * signals on the tile), check that */

   124

		return

   125

			future == (TRACK_BIT_UPPER | TRACK_BIT_LOWER) ||

   126

			future == (TRACK_BIT_LEFT  | TRACK_BIT_RIGHT);

   127

	} else {

   128

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

   129

		return true;

   130

	}

   131

}

   132

   133

   134

static const byte _valid_tileh_slopes[][15] = {

   135

   136

// set of normal ones

   137

{

   138

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

   139

	TRACK_BIT_RIGHT,

   140

	TRACK_BIT_UPPER,

   141

	TRACK_BIT_X,

   142

   143

	TRACK_BIT_LEFT,

   144

	0,

   145

	TRACK_BIT_Y,

   146

	TRACK_BIT_LOWER,

   147

   148

	TRACK_BIT_LOWER,

   149

	TRACK_BIT_Y,

   150

	0,

   151

	TRACK_BIT_LEFT,

   152

   153

	TRACK_BIT_X,

   154

	TRACK_BIT_UPPER,

   155

	TRACK_BIT_RIGHT,

   156

},

   157

   158

// allowed rail for an evenly raised platform

   159

{

   160

	0,

   161

	TRACK_BIT_LEFT,

   162

	TRACK_BIT_LOWER,

   163

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   164

   165

	TRACK_BIT_RIGHT,

   166

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

   167

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   168

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

   169

   170

	TRACK_BIT_UPPER,

   171

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   172

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

   173

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

   174

   175

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   176

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

   177

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

   178

},

   179

   180

// allowed rail on coast tile

   181

{

   182

	0,

   183

	TRACK_BIT_LEFT,

   184

	TRACK_BIT_LOWER,

   185

	TRACK_BIT_Y|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   186

   187

	TRACK_BIT_RIGHT,

   188

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

   189

	TRACK_BIT_X|TRACK_BIT_RIGHT|TRACK_BIT_LOWER,

   190

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

   191

   192

	TRACK_BIT_UPPER,

   193

	TRACK_BIT_X|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   194

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

   195

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

   196

   197

	TRACK_BIT_Y|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   198

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

   199

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

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

   214

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

   215

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

   216

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

   217

				(i += 2, tileh == 8)

   218

			) && (

   219

				bits == TRACK_BIT_X ||

   220

				(i++, bits == TRACK_BIT_Y)

   221

			)) {

   222

		return i + 15;

   223

	} else {

   224

		return 0;

   225

	}

   226

}

   227

   228

   229

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

   230

{

   231

	// never allow building on top of steep tiles

   232

	if (!IsSteepTileh(tileh)) {

   233

		rail_bits |= existing;

   234

   235

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

   236

		if (IsTileType(tile, MP_WATER) &&

   237

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

   238

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   239

		}

   240

   241

		// no special foundation

   242

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

   243

			return 0;

   244

   245

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

   246

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

   247

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

   248

				)) { // partly up

   249

			if (existing != 0) {

   250

				return 0;

   251

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

   252

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   253

			} else {

   254

				return _price.terraform;

   255

			}

   256

		}

   257

	}

   258

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   259

}

   260

   261

/* Validate functions for rail building */

   262

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

   263

   264

/** Build a single piece of rail

   265

 * @param x,y coordinates on where to build

   266

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

   267

 * @param p2 rail track to build

   268

 */

   269

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

   270

{

   271

	TileIndex tile;

   272

	uint tileh;

   273

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

   274

	Track track = (Track)p2;

   275

	TrackBits trackbit;

   276

	int32 cost = 0;

   277

	int32 ret;

   278

   279

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

   280

   281

	tile = TileVirtXY(x, y);

   282

	tileh = GetTileSlope(tile, NULL);

   283

	m5 = _m[tile].m5;

   284

	trackbit = TrackToTrackBits(track);

   285

   286

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   287

   288

	switch (GetTileType(tile)) {

   289

		case MP_TUNNELBRIDGE:

   290

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

   291

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

   292

				// Get detailed error message

   293

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

   294

			}

   295

   296

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

   297

				case 0x00: // clear land

   298

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

   299

					if (CmdFailed(ret)) return ret;

   300

					cost += ret;

   301

   302

					if (flags & DC_EXEC) {

   303

						SetTileOwner(tile, _current_player);

   304

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

   305

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

   306

					}

   307

					break;

   308

   309

				case 0x20: // rail already there

   310

					return_cmd_error(STR_1007_ALREADY_BUILT);

   311

   312

				default:

   313

					// Get detailed error message

   314

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

   315

			}

   316

			break;

   317

   318

		case MP_RAILWAY:

   319

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

   320

					!EnsureNoVehicle(tile)) {

   321

				return CMD_ERROR;

   322

			}

   323

			if (m5 & RAIL_TYPE_SPECIAL ||

   324

					!IsTileOwner(tile, _current_player) ||

   325

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

   326

				// Get detailed error message

   327

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

   328

			}

   329

   330

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

   331

			if (CmdFailed(ret)) return ret;

   332

			cost += ret;

   333

   334

			if (flags & DC_EXEC) {

   335

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

   336

				_m[tile].m5 = m5 | trackbit;

   337

			}

   338

			break;

   339

   340

		case MP_STREET:

   341

#define M(x) (1 << (x))

   342

			/* Level crossings may only be built on these slopes */

   343

			if (!HASBIT(M(14) | M(13) | M(11) | M(10) | M(7) | M(5) | M(0), tileh)) {

   344

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   345

			}

   346

#undef M

   347

   348

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   349

   350

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

   351

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

   352

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

   353

					)) {

   354

				if (flags & DC_EXEC) {

   355

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

   356

				}

   357

				break;

   358

			}

   359

   360

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

   361

				return_cmd_error(STR_1007_ALREADY_BUILT);

   362

			/* FALLTHROUGH */

   363

   364

		default:

   365

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

   366

			if (CmdFailed(ret)) return ret;

   367

			cost += ret;

   368

   369

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

   370

			if (CmdFailed(ret)) return ret;

   371

			cost += ret;

   372

   373

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

   374

			break;

   375

	}

   376

   377

	if (flags & DC_EXEC) {

   378

		MarkTileDirtyByTile(tile);

   379

		SetSignalsOnBothDir(tile, track);

   380

	}

   381

   382

	return cost + _price.build_rail;

   383

}

   384

   385

/** Remove a single piece of track

   386

 * @param x,y coordinates for removal of track

   387

 * @param p1 unused

   388

 * @param p2 rail orientation

   389

 */

   390

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

   391

{

   392

	Track track = (Track)p2;

   393

	TrackBits trackbit;

   394

	TileIndex tile;

   395

	int32 cost = _price.remove_rail;

   396

   397

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   398

	trackbit = TrackToTrackBits(track);

   399

   400

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   401

   402

	tile = TileVirtXY(x, y);

   403

   404

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

   405

		return CMD_ERROR;

   406

   407

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

   408

		return CMD_ERROR;

   409

   410

	// allow building rail under bridge

   411

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

   412

		return CMD_ERROR;

   413

   414

	switch (GetTileType(tile))

   415

	{

   416

		case MP_TUNNELBRIDGE:

   417

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

   418

				return CMD_ERROR;

   419

   420

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

   421

				return CMD_ERROR;

   422

   423

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

   424

				return CMD_ERROR;

   425

   426

			if (!(flags & DC_EXEC))

   427

				return _price.remove_rail;

   428

   429

			SetTileOwner(tile, OWNER_NONE);

   430

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

   431

			break;

   432

   433

		case MP_STREET: {

   434

			if (!IsLevelCrossing(tile)) return CMD_ERROR;

   435

   436

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

   437

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

   438

   439

			if (!(flags & DC_EXEC))

   440

				return _price.remove_rail;

   441

   442

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

   443

			break;

   444

		}

   445

   446

		case MP_RAILWAY:

   447

			if (!IsPlainRailTile(tile))

   448

				return CMD_ERROR;

   449

   450

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

   451

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

   452

				return CMD_ERROR;

   453

   454

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

   455

			if (HasSignalOnTrack(tile, track))

   456

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

   457

   458

			if (!(flags & DC_EXEC))

   459

				return cost;

   460

   461

			/* We remove the trackbit here. */

   462

			_m[tile].m5 &= ~trackbit;

   463

   464

			if (GetTrackBits(tile)  == 0) {

   465

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

   466

				DoClearSquare(tile);

   467

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

   468

				goto skip_mark_dirty;

   469

			}

   470

			break;

   471

   472

		default:

   473

			assert(0);

   474

	}

   475

   476

	/* mark_dirty */

   477

	MarkTileDirtyByTile(tile);

   478

   479

skip_mark_dirty:;

   480

   481

	SetSignalsOnBothDir(tile, track);

   482

   483

	return cost;

   484

}

   485

   486

static const struct {

   487

	int8 xinc[16];

   488

	int8 yinc[16];

   489

} _railbit = {{

   490

//  0   1   2   3   4   5

   491

	-16,  0,-16,  0, 16,  0,    0,  0,

   492

	 16,  0,  0, 16,  0,-16,    0,  0,