1

/* $Id$ */

     2

     3

/** @file rail_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "bridge.h"

     9

#include "cmd_helper.h"

    10

#include "debug.h"

    11

#include "functions.h"

    12

#include "rail_map.h"

    13

#include "road_map.h"

    14

#include "table/sprites.h"

    15

#include "table/strings.h"

    16

#include "map.h"

    17

#include "landscape.h"

    18

#include "tile.h"

    19

#include "town_map.h"

    20

#include "tunnel_map.h"

    21

#include "vehicle.h"

    22

#include "viewport.h"

    23

#include "command.h"

    24

#include "pathfind.h"

    25

#include "engine.h"

    26

#include "town.h"

    27

#include "sound.h"

    28

#include "station.h"

    29

#include "sprite.h"

    30

#include "depot.h"

    31

#include "waypoint.h"

    32

#include "window.h"

    33

#include "rail.h"

    34

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

    35

#include "newgrf.h"

    36

#include "yapf/yapf.h"

    37

#include "newgrf_callbacks.h"

    38

#include "newgrf_station.h"

    39

#include "train.h"

    40

    41

const byte _track_sloped_sprites[14] = {

    42

	14, 15, 22, 13,

    43

	 0, 21, 17, 12,

    44

	23,  0, 18, 20,

    45

	19, 16

    46

};

    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

    66

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

    67

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

    68

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

    69

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

    70

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

    71

 *               similar for lower and right.

    72

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

    73

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

    74

 * MAP5:         00abcdef => rail

    75

 *               01abcdef => rail w/ signals

    76

 *               10uuuuuu => unused

    77

 *               11uuuudd => rail depot

    78

 */

    79

    80

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

    81

{

    82

	TrackBits current; // The current track layout

    83

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

    84

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

    85

    86

	if (!IsPlainRailTile(tile)) return false;

    87

    88

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

    89

	 * what tracks first */

    90

	current = GetTrackBits(tile);

    91

	future = current | to_build;

    92

    93

	/* Are we really building something new? */

    94

	if (current == future) {

    95

		/* Nothing new is being built */

    96

		_error_message = STR_1007_ALREADY_BUILT;

    97

		return false;

    98

	}

    99

   100

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

   101

	if (flags & DC_NO_RAIL_OVERLAP || HasSignals(tile)) {

   102

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

   103

		 * signals on the tile), check that */

   104

		return future == TRACK_BIT_HORZ || future == TRACK_BIT_VERT;

   105

	} else {

   106

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

   107

		return true;

   108

	}

   109

}

   110

   111

   112

static const TrackBits _valid_tileh_slopes[][15] = {

   113

   114

/* set of normal ones */

   115

{

   116

	TRACK_BIT_ALL,

   117

	TRACK_BIT_RIGHT,

   118

	TRACK_BIT_UPPER,

   119

	TRACK_BIT_X,

   120

   121

	TRACK_BIT_LEFT,

   122

	TRACK_BIT_NONE,

   123

	TRACK_BIT_Y,

   124

	TRACK_BIT_LOWER,

   125

   126

	TRACK_BIT_LOWER,

   127

	TRACK_BIT_Y,

   128

	TRACK_BIT_NONE,

   129

	TRACK_BIT_LEFT,

   130

   131

	TRACK_BIT_X,

   132

	TRACK_BIT_UPPER,

   133

	TRACK_BIT_RIGHT,

   134

},

   135

   136

/* allowed rail for an evenly raised platform */

   137

{

   138

	TRACK_BIT_NONE,

   139

	TRACK_BIT_LEFT,

   140

	TRACK_BIT_LOWER,

   141

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   142

   143

	TRACK_BIT_RIGHT,

   144

	TRACK_BIT_ALL,

   145

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   146

	TRACK_BIT_ALL,

   147

   148

	TRACK_BIT_UPPER,

   149

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   150

	TRACK_BIT_ALL,

   151

	TRACK_BIT_ALL,

   152

   153

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   154

	TRACK_BIT_ALL,

   155

	TRACK_BIT_ALL

   156

}

   157

};

   158

   159

