1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "bridge_map.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "rail_map.h"

     9

#include "road_map.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "tunnel_map.h"

    15

#include "vehicle.h"

    16

#include "viewport.h"

    17

#include "command.h"

    18

#include "pathfind.h"

    19

#include "engine.h"

    20

#include "town.h"

    21

#include "sound.h"

    22

#include "station.h"

    23

#include "sprite.h"

    24

#include "depot.h"

    25

#include "waypoint.h"

    26

#include "rail.h"

    27

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

    28

    29

extern uint16 _custom_sprites_base;

    30

    31

const byte _track_sloped_sprites[14] = {

    32

	14, 15, 22, 13,

    33

	 0, 21, 17, 12,

    34

	23,  0, 18, 20,

    35

	19, 16

    36

};

    37

    38

void ShowTrainDepotWindow(TileIndex tile);

    39

    40

/* Format of rail map5 byte.

    41

 * 00 abcdef  => Normal rail

    42

 * 01 abcdef  => Rail with signals

    43

 * 10 ??????  => Unused

    44

 * 11 ????dd  => Depot

    45

 *

    46

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

    47

 * value for each track is given.

    48

 */

    49

    50

/*         4

    51

 *     ---------

    52

 *    |\       /|

    53

 *    | \    1/ |

    54

 *    |  \   /  |

    55

 *    |   \ /   |

    56

 *  16|    \    |32

    57

 *    |   / \2  |

    58

 *    |  /   \  |

    59

 *    | /     \ |

    60

 *    |/       \|

    61

 *     ---------

    62

 *         8

    63

 */

    64

    65

    66

// Constants for lower part of Map2 byte.

    67

enum RailMap2Lower4 {

    68

	RAIL_MAP2LO_GROUND_MASK = 0xF,

    69

	RAIL_GROUND_BROWN = 0,

    70

	RAIL_GROUND_GREEN = 1,

    71

	RAIL_GROUND_FENCE_NW = 2,

    72

	RAIL_GROUND_FENCE_SE = 3,

    73

	RAIL_GROUND_FENCE_SENW = 4,

    74

	RAIL_GROUND_FENCE_NE = 5,

    75

	RAIL_GROUND_FENCE_SW = 6,

    76

	RAIL_GROUND_FENCE_NESW = 7,

    77

	RAIL_GROUND_FENCE_VERT1 = 8,

    78

	RAIL_GROUND_FENCE_VERT2 = 9,

    79

	RAIL_GROUND_FENCE_HORIZ1 = 10,

    80

	RAIL_GROUND_FENCE_HORIZ2 = 11,

    81

	RAIL_GROUND_ICE_DESERT = 12,

    82

};

    83

    84

    85

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

    86

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

    87

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

    88

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

    89

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

    90

 *				 similar for lower and right.

    91

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

    92

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

    93

 * MAP5:         00abcdef => rail

    94

 *               01abcdef => rail w/ signals

    95

 *               10uuuuuu => unused

    96

 *               11uuuudd => rail depot

    97

 */

    98

    99

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

   100

{

   101

	RailTileType type = GetRailTileType(tile);

   102

	TrackBits current; /* The current track layout */

   103

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

   104

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   105

   106

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

   107

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

   108

   109

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

   110

	 * what tracks first */

   111

	current = GetTrackBits(tile);

   112

	future = current | to_build;

   113

   114

	/* Are we really building something new? */

   115

	if (current == future) {

   116

		/* Nothing new is being built */

   117

		_error_message = STR_1007_ALREADY_BUILT;

   118

		return false;

   119

	}

   120

   121

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

   122

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

   123

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

   124

		 * signals on the tile), check that */

   125

		return

   126

			future == (TRACK_BIT_UPPER | TRACK_BIT_LOWER) ||

   127

			future == (TRACK_BIT_LEFT  | TRACK_BIT_RIGHT);

   128

	} else {

   129

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

   130

		return true;

   131

	}

   132

}

   133

   134

   135

