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"

    45

    46

const byte _track_sloped_sprites[14] = {

    47

	14, 15, 22, 13,

    48

	 0, 21, 17, 12,

    49

	23,  0, 18, 20,

    50

	19, 16

    51

};

    52

    53

    54

/*         4

    55

 *     ---------

    56

 *    |\       /|

    57

 *    | \    1/ |

    58

 *    |  \   /  |

    59

 *    |   \ /   |

    60

 *  16|    \    |32

    61

 *    |   / \2  |

    62

 *    |  /   \  |

    63

 *    | /     \ |

    64

 *    |/       \|

    65

 *     ---------

    66

 *         8

    67

 */

    68

    69

    70

    71

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

    72

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

    73

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

    74

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

    75

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

    76

 *               similar for lower and right.

    77

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

    78

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

    79

 * MAP5:         00abcdef => rail

    80

 *               01abcdef => rail w/ signals

    81

 *               10uuuuuu => unused

    82

 *               11uuuudd => rail depot

    83

 */

    84

    85

/** Struct used in EnsureNoTrainOnTrack() */

    86

struct TrainOnTrackData {

    87

	TileIndex tile;       ///< tile to check

    88

	uint z;               ///< tile max Z

    89

	TrackBits rail_bits;  ///< trackbits of interest

    90

};

    91

    92

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

    93

{

    94

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

    95

    96

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

    97

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

    98

    99

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

   100

   101

	_error_message = VehicleInTheWayErrMsg(v);

   102

	return v;

   103

}

   104

   105

/**

   106

 * Tests if a vehicle interacts with the specified track.

   107

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   108

 *

   109

 * @param tile The tile.

   110

 * @param track The track.

   111

 */

   112

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   113

{

   114

	TrainOnTrackData info;

   115

   116

	info.tile = tile;

   117

	info.z = GetTileMaxZ(tile);

   118

	info.rail_bits = TrackToTrackBits(track);

   119

   120

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

   121

}

   122

   123

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

   124

{

   125

	TrackBits current; // The current track layout

   126

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

   127

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   128

   129

	if (!IsPlainRailTile(tile)) return false;

   130

   131

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

   132

	 * what tracks first */

   133

	current = GetTrackBits(tile);

   134

	future = current | to_build;

   135

   136

	/* Are we really building something new? */

   137

	if (current == future) {

   138

		/* Nothing new is being built */

   139

		_error_message = STR_1007_ALREADY_BUILT;

   140

		return false;

   141

	}

   142

   143

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

   144

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

   145

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

   146

		 * signals on the tile), check that */

   147

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

   148

	} else {

   149

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

   150

		return true;

   151

	}

   152

}

   153

   154

   155

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

   156

static const TrackBits _valid_tracks_without_foundation[15] = {

   157

	TRACK_BIT_ALL,

   158

	TRACK_BIT_RIGHT,

   159

	TRACK_BIT_UPPER,

   160

	TRACK_BIT_X,

   161

   162

	TRACK_BIT_LEFT,

   163

	TRACK_BIT_NONE,

   164

	TRACK_BIT_Y,

   165

	TRACK_BIT_LOWER,

   166

   167

	TRACK_BIT_LOWER,

   168

	TRACK_BIT_Y,

   169

	TRACK_BIT_NONE,

   170

	TRACK_BIT_LEFT,

   171

   172

	TRACK_BIT_X,

   173

	TRACK_BIT_UPPER,

   174

	TRACK_BIT_RIGHT,

   175

};

   176

   177

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

   178

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   179

	TRACK_BIT_NONE,

   180

	TRACK_BIT_LEFT,

   181

	TRACK_BIT_LOWER,

   182

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   183

   184

	TRACK_BIT_RIGHT,

   185

	TRACK_BIT_ALL,

   186

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   187

	TRACK_BIT_ALL,

   188

   189

	TRACK_BIT_UPPER,

   190

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   191

	TRACK_BIT_ALL,

   192

	TRACK_BIT_ALL,

   193

   194

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   195

	TRACK_BIT_ALL,

   196

	TRACK_BIT_ALL

   197

};

   198

   199

/**

   200

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

   201

 *

   202

 * @param tileh Tile slope.

   203

 * @param bits  Trackbits.

   204

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

   205

 */

   206

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   207

{

   208

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   209

   210

	if (IsSteepSlope(tileh)) {

   211

		/* Test for inclined foundations */

   212

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   213

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   214

   215

		/* Get higher track */

   216

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   217

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   218

   219

		/* Only higher track? */

   220

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

   221

   222

		/* Overlap with higher track? */

   223

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

   224

   225

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

   226

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

   227

	} else {

   228

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

   229

   230

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

   231

   232

		Corner track_corner;

   233

		switch (bits) {

   234

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   235

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   236

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   237

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   238

   239

			case TRACK_BIT_HORZ:

   240

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

   241

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

   242

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   243

   244

			case TRACK_BIT_VERT:

   245

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

   246

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

   247

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   248

   249

			case TRACK_BIT_X:

   250

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_X;

   251

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   252

   253

			case TRACK_BIT_Y:

   254

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_Y;

   255

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   256

   257

			default:

   258

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   259

		}

   260

		/* Single diagonal track */

   261

   262

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

   263

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   264

   265

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

   266

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

   267

   268

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

   269

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

   270

   271

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

   272

		return SpecialRailFoundation(track_corner);

   273

	}

   274

}

   275

   276

   277

