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

    28

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

    29

#include "newgrf.h"

    30

#include "yapf/yapf.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_station.h"

    33

    34

const byte _track_sloped_sprites[14] = {

    35

	14, 15, 22, 13,

    36

	 0, 21, 17, 12,

    37

	23,  0, 18, 20,

    38

	19, 16

    39

};

    40

    41

void ShowTrainDepotWindow(TileIndex tile);

    42

    43

/*         4

    44

 *     ---------

    45

 *    |\       /|

    46

 *    | \    1/ |

    47

 *    |  \   /  |

    48

 *    |   \ /   |

    49

 *  16|    \    |32

    50

 *    |   / \2  |

    51

 *    |  /   \  |

    52

 *    | /     \ |

    53

 *    |/       \|

    54

 *     ---------

    55

 *         8

    56

 */

    57

    58

    59

    60

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

    61

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

    62

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

    63

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

    64

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

    65

 *				 similar for lower and right.

    66

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

    67

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

    68

 * MAP5:         00abcdef => rail

    69

 *               01abcdef => rail w/ signals

    70

 *               10uuuuuu => unused

    71

 *               11uuuudd => rail depot

    72

 */

    73

    74

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

    75

{

    76

	RailTileType type = GetRailTileType(tile);

    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 (type != RAIL_TILE_NORMAL && type != RAIL_TILE_SIGNALS)

    82

		return false; /* Cannot build anything on depots and checkpoints */

    83

    84

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

    85

	 * what tracks first */

    86

	current = GetTrackBits(tile);

    87

	future = current | to_build;

    88

    89

	/* Are we really building something new? */

    90

	if (current == future) {

    91

		/* Nothing new is being built */

    92

		_error_message = STR_1007_ALREADY_BUILT;

    93

		return false;

    94

	}

    95

    96

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

    97

	if ((flags & DC_NO_RAIL_OVERLAP) || type == RAIL_TILE_SIGNALS) {

    98

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

    99

		 * signals on the tile), check that */

   100

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

   101

	} else {

   102

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

   103

		return true;

   104

	}

   105

}

   106

   107

   108

const TrackBits _valid_tileh_slopes[2][15] = {

   109

   110

// set of normal ones

   111

{

   112

	TRACK_BIT_ALL,

   113

	TRACK_BIT_RIGHT,

   114

	TRACK_BIT_UPPER,

   115

	TRACK_BIT_X,

   116

   117

	TRACK_BIT_LEFT,

   118

	0,

   119

	TRACK_BIT_Y,

   120

	TRACK_BIT_LOWER,

   121

   122

	TRACK_BIT_LOWER,

   123

	TRACK_BIT_Y,

   124

	0,

   125

	TRACK_BIT_LEFT,

   126

   127

	TRACK_BIT_X,

   128

	TRACK_BIT_UPPER,

   129

	TRACK_BIT_RIGHT,

   130

},

   131

   132

// allowed rail for an evenly raised platform

   133

{

   134

	0,

   135

	TRACK_BIT_LEFT,

   136

	TRACK_BIT_LOWER,

   137

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   138

   139

	TRACK_BIT_RIGHT,

   140

	TRACK_BIT_ALL,

   141

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   142

	TRACK_BIT_ALL,

   143

   144

	TRACK_BIT_UPPER,

   145

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   146

	TRACK_BIT_ALL,

   147

	TRACK_BIT_ALL,

   148

   149

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   150

	TRACK_BIT_ALL,

   151

	TRACK_BIT_ALL

   152

}

   153

};

   154

   155

uint GetRailFoundation(Slope tileh, TrackBits bits)

   156

{

   157

	uint i;

   158

   159

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

   160

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

   161

   162

	switch (bits) {

   163

		case TRACK_BIT_X: i = 0; break;

   164

		case TRACK_BIT_Y: i = 1; break;

   165

		default:          return 0;

   166

	}

   167

	switch (tileh) {

   168

		case SLOPE_W: i += 0; break;

   169

		case SLOPE_S: i += 2; break;

   170

		case SLOPE_E: i += 4; break;

   171

		case SLOPE_N: i += 6; break;

   172

		default:      return 0;

   173

	}

   174

	return i + 15;

   175

}

   176

   177

   178

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

   179

