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"

    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

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

    82

{

    83

	TrackBits current; // The current track layout

    84

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

    85

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

    86

    87

	if (!IsPlainRailTile(tile)) return false;

    88

    89

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

    90

	 * what tracks first */

    91

	current = GetTrackBits(tile);

    92

	future = current | to_build;

    93

    94

	/* Are we really building something new? */

    95

	if (current == future) {

    96

		/* Nothing new is being built */

    97

		_error_message = STR_1007_ALREADY_BUILT;

    98

		return false;

    99

	}

   100

   101

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

   102

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

   103

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

   104

		 * signals on the tile), check that */

   105

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

   106

	} else {

   107

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

   108

		return true;

   109

	}

   110

}

   111

   112

   113

static const TrackBits _valid_tileh_slopes[][15] = {

   114

   115

/* set of normal ones */

   116

{

   117

	TRACK_BIT_ALL,

   118

	TRACK_BIT_RIGHT,

   119

	TRACK_BIT_UPPER,

   120

	TRACK_BIT_X,

   121

   122

	TRACK_BIT_LEFT,

   123

	TRACK_BIT_NONE,

   124

	TRACK_BIT_Y,

   125

	TRACK_BIT_LOWER,

   126

   127

	TRACK_BIT_LOWER,

   128

	TRACK_BIT_Y,

   129

	TRACK_BIT_NONE,

   130

	TRACK_BIT_LEFT,

   131

   132

	TRACK_BIT_X,

   133

	TRACK_BIT_UPPER,

   134

	TRACK_BIT_RIGHT,

   135

},

   136

   137

/* allowed rail for an evenly raised platform */

   138

{

   139

	TRACK_BIT_NONE,

   140

	TRACK_BIT_LEFT,

   141

	TRACK_BIT_LOWER,

   142

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   143

   144

	TRACK_BIT_RIGHT,

   145

	TRACK_BIT_ALL,

   146

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   147

	TRACK_BIT_ALL,

   148

   149

	TRACK_BIT_UPPER,

   150

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   151

	TRACK_BIT_ALL,

   152

	TRACK_BIT_ALL,

   153

   154

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   155

	TRACK_BIT_ALL,

   156

	TRACK_BIT_ALL

   157

}

   158

};

   159

   160

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   161

{

   162

	if (!IsSteepSlope(tileh)) {

   163

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

   164

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

   165

	}

   166

   167

	switch (bits) {

   168

		default: NOT_REACHED();

   169

		case TRACK_BIT_X:     return FOUNDATION_INCLINED_X;

   170

		case TRACK_BIT_Y:     return FOUNDATION_INCLINED_Y;

   171

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

   172

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

   173

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

   174

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

   175

	}

   176

}

   177

   178

   179

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

   180

{

   181

	if (IsSteepSlope(tileh)) {

   182

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

   183

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

   184

			if (valid & rail_bits) return _price.terraform;

   185

		}

   186

	} else {

   187

		rail_bits |= existing;

   188

   189

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

   190

		if (IsTileType(tile, MP_WATER) &&

   191

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

   192

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   193

		}

   194

   195

		/* no special foundation */

   196

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

   197

			return CommandCost();

   198

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

   199

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   200

		}

   201

   202

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

   203

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

   204

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

   205

				)) { // partly up

   206

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

   207

		}

   208

	}

   209

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   210

}

   211

   212

/* Validate functions for rail building */

   213

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

   214

   215

/** Build a single piece of rail

   216

 * @param tile tile  to build on

   217

 * @param flags operation to perform

   218

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

   219

 * @param p2 rail track to build

   220

 */

   221

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

   222

{

   223

	Slope tileh;

   224

	RailType railtype;

   225

	Track track;

   226

	TrackBits trackbit;

   227

	CommandCost cost;

   228

	CommandCost ret;

   229

   230

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

   231

	railtype = (RailType)p1;

   232

	track = (Track)p2;

   233

   234

	tileh = GetTileSlope(tile, NULL);

   235

	trackbit = TrackToTrackBits(track);

   236

   237

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   238

   239

	switch (GetTileType(tile)) {

   240

		case MP_RAILWAY:

   241

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

   242

					!EnsureNoVehicleOnGround(tile)) {

   243

				return CMD_ERROR;

   244

			}

   245

			if (!IsTileOwner(tile, _current_player) ||

   246

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

   247

				/* Get detailed error message */

   248

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

   249

			}

   250

   251

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

   252

			if (CmdFailed(ret)) return ret;

   253

			cost.AddCost(ret);

   254

   255

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

   256

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

   257

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

   258

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

   259

				if (CmdFailed(ret)) return ret;

   260

				cost.AddCost(ret);

   261

			}

   262

   263

			if (flags & DC_EXEC) {

   264

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   265

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

   266

			}

   267

			break;

   268

   269

		case MP_ROAD:

   270

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

   271

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

   272

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

   273

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   274

			}

   275

