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

    22

#include "rail.h"

    23

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

    24

    25

extern uint16 _custom_sprites_base;

    26

    27

const byte _track_sloped_sprites[14] = {

    28

	14, 15, 22, 13,

    29

	 0, 21, 17, 12,

    30

	23,  0, 18, 20,

    31

	19, 16

    32

};

    33

    34

void ShowTrainDepotWindow(TileIndex tile);

    35

    36

/* Format of rail map5 byte.

    37

 * 00 abcdef  => Normal rail

    38

 * 01 abcdef  => Rail with signals

    39

 * 10 ??????  => Unused

    40

 * 11 ????dd  => Depot

    41

 *

    42

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

    43

 * value for each track is given.

    44

 */

    45

    46

/*         4

    47

 *     ---------

    48

 *    |\       /|

    49

 *    | \    1/ |

    50

 *    |  \   /  |

    51

 *    |   \ /   |

    52

 *  16|    \    |32

    53

 *    |   / \2  |

    54

 *    |  /   \  |

    55

 *    | /     \ |

    56

 *    |/       \|

    57

 *     ---------

    58

 *         8

    59

 */

    60

    61

    62

// Constants for lower part of Map2 byte.

    63

enum RailMap2Lower4 {

    64

	RAIL_MAP2LO_GROUND_MASK = 0xF,

    65

	RAIL_GROUND_BROWN = 0,

    66

	RAIL_GROUND_GREEN = 1,

    67

	RAIL_GROUND_FENCE_NW = 2,

    68

	RAIL_GROUND_FENCE_SE = 3,

    69

	RAIL_GROUND_FENCE_SENW = 4,

    70

	RAIL_GROUND_FENCE_NE = 5,

    71

	RAIL_GROUND_FENCE_SW = 6,

    72

	RAIL_GROUND_FENCE_NESW = 7,

    73

	RAIL_GROUND_FENCE_VERT1 = 8,

    74

	RAIL_GROUND_FENCE_VERT2 = 9,

    75

	RAIL_GROUND_FENCE_HORIZ1 = 10,

    76

	RAIL_GROUND_FENCE_HORIZ2 = 11,

    77

	RAIL_GROUND_ICE_DESERT = 12,

    78

};

    79

    80

    81

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

    82

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

    83

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

    84

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

    85

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

    86

 *				 similar for lower and right.

    87

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

    88

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

    89

 * MAP5:         00abcdef => rail

    90

 *               01abcdef => rail w/ signals

    91

 *               10uuuuuu => unused

    92

 *               11uuuudd => rail depot

    93

 */

    94

    95

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

    96

{

    97

	RailTileType type = GetRailTileType(tile);

    98

	TrackBits current; /* The current track layout */

    99

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

   100

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   101

   102

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

   103

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

   104

   105

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

   106

	 * what tracks first */

   107

	current = GetTrackBits(tile);

   108

	future = current | to_build;

   109

   110

	/* Are we really building something new? */

   111

	if (current == future) {

   112

		/* Nothing new is being built */

   113

		_error_message = STR_1007_ALREADY_BUILT;

   114

		return false;

   115

	}

   116

   117

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

   118

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

   119

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

   120

		 * signals on the tile), check that */

   121

		return

   122

			future == (TRACK_BIT_UPPER | TRACK_BIT_LOWER) ||

   123

			future == (TRACK_BIT_LEFT  | TRACK_BIT_RIGHT);

   124

	} else {

   125

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

   126

		return true;

   127

	}

   128

}

   129

   130

   131

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

   132

   133

// set of normal ones

   134

{

   135

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

   136

	TRACK_BIT_RIGHT,

   137

	TRACK_BIT_UPPER,

   138

	TRACK_BIT_DIAG1,

   139

   140

	TRACK_BIT_LEFT,

   141

	0,

   142

	TRACK_BIT_DIAG2,

   143

	TRACK_BIT_LOWER,

   144

   145

	TRACK_BIT_LOWER,

   146

	TRACK_BIT_DIAG2,

   147

	0,

   148

	TRACK_BIT_LEFT,

   149

   150

	TRACK_BIT_DIAG1,

   151

	TRACK_BIT_UPPER,

   152

	TRACK_BIT_RIGHT,

   153

},

   154

   155

