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

    12

#include "rail_map.h"

    13

#include "road_map.h"

    14

#include "table/sprites.h"

    15

#include "table/strings.h"

    16

#include "landscape.h"

    17

#include "town_map.h"

    18

#include "tunnel_map.h"

    20

#include "command_func.h"

    21

#include "pathfind.h"

    22

#include "engine.h"

    23

#include "town.h"

    24

#include "station.h"

    25

#include "sprite.h"

    26

#include "depot.h"

    27

#include "waypoint.h"

    28

#include "rail.h"

    29

#include "railtypes.h" // include table for railtypes

    30

#include "newgrf.h"

    31

#include "yapf/yapf.h"

    32

#include "newgrf_engine.h"

    33

#include "newgrf_callbacks.h"

    34

#include "newgrf_station.h"

    35

#include "train.h"

    36

#include "misc/autoptr.hpp"

    37

#include "variables.h"

    38

#include "autoslope.h"

    39

#include "transparency.h"

    40

#include "water.h"

    41

#include "tunnelbridge_map.h"

    42

#include "window_func.h"

    43

#include "vehicle_func.h"

    44

#include "sound_func.h"

    45

    46

    47

const byte _track_sloped_sprites[14] = {

    48

	14, 15, 22, 13,

    49

	 0, 21, 17, 12,

    50

	23,  0, 18, 20,

    51

	19, 16

    52

};

    53

    54

    55

/*         4

    56

 *     ---------

    57

 *    |\       /|

    58

 *    | \    1/ |

    59

 *    |  \   /  |

    60

 *    |   \ /   |

    61

 *  16|    \    |32

    62

 *    |   / \2  |

    63

 *    |  /   \  |

    64

 *    | /     \ |

    65

 *    |/       \|

    66

 *     ---------

    67

 *         8

    68

 */

    69

    70

    71

    72

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

    73

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

    74

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

    75

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

    76

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

    77

 *               similar for lower and right.

    78

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

    79

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

    80

 * MAP5:         00abcdef => rail

    81

 *               01abcdef => rail w/ signals

    82

 *               10uuuuuu => unused

    83

 *               11uuuudd => rail depot

    84

 */

    85

    86

    87

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

    88

{

    89

	TrackBits rail_bits = *(TrackBits *)data;

    90

    91

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

    92

    93

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

    94

    95

	_error_message = VehicleInTheWayErrMsg(v);

    96

	return v;

    97

}

    98

    99

/**

   100

 * Tests if a vehicle interacts with the specified track.

   101

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   102

 *

   103

 * @param tile The tile.

   104

 * @param track The track.

   105

 */

   106

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   107

{

   108

	TrackBits rail_bits = TrackToTrackBits(track);

   109

   110

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

   111

}

   112

   113

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

   114

{

   115

	TrackBits current; // The current track layout

   116

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

   117

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   118

   119

	if (!IsPlainRailTile(tile)) return false;

   120

   121

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

   122

	 * what tracks first */

   123

	current = GetTrackBits(tile);

   124

	future = current | to_build;

   125

   126

	/* Are we really building something new? */

   127

	if (current == future) {

   128

		/* Nothing new is being built */

   129

		_error_message = STR_1007_ALREADY_BUILT;

   130

		return false;

   131

	}

   132

   133

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

   134

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

   135

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

   136

		 * signals on the tile), check that */

   137

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

   138

	} else {

   139

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

   140

		return true;

   141

	}

   142

}

   143

   144

   145

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

   146

static const TrackBits _valid_tracks_without_foundation[15] = {

   147

	TRACK_BIT_ALL,

   148

	TRACK_BIT_RIGHT,

   149

	TRACK_BIT_UPPER,

   150

	TRACK_BIT_X,

   151

   152

	TRACK_BIT_LEFT,

   153

	TRACK_BIT_NONE,

   154

	TRACK_BIT_Y,

   155

	TRACK_BIT_LOWER,

   156

   157

	TRACK_BIT_LOWER,

   158

	TRACK_BIT_Y,

   159

	TRACK_BIT_NONE,

   160

	TRACK_BIT_LEFT,

   161

   162

	TRACK_BIT_X,

   163

	TRACK_BIT_UPPER,

   164

	TRACK_BIT_RIGHT,

   165

};

   166

   167

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

   168

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   169

	TRACK_BIT_NONE,

   170

	TRACK_BIT_LEFT,

   171

	TRACK_BIT_LOWER,

   172

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   173

   174

	TRACK_BIT_RIGHT,

   175

	TRACK_BIT_ALL,

   176

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   177

	TRACK_BIT_ALL,

   178

   179

	TRACK_BIT_UPPER,

   180

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   181

	TRACK_BIT_ALL,

   182

	TRACK_BIT_ALL,

   183

   184

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   185

	TRACK_BIT_ALL,

   186

	TRACK_BIT_ALL

   187

};

   188

   189

