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

    38

#include "newgrf_station.h"

    39

#include "train.h"

    40

#include "misc/autoptr.hpp"

    41

    42

const byte _track_sloped_sprites[14] = {

    43

	14, 15, 22, 13,

    44

	 0, 21, 17, 12,

    45

	23,  0, 18, 20,

    46

	19, 16

    47

};

    48

    49

    50

/*         4

    51

 *     ---------

    52

 *    |\       /|

    53

 *    | \    1/ |

    54

 *    |  \   /  |

    55

 *    |   \ /   |

    56

 *  16|    \    |32

    57

 *    |   / \2  |

    58

 *    |  /   \  |

    59

 *    | /     \ |

    60

 *    |/       \|

    61

 *     ---------

    62

 *         8

    63

 */

    64

    65

    66

    67

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

    68

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

    69

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

    70

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

    71

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

    72

 *               similar for lower and right.

    73

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

    74

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

    75

 * MAP5:         00abcdef => rail

    76

 *               01abcdef => rail w/ signals

    77

 *               10uuuuuu => unused

    78

 *               11uuuudd => rail depot

    79

 */

    80

    81

/** Struct used in EnsureNoTrainOnTrack() */

    82

struct TrainOnTrackData {

    83

	TileIndex tile;       ///< tile to check

    84

	uint z;               ///< tile max Z

    85

	TrackBits rail_bits;  ///< trackbits of interest

    86

};

    87

    88

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

    89

{

    90

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

    91

    92

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

    93

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

    94

    95

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

    96

    97

	_error_message = VehicleInTheWayErrMsg(v);

    98

	return v;

    99

}

   100

   101

/**

   102

 * Tests if a vehicle interacts with the specified track.

   103

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   104

 *

   105

 * @param tile The tile.

   106

 * @param track The track.

   107

 */

   108

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   109

{

   110

	TrainOnTrackData info;

   111

   112

	info.tile = tile;

   113

	info.z = GetTileMaxZ(tile);

   114

	info.rail_bits = TrackToTrackBits(track);

   115

   116

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

   117

}

   118

   119

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

   120

{

   121

	TrackBits current; // The current track layout

   122

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

   123

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   124

   125

	if (!IsPlainRailTile(tile)) return false;

   126

   127

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

   128

	 * what tracks first */

   129

	current = GetTrackBits(tile);

   130

	future = current | to_build;

   131

   132

	/* Are we really building something new? */

   133

	if (current == future) {

   134

		/* Nothing new is being built */

   135

		_error_message = STR_1007_ALREADY_BUILT;

   136

		return false;

   137

	}

   138

   139

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

   140

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

   141

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

   142

		 * signals on the tile), check that */

   143

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

   144

	} else {

   145

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

   146

		return true;

   147

	}

   148

}

   149

   150

   151