/**

   278

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

   279

 *

   280

 * @param tileh Tile slope.

   281

 * @param rail_bits Tracks to build.

   282

 * @param existing Tracks already built.

   283

 * @param tile Tile (used for water test)

   284

 * @return Error message or cost for foundation building.

   285

 */

   286

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

   287

{

   288

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

   289

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

   290

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

   291

	}

   292

   293

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

   294

   295

	/* check track/slope combination */

   296

	if ((f_new == FOUNDATION_INVALID) ||

   297

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

   298

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   299

   300

	Foundation f_old = GetRailFoundation(tileh, existing);

   301

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

   302

}

   303

   304

/* Validate functions for rail building */

   305

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

   306

   307

/** Build a single piece of rail

   308

 * @param tile tile  to build on

   309

 * @param flags operation to perform

   310

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

   311

 * @param p2 rail track to build

   312

 */

   313

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

   314

{

   315

	Slope tileh;

   316

	RailType railtype;

   317

	Track track;

   318

	TrackBits trackbit;

   319

	CommandCost cost;

   320

	CommandCost ret;

   321

   322

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

   323

	railtype = (RailType)p1;

   324

	track = (Track)p2;

   325

   326

	tileh = GetTileSlope(tile, NULL);

   327

	trackbit = TrackToTrackBits(track);

   328

   329

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   330

   331

	switch (GetTileType(tile)) {

   332

		case MP_RAILWAY:

   333

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

   334

					!EnsureNoTrainOnTrack(tile, track)) {

   335

				return CMD_ERROR;

   336

			}

   337

			if (!IsTileOwner(tile, _current_player) ||

   338

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

   339

				/* Get detailed error message */

   340

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

   341

			}

   342

   343

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

   344

			if (CmdFailed(ret)) return ret;

   345

			cost.AddCost(ret);

   346

   347

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

   348

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

   349

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

   350

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

   351

				if (CmdFailed(ret)) return ret;

   352

				cost.AddCost(ret);

   353

			}

   354

   355

			if (flags & DC_EXEC) {

   356

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   357

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

   358

			}

   359

			break;

   360

   361

		case MP_ROAD:

   362

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

   363

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

   364

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

   365

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   366

			}

   367

#undef M

   368

   369

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   370

   371

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   372

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

   373

   374

				RoadTypes roadtypes = GetRoadTypes(tile);

   375

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   376

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   377

				switch (roadtypes) {

   378

					default: break;

   379

					case ROADTYPES_TRAM:

   380

						/* Tram crossings must always have road. */

   381

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   382

						roadtypes |= ROADTYPES_ROAD;

   383

						break;

   384

   385

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

   386

						/* FALL THROUGH */

   387

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

   388

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

   389

					case ROADTYPES_ALL:      // Also incompatible

   390

						return CMD_ERROR;

   391

				}

   392

   393

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

   394

   395

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

   396

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

   397

					if (flags & DC_EXEC) {

   398

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

   399

					}

   400

					break;

   401

				}

   402

			}

   403

   404

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

   405

				return_cmd_error(STR_1007_ALREADY_BUILT);

   406

			}

   407

			/* FALLTHROUGH */

   408

   409

		default:

   410

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

   411

   412

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

   413

			if (CmdFailed(ret)) return ret;

   414

			cost.AddCost(ret);

   415

   416

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

   417

			if (CmdFailed(ret)) return ret;

   418

			cost.AddCost(ret);

   419

   420

			if (water_ground) {

   421

				cost.AddCost(-_price.clear_water);

   422

				cost.AddCost(_price.purchase_land);

   423

			}

   424

   425

			if (flags & DC_EXEC) {

   426

				MakeRailNormal(tile, _current_player, trackbit, railtype);

   427

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   428

			}

   429

			break;

   430

	}

   431

   432

	if (flags & DC_EXEC) {

   433

		MarkTileDirtyByTile(tile);

   434

		SetSignalsOnBothDir(tile, track);

   435

		YapfNotifyTrackLayoutChange(tile, track);

   436

	}

   437

   438

	return cost.AddCost(RailBuildCost(railtype));

   439

}

   440

   441

/** Remove a single piece of track

   442

 * @param tile tile to remove track from

   443

 * @param flags operation to perform

   444

 * @param p1 unused

   445

 * @param p2 rail orientation

   446

 */

   447

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

   448

{

   449

	Track track = (Track)p2;

   450

	TrackBits trackbit;

   451

	CommandCost cost(_price.remove_rail);

   452

	bool crossing = false;

   453

   454

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

   455

	trackbit = TrackToTrackBits(track);

   456

   457

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   458

   459

	switch (GetTileType(tile)) {

   460

		case MP_ROAD: {

   461

			if (!IsLevelCrossing(tile) ||

   462

					GetCrossingRailBits(tile) != trackbit ||

   463

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

   464

					!EnsureNoVehicleOnGround(tile)) {

   465

				return CMD_ERROR;

   466

			}

   467

   468

			if (flags & DC_EXEC) {

   469

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

   470

			}

   471

			break;

   472

		}

   473

   474

		case MP_RAILWAY: {

   475

			TrackBits present;

   476

   477

			if (!IsPlainRailTile(tile) ||

   478

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

   479

					!EnsureNoTrainOnTrack(tile, track)) {

   480

				return CMD_ERROR;

   481

			}

   482

   483

			present = GetTrackBits(tile);

   484

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

   485

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