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

#include "tunnelbridge.h"

    44

    45

#include "table/sprites.h"

    46

#include "table/strings.h"

    47

#include "table/railtypes.h"

    48

#include "table/track_land.h"

    49

    50

const byte _track_sloped_sprites[14] = {

    51

	14, 15, 22, 13,

    52

	 0, 21, 17, 12,

    53

	23,  0, 18, 20,

    54

	19, 16

    55

};

    56

    57

    58

/*         4

    59

 *     ---------

    60

 *    |\       /|

    61

 *    | \    1/ |

    62

 *    |  \   /  |

    63

 *    |   \ /   |

    64

 *  16|    \    |32

    65

 *    |   / \2  |

    66

 *    |  /   \  |

    67

 *    | /     \ |

    68

 *    |/       \|

    69

 *     ---------

    70

 *         8

    71

 */

    72

    73

    74

    75

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

    76

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

    77

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

    78

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

    79

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

    80

 *               similar for lower and right.

    81

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

    82

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

    83

 * MAP5:         00abcdef => rail

    84

 *               01abcdef => rail w/ signals

    85

 *               10uuuuuu => unused

    86

 *               11uuuudd => rail depot

    87

 */

    88

    89

    90

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

    91

{

    92

	TrackBits rail_bits = *(TrackBits *)data;

    93

    94

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

    95

    96

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

    97

    98

	_error_message = VehicleInTheWayErrMsg(v);

    99

	return v;

   100

}

   101

   102

/**

   103

 * Tests if a vehicle interacts with the specified track.

   104

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   105

 *

   106

 * @param tile The tile.

   107

 * @param track The track.

   108

 */

   109

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   110

{

   111

	TrackBits rail_bits = TrackToTrackBits(track);

   112

   113

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

   114

}

   115

   116

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

   117

{

   118

	TrackBits current; // The current track layout

   119

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

   120

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   121

   122

	if (!IsPlainRailTile(tile)) return false;

   123

   124

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

   125

	 * what tracks first */

   126

	current = GetTrackBits(tile);

   127

	future = current | to_build;

   128

   129

	/* Are we really building something new? */

   130

	if (current == future) {

   131

		/* Nothing new is being built */

   132

		_error_message = STR_1007_ALREADY_BUILT;

   133

		return false;

   134

	}

   135

   136

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

   137

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

   138

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

   139

		 * signals on the tile), check that */

   140

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

   141

	} else {

   142

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

   143

		return true;

   144

	}

   145

}

   146

   147

   148

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

   149

static const TrackBits _valid_tracks_without_foundation[15] = {

   150

	TRACK_BIT_ALL,

   151

	TRACK_BIT_RIGHT,

   152

	TRACK_BIT_UPPER,

   153

	TRACK_BIT_X,

   154

   155

	TRACK_BIT_LEFT,

   156

	TRACK_BIT_NONE,

   157

	TRACK_BIT_Y,

   158

	TRACK_BIT_LOWER,

   159

   160

	TRACK_BIT_LOWER,

   161

	TRACK_BIT_Y,

   162

	TRACK_BIT_NONE,

   163

	TRACK_BIT_LEFT,

   164

   165

	TRACK_BIT_X,

   166

	TRACK_BIT_UPPER,

   167

	TRACK_BIT_RIGHT,

   168

};

   169

   170

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

   171

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   172

	TRACK_BIT_NONE,

   173

	TRACK_BIT_LEFT,

   174

	TRACK_BIT_LOWER,

   175

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   176

   177

	TRACK_BIT_RIGHT,

   178

	TRACK_BIT_ALL,

   179

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   180

	TRACK_BIT_ALL,

   181

   182

	TRACK_BIT_UPPER,

   183

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   184

	TRACK_BIT_ALL,

   185

	TRACK_BIT_ALL,

   186

   187

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   188

	TRACK_BIT_ALL,

   189

	TRACK_BIT_ALL

   190

};

   191

   192

/**

   193

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

   194

 *

   195

 * @param tileh Tile slope.

   196

 * @param bits  Trackbits.

   197

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

   198

 */

   199

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   200

{

   201

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   202

   203

	if (IsSteepSlope(tileh)) {

   204

		/* Test for inclined foundations */

   205

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   206

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   207

   208

		/* Get higher track */

   209

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   210

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   211

   212

		/* Only higher track? */

   213

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

   214

   215

		/* Overlap with higher track? */

   216

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

   217

   218

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

   219

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

   220

	} else {

   221

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

   222

   223

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

   224

   225

		Corner track_corner;

   226

		switch (bits) {

   227

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   228

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   229

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   230

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   231

   232

			case TRACK_BIT_HORZ:

   233

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

   234

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

   235

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   236

   237

			case TRACK_BIT_VERT:

   238

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

   239

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

   240

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   241

   242

			case TRACK_BIT_X:

   243

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_X;

   244

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   245

   246

			case TRACK_BIT_Y:

   247

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_Y;

   248

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   249

   250

			default:

   251

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   252

		}

   253

		/* Single diagonal track */

   254

   255

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

   256

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   257

   258

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

   259

		if (IsSlopeWithThreeCornersRaised(tileh)) return FOUNDATION_LEVELED;

   260

   261

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

   262

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

   263

   264

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

   265

		return SpecialRailFoundation(track_corner);

   266

	}

   267

}

   268

   269

   270

/**

   271

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

   272

 *

   273

 * @param tileh Tile slope.

   274

 * @param rail_bits Tracks to build.

   275

 * @param existing Tracks already built.

   276

 * @param tile Tile (used for water test)

   277

 * @return Error message or cost for foundation building.

   278

 */

   279

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

   280