uint GetRailFoundation(Slope tileh, TrackBits bits)

   160

{

   161

	uint i;

   162

   163

	if (!IsSteepSlope(tileh)) {

   164

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

   165

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

   166

	}

   167

   168

	switch (bits) {

   169

		default: NOT_REACHED();

   170

		case TRACK_BIT_X: i = 0; break;

   171

		case TRACK_BIT_Y: i = 1; break;

   172

		case TRACK_BIT_LEFT:  return 15 + 8 + (tileh == SLOPE_STEEP_W ? 4 : 0);

   173

		case TRACK_BIT_LOWER: return 15 + 8 + (tileh == SLOPE_STEEP_S ? 5 : 1);

   174

		case TRACK_BIT_RIGHT: return 15 + 8 + (tileh == SLOPE_STEEP_E ? 6 : 2);

   175

		case TRACK_BIT_UPPER: return 15 + 8 + (tileh == SLOPE_STEEP_N ? 7 : 3);

   176

	}

   177

	switch (tileh) {

   178

		case SLOPE_W:

   179

		case SLOPE_STEEP_W: i += 0; break;

   180

		case SLOPE_S:

   181

		case SLOPE_STEEP_S: i += 2; break;

   182

		case SLOPE_E:

   183

		case SLOPE_STEEP_E: i += 4; break;

   184

		case SLOPE_N:

   185

		case SLOPE_STEEP_N: i += 6; break;

   186

		default: return 0;

   187

	}

   188

	return i + 15;

   189

}

   190

   191

   192

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

   193

{

   194

	if (IsSteepSlope(tileh)) {

   195

		if (existing == 0) {

   196

			TrackBits valid = TRACK_BIT_CROSS | (HASBIT(1 << SLOPE_STEEP_W | 1 << SLOPE_STEEP_E, tileh) ? TRACK_BIT_VERT : TRACK_BIT_HORZ);

   197

			if (valid & rail_bits) return _price.terraform;

   198

		}

   199

	} else {

   200

		rail_bits |= existing;

   201

   202

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

   203

		if (IsTileType(tile, MP_WATER) &&

   204

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

   205

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   206

		}

   207

   208

		/* no special foundation */

   209

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

   210

			return 0;

   211

   212

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

   213

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

   214

					(tileh == SLOPE_W || tileh == SLOPE_S || tileh == SLOPE_E || tileh == SLOPE_N)

   215

				)) { // partly up

   216

			if (existing != 0) {

   217

				return 0;

   218

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

   219

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   220

			} else {

   221

				return _price.terraform;

   222

			}

   223

		}

   224

	}

   225

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   226

}

   227

   228

/* Validate functions for rail building */

   229

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

   230

   231

/** Build a single piece of rail

   232

 * @param tile tile  to build on

   233

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

   234

 * @param p2 rail track to build

   235

 */

   236

int32 CmdBuildSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   237

{

   238

	Slope tileh;

   239

	RailType railtype;

   240

	Track track;

   241

	TrackBits trackbit;

   242

	int32 cost = 0;

   243

	int32 ret;

   244

   245

	if (!ValParamRailtype(p1) || !ValParamTrackOrientation((Track)p2)) return CMD_ERROR;

   246

	railtype = (RailType)p1;

   247

	track = (Track)p2;

   248

   249

	tileh = GetTileSlope(tile, NULL);

   250

	trackbit = TrackToTrackBits(track);

   251

   252

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   253

   254

	switch (GetTileType(tile)) {

   255

		case MP_RAILWAY:

   256

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

   257

					!EnsureNoVehicleOnGround(tile)) {

   258

				return CMD_ERROR;

   259

			}

   260

			if (!IsTileOwner(tile, _current_player) ||

   261

					!IsCompatibleRail(GetRailType(tile), railtype)) {

   262

				/* Get detailed error message */

   263

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

   264

			}

   265

   266

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

   267

			if (CmdFailed(ret)) return ret;

   268

			cost += ret;

   269

   270

			/* If the rail types don't match, try to convert only if engines of

   271

			 * the present rail type are powered on the new rail type. */

   272

			if (GetRailType(tile) != railtype && HasPowerOnRail(GetRailType(tile), railtype)) {

   273

				ret = DoCommand(tile, tile, railtype, flags, CMD_CONVERT_RAIL);

   274

				if (CmdFailed(ret)) return ret;

   275

				cost += ret;

   276

			}

   277

   278

			if (flags & DC_EXEC) {

   279

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   280

				SetTrackBits(tile, GetTrackBits(tile) | trackbit);

   281

			}

   282

			break;

   283

   284

		case MP_STREET:

   285

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

   286

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

   287

			if (!HASBIT(M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT), tileh)) {

   288

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   289

			}

   290