/**

   190

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

   191

 *

   192

 * @param tileh Tile slope.

   193

 * @param bits  Trackbits.

   194

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

   195

 */

   196

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   197

{

   198

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   199

   200

	if (IsSteepSlope(tileh)) {

   201

		/* Test for inclined foundations */

   202

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   203

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   204

   205

		/* Get higher track */

   206

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   207

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   208

   209

		/* Only higher track? */

   210

		if (bits == higher_track) return HalftileFoundation(highest_corner);

   211

   212

		/* Overlap with higher track? */

   213

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

   214

   215

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

   216

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

   217

	} else {

   218

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

   219

   220

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

   221

   222

		Corner track_corner;

   223

		switch (bits) {

   224

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   225

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   226

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   227

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   228

   229

			case TRACK_BIT_HORZ:

   230

				if (tileh == SLOPE_N) return HalftileFoundation(CORNER_N);

   231

				if (tileh == SLOPE_S) return HalftileFoundation(CORNER_S);

   232

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   233

   234

			case TRACK_BIT_VERT:

   235

				if (tileh == SLOPE_W) return HalftileFoundation(CORNER_W);

   236

				if (tileh == SLOPE_E) return HalftileFoundation(CORNER_E);

   237

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   238

   239

			case TRACK_BIT_X:

   240

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_X;

   241

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   242

   243

			case TRACK_BIT_Y:

   244

				if (HasSlopeHighestCorner(tileh)) return FOUNDATION_INCLINED_Y;

   245

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   246

   247

			default:

   248

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   249

		}

   250

		/* Single diagonal track */

   251

   252

		/* Track must be at least valid on leveled foundation */

   253

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   254

   255

		/* If slope has three raised corners, build leveled foundation */

   256

		if (HasSlopeHighestCorner(ComplementSlope(tileh))) return FOUNDATION_LEVELED;

   257

   258

		/* If neighboured corners of track_corner are lowered, build halftile foundation */

   259

		if ((tileh & SlopeWithThreeCornersRaised(OppositeCorner(track_corner))) == SlopeWithOneCornerRaised(track_corner)) return HalftileFoundation(track_corner);

   260

   261

		/* else special anti-zig-zag foundation */

   262

		return SpecialRailFoundation(track_corner);

   263

	}

   264

}

   265

   266

   267

/**

   268

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

   269

 *

   270

 * @param tileh Tile slope.

   271

 * @param rail_bits Tracks to build.

   272

 * @param existing Tracks already built.

   273

 * @param tile Tile (used for water test)

   274

 * @return Error message or cost for foundation building.

   275

 */

   276

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

   277

{

   278

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

   279

	if (IsTileType(tile, MP_WATER) || (IsTileType(tile, MP_RAILWAY) && (GetRailGroundType(tile) == RAIL_GROUND_WATER))) {

   280

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

   281

	}

   282

   283

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

   284

   285

	/* check track/slope combination */

   286

	if ((f_new == FOUNDATION_INVALID) ||

   287

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

   288

	   ) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   289

   290

	Foundation f_old = GetRailFoundation(tileh, existing);

   291

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

   292

}

   293

   294

/* Validate functions for rail building */

   295

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

   296

   297

/** Build a single piece of rail

   298

 * @param tile tile  to build on

   299

 * @param flags operation to perform

   300

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

   301

 * @param p2 rail track to build

   302

 */

   303

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

   304