#undef M

   276

   277

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   278

   279

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   280

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

   281

   282

				RoadTypes roadtypes = GetRoadTypes(tile);

   283

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   284

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   285

				switch (roadtypes) {

   286

					default: break;

   287

					case ROADTYPES_TRAM:

   288

						/* Tram crossings must always have road. */

   289

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   290

						roadtypes |= ROADTYPES_ROAD;

   291

						break;

   292

   293

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

   294

						/* FALL THROUGH */

   295

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

   296

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

   297

					case ROADTYPES_ALL:      // Also incompatible

   298

						return CMD_ERROR;

   299

				}

   300

   301

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

   302

   303

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

   304

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

   305

					if (flags & DC_EXEC) {

   306

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

   307

					}

   308

					break;

   309

				}

   310

			}

   311

   312

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

   313

				return_cmd_error(STR_1007_ALREADY_BUILT);

   314

			}

   315

			/* FALLTHROUGH */

   316

   317

		default:

   318

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

   319

			if (CmdFailed(ret)) return ret;

   320

			cost.AddCost(ret);

   321

   322

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

   323

			if (CmdFailed(ret)) return ret;

   324

			cost.AddCost(ret);

   325

   326

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

   327

			break;

   328

	}

   329

   330

	if (flags & DC_EXEC) {

   331

		MarkTileDirtyByTile(tile);

   332

		SetSignalsOnBothDir(tile, track);

   333

		YapfNotifyTrackLayoutChange(tile, track);

   334

	}

   335

   336

	return cost.AddCost(_price.build_rail);

   337

}

   338

   339

/** Remove a single piece of track

   340

 * @param tile tile to remove track from

   341

 * @param flags operation to perform

   342

 * @param p1 unused

   343

 * @param p2 rail orientation

   344

 */

   345

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

   346

{

   347

	Track track = (Track)p2;

   348

	TrackBits trackbit;

   349

	CommandCost cost(_price.remove_rail);

   350

	bool crossing = false;

   351

   352

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

   353

	trackbit = TrackToTrackBits(track);

   354

   355

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   356

   357

	switch (GetTileType(tile)) {

   358

		case MP_ROAD: {

   359

			if (!IsLevelCrossing(tile) ||

   360

					GetCrossingRailBits(tile) != trackbit ||

   361

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

   362

					!EnsureNoVehicleOnGround(tile)) {

   363

				return CMD_ERROR;

   364

			}

   365

   366

			if (flags & DC_EXEC) {

   367

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

   368

			}

   369

			break;

   370

		}

   371

   372

		case MP_RAILWAY: {

   373

			TrackBits present;

   374

   375

			if (!IsPlainRailTile(tile) ||

   376

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

   377

					!EnsureNoVehicleOnGround(tile)) {

   378

				return CMD_ERROR;

   379

			}

   380

   381

			present = GetTrackBits(tile);

   382

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

   383

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

   384

   385

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

   386

			if (HasSignalOnTrack(tile, track))

   387

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

   388

   389

			if (flags & DC_EXEC) {

   390

				present ^= trackbit;

   391

				if (present == 0) {

   392

					DoClearSquare(tile);

   393

				} else {

   394

					SetTrackBits(tile, present);

   395

				}

   396

			}

   397

			break;

   398

		}

   399

   400

		default: return CMD_ERROR;

   401

	}

   402

   403

	if (flags & DC_EXEC) {

   404

		MarkTileDirtyByTile(tile);

   405

		if (crossing) {

   406

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

   407

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

   408

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

   409

			 * 'connect' with the other piece. */

   410

			SetSignalsOnBothDir(tile, TRACK_X);

   411

			SetSignalsOnBothDir(tile, TRACK_Y);

   412

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   413

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   414

		} else {

   415

			SetSignalsOnBothDir(tile, track);

   416

			YapfNotifyTrackLayoutChange(tile, track);

   417

		}

   418

	}

   419

   420

	return cost;

   421

}

   422

   423

   424

static const TileIndexDiffC _trackdelta[] = {

   425

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

   426

	{  0,  0 },

   427

	{  0,  0 },

   428

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

   429

	{  0,  0 },

   430

	{  0,  0 }

   431

};

   432

   433

   434

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

   435

{

   436

	int x = TileX(start);

   437

	int y = TileY(start);

   438

	int ex = TileX(end);

   439

	int ey = TileY(end);

   440

	int dx, dy, trdx, trdy;

   441

   442

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

   443

   444

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

   445

	dx = ex - x;

   446

	dy = ey - y;

   447

   448

	/* calculate delta x,y for the first direction */

   449

	trdx = _trackdelta[*trackdir].x;

   450

	trdy = _trackdelta[*trackdir].y;

   451

   452

	if (!IsDiagonalTrackdir(*trackdir)) {

   453

		trdx += _trackdelta[*trackdir ^ 1].x;

   454

		trdy += _trackdelta[*trackdir ^ 1].y;

   455

	}

   456

   457

	/* validate the direction */

   458

	while (

   459

		(trdx <= 0 && dx > 0) ||

   460

		(trdx >= 0 && dx < 0) ||

   461

		(trdy <= 0 && dy > 0) ||

   462

		(trdy >= 0 && dy < 0)

   463

	) {

   464

		if (!HASBIT(*trackdir, 3)) { // first direction is invalid, try the other

   465

			SetBitT(*trackdir, 3); // reverse the direction

   466

			trdx = -trdx;

   467

			trdy = -trdy;

   468

		} else { // other direction is invalid too, invalid drag

   469

			return CMD_ERROR;

   470

		}

   471

	}

   472

   473

	/* (for diagonal tracks, this is already made sure of by above test), but:

   474

	 * for non-diagonal tracks, check if the start and end tile are on 1 line */

   475

	if (!IsDiagonalTrackdir(*trackdir)) {

   476

		trdx = _trackdelta[*trackdir].x;

   477

		trdy = _trackdelta[*trackdir].y;

   478

		if (abs(dx) != abs(dy) && abs(dx) + abs(trdy) != abs(dy) + abs(trdx))

   479

			return CMD_ERROR;

   480

	}

   481

   482

	return CommandCost();

   483

}