{

   180

	// never allow building on top of steep tiles

   181

	if (!IsSteepSlope(tileh)) {

   182

		rail_bits |= existing;

   183

   184

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

   185

		if (IsTileType(tile, MP_WATER) &&

   186

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

   187

			return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   188

		}

   189

   190

		// no special foundation

   191

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

   192

			return 0;

   193

   194

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

   195

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

   196

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

   197

				)) { // partly up

   198

			if (existing != 0) {

   199

				return 0;

   200

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

   201

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   202

			} else {

   203

				return _price.terraform;

   204

			}

   205

		}

   206

	}

   207

	return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   208

}

   209

   210

/* Validate functions for rail building */

   211

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

   212

   213

/** Build a single piece of rail

   214

 * @param tile tile  to build on

   215

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

   216

 * @param p2 rail track to build

   217

 */

   218

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

   219

{

   220

	Slope tileh;

   221

	Track track = (Track)p2;

   222

	TrackBits trackbit;

   223

	int32 cost = 0;

   224

	int32 ret;

   225

   226

	if (!ValParamRailtype(p1) || !ValParamTrackOrientation(track)) return CMD_ERROR;

   227

   228

	tileh = GetTileSlope(tile, NULL);

   229

	trackbit = TrackToTrackBits(track);

   230

   231

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   232

   233

	switch (GetTileType(tile)) {

   234

		case MP_RAILWAY:

   235

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

   236

					!EnsureNoVehicle(tile)) {

   237

				return CMD_ERROR;

   238

			}

   239

			if (GetRailTileType(tile) == RAIL_TILE_DEPOT_WAYPOINT ||

   240

					!IsTileOwner(tile, _current_player) ||

   241

					GetRailType(tile) != p1) {

   242

				// Get detailed error message

   243

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

   244

			}

   245

   246

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

   247

			if (CmdFailed(ret)) return ret;

   248

			cost += ret;

   249

   250

			if (flags & DC_EXEC) {

   251

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   252

				_m[tile].m5 |= trackbit;

   253

			}

   254

			break;

   255

   256

		case MP_STREET:

   257

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

   258

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

   259

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

   260

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   261

			}

   262

#undef M

   263

   264

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   265

   266

			if (GetRoadTileType(tile) == ROAD_TILE_NORMAL && (

   267

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

   268

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

   269

					)) {

   270

				if (flags & DC_EXEC) {

   271

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

   272

				}

   273

				break;

   274

			}

   275

   276

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

   277

				return_cmd_error(STR_1007_ALREADY_BUILT);

   278

			}

   279

			/* FALLTHROUGH */

   280

   281

		default:

   282

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

   283

			if (CmdFailed(ret)) return ret;

   284

			cost += ret;

   285

   286

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

   287

			if (CmdFailed(ret)) return ret;

   288

			cost += ret;

   289

   290

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

   291

			break;

   292

	}

   293

   294

	if (flags & DC_EXEC) {

   295

		MarkTileDirtyByTile(tile);

   296

		SetSignalsOnBothDir(tile, track);

   297

		YapfNotifyTrackLayoutChange(tile, track);

   298

	}

   299

   300

	return cost + _price.build_rail;

   301

}

   302

   303

/** Remove a single piece of track

   304

 * @param tile tile to remove track from

   305

 * @param p1 unused

   306

 * @param p2 rail orientation

   307

 */

   308

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

   309

{

   310

	Track track = (Track)p2;

   311

	TrackBits trackbit;

   312

	int32 cost = _price.remove_rail;

   313

	bool crossing = false;

   314

   315

	if (!ValParamTrackOrientation(p2)) return CMD_ERROR;

   316

	trackbit = TrackToTrackBits(track);

   317

   318

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   319

   320

	switch (GetTileType(tile)) {

   321

		case MP_STREET: {

   322

			if (!IsLevelCrossing(tile) ||

   323

					GetCrossingRailBits(tile) != trackbit ||

   324

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

   325

					!EnsureNoVehicle(tile)) {

   326

				return CMD_ERROR;

   327

			}

   328

   329

			if (flags & DC_EXEC) {

   330

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

   331

			}

   332

			break;

   333

		}

   334

   335

		case MP_RAILWAY: {

   336

			TrackBits present;

   337

   338

			if (!IsPlainRailTile(tile) ||

   339

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

   340

					!EnsureNoVehicle(tile)) {

   341

				return CMD_ERROR;

   342

			}

   343

   344

			present = GetTrackBits(tile);

   345

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

   346

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

   347

   348

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

   349

			if (HasSignalOnTrack(tile, track))

   350

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

   351

   352

			if (flags & DC_EXEC) {

   353

				present ^= trackbit;

   354

				if (present == 0) {

   355

					DoClearSquare(tile);

   356

				} else {

   357

					SetTrackBits(tile, present);

   358

				}

   359

			}

   360

			break;

   361

		}

   362

   363

		default: return CMD_ERROR;

   364

	}

   365

   366

	if (flags & DC_EXEC) {

   367

		MarkTileDirtyByTile(tile);

   368

		if (crossing) {

   369

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

   370

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

   371

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

   372

			 * 'connect' with the other piece. */

   373

			SetSignalsOnBothDir(tile, TRACK_X);

   374

			SetSignalsOnBothDir(tile, TRACK_Y);

   375

			YapfNotifyTrackLayoutChange(tile, TRACK_X);

   376

			YapfNotifyTrackLayoutChange(tile, TRACK_Y);

   377

		} else {

   378

			SetSignalsOnBothDir(tile, track);

   379

			YapfNotifyTrackLayoutChange(tile, track);

   380

		}

   381

	}

   382

   383

	return cost;

   384

}

   385

   386

   387

