1

/* $Id$ */

     2

     3

/** @file rail_cmd.cpp Handling of rail tiles. */

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

    12

#include "rail_map.h"

    13

#include "road_map.h"

    14

#include "landscape.h"

    15

#include "town_map.h"

    16

#include "tunnel_map.h"

    17

#include "viewport_func.h"

    18

#include "command_func.h"

    19

#include "pathfind.h"

    20

#include "engine_func.h"

    21

#include "engine_base.h"

    22

#include "town.h"

    23

#include "sprite.h"

    24

#include "depot_base.h"

    25

#include "depot_func.h"

    26

#include "waypoint.h"

    27

#include "rail.h"

    28

#include "newgrf.h"

    29

#include "yapf/yapf.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_station.h"

    33

#include "train.h"

    34

#include "variables.h"

    35

#include "autoslope.h"

    36

#include "transparency.h"

    37

#include "water.h"

    38

#include "tunnelbridge_map.h"

    39

#include "window_func.h"

    40

#include "vehicle_func.h"

    41

#include "sound_func.h"

    42

#include "signal_func.h"

    43

#include "tunnelbridge.h"

    44

#include "station_map.h"

    45

#include "water_map.h"

    46

#include "functions.h"

    47

#include "elrail_func.h"

    48

#include "oldpool_func.h"

    49

#include "pbs.h"

    50

#include "core/smallvec_type.hpp"

    51

    52

#include "table/sprites.h"

    53

#include "table/strings.h"

    54

#include "table/railtypes.h"

    55

#include "table/track_land.h"

    56

    57

RailtypeInfo _railtypes[RAILTYPE_END];

    58

    59

assert_compile(sizeof(_original_railtypes) <= sizeof(_railtypes));

    60

    61

/**

    62

 * Initialize rail type information.

    63

 */

    64

void ResetRailTypes()

    65

{

    66

	memset(_railtypes, 0, sizeof(_railtypes));

    67

	memcpy(_railtypes, _original_railtypes, sizeof(_original_railtypes));

    68

}

    69

    70

const byte _track_sloped_sprites[14] = {

    71

	14, 15, 22, 13,

    72

	 0, 21, 17, 12,

    73

	23,  0, 18, 20,

    74

	19, 16

    75

};

    76

    77

    78

/*         4

    79

 *     ---------

    80

 *    |\       /|

    81

 *    | \    1/ |

    82

 *    |  \   /  |

    83

 *    |   \ /   |

    84

 *  16|    \    |32

    85

 *    |   / \2  |

    86

 *    |  /   \  |

    87

 *    | /     \ |

    88

 *    |/       \|

    89

 *     ---------

    90

 *         8

    91

 */

    92

    93

    94

    95

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

    96

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

    97

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

    98

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

    99

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

   100

 *               similar for lower and right.

   101

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

   102

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

   103

 * MAP5:         00abcdef => rail

   104

 *               01abcdef => rail w/ signals

   105

 *               10uuuuuu => unused

   106

 *               11uuuudd => rail depot

   107

 */

   108

   109

   110

Vehicle *EnsureNoTrainOnTrackProc(Vehicle *v, void *data)

   111

{

   112

	TrackBits rail_bits = *(TrackBits *)data;

   113

   114

	if (v->type != VEH_TRAIN) return NULL;

   115

   116

	if ((v->u.rail.track != rail_bits) && !TracksOverlap(v->u.rail.track | rail_bits)) return NULL;

   117

   118

	_error_message = VehicleInTheWayErrMsg(v);

   119

	return v;

   120

}

   121

   122

/**

   123

 * Tests if a vehicle interacts with the specified track.

   124

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   125

 *

   126

 * @param tile The tile.

   127

 * @param track The track.

   128

 */

   129

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   130

{

   131

	TrackBits rail_bits = TrackToTrackBits(track);

   132

   133

	return !HasVehicleOnPos(tile, &rail_bits, &EnsureNoTrainOnTrackProc);

   134

}

   135

   136

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

   137

