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

    38

#include "newgrf_callbacks.h"

    39

#include "newgrf_station.h"

    40

#include "train.h"

    41

#include "misc/autoptr.hpp"

    42

#include "autoslope.h"

    43

    44

const byte _track_sloped_sprites[14] = {

    45

	14, 15, 22, 13,

    46

	 0, 21, 17, 12,

    47

	23,  0, 18, 20,

    48

	19, 16

    49

};

    50

    51

    52

/*         4

    53

 *     ---------

    54

 *    |\       /|

    55

 *    | \    1/ |

    56

 *    |  \   /  |

    57

 *    |   \ /   |

    58

 *  16|    \    |32

    59

 *    |   / \2  |

    60

 *    |  /   \  |

    61

 *    | /     \ |

    62

 *    |/       \|

    63

 *     ---------

    64

 *         8

    65

 */

    66

    67

    68

    69

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

    70

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

    71

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

    72

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

    73

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

    74

 *               similar for lower and right.

    75

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

    76

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

    77

 * MAP5:         00abcdef => rail

    78

 *               01abcdef => rail w/ signals

    79

 *               10uuuuuu => unused

    80

 *               11uuuudd => rail depot

    81

 */

    82

    83

/** Struct used in EnsureNoTrainOnTrack() */

    84

struct TrainOnTrackData {

    85

	TileIndex tile;       ///< tile to check

    86

	uint z;               ///< tile max Z

    87

	TrackBits rail_bits;  ///< trackbits of interest

    88

};

    89

    90

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

    91

{

    92

	const TrainOnTrackData *info = (const TrainOnTrackData *)data;

    93

    94

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

    95

	if (v->z_pos > info->z) return NULL;

    96

    97

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

    98

    99

	_error_message = VehicleInTheWayErrMsg(v);

   100

	return v;

   101

}

   102

   103

/**

   104

 * Tests if a vehicle interacts with the specified track.

   105

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   106

 *

   107

 * @param tile The tile.

   108

 * @param track The track.

   109

 */

   110

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   111

{

   112

	TrainOnTrackData info;

   113

   114

	info.tile = tile;

   115

	info.z = GetTileMaxZ(tile);

   116

	info.rail_bits = TrackToTrackBits(track);

   117

   118

	return VehicleFromPos(tile, &info, EnsureNoTrainOnTrackProc) == NULL;

   119

}

   120

   121

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

   122

{

   123

	TrackBits current; // The current track layout

   124

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

   125

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   126

   127

	if (!IsPlainRailTile(tile)) return false;

   128

   129

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

   130

	 * what tracks first */

   131

	current = GetTrackBits(tile);

   132

	future = current | to_build;

   133

   134

	/* Are we really building something new? */

   135

	if (current == future) {

   136

		/* Nothing new is being built */

   137

		_error_message = STR_1007_ALREADY_BUILT;

   138

		return false;

   139

	}

   140

   141

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

   142

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

   143

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

   144

		 * signals on the tile), check that */

   145

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

   146

	} else {

   147

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

   148

		return true;

   149

	}

   150

}

   151

   152

   153

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

   154

static const TrackBits _valid_tracks_without_foundation[15] = {

   155

	TRACK_BIT_ALL,

   156

	TRACK_BIT_RIGHT,

   157

	TRACK_BIT_UPPER,

   158

	TRACK_BIT_X,

   159

   160

	TRACK_BIT_LEFT,

   161

	TRACK_BIT_NONE,

   162

	TRACK_BIT_Y,

   163

	TRACK_BIT_LOWER,

   164

   165

	TRACK_BIT_LOWER,

   166

	TRACK_BIT_Y,

   167

	TRACK_BIT_NONE,

   168

	TRACK_BIT_LEFT,

   169

   170

	TRACK_BIT_X,

   171

	TRACK_BIT_UPPER,

   172

	TRACK_BIT_RIGHT,

   173

};

   174

   175

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

   176

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   177

	TRACK_BIT_NONE,

   178

	TRACK_BIT_LEFT,

   179

	TRACK_BIT_LOWER,

   180

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   181

   182

	TRACK_BIT_RIGHT,

   183

	TRACK_BIT_ALL,

   184

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   185

	TRACK_BIT_ALL,

   186

   187

	TRACK_BIT_UPPER,

   188

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   189

	TRACK_BIT_ALL,

   190

	TRACK_BIT_ALL,

   191

   192

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   193

	TRACK_BIT_ALL,

   194

	TRACK_BIT_ALL

   195

};

   196

   197

/**

   198

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

   199

 *

   200

 * @param tileh Tile slope.

   201

 * @param bits  Trackbits.

   202

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

   203

 */

   204

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   205

{

   206

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   207

   208

	if (IsSteepSlope(tileh)) {

   209

		/* Test for inclined foundations */

   210

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   211

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   212

   213

		/* Get higher track */

   214

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   215

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   216

   217

		/* Only higher track? */

   218

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

   219

   220

		/* Overlap with higher track? */

   221

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

   222

   223

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

   224

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

   225

	} else {

   226

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

   227

   228

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

   229

   230

		Corner track_corner;

   231

		switch (bits) {

   232

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   233

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   234

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   235

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   236

   237

			case TRACK_BIT_HORZ:

   238

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

   239

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

   240

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   241

   242

			case TRACK_BIT_VERT:

   243

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

   244

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

   245

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   246

   247

			case TRACK_BIT_X:

   248

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_X;

   249

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   250

   251

			case TRACK_BIT_Y:

   252

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_Y;

   253

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   254

   255

			default:

   256

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   257

		}

   258

		/* Single diagonal track */

   259

   260

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

   261

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   262

   263

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

   264

		if (HasSlopeHighestCorner(ComplementSlope(tileh))) return FOUNDATION_LEVELED;

   265

   266

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

   267

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

   268

   269

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

   270

		return SpecialRailFoundation(track_corner);

   271

	}

   272

}

   273

   274

   275