static const TileIndexDiffC _trackdelta[] = {

   388

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

   389

	{  0,  0 },

   390

	{  0,  0 },

   391

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

   392

	{  0,  0 },

   393

	{  0,  0 }

   394

};

   395

   396

   397

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

   398

{

   399

	int x = TileX(start);

   400

	int y = TileY(start);

   401

	int ex = TileX(end);

   402

	int ey = TileY(end);

   403

	int dx, dy, trdx, trdy;

   404

   405

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

   406

   407

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

   408

	dx = ex - x;

   409

	dy = ey - y;

   410

   411

	// calculate delta x,y for the first direction

   412

	trdx = _trackdelta[*trackdir].x;

   413

	trdy = _trackdelta[*trackdir].y;

   414

   415

	if (!IsDiagonalTrackdir(*trackdir)) {

   416

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

   417

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

   418

	}

   419

   420

	// validate the direction

   421

	while (

   422

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

   423

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

   424

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

   425

		(trdy >= 0 && dy < 0)

   426

	) {

   427

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

   428

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

   429

			trdx = -trdx;

   430

			trdy = -trdy;

   431

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

   432

			return CMD_ERROR;

   433

	}

   434

   435

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

   436

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

   437

	if (!IsDiagonalTrackdir(*trackdir)) {

   438

		trdx = _trackdelta[*trackdir].x;

   439

		trdy = _trackdelta[*trackdir].y;

   440

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

   441

			return CMD_ERROR;

   442

	}

   443

   444

	return 0;

   445

}

   446

   447

/** Build a stretch of railroad tracks.

   448

 * @param tile start tile of drag

   449

 * @param p1 end tile of drag

   450

 * @param p2 various bitstuffed elements

   451

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

   452

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

   453

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

   454

 */

   455

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

   456

{

   457

	int32 ret, total_cost = 0;

   458

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

   459

	Trackdir trackdir;

   460

	byte mode = HASBIT(p2, 7);

   461

	RailType railtype = (RailType)GB(p2, 0, 4);

   462

	TileIndex end_tile;

   463

   464

	if (!ValParamRailtype(railtype) || !ValParamTrackOrientation(track)) return CMD_ERROR;

   465

	if (p1 >= MapSize()) return CMD_ERROR;

   466

	end_tile = p1;

   467

	trackdir = TrackToTrackdir(track);

   468

   469

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   470

   471

	if (CmdFailed(ValidateAutoDrag(&trackdir, tile, end_tile))) return CMD_ERROR;

   472

   473

	if (flags & DC_EXEC) SndPlayTileFx(SND_20_SPLAT_2, tile);

   474

   475

	for (;;) {

   476

		ret = DoCommand(tile, railtype, TrackdirToTrack(trackdir), flags, (mode == 0) ? CMD_BUILD_SINGLE_RAIL : CMD_REMOVE_SINGLE_RAIL);

   477

   478

		if (CmdFailed(ret)) {

   479

			if ((_error_message != STR_1007_ALREADY_BUILT) && (mode == 0)) break;

   480

			_error_message = INVALID_STRING_ID;

   481

		} else

   482

			total_cost += ret;

   483

   484

		if (tile == end_tile) break;

   485

   486

		tile += ToTileIndexDiff(_trackdelta[trackdir]);