{

   281

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

   282

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

   283

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

   284

	}

   285

   286

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

   287

   288

	/* check track/slope combination */

   289

	if ((f_new == FOUNDATION_INVALID) ||

   290

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

   291

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   292

   293

	Foundation f_old = GetRailFoundation(tileh, existing);

   294

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

   295

}

   296

   297

/* Validate functions for rail building */

   298

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

   299

   300

/** Build a single piece of rail

   301

 * @param tile tile  to build on

   302

 * @param flags operation to perform

   303

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

   304

 * @param p2 rail track to build

   305

 */

   306

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

   307

{

   308

	Slope tileh;

   309

	RailType railtype = (RailType)p1;

   310

	Track track = (Track)p2;

   311

	TrackBits trackbit;

   312

	CommandCost cost(EXPENSES_CONSTRUCTION);

   313

	CommandCost ret;

   314

   315

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

   316

   317

	tileh = GetTileSlope(tile, NULL);

   318

	trackbit = TrackToTrackBits(track);

   319

   320

	switch (GetTileType(tile)) {

   321

		case MP_RAILWAY:

   322

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

   323

					!EnsureNoTrainOnTrack(tile, track)) {

   324

				return CMD_ERROR;

   325

			}

   326

			if (!IsTileOwner(tile, _current_player) ||

   327

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

   328

				/* Get detailed error message */

   329

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

   330

			}

   331

   332

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

   333

			if (CmdFailed(ret)) return ret;

   334

			cost.AddCost(ret);

   335

   336

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

   337

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

   338

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

   339

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

   340

				if (CmdFailed(ret)) return ret;

   341

				cost.AddCost(ret);

   342

			}

   343

   344

			if (flags & DC_EXEC) {

   345

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   346

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

   347

			}

   348

			break;

   349

   350

		case MP_ROAD:

   351

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

   352

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

   353

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

   354

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   355

			}

   356

#undef M

   357

   358

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   359

   360

			if (IsNormalRoad(tile)) {

   361

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

   362

   363

				RoadTypes roadtypes = GetRoadTypes(tile);

   364

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   365

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   366

				switch (roadtypes) {

   367

					default: break;

   368

					case ROADTYPES_TRAM:

   369

						/* Tram crossings must always have road. */

   370

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   371

						roadtypes |= ROADTYPES_ROAD;

   372

						break;

   373

   374

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

   375

						/* FALL THROUGH */

   376

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

   377

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

   378

					case ROADTYPES_ALL:      // Also incompatible

   379

						return CMD_ERROR;

   380

				}

   381

   382

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

   383

   384

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

   385

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

   386

					if (flags & DC_EXEC) {

   387

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

   388

						UpdateLevelCrossing(tile, false);

   389

					}

   390

					break;

   391

				}

   392

			}

   393

   394

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

   395

				return_cmd_error(STR_1007_ALREADY_BUILT);

   396

			}

   397

			/* FALLTHROUGH */

   398

   399

		default:

   400

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

   401

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

   402

   403

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

   404

			if (CmdFailed(ret)) return ret;

   405

			cost.AddCost(ret);

   406

   407

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

   408

			if (CmdFailed(ret)) return ret;

   409

			cost.AddCost(ret);

   410

   411

			if (water_ground) {

   412

				cost.AddCost(-_price.clear_water);

   413

				cost.AddCost(_price.clear_roughland);

   414

			}

   415

   416

			if (flags & DC_EXEC) {

   417

				MakeRailNormal(tile, _current_player, trackbit, railtype);

   418

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   419

			}

   420

			break;

   421

	}

   422

   423

	if (flags & DC_EXEC) {

   424

		MarkTileDirtyByTile(tile);

   425

		AddTrackToSignalBuffer(tile, track, _current_player);

   426

		YapfNotifyTrackLayoutChange(tile, track);

   427

	}

   428

   429

	return cost.AddCost(RailBuildCost(railtype));

   430

}

   431

   432

/** Remove a single piece of track

   433

 * @param tile tile to remove track from

   434

 * @param flags operation to perform

   435

 * @param p1 unused

   436

 * @param p2 rail orientation

   437

 */

   438

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

   439

{

   440

	Track track = (Track)p2;

   441

	TrackBits trackbit;

   442

	CommandCost cost(EXPENSES_CONSTRUCTION, _price.remove_rail );

   443

	bool crossing = false;

   444

   445

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

   446

	trackbit = TrackToTrackBits(track);

   447

   448

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

   449

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

   450

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

   451

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

   452

	Owner owner = INVALID_OWNER;

   453

   454

	switch (GetTileType(tile)) {

   455

		case MP_ROAD: {

   456

			if (!IsLevelCrossing(tile) ||

   457

					GetCrossingRailBits(tile) != trackbit ||

   458

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

   459

					(!(flags & DC_BANKRUPT) && !EnsureNoVehicleOnGround(tile))) {

   460

				return CMD_ERROR;

   461

			}

   462

   463

			if (flags & DC_EXEC) {

   464

				owner = GetTileOwner(tile);

   465

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

   466

			}

   467

			break;

   468

		}

   469

   470

		case MP_RAILWAY: {

   471

			TrackBits present;

   472

   473

			if (!IsPlainRailTile(tile) ||

   474

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

   475

					!EnsureNoTrainOnTrack(tile, track)) {

   476

				return CMD_ERROR;

   477

			}

   478

   479

			present = GetTrackBits(tile);

   480

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

   481

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

   482

   483

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