static const byte _valid_tileh_slopes[][15] = {

   136

   137

// set of normal ones

   138

{

   139

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

   140

	TRACK_BIT_RIGHT,

   141

	TRACK_BIT_UPPER,

   142

	TRACK_BIT_X,

   143

   144

	TRACK_BIT_LEFT,

   145

	0,

   146

	TRACK_BIT_Y,

   147

	TRACK_BIT_LOWER,

   148

   149

	TRACK_BIT_LOWER,

   150

	TRACK_BIT_Y,

   151

	0,

   152

	TRACK_BIT_LEFT,

   153

   154

	TRACK_BIT_X,

   155

	TRACK_BIT_UPPER,

   156

	TRACK_BIT_RIGHT,

   157

},

   158

   159

// allowed rail for an evenly raised platform

   160

{

   161

	0,

   162

	TRACK_BIT_LEFT,

   163

	TRACK_BIT_LOWER,

   164

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   165

   166

	TRACK_BIT_RIGHT,

   167

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

   168

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   169

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

   170

   171

	TRACK_BIT_UPPER,

   172

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   173

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

   174

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

   175

   176

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   177

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

   178

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

   179

},

   180

   181

// allowed rail on coast tile

   182

{

   183

	0,

   184

	TRACK_BIT_LEFT,

   185

	TRACK_BIT_LOWER,

   186

	TRACK_BIT_Y|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   187

   188

	TRACK_BIT_RIGHT,

   189

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

   190

	TRACK_BIT_X|TRACK_BIT_RIGHT|TRACK_BIT_LOWER,

   191

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

   192

   193

	TRACK_BIT_UPPER,

   194

	TRACK_BIT_X|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   195

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

   196

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

   197

   198

	TRACK_BIT_Y|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   199

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

   200

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

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

   215

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

   216

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

   217

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

   218

				(i += 2, tileh == 8)

   219

			) && (

   220

				bits == TRACK_BIT_X ||

   221

				(i++, bits == TRACK_BIT_Y)

   222

			)) {

   223

		return i + 15;

   224

	} else {

   225

		return 0;

   226

	}

   227

}

   228

   229

   230

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

   231

{

   232

	// never allow building on top of steep tiles

   233

	if (!IsSteepTileh(tileh)) {

   234

		rail_bits |= existing;

   235

   236

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

   237

		if (IsTileType(tile, MP_WATER) &&

   238

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

   239

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   240

		}

   241

   242

		// no special foundation

   243

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

   244

			return 0;

   245

   246

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

   247

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

   248

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

   249

				)) { // partly up

   250

			if (existing != 0) {

   251

				return 0;

   252

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

   253

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   254

			} else {

   255

				return _price.terraform;

   256

			}

   257

		}

   258

	}

   259

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   260

}

   261

   262

/* Validate functions for rail building */

   263

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

   264

   265

/** Build a single piece of rail

   266

 * @param x,y coordinates on where to build

   267

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

   268

 * @param p2 rail track to build

   269

 */

   270

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

   271

{

   272

	TileIndex tile;

   273

	uint tileh;

   274

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

   275

	Track track = (Track)p2;

   276

	TrackBits trackbit;

   277

	int32 cost = 0;

   278

	int32 ret;

   279

   280

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

   281

   282

	tile = TileVirtXY(x, y);

   283

	tileh = GetTileSlope(tile, NULL);

   284

	m5 = _m[tile].m5;

   285

	trackbit = TrackToTrackBits(track);

   286

   287

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   288

   289

	switch (GetTileType(tile)) {

   290

		case MP_TUNNELBRIDGE:

   291

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

   292

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

   293

				// Get detailed error message

   294

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

   295

			}

   296

   297

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

   298

				case 0x00: // clear land

   299

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

   300

					if (CmdFailed(ret)) return ret;

   301

					cost += ret;

   302

   303

					if (flags & DC_EXEC) SetRailUnderBridge(tile, _current_player, p1);

   304

					break;

   305

   306

				case 0x20: // rail already there

   307

					return_cmd_error(STR_1007_ALREADY_BUILT);

   308

   309

				default:

   310

					// Get detailed error message

   311

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

   312

			}

   313

			break;

   314

   315

		case MP_RAILWAY:

   316

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

   317

					!EnsureNoVehicle(tile)) {

   318

				return CMD_ERROR;

   319

			}

   320

			if (m5 & RAIL_TYPE_SPECIAL ||

   321

					!IsTileOwner(tile, _current_player) ||

   322

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

   323

				// Get detailed error message

   324

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

   325

			}

   326

   327

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

   328

			if (CmdFailed(ret)) return ret;

   329

			cost += ret;

   330

   331

			if (flags & DC_EXEC) {

   332

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

   333

				_m[tile].m5 = m5 | trackbit;

   334

			}

   335

			break;

   336

   337

		case MP_STREET:

   338

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

   339

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

   340

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

   341

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   342

			}

   343

