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

static const TrackBits _valid_tileh_slopes[][15] = {

   154

   155

/* set of normal ones */

   156

{

   157

	TRACK_BIT_ALL,

   158

	TRACK_BIT_RIGHT,

   159

	TRACK_BIT_UPPER,

   160

	TRACK_BIT_X,

   161

   162

	TRACK_BIT_LEFT,

   163

	TRACK_BIT_NONE,

   164

	TRACK_BIT_Y,

   165

	TRACK_BIT_LOWER,

   166

   167

	TRACK_BIT_LOWER,

   168

	TRACK_BIT_Y,

   169

	TRACK_BIT_NONE,

   170

	TRACK_BIT_LEFT,

   171

   172

	TRACK_BIT_X,

   173

	TRACK_BIT_UPPER,

   174

	TRACK_BIT_RIGHT,

   175

},

   176

   177

/* allowed rail for an evenly raised platform */

   178

{

   179

	TRACK_BIT_NONE,

   180

	TRACK_BIT_LEFT,

   181

	TRACK_BIT_LOWER,

   182

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   183

   184

	TRACK_BIT_RIGHT,

   185

	TRACK_BIT_ALL,

   186

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   187

	TRACK_BIT_ALL,

   188

   189

	TRACK_BIT_UPPER,

   190

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   191

	TRACK_BIT_ALL,

   192

	TRACK_BIT_ALL,

   193

   194

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   195

	TRACK_BIT_ALL,

   196

	TRACK_BIT_ALL

   197

}

   198

};

   199

   200

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   201

{

   202

	if (!IsSteepSlope(tileh)) {

   203

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

   204

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

   205

	}

   206

   207

	switch (bits) {

   208

		default: NOT_REACHED();

   209

		case TRACK_BIT_X:     return FOUNDATION_INCLINED_X;

   210

		case TRACK_BIT_Y:     return FOUNDATION_INCLINED_Y;

   211

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

   212

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

   213

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

   214

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

   215

	}

   216

}

   217

   218

   219

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

   220

{

   221

	if (IsSteepSlope(tileh)) {

   222

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

   223

			/* There may only be one track on steep slopes. (Autoslope calls with multiple bits in rail_bits) */

   224

			if (KILL_FIRST_BIT(rail_bits & TRACK_BIT_MASK) == 0) {

   225

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

   226

				if (valid & rail_bits) return _price.terraform;

   227

			}

   228

		}

   229

	} else {

   230

		rail_bits |= existing;

   231

   232

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

   233

		if (IsTileType(tile, MP_WATER) &&

   234

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

   235

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   236

		}

   237

   238

		/* no special foundation */

   239

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

   240

			return CommandCost();

   241

		} else if (!_patches.build_on_slopes) {

   242

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   243

		}

   244

   245

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

   246

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

   247

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

   248

				)) { // partly up

   249

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

   250

		}

   251

	}

   252

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   253

}

   254

   255

/* Validate functions for rail building */

   256

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

   257

   258

/** Build a single piece of rail

   259

 * @param tile tile  to build on

   260

 * @param flags operation to perform

   261

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

   262

 * @param p2 rail track to build

   263

 */

   264

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

   265

{

   266

	Slope tileh;

   267

	RailType railtype;

   268

	Track track;

   269

	TrackBits trackbit;

   270

	CommandCost cost;

   271

	CommandCost ret;

   272

   273

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

   274

	railtype = (RailType)p1;

   275

	track = (Track)p2;

   276

   277

	tileh = GetTileSlope(tile, NULL);

   278

	trackbit = TrackToTrackBits(track);

   279

   280

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   281

   282

	switch (GetTileType(tile)) {

   283

		case MP_RAILWAY:

   284

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

   285

					!EnsureNoTrainOnTrack(tile, track)) {

   286

				return CMD_ERROR;

   287

			}

   288

			if (!IsTileOwner(tile, _current_player) ||

   289

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

   290

				/* Get detailed error message */

   291

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

   292

			}

   293

   294

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

   295

			if (CmdFailed(ret)) return ret;

   296

			cost.AddCost(ret);

   297

   298

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

   299

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

   300

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

   301

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

   302

				if (CmdFailed(ret)) return ret;

   303

				cost.AddCost(ret);

   304

			}

   305

   306

			if (flags & DC_EXEC) {

   307

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   308

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

   309

			}

   310

			break;

   311

   312

		case MP_ROAD:

   313

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

   314

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

   315

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

   316

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   317

			}

   318