/**

   276

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

   277

 *

   278

 * @param tileh Tile slope.

   279

 * @param rail_bits Tracks to build.

   280

 * @param existing Tracks already built.

   281

 * @param tile Tile (used for water test)

   282

 * @return Error message or cost for foundation building.

   283

 */

   284

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

   285

{

   286

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

   288

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

   289

	}

   290

   291

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

   292

   293

	/* check track/slope combination */

   294

	if ((f_new == FOUNDATION_INVALID) ||

   295

	    ((f_new != FOUNDATION_NONE) && (!_patches.build_on_slopes || _is_old_ai_player))

   296

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   297

   298

	Foundation f_old = GetRailFoundation(tileh, existing);

   299

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

   300

}

   301

   302

/* Validate functions for rail building */

   303

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

   304

   305

/** Build a single piece of rail

   306

 * @param tile tile  to build on

   307

 * @param flags operation to perform

   308

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

   309

 * @param p2 rail track to build

   310

 */

   311

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

   312

{

   313

	Slope tileh;

   314

	RailType railtype;

   315

	Track track;

   316

	TrackBits trackbit;

   317

	CommandCost cost;

   318

	CommandCost ret;

   319

   320

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

   321

	railtype = (RailType)p1;

   322

	track = (Track)p2;

   323

   324

	tileh = GetTileSlope(tile, NULL);

   325

	trackbit = TrackToTrackBits(track);

   326

   327

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   328

   329

	switch (GetTileType(tile)) {

   330

		case MP_RAILWAY:

   331

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

   332

					!EnsureNoTrainOnTrack(tile, track)) {

   333

				return CMD_ERROR;

   334

			}

   335

			if (!IsTileOwner(tile, _current_player) ||

   336

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

   337

				/* Get detailed error message */

   338

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

   339

			}

   340

   341

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

   342

			if (CmdFailed(ret)) return ret;

   343

			cost.AddCost(ret);

   344

   345

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

   346

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

   347

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

   348

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

   349

				if (CmdFailed(ret)) return ret;

   350

				cost.AddCost(ret);

   351

			}

   352

   353

			if (flags & DC_EXEC) {

   354

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   355

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

   356

			}

   357

			break;

   358

   359

		case MP_ROAD:

   360

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

   361

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

   362

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

   363

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   364

			}

   365

#undef M

   366

   367

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   368

   369

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   370

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

   371

   372

				RoadTypes roadtypes = GetRoadTypes(tile);

   373

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   374

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   375

				switch (roadtypes) {

   376

					default: break;

   377

					case ROADTYPES_TRAM:

   378

						/* Tram crossings must always have road. */

   379

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   380

						roadtypes |= ROADTYPES_ROAD;

   381

						break;

   382

   383

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

   384

						/* FALL THROUGH */

   385

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

   386

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

   387

					case ROADTYPES_ALL:      // Also incompatible

   388

						return CMD_ERROR;

   389

				}

   390

   391

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

   392

   393

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

   394

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

   395

					if (flags & DC_EXEC) {

   396

						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));

   397

					}

   398

					break;

   399

				}

   400

			}

   401

   402

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

   403

				return_cmd_error(STR_1007_ALREADY_BUILT);

   404

			}

   405

			/* FALLTHROUGH */

   406

   407

		default:

   410

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

   411

			if (CmdFailed(ret)) return ret;

   412

			cost.AddCost(ret);

   413

   414

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

   415

			if (CmdFailed(ret)) return ret;

   416

			cost.AddCost(ret);

   417

   427

			break;

   428

	}

   429

   430

	if (flags & DC_EXEC) {

   431

		MarkTileDirtyByTile(tile);

   432

		SetSignalsOnBothDir(tile, track);

   433

		YapfNotifyTrackLayoutChange(tile, track);

   434

	}

   435

   436

	return cost.AddCost(RailBuildCost(railtype));

   437

}

   438

   439

/** Remove a single piece of track

   440

 * @param tile tile to remove track from

   441

 * @param flags operation to perform

   442

 * @param p1 unused

   443

 * @param p2 rail orientation

   444

 */

   445

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

   446

{

   447

	Track track = (Track)p2;

   448

	TrackBits trackbit;

   449

	CommandCost cost(_price.remove_rail);

   450

	bool crossing = false;

   451

   452

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

   453

	trackbit = TrackToTrackBits(track);

   454

   455

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   456

   457

	switch (GetTileType(tile)) {

   458

		case MP_ROAD: {

   459

			if (!IsLevelCrossing(tile) ||

   460

					GetCrossingRailBits(tile) != trackbit ||

   461

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

   462

					!EnsureNoVehicleOnGround(tile)) {

   463

				return CMD_ERROR;

   464

			}

   465

   466

			if (flags & DC_EXEC) {

   467

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

   468

			}

   469

			break;

   470

		}

   471

   472

		case MP_RAILWAY: {

   473

			TrackBits present;

   474

   475

			if (!IsPlainRailTile(tile) ||

   476

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

   477

					!EnsureNoTrainOnTrack(tile, track)) {

   478

				return CMD_ERROR;

   479

			}

   480

   481

			present = GetTrackBits(tile);

   482

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

   483

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

   484

   485

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