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

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   160

{

   161

	if (!IsSteepSlope(tileh)) {

   162

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

   163

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

   164

	}

   165

   166

	switch (bits) {

   167

		default: NOT_REACHED();

   168

		case TRACK_BIT_X:     return FOUNDATION_INCLINED_X;

   169

		case TRACK_BIT_Y:     return FOUNDATION_INCLINED_Y;

   170

		case TRACK_BIT_LEFT:  return (tileh == SLOPE_STEEP_W ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   171

		case TRACK_BIT_LOWER: return (tileh == SLOPE_STEEP_S ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   172

		case TRACK_BIT_RIGHT: return (tileh == SLOPE_STEEP_E ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   173

		case TRACK_BIT_UPPER: return (tileh == SLOPE_STEEP_N ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   174

	}

   175

}

   176

   177

   178

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

   179

{

   180

	if (IsSteepSlope(tileh)) {

   181

		if (_patches.build_on_slopes && existing == 0) {

   182

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

   183

			if (valid & rail_bits) return _price.terraform;

   184

		}

   185

	} else {

   186

		rail_bits |= existing;

   187

   188

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

   189

		if (IsTileType(tile, MP_WATER) &&

   190

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

   191

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   192

		}

   193

   194

		/* no special foundation */

   195

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

   196

			return CommandCost();

   197

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

   198

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   199

		}

   200

   201

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

   202

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

   203

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

   204

				)) { // partly up

   205

			return CommandCost((existing != 0) ? 0 : _price.terraform);

   206

		}

   207

	}

   208

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   209

}

   210

   211

/* Validate functions for rail building */

   212

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

   213

   214

/** Build a single piece of rail

   215

 * @param tile tile  to build on

   216

 * @param flags operation to perform

   217

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

   218

 * @param p2 rail track to build

   219

 */

   220

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

   221

{

   222

	Slope tileh;

   223

	RailType railtype;

   224

	Track track;

   225

	TrackBits trackbit;

   226

	CommandCost cost;

   227

	CommandCost ret;

   228

   229

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

   230

	railtype = (RailType)p1;

   231

	track = (Track)p2;

   232

   233

	tileh = GetTileSlope(tile, NULL);

   234

	trackbit = TrackToTrackBits(track);

   235

   236

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   237

   238

	switch (GetTileType(tile)) {

   239

		case MP_RAILWAY:

   240

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

   241

					!EnsureNoVehicleOnGround(tile)) {

   242

				return CMD_ERROR;

   243

			}

   244

			if (!IsTileOwner(tile, _current_player) ||

   245

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

   246

				/* Get detailed error message */

   247

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

   248

			}

   249

   250

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

   251

			if (CmdFailed(ret)) return ret;

   252

			cost.AddCost(ret);

   253

   254

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

   255

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

   256

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

   257

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

   258

				if (CmdFailed(ret)) return ret;

   259

				cost.AddCost(ret);

   260

			}

   261

   262

			if (flags & DC_EXEC) {

   263

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   264

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

   265

			}

   266

			break;

   267

   269

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

   270

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

   271

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

   272

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   273

			}

   274

#undef M

   275

   276

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   277

   278

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   279

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

   280

   281

				RoadTypes roadtypes = GetRoadTypes(tile);

   282

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   283

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   284

				switch (roadtypes) {

   285

					default: break;

   286

					case ROADTYPES_TRAM:

   287

						/* Tram crossings must always have road. */

   288

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   289

						roadtypes |= ROADTYPES_ROAD;

   290

						break;

   291

   292

					case ROADTYPES_ROADTRAM: if (road == tram) break;

   293

						/* FALL THROUGH */

   294

					case ROADTYPES_ROADHWAY: // Road and highway are incompatible in this case

   295

					case ROADTYPES_TRAMHWAY: // Tram and highway are incompatible in this case

   296

					case ROADTYPES_ALL:      // Also incompatible

   297

						return CMD_ERROR;

   298

				}

   299

   300

				road |= tram | GetRoadBits(tile, ROADTYPE_HWAY);

   301

   302

				if ((track == TRACK_X && road == ROAD_Y) ||

   303

						(track == TRACK_Y && road == ROAD_X)) {

   304

					if (flags & DC_EXEC) {

   305

						MakeRoadCrossing(tile, GetRoadOwner(tile, ROADTYPE_ROAD), GetRoadOwner(tile, ROADTYPE_TRAM), GetRoadOwner(tile, ROADTYPE_HWAY), _current_player, (track == TRACK_X ? AXIS_Y : AXIS_X), railtype, roadtypes, GetTownIndex(tile));

   306

					}

   307

					break;

   308

				}

   309

			}

   310

   311

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

   312

				return_cmd_error(STR_1007_ALREADY_BUILT);

   313

			}

   314

			/* FALLTHROUGH */

   315

   316

		default:

   317

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

   318

			if (CmdFailed(ret)) return ret;

   319

			cost.AddCost(ret);

   320

   321

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

   322

			if (CmdFailed(ret)) return ret;

   323

			cost.AddCost(ret);

   324

   325

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

   326

			break;

   327

	}

   328

   329

	if (flags & DC_EXEC) {

   330

		MarkTileDirtyByTile(tile);

   331

		SetSignalsOnBothDir(tile, track);

   332

		YapfNotifyTrackLayoutChange(tile, track);

   333

	}

   334

   335

	return cost.AddCost(_price.build_rail);

   336

}

   337

   338

