1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "bridge_map.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "rail_map.h"

     9

#include "road_map.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "town_map.h"

    15

#include "tunnel_map.h"

    16

#include "vehicle.h"

    17

#include "viewport.h"

    18

#include "command.h"

    19

#include "pathfind.h"

    20

#include "engine.h"

    21

#include "town.h"

    22

#include "sound.h"

    23

#include "station.h"

    24

#include "sprite.h"

    25

#include "depot.h"

    26

#include "waypoint.h"

    27

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

    33

#include "newgrf_station.h"

    34

#include "train.h"

    35

    36

const byte _track_sloped_sprites[14] = {

    37

	14, 15, 22, 13,

    38

	 0, 21, 17, 12,

    39

	23,  0, 18, 20,

    40

	19, 16

    41

};

    42

    43

    44

/*         4

    45

 *     ---------

    46

 *    |\       /|

    47

 *    | \    1/ |

    48

 *    |  \   /  |

    49

 *    |   \ /   |

    50

 *  16|    \    |32

    51

 *    |   / \2  |

    52

 *    |  /   \  |

    53

 *    | /     \ |

    54

 *    |/       \|

    55

 *     ---------

    56

 *         8

    57

 */

    58

    59

    60

    61

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

    62

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

    63

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

    64

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

    65

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

    66

 *               similar for lower and right.

    67

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

    68

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

    69

 * MAP5:         00abcdef => rail

    70

 *               01abcdef => rail w/ signals

    71

 *               10uuuuuu => unused

    72

 *               11uuuudd => rail depot

    73

 */

    74

    75

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

    76

{

    77

	TrackBits current; /* The current track layout */

    78

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

    79

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

    80

    81

	if (!IsPlainRailTile(tile)) return false;

    82

    83

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

    84

	 * what tracks first */

    85

	current = GetTrackBits(tile);

    86

	future = current | to_build;

    87

    88

	/* Are we really building something new? */

    89

	if (current == future) {

    90

		/* Nothing new is being built */

    91

		_error_message = STR_1007_ALREADY_BUILT;

    92

		return false;

    93

	}

    94

    95

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

    96

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

    97

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

    98

		 * signals on the tile), check that */

    99

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

   100

	} else {

   101

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

   102

		return true;

   103

	}

   104

}

   105

   106

   107

static const TrackBits _valid_tileh_slopes[][15] = {

   108

   109

// set of normal ones

   110

{

   111

	TRACK_BIT_ALL,

   112

	TRACK_BIT_RIGHT,

   113

	TRACK_BIT_UPPER,

   114

	TRACK_BIT_X,

   115

   116

	TRACK_BIT_LEFT,

   117

	TRACK_BIT_NONE,

   118

	TRACK_BIT_Y,

   119

	TRACK_BIT_LOWER,

   120

   121

	TRACK_BIT_LOWER,

   122

	TRACK_BIT_Y,

   123

	TRACK_BIT_NONE,

   124

	TRACK_BIT_LEFT,

   125

   126

	TRACK_BIT_X,

   127

	TRACK_BIT_UPPER,

   128

	TRACK_BIT_RIGHT,

   129

},

   130

   131

// allowed rail for an evenly raised platform

   132

{

   133

	TRACK_BIT_NONE,

   134

	TRACK_BIT_LEFT,

   135

	TRACK_BIT_LOWER,

   136

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   137

   138

	TRACK_BIT_RIGHT,

   139

	TRACK_BIT_ALL,

   140

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   141

	TRACK_BIT_ALL,

   142

   143

	TRACK_BIT_UPPER,

   144

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   145

	TRACK_BIT_ALL,

   146

	TRACK_BIT_ALL,

   147

   148

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   149

	TRACK_BIT_ALL,

   150

	TRACK_BIT_ALL

   151

}

   152

};

   153

   154

uint GetRailFoundation(Slope tileh, TrackBits bits)

   155

