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

#include "transparency.h"

    44

    45

const byte _track_sloped_sprites[14] = {

    46

	14, 15, 22, 13,

    47

	 0, 21, 17, 12,

    48

	23,  0, 18, 20,

    49

	19, 16

    50

};

    51

    52

    53

/*         4

    54

 *     ---------

    55

 *    |\       /|

    56

 *    | \    1/ |

    57

 *    |  \   /  |

    58

 *    |   \ /   |

    59

 *  16|    \    |32

    60

 *    |   / \2  |

    61

 *    |  /   \  |

    62

 *    | /     \ |

    63

 *    |/       \|

    64

 *     ---------

    65

 *         8

    66

 */

    67

    68

    69

    70

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

    71

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

    72

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

    73

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

    74

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

    75

 *               similar for lower and right.

    76

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

    77

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

    78

 * MAP5:         00abcdef => rail

    79

 *               01abcdef => rail w/ signals

    80

 *               10uuuuuu => unused

    81

 *               11uuuudd => rail depot

    82

 */

    83

    84

/** Struct used in EnsureNoTrainOnTrack() */

    85

struct TrainOnTrackData {

    86

	TileIndex tile;       ///< tile to check

    87

	uint z;               ///< tile max Z

    88

	TrackBits rail_bits;  ///< trackbits of interest

    89

};

    90

    91

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

    92

{

    93

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

    94

    95

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

    96

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

    97

    98

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

    99

   100

	_error_message = VehicleInTheWayErrMsg(v);

   101

	return v;

   102

}

   103

   104

/**

   105

 * Tests if a vehicle interacts with the specified track.

   106

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   107

 *

   108

 * @param tile The tile.

   109

 * @param track The track.

   110

 */

   111

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   112

{

   113

	TrainOnTrackData info;

   114

   115

	info.tile = tile;

   116

	info.z = GetTileMaxZ(tile);

   117

	info.rail_bits = TrackToTrackBits(track);

   118

   119

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

   120

}

   121

   122

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

   123

{

   124

	TrackBits current; // The current track layout

   125

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

   126

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   127

   128

	if (!IsPlainRailTile(tile)) return false;

   129

   130

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

   131

	 * what tracks first */

   132

	current = GetTrackBits(tile);

   133

	future = current | to_build;

   134

   135

	/* Are we really building something new? */

   136

	if (current == future) {

   137

		/* Nothing new is being built */

   138

		_error_message = STR_1007_ALREADY_BUILT;

   139

		return false;

   140

	}

   141

   142

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

   143

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

   144

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

   145

		 * signals on the tile), check that */

   146

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

   147

	} else {

   148

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

   149

		return true;

   150

	}

   151

}

   152

   153

   154

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

   155

static const TrackBits _valid_tracks_without_foundation[15] = {

   156

	TRACK_BIT_ALL,

   157

	TRACK_BIT_RIGHT,

   158

	TRACK_BIT_UPPER,

   159

	TRACK_BIT_X,

   160

   161

	TRACK_BIT_LEFT,

   162

	TRACK_BIT_NONE,

   163

	TRACK_BIT_Y,

   164

	TRACK_BIT_LOWER,

   165

   166

	TRACK_BIT_LOWER,

   167

	TRACK_BIT_Y,

   168

	TRACK_BIT_NONE,

   169

	TRACK_BIT_LEFT,

   170

   171

	TRACK_BIT_X,

   172

	TRACK_BIT_UPPER,

   173

	TRACK_BIT_RIGHT,

   174

};

   175

   176

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

   177

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   178

	TRACK_BIT_NONE,

   179

	TRACK_BIT_LEFT,

   180

	TRACK_BIT_LOWER,

   181

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   182

   183

	TRACK_BIT_RIGHT,

   184

	TRACK_BIT_ALL,

   185

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   186

	TRACK_BIT_ALL,

   187

   188

	TRACK_BIT_UPPER,

   189

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   190

	TRACK_BIT_ALL,

   191

	TRACK_BIT_ALL,

   192

   193

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   194

	TRACK_BIT_ALL,

   195

	TRACK_BIT_ALL

   196

};

   197

   198

/**

   199

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

   200

 *

   201

 * @param tileh Tile slope.

   202

 * @param bits  Trackbits.

   203

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

   204

 */

   205

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   206

{

   207

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   208

   209

	if (IsSteepSlope(tileh)) {

   210

		/* Test for inclined foundations */

   211

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   212

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   213

   214

		/* Get higher track */

   215

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   216

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   217

   218

		/* Only higher track? */

   219

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

   220

   221

		/* Overlap with higher track? */

   222

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

   223

   224

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

   225

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

   226

	} else {

   227

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

   228

   229

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

   230

   231

		Corner track_corner;

   232

		switch (bits) {

   233

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   234

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   235

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   236

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   237

   238

			case TRACK_BIT_HORZ:

   239

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

   240

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

   241

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   242

   243

			case TRACK_BIT_VERT:

   244

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

   245

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

   246

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   247

   248

			case TRACK_BIT_X:

   249

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_X;

   250

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   251

   252

			case TRACK_BIT_Y:

   253

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_Y;

   254

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   255

   256

			default:

   257

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   258

		}

   259

		/* Single diagonal track */

   260

   261

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

   262

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   263

   264

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

   265

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

   266

   267

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

   268

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

   269

   270

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

   271

		return SpecialRailFoundation(track_corner);

   272

	}

   273

}

   274

   275

   276