#undef M

   291

   292

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   293

   294

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   295

				if (HasRoadWorks(tile)) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   296

   297

				if ((track == TRACK_X && GetRoadBits(tile) == ROAD_Y) ||

   298

						(track == TRACK_Y && GetRoadBits(tile) == ROAD_X)) {

   299

					if (flags & DC_EXEC) {

   300

						MakeRoadCrossing(tile, GetTileOwner(tile), _current_player, (track == TRACK_X ? AXIS_Y : AXIS_X), railtype, GetTownIndex(tile));

   301

					}

   302

					break;

   303

				}

   304

			}

   305

   306

			if (IsLevelCrossing(tile) && GetCrossingRailBits(tile) == trackbit) {

   307

				return_cmd_error(STR_1007_ALREADY_BUILT);

   308

			}

   309

			/* FALLTHROUGH */

   310

   311

		default:

   312

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

   313

			if (CmdFailed(ret)) return ret;

   314

			cost += ret;

   315

   316

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

   317

			if (CmdFailed(ret)) return ret;

   318

			cost += ret;

   319

   320

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

   321

			break;

   322

	}

   323

   324

	if (flags & DC_EXEC) {

   325

		MarkTileDirtyByTile(tile);

   326

		SetSignalsOnBothDir(tile, track);

   327

		YapfNotifyTrackLayoutChange(tile, track);

   328

	}

   329

   330

	return cost + _price.build_rail;

   331

}

   332

   333

/** Remove a single piece of track

   334

 * @param tile tile to remove track from

   335

 * @param p1 unused

   336

 * @param p2 rail orientation

   337

 */

   338

int32 CmdRemoveSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   339

{

   340

	Track track = (Track)p2;

   341

	TrackBits trackbit;

   342

	int32 cost = _price.remove_rail;

   343

	bool crossing = false;

   344

   345

	if (!ValParamTrackOrientation((Track)p2)) return CMD_ERROR;

   346

	trackbit = TrackToTrackBits(track);

   347

   348

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   349

   350

	switch (GetTileType(tile)) {

   351

		case MP_STREET: {

   352

			if (!IsLevelCrossing(tile) ||

   353

					GetCrossingRailBits(tile) != trackbit ||

   354

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

   355

					!EnsureNoVehicleOnGround(tile)) {

   356

				return CMD_ERROR;

   357

			}

   358

   359

			if (flags & DC_EXEC) {

   360

				MakeRoadNormal(tile, GetCrossingRoadOwner(tile), GetCrossingRoadBits(tile), GetTownIndex(tile));

   361

			}

   362

			break;

   363

		}

   364

   365

		case MP_RAILWAY: {

   366

			TrackBits present;

   367

   368

			if (!IsPlainRailTile(tile) ||

   369

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

   370

					!EnsureNoVehicleOnGround(tile)) {

   371

				return CMD_ERROR;

   372

			}

   373

   374

			present = GetTrackBits(tile);

   375

			if ((present & trackbit) == 0) return CMD_ERROR;

   376

			if (present == (TRACK_BIT_X | TRACK_BIT_Y)) crossing = true;

   377

   378

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

   379

			if (HasSignalOnTrack(tile, track))

   380

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

   381

   382

			if (flags & DC_EXEC) {

   383

				present ^= trackbit;

   384

				if (present == 0) {

   385

					DoClearSquare(tile);

   386

				} else {

   387

					SetTrackBits(tile, present);

   388

				}

   389

			}

   390

			break;

   391

		}

   392

   393

		default: return CMD_ERROR;

   394

	}

   395

   396

	if (flags & DC_EXEC) {

   397

		MarkTileDirtyByTile(tile);

   398

		if (crossing) {

   399

			/* crossing is set when only TRACK_BIT_X and TRACK_BIT_Y are set. As we

   400

			 * are removing one of these pieces, we'll need to update signals for

   401

			 * both directions explicitly, as after the track is removed it won't

   402

			 * 'connect' with the other piece. */

   403

			SetSignalsOnBothDir(tile, TRACK_X);

   404

			SetSignalsOnBothDir(tile, TRACK_Y);

   405

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   406

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   407

		} else {

   408

			SetSignalsOnBothDir(tile, track);

   409

			YapfNotifyTrackLayoutChange(tile, track);

   410

		}

   411

	}

   412

   413

	return cost;

   414

}

   415

   416

   417