/** Remove a single piece of track

   339

 * @param tile tile to remove track from

   340

 * @param flags operation to perform

   341

 * @param p1 unused

   342

 * @param p2 rail orientation

   343

 */

   344

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

   345

{

   346

	Track track = (Track)p2;

   347

	TrackBits trackbit;

   348

	CommandCost cost(_price.remove_rail);

   349

	bool crossing = false;

   350

   351

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

   352

	trackbit = TrackToTrackBits(track);

   353

   354

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   355

   356

	switch (GetTileType(tile)) {

   358

			if (!IsLevelCrossing(tile) ||

   359

					GetCrossingRailBits(tile) != trackbit ||

   360

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

   361

					!EnsureNoVehicleOnGround(tile)) {

   362

				return CMD_ERROR;

   363

			}

   364

   365

			if (flags & DC_EXEC) {

   366

				MakeRoadNormal(tile, GetCrossingRoadBits(tile), GetRoadTypes(tile), GetTownIndex(tile), GetRoadOwner(tile, ROADTYPE_ROAD), GetRoadOwner(tile, ROADTYPE_TRAM), GetRoadOwner(tile, ROADTYPE_HWAY));

   367

			}

   368

			break;

   369

		}

   370

   371

		case MP_RAILWAY: {

   372

			TrackBits present;

   373

   374

			if (!IsPlainRailTile(tile) ||

   375

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

   376

					!EnsureNoVehicleOnGround(tile)) {

   377

				return CMD_ERROR;

   378

			}

   379

   380

			present = GetTrackBits(tile);

   381

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

   382

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

   383

   384

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

   385

			if (HasSignalOnTrack(tile, track))

   386

				cost.AddCost(DoCommand(tile, track, 0, flags, CMD_REMOVE_SIGNALS));

   387

   388

			if (flags & DC_EXEC) {

   389

				present ^= trackbit;

   390

				if (present == 0) {

   391

					DoClearSquare(tile);

   392

				} else {

   393

					SetTrackBits(tile, present);

   394

				}

   395

			}

   396

			break;

   397

		}

   398

   399

		default: return CMD_ERROR;

   400

	}

   401

   402

	if (flags & DC_EXEC) {

   403

		MarkTileDirtyByTile(tile);

   404

		if (crossing) {

   405

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

   406

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

   407

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

   408

			 * 'connect' with the other piece. */

   409

			SetSignalsOnBothDir(tile, TRACK_X);

   410

			SetSignalsOnBothDir(tile, TRACK_Y);

   411

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   412

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   413

		} else {

   414

			SetSignalsOnBothDir(tile, track);

   415

			YapfNotifyTrackLayoutChange(tile, track);

   416

		}

   417

	}

   418

   419

	return cost;

   420

}

   421

   422

   423

static const TileIndexDiffC _trackdelta[] = {

   424

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

   425

	{  0,  0 },

   426

	{  0,  0 },

   427

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

   428

	{  0,  0 },

   429

	{  0,  0 }

   430

};

   431

   432

   433

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

   434

{

   435

	int x = TileX(start);

   436

	int y = TileY(start);

   437

	int ex = TileX(end);

   438

	int ey = TileY(end);

   439

	int dx, dy, trdx, trdy;

   440

   441

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

   442

   443

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

   444

	dx = ex - x;

   445

	dy = ey - y;

   446

   447

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

   448

	trdx = _trackdelta[*trackdir].x;

   449

	trdy = _trackdelta[*trackdir].y;

   450

   451

	if (!IsDiagonalTrackdir(*trackdir)) {

   452

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

   453

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

   454

	}

   455

   456

	/* validate the direction */

   457

	while (

   458

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

   459

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

   460

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

   461

		(trdy >= 0 && dy < 0)

   462

	) {

   463

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

   464

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

   465

			trdx = -trdx;

   466

			trdy = -trdy;

   467

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

   468

			return CMD_ERROR;

   469

		}

   470

	}

   471

   472

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

   473

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

   474

	if (!IsDiagonalTrackdir(*trackdir)) {

   475

		trdx = _trackdelta[*trackdir].x;

   476

		trdy = _trackdelta[*trackdir].y;

   477

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

   478

			return CMD_ERROR;

   479

	}

   480

   481

	return CommandCost();

   482

}

   483