#undef M

   344

   345

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   346

   347

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

   348

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

   349

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

   350

					)) {

   351

				if (flags & DC_EXEC) {

   352

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

   353

				}

   354

				break;

   355

			}

   356

   357

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

   358

				return_cmd_error(STR_1007_ALREADY_BUILT);

   359

			/* FALLTHROUGH */

   360

   361

		default:

   362

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

   363

			if (CmdFailed(ret)) return ret;

   364

			cost += ret;

   365

   366

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

   367

			if (CmdFailed(ret)) return ret;

   368

			cost += ret;

   369

   370

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

   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

/** Remove a single piece of track

   383

 * @param x,y coordinates for removal of track

   384

 * @param p1 unused

   385

 * @param p2 rail orientation

   386

 */

   387

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

   388

{

   389

	Track track = (Track)p2;

   390

	TrackBits trackbit;

   391

	TileIndex tile;

   392

	int32 cost = _price.remove_rail;

   393

   394

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   395

	trackbit = TrackToTrackBits(track);

   396

   397

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   398

   399

	tile = TileVirtXY(x, y);

   400

   401

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

   402

		return CMD_ERROR;

   403

   404

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

   405

		return CMD_ERROR;

   406

   407

	// allow building rail under bridge

   408

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

   409

		return CMD_ERROR;

   410

   411

	switch (GetTileType(tile))

   412

	{

   413

		case MP_TUNNELBRIDGE:

   414

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

   415

				return CMD_ERROR;

   416

   417

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

   418

				return CMD_ERROR;

   419

   420

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

   421

				return CMD_ERROR;

   422

   423

			if (!(flags & DC_EXEC))

   424

				return _price.remove_rail;

   425

   426

			SetClearUnderBridge(tile);

   427

			break;

   428

   429

		case MP_STREET: {

   430

			if (!IsLevelCrossing(tile)) return CMD_ERROR;

   431

   432

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

   433

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

   434

   435

			if (!(flags & DC_EXEC))

   436

				return _price.remove_rail;

   437

   438

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

   439

			break;

   440

		}

   441

   442

		case MP_RAILWAY:

   443

			if (!IsPlainRailTile(tile))

   444

				return CMD_ERROR;

   445

   446

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

   447

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

   448

				return CMD_ERROR;

   449

   450

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

   451

			if (HasSignalOnTrack(tile, track))

   452

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

   453

   454

			if (!(flags & DC_EXEC))

   455

				return cost;

   456

   457

			/* We remove the trackbit here. */

   458

			_m[tile].m5 &= ~trackbit;

   459

   460

			if (GetTrackBits(tile)  == 0) {

   461

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

   462

				DoClearSquare(tile);

   463

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

   464

				goto skip_mark_dirty;

   465

			}

   466

			break;

   467

   468

		default:

   469

			assert(0);

   470

	}

   471

   472

	/* mark_dirty */

   473

	MarkTileDirtyByTile(tile);

   474

   475

skip_mark_dirty:;

   476

   477

	SetSignalsOnBothDir(tile, track);

   478

   479

	return cost;

   480

}

   481

   482

static const struct {

   483

	int8 xinc[16];

   484

	int8 yinc[16];

   485

} _railbit = {{

   486

//  0   1   2   3   4   5

   487

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

   488

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

   489

},{

   490

	  0, 16,  0, 16,  0, 16,    0,  0,

   491

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

   492

}};