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

    21

#include "town.h"

    22

#include "station.h"

    23

#include "sprite.h"

    24

#include "depot.h"

    25

#include "waypoint.h"

    26

#include "rail.h"

    27

#include "newgrf.h"

    28

#include "yapf/yapf.h"

    29

#include "newgrf_engine.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_station.h"

    32

#include "train.h"

    33

#include "misc/autoptr.hpp"

    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

    44

#include "table/sprites.h"

    45

#include "table/strings.h"

    46

#include "table/railtypes.h"

    47

    48

const byte _track_sloped_sprites[14] = {

    49

	14, 15, 22, 13,

    50

	 0, 21, 17, 12,

    51

	23,  0, 18, 20,

    52

	19, 16

    53

};

    54

    55

    56

/*         4

    57

 *     ---------

    58

 *    |\       /|

    59

 *    | \    1/ |

    60

 *    |  \   /  |

    61

 *    |   \ /   |

    62

 *  16|    \    |32

    63

 *    |   / \2  |

    64

 *    |  /   \  |

    65

 *    | /     \ |

    66

 *    |/       \|

    67

 *     ---------

    68

 *         8

    69

 */

    70

    71

    72

    73

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

    74

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

    75

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

    76

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

    77

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

    78

 *               similar for lower and right.

    79

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

    80

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

    81

 * MAP5:         00abcdef => rail

    82

 *               01abcdef => rail w/ signals

    83

 *               10uuuuuu => unused

    84

 *               11uuuudd => rail depot

    85

 */

    86

    87

    88

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

    89

{

    90

	TrackBits rail_bits = *(TrackBits *)data;

    91

    92

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

    93

    94

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

    95

    96

	_error_message = VehicleInTheWayErrMsg(v);

    97

	return v;

    98

}

    99

   100

/**

   101

 * Tests if a vehicle interacts with the specified track.

   102

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   103

 *

   104

 * @param tile The tile.

   105

 * @param track The track.

   106

 */

   107

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   108

{

   109

	TrackBits rail_bits = TrackToTrackBits(track);

   110

   111

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

   112

}

   113

   114

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

   115

{

   116

	TrackBits current; // The current track layout

   117

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

   118

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   119

   120

	if (!IsPlainRailTile(tile)) return false;

   121

   122

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

   123

	 * what tracks first */

   124

	current = GetTrackBits(tile);

   125

	future = current | to_build;

   126

   127

	/* Are we really building something new? */

   128

	if (current == future) {

   129

		/* Nothing new is being built */

   130

		_error_message = STR_1007_ALREADY_BUILT;

   131

		return false;

   132

	}

   133

   134

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

   135

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

   136

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

   137

		 * signals on the tile), check that */

   138

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

   139

	} else {

   140

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

   141

		return true;

   142

	}

   143

}

   144

   145

   146

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

   147

static const TrackBits _valid_tracks_without_foundation[15] = {

   148

	TRACK_BIT_ALL,

   149

	TRACK_BIT_RIGHT,

   150

	TRACK_BIT_UPPER,

   151

	TRACK_BIT_X,

   152

   153

	TRACK_BIT_LEFT,

   154

	TRACK_BIT_NONE,

   155

	TRACK_BIT_Y,

   156

	TRACK_BIT_LOWER,

   157

   158

	TRACK_BIT_LOWER,

   159

	TRACK_BIT_Y,

   160

	TRACK_BIT_NONE,

   161

	TRACK_BIT_LEFT,

   162

   163

	TRACK_BIT_X,

   164

	TRACK_BIT_UPPER,

   165

	TRACK_BIT_RIGHT,

   166

};

   167

   168

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

   169

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   170

	TRACK_BIT_NONE,

   171

	TRACK_BIT_LEFT,

   172

	TRACK_BIT_LOWER,

   173

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   174

   175

	TRACK_BIT_RIGHT,

   176

	TRACK_BIT_ALL,

   177

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   178

	TRACK_BIT_ALL,

   179

   180

	TRACK_BIT_UPPER,

   181

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   182

	TRACK_BIT_ALL,

   183

	TRACK_BIT_ALL,

   184

   185

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   186

	TRACK_BIT_ALL,

   187

	TRACK_BIT_ALL

   188

};

   189

   190

/**

   191

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

   192

 *

   193

 * @param tileh Tile slope.

   194

 * @param bits  Trackbits.

   195

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

   196

 */

   197

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   198

{

   199

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   200

   201

	if (IsSteepSlope(tileh)) {

   202

		/* Test for inclined foundations */

   203

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   204

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   205

   206

		/* Get higher track */

   207

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   208

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   209

   210

		/* Only higher track? */

   211

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

   212

   213

		/* Overlap with higher track? */

   214

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

   215

   216

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

   217

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

   218

	} else {

   219

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

   220

   221

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

   222

   223

		Corner track_corner;

   224

		switch (bits) {

   225

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   226

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   227

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   228

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   229

   230

			case TRACK_BIT_HORZ:

   231

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

   232

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

   233

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   234

   235

			case TRACK_BIT_VERT:

   236

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

   237

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

   238

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   239

   240

			case TRACK_BIT_X:

   241

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_X;

   242

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   243

   244

			case TRACK_BIT_Y:

   245

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_Y;

   246

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   247

   248

			default:

   249

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   250

		}

   251

		/* Single diagonal track */

   252

   253

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

   254

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   255

   256

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

   257

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

   258

   259

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

   260

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

   261

   262

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

   263

		return SpecialRailFoundation(track_corner);

   264

	}

   265

}

   266

   267

   268

