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

    43

const byte _track_sloped_sprites[14] = {

    44

	14, 15, 22, 13,

    45

	 0, 21, 17, 12,

    46

	23,  0, 18, 20,

    47

	19, 16

    48

};

    49

    50

    51

/*         4

    52

 *     ---------

    53

 *    |\       /|

    54

 *    | \    1/ |

    55

 *    |  \   /  |

    56

 *    |   \ /   |

    57

 *  16|    \    |32

    58

 *    |   / \2  |

    59

 *    |  /   \  |

    60

 *    | /     \ |

    61

 *    |/       \|

    62

 *     ---------

    63

 *         8

    64

 */

    65

    66

    67

    68

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

    69

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

    70

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

    71

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

    72

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

    73

 *               similar for lower and right.

    74

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

    75

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

    76

 * MAP5:         00abcdef => rail

    77

 *               01abcdef => rail w/ signals

    78

 *               10uuuuuu => unused

    79

 *               11uuuudd => rail depot

    80

 */

    81

    82

/** Struct used in EnsureNoTrainOnTrack() */

    83

struct TrainOnTrackData {

    84

	TileIndex tile;       ///< tile to check

    85

	uint z;               ///< tile max Z

    86

	TrackBits rail_bits;  ///< trackbits of interest

    87

};

    88

    89

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

    90

{

    91

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

    92

    93

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

    94

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

    95

    96

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

    97

    98

	_error_message = VehicleInTheWayErrMsg(v);

    99

	return v;

   100

}

   101

   102

/**

   103

 * Tests if a vehicle interacts with the specified track.

   104

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   105

 *

   106

 * @param tile The tile.

   107

 * @param track The track.

   108

 */

   109

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   110

{

   111

	TrainOnTrackData info;

   112

   113

	info.tile = tile;

   114

	info.z = GetTileMaxZ(tile);

   115

	info.rail_bits = TrackToTrackBits(track);

   116

   117

	return VehicleFromPos(tile, &info, 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

static const TrackBits _valid_tileh_slopes[][15] = {

   153

   154

/* set of normal ones */

   155

{

   156

	TRACK_BIT_ALL,

   157

	TRACK_BIT_RIGHT,

   158

	TRACK_BIT_UPPER,

   159

	TRACK_BIT_X,

   160

   161

	TRACK_BIT_LEFT,

   162

	TRACK_BIT_NONE,

   163

	TRACK_BIT_Y,

   164

	TRACK_BIT_LOWER,

   165

   166

	TRACK_BIT_LOWER,

   167

	TRACK_BIT_Y,

   168

	TRACK_BIT_NONE,

   169

	TRACK_BIT_LEFT,

   170

   171

	TRACK_BIT_X,

   172

	TRACK_BIT_UPPER,

   173

	TRACK_BIT_RIGHT,

   174

},

   175

   176

/* allowed rail for an evenly raised platform */

   177

{

   178

	TRACK_BIT_NONE,

   179

	TRACK_BIT_LEFT,

   180

	TRACK_BIT_LOWER,

   181

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   182

   183

	TRACK_BIT_RIGHT,

   184

	TRACK_BIT_ALL,

   185

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   186

	TRACK_BIT_ALL,

   187

   188

	TRACK_BIT_UPPER,

   189

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   190

	TRACK_BIT_ALL,

   191

	TRACK_BIT_ALL,

   192

   193

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   194

	TRACK_BIT_ALL,

   195

	TRACK_BIT_ALL

   196

}

   197

};

   198

   199

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   200

{

   201

	if (!IsSteepSlope(tileh)) {

   202

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

   203

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

   204

	}

   205

   206

	switch (bits) {

   207

		default: NOT_REACHED();

   208

		case TRACK_BIT_X:     return FOUNDATION_INCLINED_X;

   209

		case TRACK_BIT_Y:     return FOUNDATION_INCLINED_Y;

   210

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

   211

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

   212

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

   213

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

   214

	}

   215

}

   216

   217

   218

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

   219

{

   220

	if (IsSteepSlope(tileh)) {

   221

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

   222

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

   223

			if (valid & rail_bits) return _price.terraform;

   224

		}

   225

	} else {

   226

		rail_bits |= existing;

   227

   228

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

   229

		if (IsTileType(tile, MP_WATER) &&

   230

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

   231

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   232

		}

   233

   234

		/* no special foundation */

   235

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

   236

			return CommandCost();

   237

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

   238

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   239

		}

   240

   241

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

   242

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

   243

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

   244

				)) { // partly up

   245

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

   246

		}

   247

	}

   248

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   249

}

   250

   251

/* Validate functions for rail building */

   252

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

   253

   254

/** Build a single piece of rail

   255

 * @param tile tile  to build on

   256

 * @param flags operation to perform

   257

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

   258

 * @param p2 rail track to build

   259

 */

   260

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

   261

