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

    44

const byte _track_sloped_sprites[14] = {

    45

	14, 15, 22, 13,

    46

	 0, 21, 17, 12,

    47

	23,  0, 18, 20,

    48

	19, 16

    49

};

    50

    51

    52

/*         4

    53

 *     ---------

    54

 *    |\       /|

    55

 *    | \    1/ |

    56

 *    |  \   /  |

    57

 *    |   \ /   |

    58

 *  16|    \    |32

    59

 *    |   / \2  |

    60

 *    |  /   \  |

    61

 *    | /     \ |

    62

 *    |/       \|

    63

 *     ---------

    64

 *         8

    65

 */

    66

    67

    68

    69

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

    70

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

    71

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

    72

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

    73

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

    74

 *               similar for lower and right.

    75

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

    76

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

    77

 * MAP5:         00abcdef => rail

    78

 *               01abcdef => rail w/ signals

    79

 *               10uuuuuu => unused

    80

 *               11uuuudd => rail depot

    81

 */

    82

    83

/** Struct used in EnsureNoTrainOnTrack() */

    84

struct TrainOnTrackData {

    85

	TileIndex tile;       ///< tile to check

    86

	uint z;               ///< tile max Z

    87

	TrackBits rail_bits;  ///< trackbits of interest

    88

};

    89

    90

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

    91

{

    92

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

    93

    94

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

    95

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

    96

    97

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

    98

    99

	_error_message = VehicleInTheWayErrMsg(v);

   100

	return v;

   101

}

   102

   103

/**

   104

 * Tests if a vehicle interacts with the specified track.

   105

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   106

 *

   107

 * @param tile The tile.

   108

 * @param track The track.

   109

 */

   110

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   111

{

   112

	TrainOnTrackData info;

   113

   114

	info.tile = tile;

   115

	info.z = GetTileMaxZ(tile);

   116

	info.rail_bits = TrackToTrackBits(track);

   117

   118

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

   119

}

   120

   121

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

   122

{

   123

	TrackBits current; // The current track layout

   124

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

   125

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   126

   127

	if (!IsPlainRailTile(tile)) return false;

   128

   129

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

   130

	 * what tracks first */

   131

	current = GetTrackBits(tile);

   132

	future = current | to_build;

   133

   134

	/* Are we really building something new? */

   135

	if (current == future) {

   136

		/* Nothing new is being built */

   137

		_error_message = STR_1007_ALREADY_BUILT;

   138

		return false;

   139

	}

   140

   141

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

   142

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

   143

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

   144

		 * signals on the tile), check that */

   145

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

   146

	} else {

   147

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

   148

		return true;

   149

	}

   150

}

   151

   152

   153

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

   154

static const TrackBits _valid_tracks_without_foundation[15] = {

   155

	TRACK_BIT_ALL,

   156

	TRACK_BIT_RIGHT,

   157

	TRACK_BIT_UPPER,

   158

	TRACK_BIT_X,

   159

   160

	TRACK_BIT_LEFT,

   161

	TRACK_BIT_NONE,

   162

	TRACK_BIT_Y,

   163

	TRACK_BIT_LOWER,

   164

   165

	TRACK_BIT_LOWER,

   166

	TRACK_BIT_Y,

   167

	TRACK_BIT_NONE,

   168

	TRACK_BIT_LEFT,

   169

   170

	TRACK_BIT_X,

   171

	TRACK_BIT_UPPER,

   172

	TRACK_BIT_RIGHT,

   173

};

   174

   175

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

   176

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   177

	TRACK_BIT_NONE,

   178

	TRACK_BIT_LEFT,

   179

	TRACK_BIT_LOWER,

   180

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   181

   182

	TRACK_BIT_RIGHT,

   183

	TRACK_BIT_ALL,

   184

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   185

	TRACK_BIT_ALL,

   186

   187

	TRACK_BIT_UPPER,

   188

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   189

	TRACK_BIT_ALL,

   190

	TRACK_BIT_ALL,

   191

   192

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   193

	TRACK_BIT_ALL,

   194

	TRACK_BIT_ALL

   195

};

   196

   197

/**

   198

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

   199

 *

   200

 * @param tileh Tile slope.

   201

 * @param bits  Trackbits.

   202

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

   203

 */

   204

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   205

{

   206

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   207

   208

	if (IsSteepSlope(tileh)) {

   209

		/* Test for inclined foundations */

   210

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   211

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   212

   213

		/* Get higher track */

   214

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   215

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   216

   217

		/* Only higher track? */

   218

		if (bits == higher_track) return FOUNDATION_STEEP_HIGHER;

   219

   220

		/* Overlap with higher track? */

   221

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

   222

   223

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

   224

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

   225

	} else {

   226

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

   227

   228

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

   229

   230

		switch (bits) {

   231

			case TRACK_BIT_X:

   232

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_X;

   233

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   234

   235

			case TRACK_BIT_Y:

   236

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_Y;

   237

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   238

   239

			default:

   240

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   241

		}

   242

	}

   243

}

   244

   245

   246

/**

   247

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

   248

 *

   249

 * @param tileh Tile slope.

   250

 * @param rail_bits Tracks to build.

   251

 * @param existing Tracks already built.

   252

 * @param tile Tile (used for water test)

   253

 * @return Error message or cost for foundation building.

   254

 */

   255

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

   256

