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 "table/sprites.h"

    15

#include "table/strings.h"

    16

#include "landscape.h"

    17

#include "town_map.h"

    18

#include "tunnel_map.h"

    19

#include "viewport.h"

    20

#include "command_func.h"

    21

#include "pathfind.h"

    22

#include "engine.h"

    23

#include "town.h"

    24

#include "sound.h"

    25

#include "station.h"

    26

#include "sprite.h"

    27

#include "depot.h"

    28

#include "waypoint.h"

    29

#include "rail.h"

    30

#include "railtypes.h" // include table for railtypes

    31

#include "newgrf.h"

    32

#include "yapf/yapf.h"

    33

#include "newgrf_engine.h"

    34

#include "newgrf_callbacks.h"

    35

#include "newgrf_station.h"

    36

#include "train.h"

    37

#include "misc/autoptr.hpp"

    38

#include "autoslope.h"

    39

#include "transparency.h"

    40

#include "water.h"

    41

#include "tunnelbridge_map.h"

    42

#include "window_func.h"

    43

#include "vehicle_func.h"

    44

    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

    86

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

    87

{

    88

	TrackBits rail_bits = *(TrackBits *)data;

    89

    90

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

    91

    92

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

    93

    94

	_error_message = VehicleInTheWayErrMsg(v);

    95

	return v;

    96

}

    97

    98

/**

    99

 * Tests if a vehicle interacts with the specified track.

   100

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   101

 *

   102

 * @param tile The tile.

   103

 * @param track The track.

   104

 */

   105

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   106

{

   107

	TrackBits rail_bits = TrackToTrackBits(track);

   108

   109

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

   110

}

   111

   112

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

   113

{

   114

	TrackBits current; // The current track layout

   115

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

   116

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   117

   118

	if (!IsPlainRailTile(tile)) return false;

   119

   120

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

   121

	 * what tracks first */

   122

	current = GetTrackBits(tile);

   123

	future = current | to_build;

   124

   125

	/* Are we really building something new? */

   126

	if (current == future) {

   127

		/* Nothing new is being built */

   128

		_error_message = STR_1007_ALREADY_BUILT;

   129

		return false;

   130

	}

   131

   132

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

   133

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

   134

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

   135

		 * signals on the tile), check that */

   136

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

   137

	} else {

   138

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

   139

		return true;

   140

	}

   141

}

   142

   143

   144

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

   145

static const TrackBits _valid_tracks_without_foundation[15] = {

   146

	TRACK_BIT_ALL,

   147

	TRACK_BIT_RIGHT,

   148

	TRACK_BIT_UPPER,

   149

	TRACK_BIT_X,

   150

   151

	TRACK_BIT_LEFT,

   152

	TRACK_BIT_NONE,

   153

	TRACK_BIT_Y,

   154

	TRACK_BIT_LOWER,

   155

   156

	TRACK_BIT_LOWER,

   157

	TRACK_BIT_Y,

   158

	TRACK_BIT_NONE,

   159

	TRACK_BIT_LEFT,

   160

   161

	TRACK_BIT_X,

   162

	TRACK_BIT_UPPER,

   163

	TRACK_BIT_RIGHT,

   164

};

   165

   166

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

   167

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   168

	TRACK_BIT_NONE,

   169

	TRACK_BIT_LEFT,

   170

	TRACK_BIT_LOWER,

   171

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   172

   173

	TRACK_BIT_RIGHT,

   174

	TRACK_BIT_ALL,

   175

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   176

	TRACK_BIT_ALL,

   177

   178

	TRACK_BIT_UPPER,

   179

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   180

	TRACK_BIT_ALL,

   181

	TRACK_BIT_ALL,

   182

   183

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   184

	TRACK_BIT_ALL,

   185

	TRACK_BIT_ALL

   186

};

   187

   188

/**

   189

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

   190

 *

   191

 * @param tileh Tile slope.

   192

 * @param bits  Trackbits.

   193

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

   194

 */

   195

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   196

{

   197

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   198

   199

	if (IsSteepSlope(tileh)) {

   200

		/* Test for inclined foundations */

   201

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   202

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   203

   204

		/* Get higher track */

   205

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   206

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   207

   208

		/* Only higher track? */

   209

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

   210

   211

		/* Overlap with higher track? */

   212

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

   213

   214

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

   215

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

   216

	} else {

   217

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

   218

   219

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

   220

   221

		Corner track_corner;

   222

		switch (bits) {

   223

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   224

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   225

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   226

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   227

   228

			case TRACK_BIT_HORZ:

   229

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

   230

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

   231

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   232

   233

			case TRACK_BIT_VERT:

   234

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

   235

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

   236

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   237

   238

			case TRACK_BIT_X:

   239

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_X;

   240

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   241

   242

			case TRACK_BIT_Y:

   243

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_Y;

   244

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   245

   246

			default:

   247

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   248

		}

   249

		/* Single diagonal track */

   250

   251

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

   252

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   253

   254

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

   255

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

   256

   257

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

   258

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

   259

   260

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

   261

		return SpecialRailFoundation(track_corner);

   262

	}

   263

}

   264

   265

   266