{

   262

	Slope tileh;

   263

	RailType railtype;

   264

	Track track;

   265

	TrackBits trackbit;

   266

	CommandCost cost;

   267

	CommandCost ret;

   268

   269

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

   270

	railtype = (RailType)p1;

   271

	track = (Track)p2;

   272

   273

	tileh = GetTileSlope(tile, NULL);

   274

	trackbit = TrackToTrackBits(track);

   275

   276

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   277

   278

	switch (GetTileType(tile)) {

   279

		case MP_RAILWAY:

   280

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

   281

					!EnsureNoTrainOnTrack(tile, track)) {

   282

				return CMD_ERROR;

   283

			}

   284

			if (!IsTileOwner(tile, _current_player) ||

   285

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

   286

				/* Get detailed error message */

   287

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

   288

			}

   289

   290

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

   291

			if (CmdFailed(ret)) return ret;

   292

			cost.AddCost(ret);

   293

   294

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

   295

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

   296

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

   297

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

   298

				if (CmdFailed(ret)) return ret;

   299

				cost.AddCost(ret);

   300

			}

   301

   302

			if (flags & DC_EXEC) {

   303

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   304

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

   305

			}

   306

			break;

   307

   308

		case MP_ROAD:

   309

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

   310

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

   311

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

   312

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   313

			}

   314

#undef M

   315

   316

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   317

   318

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   319

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

   320

   321

				RoadTypes roadtypes = GetRoadTypes(tile);

   322

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   323

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   324

				switch (roadtypes) {

   325

					default: break;

   326

					case ROADTYPES_TRAM:

   327

						/* Tram crossings must always have road. */

   328

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   329

						roadtypes |= ROADTYPES_ROAD;

   330

						break;

   331

   332

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

   333

						/* FALL THROUGH */

   334

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

   335

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

   336

					case ROADTYPES_ALL:      // Also incompatible

   337

						return CMD_ERROR;

   338

				}

   339

   340

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

   341

   342

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

   343

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

   344

					if (flags & DC_EXEC) {

   345

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

   346

					}

   347

					break;

   348

				}

   349

			}

   350

   351

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

   352

				return_cmd_error(STR_1007_ALREADY_BUILT);

   353

			}

   354

			/* FALLTHROUGH */

   355

   356

		default:

   357

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

   358

			if (CmdFailed(ret)) return ret;

   359

			cost.AddCost(ret);

   360

   361

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

   362

			if (CmdFailed(ret)) return ret;

   363

			cost.AddCost(ret);

   364

   365

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

   366

			break;

   367

	}

   368

   369

	if (flags & DC_EXEC) {

   370

		MarkTileDirtyByTile(tile);

   371

		SetSignalsOnBothDir(tile, track);

   372

		YapfNotifyTrackLayoutChange(tile, track);

   373

	}

   374

   375

	return cost.AddCost(_price.build_rail);

   376

}

   377

   378

/** Remove a single piece of track

   379

 * @param tile tile to remove track from

   380

 * @param flags operation to perform

   381

 * @param p1 unused

   382

 * @param p2 rail orientation

   383

 */

   384

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

   385

{

   386

	Track track = (Track)p2;

   387

	TrackBits trackbit;

   388

	CommandCost cost(_price.remove_rail);

   389

	bool crossing = false;

   390

   391

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

   392

	trackbit = TrackToTrackBits(track);

   393

   394

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   395

   396

	switch (GetTileType(tile)) {

   397

		case MP_ROAD: {

   398

			if (!IsLevelCrossing(tile) ||

   399

					GetCrossingRailBits(tile) != trackbit ||

   400

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

   401

					!EnsureNoVehicleOnGround(tile)) {

   402

				return CMD_ERROR;

   403

			}

   404

   405

			if (flags & DC_EXEC) {

   406

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

   407

			}

   408

			break;

   409

		}

   410

   411

		case MP_RAILWAY: {

   412

			TrackBits present;

   413

   414

			if (!IsPlainRailTile(tile) ||

   415

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

   416

					!EnsureNoTrainOnTrack(tile, track)) {

   417

				return CMD_ERROR;

   418

			}

   419

   420

			present = GetTrackBits(tile);

   421

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

   422

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

   423

   424

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

   425

			if (HasSignalOnTrack(tile, track))

   426

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

   427

   428

			if (flags & DC_EXEC) {

   429

				present ^= trackbit;

   430

				if (present == 0) {

   431

					DoClearSquare(tile);

   432

				} else {

   433

					SetTrackBits(tile, present);

   434

				}

   435

			}

   436

			break;

   437

		}

   438

   439

		default: return CMD_ERROR;

   440

	}

   441

   442

	if (flags & DC_EXEC) {

   443

		MarkTileDirtyByTile(tile);

   444

		if (crossing) {

   445

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

   446

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

   447

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

   448

			 * 'connect' with the other piece. */

   449

			SetSignalsOnBothDir(tile, TRACK_X);

   450

			SetSignalsOnBothDir(tile, TRACK_Y);

   451

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   452

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   453

		} else {

   454

			SetSignalsOnBothDir(tile, track);

   455

			YapfNotifyTrackLayoutChange(tile, track);

   456

		}

   457

	}

   458

   459

	return cost;

   460

}

   461

   462

   463

static const TileIndexDiffC _trackdelta[] = {

   464

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

   465

	{  0,  0 },

   466

	{  0,  0 },

   467

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

   468

	{  0,  0 },

   469

	{  0,  0 }

   470

};

   471

   472

   473

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

   474

{

   475

	int x = TileX(start);

   476

	int y = TileY(start);

   477

	int ex = TileX(end);

   478

	int ey = TileY(end);

   479

	int dx, dy, trdx, trdy;

   480

   481

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

   482

   483

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

   484

	dx = ex - x;

   485