{

   305

	Slope tileh;

   306

	RailType railtype;

   307

	Track track;

   308

	TrackBits trackbit;

   309

	CommandCost cost;

   310

	CommandCost ret;

   311

   312

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

   313

	railtype = (RailType)p1;

   314

	track = (Track)p2;

   315

   316

	tileh = GetTileSlope(tile, NULL);

   317

	trackbit = TrackToTrackBits(track);

   318

   319

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   320

   321

	switch (GetTileType(tile)) {

   322

		case MP_RAILWAY:

   323

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

   324

					!EnsureNoTrainOnTrack(tile, track)) {

   325

				return CMD_ERROR;

   326

			}

   327

			if (!IsTileOwner(tile, _current_player) ||

   328

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

   329

				/* Get detailed error message */

   330

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

   331

			}

   332

   333

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

   334

			if (CmdFailed(ret)) return ret;

   335

			cost.AddCost(ret);

   336

   337

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

   338

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

   339

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

   340

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

   341

				if (CmdFailed(ret)) return ret;

   342

				cost.AddCost(ret);

   343

			}

   344

   345

			if (flags & DC_EXEC) {

   346

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   347

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

   348

			}

   349

			break;

   350

   351

		case MP_ROAD:

   352

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

   353

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

   354

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

   355

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   356

			}

   357

#undef M

   358

   359

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   360

   361

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   362

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

   363

   364

				RoadTypes roadtypes = GetRoadTypes(tile);

   365

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   366

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   367

				switch (roadtypes) {

   368

					default: break;

   369

					case ROADTYPES_TRAM:

   370

						/* Tram crossings must always have road. */

   371

						SetRoadOwner(tile, ROADTYPE_ROAD, _current_player);

   372

						roadtypes |= ROADTYPES_ROAD;

   373

						break;

   374

   375

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

   376

						/* FALL THROUGH */

   377

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

   378

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

   379

					case ROADTYPES_ALL:      // Also incompatible

   380

						return CMD_ERROR;

   381

				}

   382

   383

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

   384

   385

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

   386

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

   387

					if (flags & DC_EXEC) {

   388

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

   389

					}

   390

					break;

   391

				}

   392

			}

   393

   394

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

   395

				return_cmd_error(STR_1007_ALREADY_BUILT);

   396

			}

   397

			/* FALLTHROUGH */

   398

   399

		default:

   400

			bool water_ground = IsTileType(tile, MP_WATER) && !IsSteepSlope(tileh) && HasSlopeHighestCorner(tileh);

   401

   402

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

   403

			if (CmdFailed(ret)) return ret;

   404

			cost.AddCost(ret);

   405

   406

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

   407

			if (CmdFailed(ret)) return ret;

   408

			cost.AddCost(ret);

   409

   410

			if (water_ground) {

   411

				cost.AddCost(-_price.clear_water);

   412

				cost.AddCost(_price.clear_roughland);

   413

			}

   414

   415

			if (flags & DC_EXEC) {

   416

				MakeRailNormal(tile, _current_player, trackbit, railtype);

   417

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   418

			}

   419

			break;

   420

	}

   421

   422

	if (flags & DC_EXEC) {

   423

		MarkTileDirtyByTile(tile);

   424

		SetSignalsOnBothDir(tile, track);

   425

		YapfNotifyTrackLayoutChange(tile, track);

   426

	}

   427

   428

	return cost.AddCost(RailBuildCost(railtype));

   429

}

   430

   431

/** Remove a single piece of track

   432

 * @param tile tile to remove track from

   433

 * @param flags operation to perform

   434

 * @param p1 unused

   435

 * @param p2 rail orientation

   436

 */

   437

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

   438

{

   439

	Track track = (Track)p2;

   440

	TrackBits trackbit;

   441

	CommandCost cost(_price.remove_rail);

   442

	bool crossing = false;

   443

   444

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

   445

	trackbit = TrackToTrackBits(track);

   446

   447

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   448

   449

	switch (GetTileType(tile)) {

   450

		case MP_ROAD: {

   451

			if (!IsLevelCrossing(tile) ||

   452

					GetCrossingRailBits(tile) != trackbit ||

   453

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

   454

					!EnsureNoVehicleOnGround(tile)) {

   455

				return CMD_ERROR;

   456

			}

   457

   458

			if (flags & DC_EXEC) {

   459

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

   460

			}

   461

			break;

   462

		}

   463

   464

		case MP_RAILWAY: {

   465

			TrackBits present;

   466

   467

			if (!IsPlainRailTile(tile) ||

   468

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

   469

					!EnsureNoTrainOnTrack(tile, track)) {

   470

				return CMD_ERROR;

   471

			}

   472

   473

			present = GetTrackBits(tile);

   474

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

   475

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

   476

   477

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

   478

			if (HasSignalOnTrack(tile, track))

   479

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

   480

   481

			if (flags & DC_EXEC) {

   482

				present ^= trackbit;

   483

				if (present == 0) {

   484

					if (GetRailGroundType(tile) == RAIL_GROUND_WATER) {