{

   257

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

   258

	if (IsTileType(tile, MP_WATER)) {

   259

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

   260

	}

   261

   262

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

   263

   264

	/* check track/slope combination */

   265

	if ((f_new == FOUNDATION_INVALID) ||

   266

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

   267

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   268

   269

	Foundation f_old = GetRailFoundation(tileh, existing);

   270

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

   271

}

   272

   273

/* Validate functions for rail building */

   274

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

   275

   276

/** Build a single piece of rail

   277

 * @param tile tile  to build on

   278

 * @param flags operation to perform

   279

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

   280

 * @param p2 rail track to build

   281

 */

   282

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

   283

{

   284

	Slope tileh;

   285

	RailType railtype;

   286

	Track track;

   287

	TrackBits trackbit;

   288

	CommandCost cost;

   289

	CommandCost ret;

   290

   291

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

   292

	railtype = (RailType)p1;

   293

	track = (Track)p2;

   294

   295

	tileh = GetTileSlope(tile, NULL);

   296

	trackbit = TrackToTrackBits(track);

   297

   298

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   299

   300

	switch (GetTileType(tile)) {

   301

		case MP_RAILWAY:

   302

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

   303

					!EnsureNoTrainOnTrack(tile, track)) {

   304

				return CMD_ERROR;

   305

			}

   306

			if (!IsTileOwner(tile, _current_player) ||

   307

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

   308

				/* Get detailed error message */

   309

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

   310

			}

   311

   312

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

   313

			if (CmdFailed(ret)) return ret;

   314

			cost.AddCost(ret);

   315

   316

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

   317

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

   318

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

   319

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

   320

				if (CmdFailed(ret)) return ret;

   321

				cost.AddCost(ret);

   322

			}

   323

   324

			if (flags & DC_EXEC) {

   325

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   326

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

   327

			}

   328

			break;

   329

   330

		case MP_ROAD:

   331

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

   332

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

   333

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

   334

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   335

			}

   336

#undef M

   337

   338

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   339

   340

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   341

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

   342

   343

				RoadTypes roadtypes = GetRoadTypes(tile);

   344

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   345

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   346

				switch (roadtypes) {

   347

					default: break;

   348

					case ROADTYPES_TRAM:

   349

						/* Tram crossings must always have road. */

   350

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   351

						roadtypes |= ROADTYPES_ROAD;

   352

						break;

   353

   354

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

   355

						/* FALL THROUGH */

   356

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

   357

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

   358

					case ROADTYPES_ALL:      // Also incompatible

   359

						return CMD_ERROR;

   360

				}

   361

   362

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

   363

   364

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

   365

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

   366

					if (flags & DC_EXEC) {

   367

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

   368

					}

   369

					break;

   370

				}

   371

			}

   372

   373

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

   374

				return_cmd_error(STR_1007_ALREADY_BUILT);

   375

			}

   376

			/* FALLTHROUGH */

   377

   378

		default:

   379

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

   380

			if (CmdFailed(ret)) return ret;

   381

			cost.AddCost(ret);

   382

   383

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

   384

			if (CmdFailed(ret)) return ret;

   385

			cost.AddCost(ret);

   386

   387

			if (flags & DC_EXEC) MakeRailNormal(tile, _current_player, trackbit, railtype);

   388

			break;

   389

	}

   390

   391

	if (flags & DC_EXEC) {

   392

		MarkTileDirtyByTile(tile);

   393

		SetSignalsOnBothDir(tile, track);

   394

		YapfNotifyTrackLayoutChange(tile, track);

   395

	}

   396

   398

}

   399

   400

/** Remove a single piece of track

   401

 * @param tile tile to remove track from

   402

 * @param flags operation to perform

   403

 * @param p1 unused

   404

 * @param p2 rail orientation

   405

 */

   406

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

   407

{

   408

	Track track = (Track)p2;

   409

	TrackBits trackbit;

   410

	CommandCost cost(_price.remove_rail);

   411

	bool crossing = false;

   412

   413

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

   414

	trackbit = TrackToTrackBits(track);

   415

   416

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   417

   418

	switch (GetTileType(tile)) {

   419

		case MP_ROAD: {

   420

			if (!IsLevelCrossing(tile) ||

   421

					GetCrossingRailBits(tile) != trackbit ||

   422

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

   423

					!EnsureNoVehicleOnGround(tile)) {

   424

				return CMD_ERROR;

   425

			}

   426

   427

			if (flags & DC_EXEC) {

   428

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

   429

			}

   430

			break;

   431

		}

   432

   433

		case MP_RAILWAY: {

   434

			TrackBits present;

   435

   436

			if (!IsPlainRailTile(tile) ||

   437

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

   438

					!EnsureNoTrainOnTrack(tile, track)) {

   439

				return CMD_ERROR;

   440

			}

   441

   442

			present = GetTrackBits(tile);

   443

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

   444

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

   445

   446

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

   447

			if (HasSignalOnTrack(tile, track))

   448

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

   449

   450

			if (flags & DC_EXEC) {

   451

				present ^= trackbit;

   452

				if (present == 0) {

   453

					DoClearSquare(tile);

   454

				} else {

   455

					SetTrackBits(tile, present);

   456

				}

   457

			}

   458

			break;

   459

		}

   460

   461

		default: return CMD_ERROR;

   462

	}

   463

   464

	if (flags & DC_EXEC) {

   465

		MarkTileDirtyByTile(tile);

   466

		if (crossing) {

   467

			/* crossing is set when only TRACK_BIT_X and TRACK_BIT_Y are set. As we

   468

			 * are removing one of these pieces, we'll need to update signals for

   469

			 * both directions explicitly, as after the track is removed it won't

   470

			 * 'connect' with the other piece. */

   471

			SetSignalsOnBothDir(tile, TRACK_X);

   472

			SetSignalsOnBothDir(tile, TRACK_Y);

   473

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   474

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   475

		} else {

   476

			SetSignalsOnBothDir(tile, track);

   477

			YapfNotifyTrackLayoutChange(tile, track);

   478

		}

   479

	}

   480

   481

	return cost;

   482

}

   483

   484

   485

static const TileIndexDiffC _trackdelta[] = {