// allowed rail for an evenly raised platform

   156

{

   157

	0,

   158

	TRACK_BIT_LEFT,

   159

	TRACK_BIT_LOWER,

   160

	TRACK_BIT_DIAG2 | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   161

   162

	TRACK_BIT_RIGHT,

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

   165

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

   166

   167

	TRACK_BIT_UPPER,

   168

	TRACK_BIT_DIAG1 | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   169

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

   170

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

   171

   172

	TRACK_BIT_DIAG2 | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   173

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

   174

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

   175

},

   176

   177

// allowed rail on coast tile

   178

{

   179

	0,

   180

	TRACK_BIT_LEFT,

   181

	TRACK_BIT_LOWER,

   182

	TRACK_BIT_DIAG2|TRACK_BIT_LEFT|TRACK_BIT_LOWER,

   183

   184

	TRACK_BIT_RIGHT,

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

   187

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

   188

   189

	TRACK_BIT_UPPER,

   190

	TRACK_BIT_DIAG1|TRACK_BIT_LEFT|TRACK_BIT_UPPER,

   191

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

   192

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

   193

   194

	TRACK_BIT_DIAG2|TRACK_BIT_RIGHT|TRACK_BIT_UPPER,

   195

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

   196

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

   197

	},

   198

   199

	// valid railway crossings on slopes

   200

	{

   201

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

   202

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

   203

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

   204

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

   205

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

   206

	}

   207

};

   208

   209

uint GetRailFoundation(uint tileh, uint bits)

   210

{

   211

	int i;

   212

   213

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

   214

		return 0;

   215

   216

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

   217

		return tileh;

   218

   219

	if ((

   220

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

   221

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

   222

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

   223

				(i += 2, tileh == 8)

   224

			) && (

   225

				bits == TRACK_BIT_DIAG1 ||

   226

				(i++, bits == TRACK_BIT_DIAG2)

   227

			)) {

   228

		return i + 15;

   229

	} else {

   230

		return 0;

   231

	}

   232

}

   233

   234

   235

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

   236

{

   237

	// never allow building on top of steep tiles

   238

	if (!IsSteepTileh(tileh)) {

   239

		rail_bits |= existing;

   240

   241

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

   242

		if (IsTileType(tile, MP_WATER) &&

   243

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

   244

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   245

		}

   246

   247

		// no special foundation

   248

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

   249

			return 0;

   250

   251

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

   252

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

   253

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

   254

				)) { // partly up

   255

			if (existing != 0) {

   256

				return 0;

   257

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

   258

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   259

			} else {

   260

				return _price.terraform;

   261

			}

   262

		}

   263

	}

   264

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   265

}

   266

   267

/* Validate functions for rail building */

   268

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

   269

   270

/** Build a single piece of rail

   271

 * @param x,y coordinates on where to build

   272

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

   273

 * @param p2 rail track to build

   274

 */

   275

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

   276