static const TrackBits _valid_tileh_slopes[][15] = {

   152

   153

/* set of normal ones */

   154

{

   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

/* allowed rail for an evenly raised platform */

   176

{

   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

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   199

{

   200

	if (!IsSteepSlope(tileh)) {

   201

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

   202

		if ((~_valid_tileh_slopes[1][tileh] & bits) == 0) return FOUNDATION_LEVELED;

   203

	}

   204

   205

	switch (bits) {

   206

		default: NOT_REACHED();

   207

		case TRACK_BIT_X:     return FOUNDATION_INCLINED_X;

   208

		case TRACK_BIT_Y:     return FOUNDATION_INCLINED_Y;

   209

		case TRACK_BIT_LEFT:  return (tileh == SLOPE_STEEP_W ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   210

		case TRACK_BIT_LOWER: return (tileh == SLOPE_STEEP_S ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   211

		case TRACK_BIT_RIGHT: return (tileh == SLOPE_STEEP_E ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   212

		case TRACK_BIT_UPPER: return (tileh == SLOPE_STEEP_N ? FOUNDATION_STEEP_HIGHER : FOUNDATION_STEEP_LOWER);

   213

	}

   214

}

   215

   216

   217

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

   218

{

   219

	if (IsSteepSlope(tileh)) {

   220

		if (_patches.build_on_slopes && existing == 0) {

   221

			TrackBits valid = TRACK_BIT_CROSS | (HASBIT(1 << SLOPE_STEEP_W | 1 << SLOPE_STEEP_E, tileh) ? TRACK_BIT_VERT : TRACK_BIT_HORZ);

   222

			if (valid & rail_bits) return _price.terraform;

   223

		}

   224

	} else {

   225

		rail_bits |= existing;

   226

   227

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

   228

		if (IsTileType(tile, MP_WATER) &&

   229

				~_valid_tileh_slopes[1][tileh] & rail_bits) {

   230

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   231

		}

   232

   233

		/* no special foundation */

   234

		if ((~_valid_tileh_slopes[0][tileh] & rail_bits) == 0) {

   235

			return CommandCost();

   236

		} else if (!_patches.build_on_slopes || _is_old_ai_player) {

   237

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   238

		}

   239

   240

		if ((~_valid_tileh_slopes[1][tileh] & rail_bits) == 0 || ( // whole tile is leveled up

   241

					(rail_bits == TRACK_BIT_X || rail_bits == TRACK_BIT_Y) &&

   242

					(tileh == SLOPE_W || tileh == SLOPE_S || tileh == SLOPE_E || tileh == SLOPE_N)

   243

				)) { // partly up

   244

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

   245

		}

   246

	}

   247

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   248

}

   249

   250

/* Validate functions for rail building */

   251

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

   252

   253

/** Build a single piece of rail

   254

 * @param tile tile  to build on

   255

 * @param flags operation to perform

   256

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

   257

 * @param p2 rail track to build

   258

 */

   259

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

   260

{

   261

	Slope tileh;

   262

	RailType railtype;

   263

	Track track;

   264

	TrackBits trackbit;

   265

	CommandCost cost;

   266

	CommandCost ret;

   267

   268

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

   269

	railtype = (RailType)p1;

   270

	track = (Track)p2;

   271

   272

	tileh = GetTileSlope(tile, NULL);

   273

	trackbit = TrackToTrackBits(track);

   274

   275

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   276

   277

	switch (GetTileType(tile)) {

   278

		case MP_RAILWAY:

   279

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

   280

					!EnsureNoTrainOnTrack(tile, track)) {

   281

				return CMD_ERROR;

   282

			}

   283

			if (!IsTileOwner(tile, _current_player) ||

   284

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

   285

				/* Get detailed error message */

   286

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

   287

			}

   288

   289

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

   290

			if (CmdFailed(ret)) return ret;

   291

			cost.AddCost(ret);

   292

   293

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

   294

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

   295

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

   296

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

   297

				if (CmdFailed(ret)) return ret;

   298

				cost.AddCost(ret);

   299

			}

   300

   301

			if (flags & DC_EXEC) {

   302

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   303

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

   304

			}

   305

			break;

   306

   307

		case MP_ROAD:

   308

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

   309

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

   310

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

   311

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   312

			}

   313

#undef M

   314

   315

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   316

   317

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   318

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

   319

   320

				RoadTypes roadtypes = GetRoadTypes(tile);

   321

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   322

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   323

				switch (roadtypes) {

   324

					default: break;

   325

					case ROADTYPES_TRAM:

   326

						/* Tram crossings must always have road. */

   327

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   328

						roadtypes |= ROADTYPES_ROAD;

   329

						break;

   330

   331

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

   332

						/* FALL THROUGH */

   333

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

   334

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

   335

					case ROADTYPES_ALL:      // Also incompatible

   336

						return CMD_ERROR;

   337

				}

   338

   339

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

   340

   341

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

   342

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

   343

					if (flags & DC_EXEC) {

   344

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

   345

					}

   346

					break;

   347

				}

   348

			}

   349

   350

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

   351

				return_cmd_error(STR_1007_ALREADY_BUILT);

   352

			}

   353

			/* FALLTHROUGH */

   354

   355

		default:

   356

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

   357

			if (CmdFailed(ret)) return ret;

   358

			cost.AddCost(ret);

   359

   360

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

   361

			if (CmdFailed(ret)) return ret;

   362

			cost.AddCost(ret);

   363

   364

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

   365

			break;

   366

	}

   367

   368

	if (flags & DC_EXEC) {

   369

		MarkTileDirtyByTile(tile);

   370

		SetSignalsOnBothDir(tile, track);

   371

		YapfNotifyTrackLayoutChange(tile, track);

   372

	}

   373

   374

	return cost.AddCost(_price.build_rail);

   375

}

   376

   377