/**

   267

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

   268

 *

   269

 * @param tileh Tile slope.

   270

 * @param rail_bits Tracks to build.

   271

 * @param existing Tracks already built.

   272

 * @param tile Tile (used for water test)

   273

 * @return Error message or cost for foundation building.

   274

 */

   275

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

   276

{

   277

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

   278

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

   279

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

   280

	}

   281

   282

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

   283

   284

	/* check track/slope combination */

   285

	if ((f_new == FOUNDATION_INVALID) ||

   286

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

   287

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   288

   289

	Foundation f_old = GetRailFoundation(tileh, existing);

   290

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

   291

}

   292

   293

/* Validate functions for rail building */

   294

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

   295

   296

/** Build a single piece of rail

   297

 * @param tile tile  to build on

   298

 * @param flags operation to perform

   299

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

   300

 * @param p2 rail track to build

   301

 */

   302

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

   303

{

   304

	Slope tileh;

   305

	RailType railtype;

   306

	Track track;

   307

	TrackBits trackbit;

   308

	CommandCost cost;

   309

	CommandCost ret;

   310

   311

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

   312

	railtype = (RailType)p1;

   313

	track = (Track)p2;

   314

   315

	tileh = GetTileSlope(tile, NULL);

   316

	trackbit = TrackToTrackBits(track);

   317

   318

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   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 (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   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

					}

   389

					break;

   390

				}

   391

			}

   392

   393

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

   394

				return_cmd_error(STR_1007_ALREADY_BUILT);

   395

			}

   396

			/* FALLTHROUGH */

   397

   398

		default:

   399

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

   400

   401

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

   402

			if (CmdFailed(ret)) return ret;

   403

			cost.AddCost(ret);

   404

   405

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

   406

			if (CmdFailed(ret)) return ret;

   407

			cost.AddCost(ret);

   408

   409

			if (water_ground) {

   410

				cost.AddCost(-_price.clear_water);

   411

				cost.AddCost(_price.clear_roughland);

   412

			}

   413

   414

			if (flags & DC_EXEC) {

   415

				MakeRailNormal(tile, _current_player, trackbit, railtype);

   416

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   417

			}

   418

			break;

   419

	}

   420

   421

	if (flags & DC_EXEC) {

   422

		MarkTileDirtyByTile(tile);

   423

		SetSignalsOnBothDir(tile, track);

   424

		YapfNotifyTrackLayoutChange(tile, track);

   425

	}

   426

   427

	return cost.AddCost(RailBuildCost(railtype));

   428

}

   429

   430

/** Remove a single piece of track

   431

 * @param tile tile to remove track from

   432

 * @param flags operation to perform

   433

 * @param p1 unused

   434

 * @param p2 rail orientation

   435

 */

   436

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

   437

{

   438

	Track track = (Track)p2;

   439

	TrackBits trackbit;

   440

	CommandCost cost(_price.remove_rail);

   441

	bool crossing = false;

   442

   443

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

   444

	trackbit = TrackToTrackBits(track);

   445

   446

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   447

   448

	switch (GetTileType(tile)) {

   449

		case MP_ROAD: {

   450

			if (!IsLevelCrossing(tile) ||

   451

					GetCrossingRailBits(tile) != trackbit ||

   452

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

   453

					!EnsureNoVehicleOnGround(tile)) {

   454

				return CMD_ERROR;

   455

			}

   456

   457

			if (flags & DC_EXEC) {

   458

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

   459

			}

   460

			break;

   461

		}

   462

   463

		case MP_RAILWAY: {

   464

			TrackBits present;

   465

   466

			if (!IsPlainRailTile(tile) ||

   467

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

   468

					!EnsureNoTrainOnTrack(tile, track)) {

   469

				return CMD_ERROR;

   470

			}

   471

   472

			present = GetTrackBits(tile);

   473

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

   474

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

   475

   476

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

   477

			if (HasSignalOnTrack(tile, track))

   478

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

   479

   480

			if (flags & DC_EXEC) {

   481

				present ^= trackbit;

   482

				if (present == 0) {

   483

					if (GetRailGroundType(tile) == RAIL_GROUND_WATER) {

   484

						MakeShore(tile);