{

   138

	TrackBits current; // The current track layout

   139

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

   140

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   141

   142

	if (!IsPlainRailTile(tile)) return false;

   143

   144

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

   145

	 * what tracks first */

   146

	current = GetTrackBits(tile);

   147

	future = current | to_build;

   148

   149

	/* Are we really building something new? */

   150

	if (current == future) {

   151

		/* Nothing new is being built */

   152

		_error_message = STR_1007_ALREADY_BUILT;

   153

		return false;

   154

	}

   155

   156

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

   157

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

   158

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

   159

		 * signals on the tile), check that */

   160

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

   161

	} else {

   162

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

   163

		return true;

   164

	}

   165

}

   166

   167

   168

/** Valid TrackBits on a specific (non-steep)-slope without foundation */

   169

static const TrackBits _valid_tracks_without_foundation[15] = {

   170

	TRACK_BIT_ALL,

   171

	TRACK_BIT_RIGHT,

   172

	TRACK_BIT_UPPER,

   173

	TRACK_BIT_X,

   174

   175

	TRACK_BIT_LEFT,

   176

	TRACK_BIT_NONE,

   177

	TRACK_BIT_Y,

   178

	TRACK_BIT_LOWER,

   179

   180

	TRACK_BIT_LOWER,

   181

	TRACK_BIT_Y,

   182

	TRACK_BIT_NONE,

   183

	TRACK_BIT_LEFT,

   184

   185

	TRACK_BIT_X,

   186

	TRACK_BIT_UPPER,

   187

	TRACK_BIT_RIGHT,

   188

};

   189

   190

/** Valid TrackBits on a specific (non-steep)-slope with leveled foundation */

   191

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   192

	TRACK_BIT_NONE,

   193

	TRACK_BIT_LEFT,

   194

	TRACK_BIT_LOWER,

   195

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   196

   197

	TRACK_BIT_RIGHT,

   198

	TRACK_BIT_ALL,

   199

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   200

	TRACK_BIT_ALL,

   201

   202

	TRACK_BIT_UPPER,

   203

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   204

	TRACK_BIT_ALL,

   205

	TRACK_BIT_ALL,

   206

   207

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   208

	TRACK_BIT_ALL,

   209

	TRACK_BIT_ALL

   210

};

   211

   212

/**

   213

 * Checks if a track combination is valid on a specific slope and returns the needed foundation.

   214

 *

   215

 * @param tileh Tile slope.

   216

 * @param bits  Trackbits.

   217

 * @return Needed foundation or FOUNDATION_INVALID if track/slope combination is not allowed.

   218

 */

   219

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   220