/** Remove a single piece of track

   378

 * @param tile tile to remove track from

   379

 * @param flags operation to perform

   380

 * @param p1 unused

   381

 * @param p2 rail orientation

   382

 */

   383

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

   384

{

   385

	Track track = (Track)p2;

   386

	TrackBits trackbit;

   387

	CommandCost cost(_price.remove_rail);

   388

	bool crossing = false;

   389

   390

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

   391

	trackbit = TrackToTrackBits(track);

   392

   393

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   394

   395

	switch (GetTileType(tile)) {

   396

		case MP_ROAD: {

   397

			if (!IsLevelCrossing(tile) ||

   398

					GetCrossingRailBits(tile) != trackbit ||

   399

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

   400

					!EnsureNoVehicleOnGround(tile)) {

   401

				return CMD_ERROR;

   402

			}

   403

   404

			if (flags & DC_EXEC) {

   405

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

   406

			}

   407

			break;

   408

		}

   409

   410

		case MP_RAILWAY: {

   411

			TrackBits present;

   412

   413

			if (!IsPlainRailTile(tile) ||

   414

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

   415

					!EnsureNoTrainOnTrack(tile, track)) {

   416

				return CMD_ERROR;

   417

			}

   418

   419

			present = GetTrackBits(tile);

   420

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

   421

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

   422

   423

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

   424

			if (HasSignalOnTrack(tile, track))

   425

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

   426

   427

			if (flags & DC_EXEC) {

   428

				present ^= trackbit;

   429

				if (present == 0) {

   430

					DoClearSquare(tile);

   431

				} else {

   432

					SetTrackBits(tile, present);

   433

				}

   434

			}

   435

			break;

   436

		}

   437

   438

		default: return CMD_ERROR;

   439

	}

   440

   441

	if (flags & DC_EXEC) {

   442

		MarkTileDirtyByTile(tile);

   443

		if (crossing) {

   444

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

   445

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

   446

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

   447

			 * 'connect' with the other piece. */

   448

			SetSignalsOnBothDir(tile, TRACK_X);

   449

			SetSignalsOnBothDir(tile, TRACK_Y);

   450

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   451

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   452

		} else {

   453

			SetSignalsOnBothDir(tile, track);

   454

			YapfNotifyTrackLayoutChange(tile, track);

   455

		}

   456

	}

   457

   458

	return cost;

   459

}

   460

   461

   462

static const TileIndexDiffC _trackdelta[] = {

   463

	{ -1,  0 }, {  0,  1 }, { -1,  0 }, {  0,  1 }, {  1,  0 }, {  0,  1 },

   464

	{  0,  0 },

   465

	{  0,  0 },

   466

	{  1,  0 }, {  0, -1 }, {  0, -1 }, {  1,  0 }, {  0, -1 }, { -1,  0 },

   467

	{  0,  0 },

   468

	{  0,  0 }

   469

};

   470

   471

   472

static CommandCost ValidateAutoDrag(Trackdir *trackdir, TileIndex start, TileIndex end)

   473

{

   474

	int x = TileX(start);

   475

	int y = TileY(start);

   476

	int ex = TileX(end);

   477

	int ey = TileY(end);

   478

	int dx, dy, trdx, trdy;

   479

   480

	if (!ValParamTrackOrientation(TrackdirToTrack(*trackdir))) return CMD_ERROR;

   481

   482

	/* calculate delta x,y from start to end tile */

   483

	dx = ex - x;

   484

	dy = ey - y;

   485