#undef M

   319

   320

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   321

   322

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   323

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

   324

   325

				RoadTypes roadtypes = GetRoadTypes(tile);

   326

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   327

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   328

				switch (roadtypes) {

   329

					default: break;

   330

					case ROADTYPES_TRAM:

   331

						/* Tram crossings must always have road. */

   332

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   333

						roadtypes |= ROADTYPES_ROAD;

   334

						break;

   335

   336

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

   337

						/* FALL THROUGH */

   338

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

   339

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

   340

					case ROADTYPES_ALL:      // Also incompatible

   341

						return CMD_ERROR;

   342

				}

   343

   344

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

   345

   346

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

   347

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

   348

					if (flags & DC_EXEC) {

   349

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

   350

					}

   351

					break;

   352

				}

   353

			}

   354

   355

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

   356

				return_cmd_error(STR_1007_ALREADY_BUILT);

   357

			}

   358

			/* FALLTHROUGH */

   359

   360

		default:

   361

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

   362

			if (CmdFailed(ret)) return ret;

   363

			cost.AddCost(ret);

   364

   365

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

   366

			if (CmdFailed(ret)) return ret;

   367

			cost.AddCost(ret);

   368

   369

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

   370

			break;

   371

	}

   372

   373

	if (flags & DC_EXEC) {

   374

		MarkTileDirtyByTile(tile);

   375

		SetSignalsOnBothDir(tile, track);

   376

		YapfNotifyTrackLayoutChange(tile, track);

   377

	}

   378

   379

	return cost.AddCost(_price.build_rail);

   380

}

   381

   382

/** Remove a single piece of track

   383

 * @param tile tile to remove track from

   384

 * @param flags operation to perform

   385

 * @param p1 unused

   386

 * @param p2 rail orientation

   387

 */

   388

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

   389

{

   390

	Track track = (Track)p2;

   391

	TrackBits trackbit;

   392

	CommandCost cost(_price.remove_rail);

   393

	bool crossing = false;

   394

   395

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

   396

	trackbit = TrackToTrackBits(track);

   397

   398

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   399

   400

	switch (GetTileType(tile)) {

   401

		case MP_ROAD: {

   402

			if (!IsLevelCrossing(tile) ||

   403

					GetCrossingRailBits(tile) != trackbit ||

   404

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

   405

					!EnsureNoVehicleOnGround(tile)) {

   406

				return CMD_ERROR;

   407

			}

   408

   409

			if (flags & DC_EXEC) {

   410

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

   411

			}

   412

			break;

   413

		}

   414

   415

		case MP_RAILWAY: {

   416

			TrackBits present;

   417

   418

			if (!IsPlainRailTile(tile) ||

   419

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

   420

					!EnsureNoTrainOnTrack(tile, track)) {

   421

				return CMD_ERROR;

   422

			}

   423

   424

			present = GetTrackBits(tile);

   425

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

   426

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

   427

   428

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

   429

			if (HasSignalOnTrack(tile, track))

   430

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

   431

   432

			if (flags & DC_EXEC) {

   433

				present ^= trackbit;

   434

				if (present == 0) {

   435

					DoClearSquare(tile);

   436

				} else {

   437

					SetTrackBits(tile, present);

   438

				}

   439

			}

   440

			break;

   441

		}

   442

   443

		default: return CMD_ERROR;

   444

	}

   445

   446

	if (flags & DC_EXEC) {

   447

		MarkTileDirtyByTile(tile);

   448

		if (crossing) {

   449

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

   450

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

   451

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

   452

			 * 'connect' with the other piece. */

   453

			SetSignalsOnBothDir(tile, TRACK_X);

   454

			SetSignalsOnBothDir(tile, TRACK_Y);

   455

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   456

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   457

		} else {

   458

			SetSignalsOnBothDir(tile, track);

   459

			YapfNotifyTrackLayoutChange(tile, track);

   460

		}

   461

	}

   462

   463

	return cost;

   464

}

   465

   466

   467

static const TileIndexDiffC _trackdelta[] = {

   468

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

   469

	{  0,  0 },

   470

	{  0,  0 },

   471

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

   472

	{  0,  0 },

   473

	{  0,  0 }

   474

};

   475

   476

   477

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

   478

{

   479

	int x = TileX(start);

   480

	int y = TileY(start);

   481

	int ex = TileX(end);

   482

	int ey = TileY(end);

   483

	int dx, dy, trdx, trdy;

   484

   485