{

   221

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   222

   223

	if (IsSteepSlope(tileh)) {

   224

		/* Test for inclined foundations */

   225

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   226

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   227

   228

		/* Get higher track */

   229

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   230

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   231

   232

		/* Only higher track? */

   233

		if (bits == higher_track) return HalftileFoundation(highest_corner);

   234

   235

		/* Overlap with higher track? */

   236

		if (TracksOverlap(bits | higher_track)) return FOUNDATION_INVALID;

   237

   238

		/* either lower track or both higher and lower track */

   239

		return ((bits & higher_track) != 0 ? FOUNDATION_STEEP_BOTH : FOUNDATION_STEEP_LOWER);

   240

	} else {

   241

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

   242

   243

		bool valid_on_leveled = ((~_valid_tracks_on_leveled_foundation[tileh] & bits) == 0);

   244

   245

		Corner track_corner;

   246

		switch (bits) {

   247

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   248

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   249

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   250

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   251

   252

			case TRACK_BIT_HORZ:

   253

				if (tileh == SLOPE_N) return HalftileFoundation(CORNER_N);

   254

				if (tileh == SLOPE_S) return HalftileFoundation(CORNER_S);

   255

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   256

   257

			case TRACK_BIT_VERT:

   258

				if (tileh == SLOPE_W) return HalftileFoundation(CORNER_W);

   259

				if (tileh == SLOPE_E) return HalftileFoundation(CORNER_E);

   260

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   261

   262

			case TRACK_BIT_X:

   263

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_X;

   264

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   265

   266

			case TRACK_BIT_Y:

   267

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_Y;

   268

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   269

   270

			default:

   271

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   272

		}

   273

		/* Single diagonal track */

   274

   275

		/* Track must be at least valid on leveled foundation */

   276

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   277

   278

		/* If slope has three raised corners, build leveled foundation */

   279

		if (IsSlopeWithThreeCornersRaised(tileh)) return FOUNDATION_LEVELED;

   280

   281

		/* If neighboured corners of track_corner are lowered, build halftile foundation */

   282

		if ((tileh & SlopeWithThreeCornersRaised(OppositeCorner(track_corner))) == SlopeWithOneCornerRaised(track_corner)) return HalftileFoundation(track_corner);

   283

   284

		/* else special anti-zig-zag foundation */

   285

		return SpecialRailFoundation(track_corner);

   286

	}

   287

}

   288

   289

   290

/**

   291

 * Tests if a track can be build on a tile.

   292

 *

   293

 * @param tileh Tile slope.

   294

 * @param rail_bits Tracks to build.

   295

 * @param existing Tracks already built.

   296

 * @param tile Tile (used for water test)

   297

 * @return Error message or cost for foundation building.

   298

 */

   299

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

   300

{

   301

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

   302

	if (IsTileType(tile, MP_WATER) || (IsTileType(tile, MP_RAILWAY) && (GetRailGroundType(tile) == RAIL_GROUND_WATER))) {

   303

		if (!IsSteepSlope(tileh) && ((~_valid_tracks_on_leveled_foundation[tileh] & (rail_bits | existing)) != 0)) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   304

	}

   305

   306

	Foundation f_new = GetRailFoundation(tileh, rail_bits | existing);

   307

   308

	/* check track/slope combination */

   309

	if ((f_new == FOUNDATION_INVALID) ||

   310

			((f_new != FOUNDATION_NONE) && (!_settings_game.construction.build_on_slopes || _is_old_ai_company))) {

   311

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   312

	}

   313

   314

	Foundation f_old = GetRailFoundation(tileh, existing);

   315

	return CommandCost(EXPENSES_CONSTRUCTION, f_new != f_old ? _price.terraform : (Money)0);

   316

}

   317

   318

/* Validate functions for rail building */

   319

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

   320

   321

/** Build a single piece of rail

   322

 * @param tile tile  to build on

   323

 * @param flags operation to perform

   324

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

   325

 * @param p2 rail track to build

   326

 */

   327

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

   328

{

   329

	Slope tileh;

   330

	RailType railtype = (RailType)p1;

   331

	Track track = (Track)p2;

   332

	TrackBits trackbit;

   333

	CommandCost cost(EXPENSES_CONSTRUCTION);

   334

	CommandCost ret;

   335

   336

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

   337

   338

	tileh = GetTileSlope(tile, NULL);

   339

	trackbit = TrackToTrackBits(track);

   340

   341

	switch (GetTileType(tile)) {

   342

		case MP_RAILWAY:

   343

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

   344

					!EnsureNoTrainOnTrack(tile, track)) {

   345

				return CMD_ERROR;

   346

			}

   347

			if (!IsTileOwner(tile, _current_company) ||

   348

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

   349

				/* Get detailed error message */

   350

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

   351

			}

   352

   353

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

   354

			if (CmdFailed(ret)) return ret;

   355

			cost.AddCost(ret);

   356

   357

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

   358

			 * the new rail type are not powered on the present rail type and engines of

   359

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

   360

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

   361

				if (HasPowerOnRail(GetRailType(tile), railtype)) {

   362

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

   363

					if (CmdFailed(ret)) return ret;

   364

					cost.AddCost(ret);

   365

				} else {

   366

					return CMD_ERROR;

   367

				}

   368

			}

   369

   370

			if (flags & DC_EXEC) {

   371

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   372

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

   373

			}

   374

			break;

   375

   376

		case MP_ROAD:

   377

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

   378

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

   379

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

   380

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   381

			}

   382