/**

   277

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

   278

 *

   279

 * @param tileh Tile slope.

   280

 * @param rail_bits Tracks to build.

   281

 * @param existing Tracks already built.

   282

 * @param tile Tile (used for water test)

   283

 * @return Error message or cost for foundation building.

   284

 */

   285

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

   286

{

   287

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

   288

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

   289

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

   290

	}

   291

   292

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

   293

   294

	/* check track/slope combination */

   295

	if ((f_new == FOUNDATION_INVALID) ||

   296

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

   297

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   298

   299

	Foundation f_old = GetRailFoundation(tileh, existing);

   300

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

   301

}

   302

   303

/* Validate functions for rail building */

   304

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

   305

   306

/** Build a single piece of rail

   307

 * @param tile tile  to build on

   308

 * @param flags operation to perform

   309

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

   310

 * @param p2 rail track to build

   311

 */

   312

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

   313

{

   314

	Slope tileh;

   315

	RailType railtype;

   316

	Track track;

   317

	TrackBits trackbit;

   318

	CommandCost cost;

   319

	CommandCost ret;

   320

   321

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

   322

	railtype = (RailType)p1;

   323

	track = (Track)p2;

   324

   325

	tileh = GetTileSlope(tile, NULL);

   326

	trackbit = TrackToTrackBits(track);

   327

   328

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   329

   330

	switch (GetTileType(tile)) {

   331

		case MP_RAILWAY:

   332

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

   333

					!EnsureNoTrainOnTrack(tile, track)) {

   334

				return CMD_ERROR;

   335

			}

   336

			if (!IsTileOwner(tile, _current_player) ||

   337

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

   338

				/* Get detailed error message */

   339

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

   340

			}

   341

   342

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

   343

			if (CmdFailed(ret)) return ret;

   344

			cost.AddCost(ret);

   345

   346

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

   347

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

   348

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

   349

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

   350

				if (CmdFailed(ret)) return ret;

   351

				cost.AddCost(ret);

   352

			}

   353

   354

			if (flags & DC_EXEC) {

   355

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   356

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

   357

			}

   358

			break;

   359

   360

		case MP_ROAD:

   361

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

   362

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

   363

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

   364

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   365

			}

   366

#undef M

   367

   368

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   369

   370

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   371

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

   372

   373

				RoadTypes roadtypes = GetRoadTypes(tile);

   374

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   375

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   376

				switch (roadtypes) {

   377

					default: break;

   378

					case ROADTYPES_TRAM:

   379

						/* Tram crossings must always have road. */

   380

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   381

						roadtypes |= ROADTYPES_ROAD;

   382

						break;

   383

   384

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

   385

						/* FALL THROUGH */

   386

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

   387

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

   388

					case ROADTYPES_ALL:      // Also incompatible

   389

						return CMD_ERROR;

   390

				}

   391

   392

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

   393

   394

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

   395

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

   396

					if (flags & DC_EXEC) {

   397

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

   398

					}

   399

					break;

   400

				}

   401

			}

   402

   403

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

   404

				return_cmd_error(STR_1007_ALREADY_BUILT);

   405

			}

   406

			/* FALLTHROUGH */

   407

   408

		default:

   409

			bool water_ground = IsTileType(tile, MP_WATER) && !IsSteepSlope(tileh) && HasSlopeHighestCorner(tileh);

   410

   411

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

   412

			if (CmdFailed(ret)) return ret;

   413

			cost.AddCost(ret);

   414

   415

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

   416

			if (CmdFailed(ret)) return ret;

   417

			cost.AddCost(ret);

   418

   419

			if (water_ground) {

   420

				cost.AddCost(-_price.clear_water);

   421

				cost.AddCost(_price.purchase_land);

   422

			}

   423

   424

			if (flags & DC_EXEC) {

   425

				MakeRailNormal(tile, _current_player, trackbit, railtype);

   426

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   427

			}

   428

			break;

   429

	}

   430

   431

	if (flags & DC_EXEC) {

   432

		MarkTileDirtyByTile(tile);

   433

		SetSignalsOnBothDir(tile, track);

   434

		YapfNotifyTrackLayoutChange(tile, track);

   435

	}

   436

   437

	return cost.AddCost(RailBuildCost(railtype));

   438

}

   439

   440

/** Remove a single piece of track

   441

 * @param tile tile to remove track from

   442

 * @param flags operation to perform

   443

 * @param p1 unused

   444

 * @param p2 rail orientation

   445

 */

   446

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

   447

{

   448

	Track track = (Track)p2;

   449

	TrackBits trackbit;

   450

	CommandCost cost(_price.remove_rail);

   451

	bool crossing = false;

   452

   453

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

   454

	trackbit = TrackToTrackBits(track);

   455

   456

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   457

   458

	switch (GetTileType(tile)) {

   459

		case MP_ROAD: {

   460

			if (!IsLevelCrossing(tile) ||

   461

					GetCrossingRailBits(tile) != trackbit ||

   462

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

   463

					!EnsureNoVehicleOnGround(tile)) {

   464

				return CMD_ERROR;

   465

			}

   466

   467

			if (flags & DC_EXEC) {

   468

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

   469

			}

   470

			break;

   471

		}

   472

   473

		case MP_RAILWAY: {

   474

			TrackBits present;

   475

   476

			if (!IsPlainRailTile(tile) ||

   477

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

   478

					!EnsureNoTrainOnTrack(tile, track)) {

   479

				return CMD_ERROR;

   480

			}

   481

   482

			present = GetTrackBits(tile);

   483

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

   484

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

   485