{

   277

	TileIndex tile;

   278

	uint tileh;

   279

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

   280

	Track track = (Track)p2;

   281

	TrackBits trackbit;

   282

	int32 cost = 0;

   283

	int32 ret;

   284

   285

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

   286

   287

	tile = TileVirtXY(x, y);

   288

	tileh = GetTileSlope(tile, NULL);

   289

	m5 = _m[tile].m5;

   290

	trackbit = TrackToTrackBits(track);

   291

   292

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   293

   294

	switch (GetTileType(tile)) {

   295

		case MP_TUNNELBRIDGE:

   296

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

   297

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

   298

				// Get detailed error message

   299

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

   300

			}

   301

   302

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

   303

				case 0x00: // clear land

   304

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

   305

					if (CmdFailed(ret)) return ret;

   306

					cost += ret;

   307

   308

					if (flags & DC_EXEC) {

   309

						SetTileOwner(tile, _current_player);

   310

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

   311

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

   312

					}

   313

					break;

   314

   315

				case 0x20: // rail already there

   316

					return_cmd_error(STR_1007_ALREADY_BUILT);

   317

   318

				default:

   319

					// Get detailed error message

   320

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

   321

			}

   322

			break;

   323

   324

		case MP_RAILWAY:

   325

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

   326

					!EnsureNoVehicle(tile)) {

   327

				return CMD_ERROR;

   328

			}

   329

			if (m5 & RAIL_TYPE_SPECIAL ||

   330

					!IsTileOwner(tile, _current_player) ||

   331

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

   332

				// Get detailed error message

   333

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

   334

			}

   335

   336

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

   337

			if (CmdFailed(ret)) return ret;

   338

			cost += ret;

   339

   340

			if (flags & DC_EXEC) {

   341

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

   342

				_m[tile].m5 = m5 | trackbit;

   343

			}

   344

			break;

   345

   346

		case MP_STREET:

   347

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

   348

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   349

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   350

   351

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

   352

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

   353

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

   354

					)) {

   355

				if (flags & DC_EXEC) {

   356

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

   357

					SetTileOwner(tile, _current_player);

   358

					_m[tile].m4 = p1;

   359

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

   360

				}

   361

				break;

   362

			}

   363

   364

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

   365

				return_cmd_error(STR_1007_ALREADY_BUILT);

   366

			/* FALLTHROUGH */

   367

   368

		default:

   369

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

   370

			if (CmdFailed(ret)) return ret;

   371

			cost += ret;

   372

   373

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

   374

			if (CmdFailed(ret)) return ret;

   375

			cost += ret;

   376

   377

			if (flags & DC_EXEC) {

   378

				SetTileType(tile, MP_RAILWAY);

   379

				SetTileOwner(tile, _current_player);

   380

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

   381

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

   382

				_m[tile].m5 = trackbit;

   383

			}

   384

			break;

   385

	}

   386

   387

	if (flags & DC_EXEC) {

   388

		MarkTileDirtyByTile(tile);

   389

		SetSignalsOnBothDir(tile, track);

   390

	}

   391

   392

	return cost + _price.build_rail;

   393

}

   394

   395

/** Remove a single piece of track

   396

 * @param x,y coordinates for removal of track

   397

 * @param p1 unused

   398

 * @param p2 rail orientation

   399

 */

   400

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

   401

{

   402

	Track track = (Track)p2;

   403

	TrackBits trackbit;

   404

	TileIndex tile;

   405

	byte m5;

   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

			if (!IsLevelCrossing(tile)) return CMD_ERROR;

   446

   447

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

   448

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

   449

				m5 = 5;

   450

				if (track != TRACK_DIAG1)

   451

					return CMD_ERROR;

   452

			} else {

   453

				m5 = 10;

   454

				if (track != TRACK_DIAG2)

   455

					return CMD_ERROR;

   456

			}

   457

   458

			if (!(flags & DC_EXEC))

   459

				return _price.remove_rail;

   460

   461

			_m[tile].m5 = m5;

   462

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

   463

			_m[tile].m2 = 0;

   464

			break;

   465

   466

		case MP_RAILWAY:

   467

			if (!IsPlainRailTile(tile))

   468

				return CMD_ERROR;

   469

   470

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

   471

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

   472

				return CMD_ERROR;

   473

   474

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

   475

			if (HasSignalOnTrack(tile, track))

   476

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

   477

   478

			if (!(flags & DC_EXEC))

   479

				return cost;

   480

   481

			/* We remove the trackbit here. */

   482

			_m[tile].m5 &= ~trackbit;

   483

   484

			if (GetTrackBits(tile)  == 0) {

   485

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

   486

				DoClearSquare(tile);

   487

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

   488

				goto skip_mark_dirty;

   489

			}

   490

			break;

   491

   492

		default: