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

    22

#include "town.h"

    23

#include "sprite.h"

    24

#include "depot_base.h"

    25

#include "depot_func.h"

    26

#include "waypoint.h"

    27

#include "rail.h"

    28

#include "newgrf.h"

    29

#include "yapf/yapf.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_station.h"

    33

#include "train.h"

    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

#include "station_map.h"

    45

#include "water_map.h"

    46

#include "functions.h"

    47

#include "oldpool_func.h"

    48

    49

#include "table/sprites.h"

    50

#include "table/strings.h"

    51

#include "table/railtypes.h"

    52

#include "table/track_land.h"

    53

    54

const byte _track_sloped_sprites[14] = {

    55

	14, 15, 22, 13,

    56

	 0, 21, 17, 12,

    57

	23,  0, 18, 20,

    58

	19, 16

    59

};

    60

    61

    62

/*         4

    63

 *     ---------

    64

 *    |\       /|

    65

 *    | \    1/ |

    66

 *    |  \   /  |

    67

 *    |   \ /   |

    68

 *  16|    \    |32

    69

 *    |   / \2  |

    70

 *    |  /   \  |

    71

 *    | /     \ |

    72

 *    |/       \|

    73

 *     ---------

    74

 *         8

    75

 */

    76

    77

    78

    79

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

    80

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

    81

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

    82

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

    83

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

    84

 *               similar for lower and right.

    85

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

    86

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

    87

 * MAP5:         00abcdef => rail

    88

 *               01abcdef => rail w/ signals

    89

 *               10uuuuuu => unused

    90

 *               11uuuudd => rail depot

    91

 */

    92

    93

    94

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

    95

{

    96

	TrackBits rail_bits = *(TrackBits *)data;

    97

    98

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

    99

   100

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

   101

   102

	_error_message = VehicleInTheWayErrMsg(v);

   103

	return v;

   104

}

   105

   106

/**

   107

 * Tests if a vehicle interacts with the specified track.

   108

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   109

 *

   110

 * @param tile The tile.

   111

 * @param track The track.

   112

 */

   113

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   114

{

   115

	TrackBits rail_bits = TrackToTrackBits(track);

   116

   117

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

   118

}

   119

   120

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

   121

{

   122

	TrackBits current; // The current track layout

   123

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

   124

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   125

   126

	if (!IsPlainRailTile(tile)) return false;

   127

   128

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

   129

	 * what tracks first */

   130

	current = GetTrackBits(tile);

   131

	future = current | to_build;

   132

   133

	/* Are we really building something new? */

   134

	if (current == future) {

   135

		/* Nothing new is being built */

   136

		_error_message = STR_1007_ALREADY_BUILT;

   137

		return false;

   138

	}

   139

   140

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

   141

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

   142

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

   143

		 * signals on the tile), check that */

   144

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

   145

	} else {

   146

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

   147

		return true;

   148

	}

   149

}

   150

   151

   152

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

   153

static const TrackBits _valid_tracks_without_foundation[15] = {

   154

	TRACK_BIT_ALL,

   155

	TRACK_BIT_RIGHT,

   156

	TRACK_BIT_UPPER,

   157

	TRACK_BIT_X,

   158

   159

	TRACK_BIT_LEFT,

   160

	TRACK_BIT_NONE,

   161

	TRACK_BIT_Y,

   162

	TRACK_BIT_LOWER,

   163

   164

	TRACK_BIT_LOWER,

   165

	TRACK_BIT_Y,

   166

	TRACK_BIT_NONE,

   167

	TRACK_BIT_LEFT,

   168

   169

	TRACK_BIT_X,

   170

	TRACK_BIT_UPPER,

   171

	TRACK_BIT_RIGHT,

   172

};

   173

   174

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

   175

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   176

	TRACK_BIT_NONE,

   177

	TRACK_BIT_LEFT,

   178

	TRACK_BIT_LOWER,

   179

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   180

   181

	TRACK_BIT_RIGHT,

   182

	TRACK_BIT_ALL,

   183

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   184

	TRACK_BIT_ALL,

   185

   186

	TRACK_BIT_UPPER,

   187

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   188

	TRACK_BIT_ALL,

   189

	TRACK_BIT_ALL,

   190

   191

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   192

	TRACK_BIT_ALL,

   193

	TRACK_BIT_ALL

   194

};

   195

   196

/**

   197

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

   198

 *

   199

 * @param tileh Tile slope.

   200

 * @param bits  Trackbits.

   201

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

   202

 */

   203

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   204

{

   205

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   206

   207

	if (IsSteepSlope(tileh)) {

   208

		/* Test for inclined foundations */

   209

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   210

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   211

   212

		/* Get higher track */

   213

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   214

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   215

   216

		/* Only higher track? */

   217

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

   218

   219

		/* Overlap with higher track? */

   220

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

   221

   222

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

   223

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

   224

	} else {

   225

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

   226

   227

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

   228

   229

		Corner track_corner;

   230

		switch (bits) {

   231

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   232

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   233

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   234

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   235

   236

			case TRACK_BIT_HORZ:

   237

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

   238

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

   239

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   240

   241

			case TRACK_BIT_VERT:

   242

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

   243

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

   244

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   245

   246

			case TRACK_BIT_X:

   247

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_X;

   248

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   249

   250

			case TRACK_BIT_Y:

   251

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_Y;

   252

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   253

   254

			default:

   255

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   256

		}

   257

		/* Single diagonal track */

   258

   259

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

   260

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   261

   262

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

   263

		if (IsSlopeWithThreeCornersRaised(tileh)) return FOUNDATION_LEVELED;

   264

   265

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

   266

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

   267

   268

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

   269

		return SpecialRailFoundation(track_corner);

   270

	}

   271

}

   272

   273

   274

/**

   275

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

   276

 *

   277

 * @param tileh Tile slope.

   278

 * @param rail_bits Tracks to build.

   279

 * @param existing Tracks already built.

   280

 * @param tile Tile (used for water test)

   281

 * @return Error message or cost for foundation building.

   282

 */

   283

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

   284

{

   285

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

   286

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

   287

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

   288

	}

   289

   290

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

   291

   292

	/* check track/slope combination */

   293

	if ((f_new == FOUNDATION_INVALID) ||

   294

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

   295

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   296

   297

	Foundation f_old = GetRailFoundation(tileh, existing);

   298

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

   299

}

   300

   301

/* Validate functions for rail building */

   302

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

   303

   304

/** Build a single piece of rail

   305

 * @param tile tile  to build on

   306

 * @param flags operation to perform

   307

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

   308

 * @param p2 rail track to build

   309

 */

   310

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

   311

{

   312

	Slope tileh;

   313

	RailType railtype = (RailType)p1;

   314

	Track track = (Track)p2;

   315

	TrackBits trackbit;

   316

	CommandCost cost(EXPENSES_CONSTRUCTION);

   317

	CommandCost ret;

   318

   319

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

   320

   321

	tileh = GetTileSlope(tile, NULL);

   322

	trackbit = TrackToTrackBits(track);

   323

   324

	switch (GetTileType(tile)) {

   325

		case MP_RAILWAY:

   326

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

   327

					!EnsureNoTrainOnTrack(tile, track)) {

   328

				return CMD_ERROR;

   329

			}

   330

			if (!IsTileOwner(tile, _current_player) ||

   331

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

   332

				/* Get detailed error message */

   333

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

   334

			}

   335

   336

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

   337

			if (CmdFailed(ret)) return ret;

   338

			cost.AddCost(ret);

   339

   340

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

   341

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

   342

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

   343

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

   344

				if (CmdFailed(ret)) return ret;

   345

				cost.AddCost(ret);

   346

			}

   347

   348

			if (flags & DC_EXEC) {

   349

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   350

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

   351

			}

   352

			break;

   353

   354

		case MP_ROAD:

   355

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

   356

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

   357

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

   358

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   359

			}

   360

#undef M

   361

   362

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   363

   364

			if (IsNormalRoad(tile)) {

   365

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

   366

   367

				if (GetDisallowedRoadDirections(tile) != DRD_NONE) return_cmd_error(STR_ERR_CROSSING_ON_ONEWAY_ROAD);

   368

   369

				RoadTypes roadtypes = GetRoadTypes(tile);

   370

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   371

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   372

				switch (roadtypes) {

   373

					default: break;

   374

					case ROADTYPES_TRAM:

   375

						/* Tram crossings must always have road. */

   376

						if (flags & DC_EXEC) SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   377

						roadtypes |= ROADTYPES_ROAD;

   378

						break;

   379

   380

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

   381

						/* FALL THROUGH */

   382

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

   383

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

   384

					case ROADTYPES_ALL:      // Also incompatible

   385

						return CMD_ERROR;

   386

				}

   387

   388

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

   389

   390

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

   391

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

   392

					if (flags & DC_EXEC) {

   393

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

   394

						UpdateLevelCrossing(tile, false);

   395

					}

   396

					break;

   397

				}

   398

			}

   399

   400

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

   401

				return_cmd_error(STR_1007_ALREADY_BUILT);

   402

			}

   403

			/* FALLTHROUGH */

   404

   405

		default:

   406

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

   407

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

   408

   409

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

   410

			if (CmdFailed(ret)) return ret;

   411

			cost.AddCost(ret);

   412

   413

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

   414

			if (CmdFailed(ret)) return ret;

   415

			cost.AddCost(ret);

   416

   417

			if (water_ground) {

   418

				cost.AddCost(-_price.clear_water);

   419

				cost.AddCost(_price.clear_roughland);

   420

			}

   421

   422

			if (flags & DC_EXEC) {

   423

				MakeRailNormal(tile, _current_player, trackbit, railtype);

   424

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   425

			}

   426

			break;

   427

	}

   428

   429

	if (flags & DC_EXEC) {

   430

		MarkTileDirtyByTile(tile);

   431

		AddTrackToSignalBuffer(tile, track, _current_player);

   432

		YapfNotifyTrackLayoutChange(tile, track);

   433

	}

   434

   435

	return cost.AddCost(RailBuildCost(railtype));

   436

}

   437

   438

/** Remove a single piece of track

   439

 * @param tile tile to remove track from

   440

 * @param flags operation to perform

   441

 * @param p1 unused

   442

 * @param p2 rail orientation

   443

 */

   444

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

   445

{

   446

	Track track = (Track)p2;

   447

	TrackBits trackbit;

   448

	CommandCost cost(EXPENSES_CONSTRUCTION, _price.remove_rail );

   449

	bool crossing = false;

   450

   451

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

   452

	trackbit = TrackToTrackBits(track);

   453

   454

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

   455

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

   456

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

   457

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

   458

	Owner owner = INVALID_OWNER;

   459

   460

	switch (GetTileType(tile)) {

   461

		case MP_ROAD: {

   462

			if (!IsLevelCrossing(tile) ||

   463

					GetCrossingRailBits(tile) != trackbit ||

   464

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

   465

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

   466

				return CMD_ERROR;

   467

			}

   468

   469

			if (flags & DC_EXEC) {

   470

				owner = GetTileOwner(tile);

   471

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

   472

			}

   473

			break;

   474

		}

   475

   476

		case MP_RAILWAY: {

   477

			TrackBits present;

   478

   479

			if (!IsPlainRailTile(tile) ||

   480

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

   481

					!EnsureNoTrainOnTrack(tile, track)) {

   482

				return CMD_ERROR;

   483

			}