/**

   269

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

   270

 *

   271

 * @param tileh Tile slope.

   272

 * @param rail_bits Tracks to build.

   273

 * @param existing Tracks already built.

   274

 * @param tile Tile (used for water test)

   275

 * @return Error message or cost for foundation building.

   276

 */

   277

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

   278

{

   279

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

   280

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

   281

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

   282

	}

   283

   284

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

   285

   286

	/* check track/slope combination */

   287

	if ((f_new == FOUNDATION_INVALID) ||

   288

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

   289

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   290

   291

	Foundation f_old = GetRailFoundation(tileh, existing);

   292

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

   293

}

   294

   295

/* Validate functions for rail building */

   296

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

   297

   298

/** Build a single piece of rail

   299

 * @param tile tile  to build on

   300

 * @param flags operation to perform

   301

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

   302

 * @param p2 rail track to build

   303

 */

   304

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

   305

{

   306

	Slope tileh;

   307

	RailType railtype = (RailType)p1;

   308

	Track track = (Track)p2;

   309

	TrackBits trackbit;

   310

	CommandCost cost(EXPENSES_CONSTRUCTION);

   311

	CommandCost ret;

   312

   313

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

   314

   315

	tileh = GetTileSlope(tile, NULL);

   316

	trackbit = TrackToTrackBits(track);

   317

   318

	switch (GetTileType(tile)) {

   319

		case MP_RAILWAY:

   320

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

   321

					!EnsureNoTrainOnTrack(tile, track)) {

   322

				return CMD_ERROR;

   323

			}

   324

			if (!IsTileOwner(tile, _current_player) ||

   325

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

   326

				/* Get detailed error message */

   327

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

   328

			}

   329

   330

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

   331

			if (CmdFailed(ret)) return ret;

   332

			cost.AddCost(ret);

   333

   334

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

   335

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

   336

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

   337

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

   338

				if (CmdFailed(ret)) return ret;

   339

				cost.AddCost(ret);

   340

			}

   341

   342

			if (flags & DC_EXEC) {

   343

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   344

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

   345

			}

   346

			break;

   347

   348

		case MP_ROAD:

   349

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

   350

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

   351

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

   352

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   353

			}

   354

#undef M

   355

   356

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   357

   358

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   359

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

   360

   361

				RoadTypes roadtypes = GetRoadTypes(tile);

   362

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   363

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   364

				switch (roadtypes) {

   365

					default: break;

   366

					case ROADTYPES_TRAM:

   367

						/* Tram crossings must always have road. */

   368

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   369

						roadtypes |= ROADTYPES_ROAD;

   370

						break;

   371

   372

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

   373

						/* FALL THROUGH */

   374

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

   375

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

   376

					case ROADTYPES_ALL:      // Also incompatible

   377

						return CMD_ERROR;

   378

				}

   379

   380

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

   381

   382

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

   383

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

   384

					if (flags & DC_EXEC) {

   385

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

   387

					}

   388

					break;

   389

				}

   390

			}

   391

   392

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

   393

				return_cmd_error(STR_1007_ALREADY_BUILT);

   394

			}

   395

			/* FALLTHROUGH */

   396

   397

		default:

   398

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

   399

   400

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

   401

			if (CmdFailed(ret)) return ret;

   402

			cost.AddCost(ret);

   403

   404

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

   405

			if (CmdFailed(ret)) return ret;

   406

			cost.AddCost(ret);

   407

   408

			if (water_ground) {

   409

				cost.AddCost(-_price.clear_water);

   410

				cost.AddCost(_price.clear_roughland);

   411

			}

   412

   413

			if (flags & DC_EXEC) {

   414

				MakeRailNormal(tile, _current_player, trackbit, railtype);

   415

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   416

			}

   417

			break;

   418

	}

   419

   420

	if (flags & DC_EXEC) {

   421

		MarkTileDirtyByTile(tile);

   422

		AddTrackToSignalBuffer(tile, track, _current_player);

   423

		YapfNotifyTrackLayoutChange(tile, track);

   424

	}

   425

   426

	return cost.AddCost(RailBuildCost(railtype));

   427

}

   428

   429

/** Remove a single piece of track

   430

 * @param tile tile to remove track from

   431

 * @param flags operation to perform

   432

 * @param p1 unused

   433

 * @param p2 rail orientation

   434

 */

   435

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

   436

{

   437

	Track track = (Track)p2;

   438

	TrackBits trackbit;

   439

	CommandCost cost(EXPENSES_CONSTRUCTION, _price.remove_rail );

   440

	bool crossing = false;

   441

   442

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

   443

	trackbit = TrackToTrackBits(track);

   444

   445

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

   446

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

   447

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

   448

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

   449

	Owner owner = INVALID_OWNER;

   450

   451

	switch (GetTileType(tile)) {

   452

		case MP_ROAD: {

   453

			if (!IsLevelCrossing(tile) ||

   454

					GetCrossingRailBits(tile) != trackbit ||

   455

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

   456

					!EnsureNoVehicleOnGround(tile)) {

   457

				return CMD_ERROR;

   458

			}

   459

   460

			if (flags & DC_EXEC) {

   461

				owner = GetTileOwner(tile);

   462

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

   463

			}

   464

			break;

   465

		}

   466

   467

		case MP_RAILWAY: {

   468

			TrackBits present;

   469

   470

			if (!IsPlainRailTile(tile) ||

   471

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

   472

					!EnsureNoTrainOnTrack(tile, track)) {

   473

				return CMD_ERROR;

   474

			}

   475

   476

			present = GetTrackBits(tile);

   477

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

   478

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

   479

   480

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

   481

			if (HasSignalOnTrack(tile, track))

   482

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

   483

   484

			if (flags & DC_EXEC) {