{

   156

	uint i;

   157

   158

	if (!IsSteepSlope(tileh)) {

   159

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

   160

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

   161

	}

   162

   163

	switch (bits) {

   164

		default: NOT_REACHED();

   165

		case TRACK_BIT_X: i = 0; break;

   166

		case TRACK_BIT_Y: i = 1; break;

   167

		case TRACK_BIT_LEFT:  return 15 + 8 + (tileh == SLOPE_STEEP_W ? 4 : 0);

   168

		case TRACK_BIT_LOWER: return 15 + 8 + (tileh == SLOPE_STEEP_S ? 5 : 1);

   169

		case TRACK_BIT_RIGHT: return 15 + 8 + (tileh == SLOPE_STEEP_E ? 6 : 2);

   170

		case TRACK_BIT_UPPER: return 15 + 8 + (tileh == SLOPE_STEEP_N ? 7 : 3);

   171

	}

   172

	switch (tileh) {

   173

		case SLOPE_W:

   174

		case SLOPE_STEEP_W: i += 0; break;

   175

		case SLOPE_S:

   176

		case SLOPE_STEEP_S: i += 2; break;

   177

		case SLOPE_E:

   178

		case SLOPE_STEEP_E: i += 4; break;

   179

		case SLOPE_N:

   180

		case SLOPE_STEEP_N: i += 6; break;

   181

		default: return 0;

   182

	}

   183

	return i + 15;

   184

}

   185

   186

   187

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

   188

{

   189

	if (IsSteepSlope(tileh)) {

   190

		if (existing == 0) {

   191

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

   192

			if (valid & rail_bits) return _price.terraform;

   193

		}

   194

	} else {

   195

		rail_bits |= existing;

   196

   197

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

   198

		if (IsTileType(tile, MP_WATER) &&

   199

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

   200

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   201

		}

   202

   203

		// no special foundation

   204

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

   205

			return 0;

   206

   207

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

   208

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

   209

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

   210

				)) { // partly up

   211

			if (existing != 0) {

   212

				return 0;

   213

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

   214

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   215

			} else {

   216

				return _price.terraform;

   217

			}

   218

		}

   219

	}

   220

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   221

}

   222

   223

/* Validate functions for rail building */

   224

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

   225

   226

/** Build a single piece of rail

   227

 * @param tile tile  to build on

   228

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

   229

 * @param p2 rail track to build

   230

 */

   231

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

   232

{

   233

	Slope tileh;

   234

	RailType railtype;

   235

	Track track;

   236

	TrackBits trackbit;

   237

	int32 cost = 0;

   238

	int32 ret;

   239

   240

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

   241

	railtype = (RailType)p1;

   242

	track = (Track)p2;

   243

   244

	tileh = GetTileSlope(tile, NULL);

   245

	trackbit = TrackToTrackBits(track);

   246

   247

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   248

   249

	switch (GetTileType(tile)) {

   250

		case MP_RAILWAY:

   251

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

   252

					!EnsureNoVehicle(tile)) {

   253

				return CMD_ERROR;

   254

			}

   255

			if (!IsTileOwner(tile, _current_player) ||

   256

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

   257

				// Get detailed error message

   258

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

   259

			}

   260

   261

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

   262

			if (CmdFailed(ret)) return ret;

   263

			cost += ret;

   264

   265

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

   266

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

   267

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

   268

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

   269

				if (CmdFailed(ret)) return ret;

   270

				cost += ret;

   271

			}

   272

   273

			if (flags & DC_EXEC) {

   274

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   275

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

   276

			}

   277

			break;

   278

   279

		case MP_STREET:

   280

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

   281

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

   282

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

   283

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   284

			}

   285

#undef M

   286

   287

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   288

   289

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL) {

   290

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

   291

   292

				if ((track == TRACK_X && GetRoadBits(tile) == ROAD_Y) ||

   293

						(track == TRACK_Y && GetRoadBits(tile) == ROAD_X)) {

   294

					if (flags & DC_EXEC) {

   295

						MakeRoadCrossing(tile, GetTileOwner(tile), _current_player, (track == TRACK_X ? AXIS_Y : AXIS_X), railtype, GetTownIndex(tile));

   296

					}

   297

					break;

   298

				}

   299

			}

   300

   301

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

   302

				return_cmd_error(STR_1007_ALREADY_BUILT);

   303

			}

   304

			/* FALLTHROUGH */

   305

   306

		default:

   307

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

   308

			if (CmdFailed(ret)) return ret;

   309

			cost += ret;

   310

   311

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

   312

			if (CmdFailed(ret)) return ret;

   313

			cost += ret;

   314

   315

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

   316

			break;

   317

	}

   318

   319

	if (flags & DC_EXEC) {

   320

		MarkTileDirtyByTile(tile);

   321

		SetSignalsOnBothDir(tile, track);

   322

		YapfNotifyTrackLayoutChange(tile, track);

   323

	}

   324

   325

	return cost + _price.build_rail;

   326

}

   327

   328

/** Remove a single piece of track

   329

 * @param tile tile to remove track from

   330

 * @param p1 unused

   331

 * @param p2 rail orientation

   332

 */

   333

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

   334