static const TileIndexDiffC _trackdelta[] = {

   418

	{ -1,  0 }, {  0,  1 }, { -1,  0 }, {  0,  1 }, {  1,  0 }, {  0,  1 },

   419

	{  0,  0 },

   420

	{  0,  0 },

   421

	{  1,  0 }, {  0, -1 }, {  0, -1 }, {  1,  0 }, {  0, -1 }, { -1,  0 },

   422

	{  0,  0 },

   423

	{  0,  0 }

   424

};

   425

   426

   427

static int32 ValidateAutoDrag(Trackdir *trackdir, TileIndex start, TileIndex end)

   428

{

   429

	int x = TileX(start);

   430

	int y = TileY(start);

   431

	int ex = TileX(end);

   432

	int ey = TileY(end);

   433

	int dx, dy, trdx, trdy;

   434

   435

	if (!ValParamTrackOrientation(TrackdirToTrack(*trackdir))) return CMD_ERROR;

   436

   437

	/* calculate delta x,y from start to end tile */

   438

	dx = ex - x;

   439

	dy = ey - y;

   440

   441

	/* calculate delta x,y for the first direction */

   442

	trdx = _trackdelta[*trackdir].x;

   443

	trdy = _trackdelta[*trackdir].y;

   444

   445

	if (!IsDiagonalTrackdir(*trackdir)) {

   446

		trdx += _trackdelta[*trackdir ^ 1].x;

   447

		trdy += _trackdelta[*trackdir ^ 1].y;

   448

	}

   449

   450

	/* validate the direction */

   451

	while (

   452

		(trdx <= 0 && dx > 0) ||

   453

		(trdx >= 0 && dx < 0) ||

   454

		(trdy <= 0 && dy > 0) ||

   455

		(trdy >= 0 && dy < 0)

   456

	) {

   457

		if (!HASBIT(*trackdir, 3)) { // first direction is invalid, try the other

   458

			SetBitT(*trackdir, 3); // reverse the direction

   459

			trdx = -trdx;

   460

			trdy = -trdy;

   461

		} else { // other direction is invalid too, invalid drag

   462

			return CMD_ERROR;

   463

		}

   464

	}

   465

   466

	/* (for diagonal tracks, this is already made sure of by above test), but:

   467

	 * for non-diagonal tracks, check if the start and end tile are on 1 line */

   468

	if (!IsDiagonalTrackdir(*trackdir)) {

   469

		trdx = _trackdelta[*trackdir].x;

   470

		trdy = _trackdelta[*trackdir].y;

   471

		if (abs(dx) != abs(dy) && abs(dx) + abs(trdy) != abs(dy) + abs(trdx))

   472

			return CMD_ERROR;

   473

	}

   474

   475

	return 0;

   476

}

   477

   478

/** Build a stretch of railroad tracks.

   479

 * @param tile start tile of drag

   480

 * @param p1 end tile of drag

   481

 * @param p2 various bitstuffed elements

   482

 * - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)

   483

 * - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)

   484

 * - p2 = (bit 7)   - 0 = build, 1 = remove tracks