#undef M

   383

   384

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   385

   386

			if (IsNormalRoad(tile)) {

   387

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

   388

   389

				if (GetDisallowedRoadDirections(tile) != DRD_NONE) return_cmd_error(STR_ERR_CROSSING_ON_ONEWAY_ROAD);

   390

   391

				RoadTypes roadtypes = GetRoadTypes(tile);

   392

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   393

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   394

				switch (roadtypes) {

   395

					default: break;

   396

					case ROADTYPES_TRAM:

   397

						/* Tram crossings must always have road. */

   398

						if (flags & DC_EXEC) SetRoadOwner(tile, ROADTYPE_ROAD, _current_company);

   399

						roadtypes |= ROADTYPES_ROAD;

   400

						break;

   401

   402

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

   403

						/* FALL THROUGH */

   404

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

   405

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

   406

					case ROADTYPES_ALL:      // Also incompatible

   407

						return CMD_ERROR;

   408

				}

   409

   410

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

   411

   412

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

   413

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

   414

					if (flags & DC_EXEC) {

   415

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

   416

						UpdateLevelCrossing(tile, false);

   417

					}

   418

					break;

   419

				}

   420

			}

   421

   422

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

   423

				return_cmd_error(STR_1007_ALREADY_BUILT);

   424

			}

   425

			/* FALLTHROUGH */

   426

   427

		default:

   428

			/* Will there be flat water on the lower halftile? */

   429

			bool water_ground = IsTileType(tile, MP_WATER) && IsSlopeWithOneCornerRaised(tileh);

   430

   431

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

   432

			if (CmdFailed(ret)) return ret;

   433

			cost.AddCost(ret);

   434

   435

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

   436

			if (CmdFailed(ret)) return ret;

   437

			cost.AddCost(ret);

   438

   439

			if (water_ground) {

   440

				cost.AddCost(-_price.clear_water);

   441

				cost.AddCost(_price.clear_roughland);

   442

			}

   443

   444

			if (flags & DC_EXEC) {

   445

				MakeRailNormal(tile, _current_company, trackbit, railtype);

   446

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   447

			}

   448

			break;

   449

	}

   450

   451

	if (flags & DC_EXEC) {

   452

		MarkTileDirtyByTile(tile);

   453

		AddTrackToSignalBuffer(tile, track, _current_company);

   454

		YapfNotifyTrackLayoutChange(tile, track);

   455

	}

   456

   457

	return cost.AddCost(RailBuildCost(railtype));

   458

}

   459

   460

/** Remove a single piece of track

   461

 * @param tile tile to remove track from

   462

 * @param flags operation to perform

   463

 * @param p1 unused

   464

 * @param p2 rail orientation

   465

 */

   466

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

   467

{

   468

	Track track = (Track)p2;

   469

	TrackBits trackbit;

   470

	CommandCost cost(EXPENSES_CONSTRUCTION, _price.remove_rail );

   471

	bool crossing = false;

   472

   473

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

   474

	trackbit = TrackToTrackBits(track);

   475

   476

	/* Need to read tile owner now because it may change when the rail is removed

   477

	 * Also, in case of floods, _current_company != owner

   478

	 * There may be invalid tiletype even in exec run (when removing long track),

   479

	 * so do not call GetTileOwner(tile) in any case here */

   480

	Owner owner = INVALID_OWNER;

   481

   482

	Vehicle *v = NULL;

   483

   484