{

   335

	Track track = (Track)p2;

   336

	TrackBits trackbit;

   337

	int32 cost = _price.remove_rail;

   338

	bool crossing = false;

   339

   340

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

   341

	trackbit = TrackToTrackBits(track);

   342

   343

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   344

   345

	switch (GetTileType(tile)) {

   346

		case MP_STREET: {

   347

			if (!IsLevelCrossing(tile) ||

   348

					GetCrossingRailBits(tile) != trackbit ||

   349

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

   350

					!EnsureNoVehicle(tile)) {

   351

				return CMD_ERROR;

   352

			}

   353

   354

			if (flags & DC_EXEC) {

   355

				MakeRoadNormal(tile, GetCrossingRoadOwner(tile), GetCrossingRoadBits(tile), GetTownIndex(tile));

   356

			}

   357

			break;

   358

		}

   359

   360

		case MP_RAILWAY: {

   361

			TrackBits present;

   362

   363

			if (!IsPlainRailTile(tile) ||

   364

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

   365

					!EnsureNoVehicle(tile)) {

   366

				return CMD_ERROR;

   367

			}

   368

   369

			present = GetTrackBits(tile);

   370

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

   371

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

   372

   373

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

   374

			if (HasSignalOnTrack(tile, track))

   375

				cost += DoCommand(tile, track, 0, flags, CMD_REMOVE_SIGNALS);

   376

   377

			if (flags & DC_EXEC) {

   378

				present ^= trackbit;

   379

				if (present == 0) {

   380

					DoClearSquare(tile);

   381

				} else {

   382

					SetTrackBits(tile, present);

   383

				}

   384

			}

   385

			break;

   386

		}

   387

   388

		default: return CMD_ERROR;

   389

	}

   390

   391

	if (flags & DC_EXEC) {

   392

		MarkTileDirtyByTile(tile);

   393

		if (crossing) {

   394

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

   395

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

   396

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

   397

			 * 'connect' with the other piece. */

   398

			SetSignalsOnBothDir(tile, TRACK_X);

   399

			SetSignalsOnBothDir(tile, TRACK_Y);

   400

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   401

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   402

		} else {

   403

			SetSignalsOnBothDir(tile, track);

   404

			YapfNotifyTrackLayoutChange(tile, track);

   405

		}

   406

	}

   407

   408

	return cost;

   409

}

   410

   411

   412

static const TileIndexDiffC _trackdelta[] = {

   413

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

   414

	{  0,  0 },

   415

	{  0,  0 },

   416

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

   417

	{  0,  0 },

   418

	{  0,  0 }

   419

};

   420

   421

   422

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

   423

{

   424

	int x = TileX(start);

   425

	int y = TileY(start);

   426

	int ex = TileX(end);

   427

	int ey = TileY(end);

   428

	int dx, dy, trdx, trdy;

   429

   430

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

   431

   432

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

   433

	dx = ex - x;

   434

	dy = ey - y;

   435

   436

	// calculate delta x,y for the first direction

   437

	trdx = _trackdelta[*trackdir].x;

   438

	trdy = _trackdelta[*trackdir].y;

   439

   440

	if (!IsDiagonalTrackdir(*trackdir)) {

   441

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

   442

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

   443

	}

   444

   445

	// validate the direction

   446

	while (

   447

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

   448

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

   449

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

   450

		(trdy >= 0 && dy < 0)

   451

	) {

   452

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

   453

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

   454

			trdx = -trdx;

   455

			trdy = -trdy;

   456

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

   457

			return CMD_ERROR;

   458

		}

   459

	}

   460

   461

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

   462

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

   463

	if (!IsDiagonalTrackdir(*trackdir)) {

   464

		trdx = _trackdelta[*trackdir].x;

   465

		trdy = _trackdelta[*trackdir].y;

   466

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

   467

			return CMD_ERROR;

   468

	}

   469

   470

	return 0;

   471

}

   472

   473

/** Build a stretch of railroad tracks.

   474

 * @param tile start tile of drag

   475

 * @param p1 end tile of drag

   476

 * @param p2 various bitstuffed elements

   477

 * - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)

   478

 * - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)

   479

 * - p2 = (bit 7)   - 0 = build, 1 = remove tracks

   480

 */

   481

static int32 CmdRailTrackHelper(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   482

{

   483

	int32 ret, total_cost = 0;

   484

	Track track = (Track)GB(p2, 4, 3);

   485

	Trackdir trackdir;

   486