1

/* $Id$ */

     2

     3

/** @file tunnelbridge_cmd.c

     4

 * This file deals with tunnels and bridges (non-gui stuff)

     5

 * @todo seperate this file into two

     6

 */

     7

     8

#include "stdafx.h"

     9

#include "openttd.h"

    10

#include "bridge_map.h"

    11

#include "rail_map.h"

    12

#include "road_map.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "functions.h"

    16

#include "map.h"

    17

#include "tile.h"

    18

#include "tunnel_map.h"

    19

#include "vehicle.h"

    20

#include "viewport.h"

    21

#include "command.h"

    22

#include "player.h"

    23

#include "town.h"

    24

#include "sound.h"

    25

#include "variables.h"

    26

#include "bridge.h"

    27

#include "train.h"

    28

#include "water_map.h"

    29

#include "yapf/yapf.h"

    30

#include "date.h"

    31

#include "newgrf_sound.h"

    32

    33

#include "table/bridge_land.h"

    34

    35

extern const byte _track_sloped_sprites[14];

    36

extern const SpriteID _water_shore_sprites[15];

    37

    38

extern void DrawCanalWater(TileIndex tile);

    39

    40

const Bridge orig_bridge[] = {

    41

/*

    42

	     year of availablity

    43

	     |  minimum length

    44

	     |  |   maximum length

    45

	     |  |   |    price

    46

	     |  |   |    |    maximum speed

    47

	     |  |   |    |    |  sprite to use in GUI                string with description

    48

	     |  |   |    |    |  |                                   |                            */

    49

	{    0, 0, 16,  80,  32, 0xA24                             , STR_5012_WOODEN             , NULL, 0 },

    50

	{    0, 0,  2, 112,  48, 0xA26 | PALETTE_TO_STRUCT_RED     , STR_5013_CONCRETE           , NULL, 0 },

    51

	{ 1930, 0,  5, 144,  64, 0xA25                             , STR_500F_GIRDER_STEEL       , NULL, 0 },

    52

	{    0, 2, 10, 168,  80, 0xA22 | PALETTE_TO_STRUCT_CONCRETE, STR_5011_SUSPENSION_CONCRETE, NULL, 0 },

    53

	{ 1930, 3, 16, 185,  96, 0xA22                             , STR_500E_SUSPENSION_STEEL   , NULL, 0 },

    54

	{ 1930, 3, 16, 192, 112, 0xA22 | PALETTE_TO_STRUCT_YELLOW  , STR_500E_SUSPENSION_STEEL   , NULL, 0 },

    55

	{ 1930, 3,  7, 224, 160, 0xA23                             , STR_5010_CANTILEVER_STEEL   , NULL, 0 },

    56

	{ 1930, 3,  8, 232, 208, 0xA23 | PALETTE_TO_STRUCT_BROWN   , STR_5010_CANTILEVER_STEEL   , NULL, 0 },

    57

	{ 1930, 3,  9, 248, 240, 0xA23 | PALETTE_TO_STRUCT_RED     , STR_5010_CANTILEVER_STEEL   , NULL, 0 },

    58

	{ 1930, 0,  2, 240, 256, 0xA27                             , STR_500F_GIRDER_STEEL       , NULL, 0 },

    59

	{ 1995, 2, 16, 255, 320, 0xA28                             , STR_5014_TUBULAR_STEEL      , NULL, 0 },

    60

	{ 2005, 2, 32, 380, 512, 0xA28 | PALETTE_TO_STRUCT_YELLOW  , STR_5014_TUBULAR_STEEL      , NULL, 0 },

    61

	{ 2010, 2, 32, 510, 608, 0xA28 | PALETTE_TO_STRUCT_GREY    , STR_BRIDGE_TUBULAR_SILICON  , NULL, 0 }

    62

};

    63

    64

Bridge _bridge[MAX_BRIDGES];

    65

    66

    67

// calculate the price factor for building a long bridge.

    68

// basically the cost delta is 1,1, 1, 2,2, 3,3,3, 4,4,4,4, 5,5,5,5,5, 6,6,6,6,6,6,  7,7,7,7,7,7,7,  8,8,8,8,8,8,8,8,

    69

int CalcBridgeLenCostFactor(int x)

    70

{

    71

	int n;

    72

	int r;

    73

    74

	if (x < 2) return x;

    75

	x -= 2;

    76

	for (n = 0, r = 2;; n++) {

    77

		if (x <= n) return r + x * n;

    78

		r += n * n;

    79

		x -= n;

    80

	}

    81

}

    82

    83

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

    84

enum {

    85

	// foundation, whole tile is leveled up --> 3 corners raised

    86

	BRIDGE_FULL_LEVELED_FOUNDATION = M(SLOPE_WSE) | M(SLOPE_NWS) | M(SLOPE_ENW) | M(SLOPE_SEN),

    87

	// foundation, tile is partly leveled up --> 1 corner raised

    88

	BRIDGE_PARTLY_LEVELED_FOUNDATION = M(SLOPE_W) | M(SLOPE_S) | M(SLOPE_E) | M(SLOPE_N),

    89

	// no foundations (X,Y direction)

    90

	BRIDGE_NO_FOUNDATION = M(SLOPE_FLAT) | M(SLOPE_SW) | M(SLOPE_SE) | M(SLOPE_NW) | M(SLOPE_NE),

    91

	BRIDGE_HORZ_RAMP = (BRIDGE_PARTLY_LEVELED_FOUNDATION | BRIDGE_NO_FOUNDATION) & ~M(SLOPE_FLAT)

    92

};

    93

#undef M

    94

    95

static inline const PalSpriteID *GetBridgeSpriteTable(int index, byte table)

    96

{

    97

	const Bridge *bridge = &_bridge[index];

    98

	assert(table < 7);

    99

	if (bridge->sprite_table == NULL || bridge->sprite_table[table] == NULL) {

   100

		return _bridge_sprite_table[index][table];

   101

	} else {

   102

		return bridge->sprite_table[table];

   103

	}

   104

}

   105

   106

static inline byte GetBridgeFlags(int index) { return _bridge[index].flags;}

   107

   108

   109

/** Check the slope at the bridge ramps in three easy steps:

   110

 * - valid slopes without foundation

   111

 * - valid slopes with foundation

   112

 * - rest is invalid

   113

 */

   114

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

   115

static int32 CheckBridgeSlopeNorth(Axis axis, Slope tileh)

   116

{

   117

	uint32 valid;

   118

   119

	valid = M(SLOPE_FLAT) | (axis == AXIS_X ? M(SLOPE_NE) : M(SLOPE_NW));

   120

	if (HASBIT(valid, tileh)) return 0;

   121

   122

	valid =

   123

		BRIDGE_FULL_LEVELED_FOUNDATION | M(SLOPE_N) | M(SLOPE_STEEP_N) |

   124

		(axis == AXIS_X ? M(SLOPE_E) | M(SLOPE_STEEP_E) : M(SLOPE_W) | M(SLOPE_STEEP_W));

   125

	if (HASBIT(valid, tileh)) return _price.terraform;

   126

   127

	return CMD_ERROR;

   128

}

   129

   130

static int32 CheckBridgeSlopeSouth(Axis axis, Slope tileh)

   131

{

   132

	uint32 valid;

   133

   134

	valid = M(SLOPE_FLAT) | (axis == AXIS_X ? M(SLOPE_SW) : M(SLOPE_SE));

   135

	if (HASBIT(valid, tileh)) return 0;

   136

   137

	valid =

   138

		BRIDGE_FULL_LEVELED_FOUNDATION | M(SLOPE_S) | M(SLOPE_STEEP_S) |

   139

		(axis == AXIS_X ? M(SLOPE_W) | M(SLOPE_STEEP_W) : M(SLOPE_E) | M(SLOPE_STEEP_E));

   140

	if (HASBIT(valid, tileh)) return _price.terraform;

   141

   142

	return CMD_ERROR;

   143

}

   144

#undef M

   145

   146

   147

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   148

{

   149

	int x1 = TileX(begin);

   150

	int y1 = TileY(begin);

   151

	int x2 = TileX(end);

   152

	int y2 = TileY(end);

   153

   154

	return abs(x2 + y2 - x1 - y1) - 1;

   155

}

   156

   157

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   158

{

   159

	const Bridge *b = &_bridge[bridge_type];

   160

	uint max; // max possible length of a bridge (with patch 100)

   161

   162

	if (bridge_type >= MAX_BRIDGES) return false;

   163

	if (b->avail_year > _cur_year) return false;

   164

   165

	max = b->max_length;

   166

	if (max >= 16 && _patches.longbridges) max = 100;

   167

   168

	return b->min_length <= bridge_len && bridge_len <= max;

   169

}

   170

   171

/** Build a Bridge

   172

 * @param end_tile end tile

   173

 * @param p1 packed start tile coords (~ dx)

   174

 * @param p2 various bitstuffed elements

   175

 * - p2 = (bit 0- 7) - bridge type (hi bh)

   176

 * - p2 = (bit 8-..) - rail type. bit15 ((x>>8)&0x80) means road bridge.

   177

 */

   178

int32 CmdBuildBridge(TileIndex end_tile, uint32 flags, uint32 p1, uint32 p2)

   179

{

   180

	int bridge_type;

   181

	TransportType transport;

   182

	RailType railtype;

   183

	uint x;

   184

	uint y;

   185

	uint sx;

   186

	uint sy;

   187

	TileIndex tile_start;

   188

	TileIndex tile_end;

   189

	Slope tileh_start;

   190

	Slope tileh_end;

   191

	uint z_start;

   192

	uint z_end;

   193

	TileIndex tile;

   194

	TileIndexDiff delta;

   195

	uint bridge_len;

   196

	uint odd_middle_part;

   197

	Axis direction;

   198

	uint i;

   199

	int32 cost, terraformcost, ret;

   200

	bool allow_on_slopes;

   201

   202

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   203

   204

	/* unpack parameters */

   205

	bridge_type = GB(p2, 0, 8);

   206

   207

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

   208

   209

	// type of bridge

   210

	if (HASBIT(p2, 15)) {

   211

		railtype = 0;

   212

		transport = TRANSPORT_ROAD;

   213

	} else {

   214

		if (!ValParamRailtype(GB(p2, 8, 8))) return CMD_ERROR;

   215

		railtype = GB(p2, 8, 8);

   216

		transport = TRANSPORT_RAIL;

   217

	}

   218

   219

	x = TileX(end_tile);

   220

	y = TileY(end_tile);

   221

	sx = TileX(p1);

   222

	sy = TileY(p1);

   223

   224

	/* check if valid, and make sure that (x,y) are smaller than (sx,sy) */

   225

	if (x == sx) {

   226

		if (y == sy) return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   227

		direction = AXIS_Y;

   228

		if (y > sy) uintswap(y,sy);

   229

	} else if (y == sy) {

   230

		direction = AXIS_X;

   231

		if (x > sx) uintswap(x,sx);

   232

	} else {

   233

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   234

	}

   235

   236

	/* set and test bridge length, availability */

   237

	bridge_len = sx + sy - x - y - 1;

   238

	if (!CheckBridge_Stuff(bridge_type, bridge_len)) return_cmd_error(STR_5015_CAN_T_BUILD_BRIDGE_HERE);

   239

   240

	/* retrieve landscape height and ensure it's on land */

   241

	tile_start = TileXY(x, y);

   242

	tile_end = TileXY(sx, sy);

   243

	if (IsClearWaterTile(tile_start) || IsClearWaterTile(tile_end)) {

   244

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   245

	}

   246

   247

	tileh_start = GetTileSlope(tile_start, &z_start);

   248

	tileh_end = GetTileSlope(tile_end, &z_end);

   249

   250

	if (IsSteepSlope(tileh_start)) z_start += TILE_HEIGHT;

   251

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   252

		z_start += TILE_HEIGHT;

   253

		tileh_start = SLOPE_FLAT;

   254

	}

   255

   256

	if (IsSteepSlope(tileh_end)) z_end += TILE_HEIGHT;

   257

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   258

		z_end += TILE_HEIGHT;

   259

		tileh_end = SLOPE_FLAT;

   260

	}

   261

   262

	if (z_start != z_end) return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   263

   264

	// Towns are not allowed to use bridges on slopes.

   265

	allow_on_slopes = (!_is_old_ai_player

   266

	                   && _current_player != OWNER_TOWN && _patches.build_on_slopes);

   267

   268

	/* Try and clear the start landscape */

   269

   270

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

   271

	if (CmdFailed(ret)) return ret;

   272

	cost = ret;

   273

   274

	terraformcost = CheckBridgeSlopeNorth(direction, tileh_start);

   275

	if (CmdFailed(terraformcost) || (terraformcost != 0 && !allow_on_slopes))

   276

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   277

	cost += terraformcost;

   278

   279

	/* Try and clear the end landscape */

   280

   281

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

   282

	if (CmdFailed(ret)) return ret;

   283

	cost += ret;

   284

   285

	// false - end tile slope check

   286

	terraformcost = CheckBridgeSlopeSouth(direction, tileh_end);

   287

	if (CmdFailed(terraformcost) || (terraformcost != 0 && !allow_on_slopes))

   288

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   289

	cost += terraformcost;

   290

   291

   292

	/* do the drill? */

   293

	if (flags & DC_EXEC) {

   294

		DiagDirection dir = AxisToDiagDir(direction);

   295

   296

		if (transport == TRANSPORT_RAIL) {

   297

			MakeRailBridgeRamp(tile_start, _current_player, bridge_type, dir, railtype);

   298

			MakeRailBridgeRamp(tile_end,   _current_player, bridge_type, ReverseDiagDir(dir), railtype);

   299

		} else {

   300

			MakeRoadBridgeRamp(tile_start, _current_player, bridge_type, dir);

   301

			MakeRoadBridgeRamp(tile_end,   _current_player, bridge_type, ReverseDiagDir(dir));

   302

		}

   303

		MarkTileDirtyByTile(tile_start);

   304

		MarkTileDirtyByTile(tile_end);

   305

	}

   306

   307

	// position of middle part of the odd bridge (larger than MAX(i) otherwise)

   308

	odd_middle_part = (bridge_len % 2) ? (bridge_len / 2) : bridge_len;

   309

   310

	tile = tile_start;

   311

	delta = (direction == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));

   312

	for (i = 0; i != bridge_len; i++) {

   313

		TransportType transport_under;

   314

		Owner owner_under = OWNER_NONE;

   315

		RailType rail_under = INVALID_RAILTYPE;

   316

		uint z;

   317

   318

		tile += delta;

   319

   320

		if (GetTileSlope(tile, &z) != SLOPE_FLAT && z >= z_start) {

   321

			return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   322

		}

   323

   324

		switch (GetTileType(tile)) {

   325

			case MP_WATER:

   326

				if (!EnsureNoVehicle(tile)) return_cmd_error(STR_980E_SHIP_IN_THE_WAY);

   327

				if (!IsWater(tile) && !IsCoast(tile)) goto not_valid_below;

   328

				transport_under = TRANSPORT_WATER;

   329

				owner_under = GetTileOwner(tile);

   330

				break;

   331

   332

			case MP_RAILWAY:

   333

				if (GetRailTileType(tile) != RAIL_TILE_NORMAL ||

   334

						GetTrackBits(tile) != AxisToTrackBits(OtherAxis(direction))) {

   335

					goto not_valid_below;

   336

				}

   337

				transport_under = TRANSPORT_RAIL;

   338

				owner_under = GetTileOwner(tile);

   339

				rail_under = GetRailType(tile);

   340

				break;

   341

   342

			case MP_STREET:

   343

				if (GetRoadTileType(tile) != ROAD_TILE_NORMAL) goto not_valid_below;

   344

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

   345

				if (GetRoadBits(tile) != (direction == AXIS_X ? ROAD_Y : ROAD_X)) {

   346

					goto not_valid_below;

   347

				}

   348

				transport_under = TRANSPORT_ROAD;

   349

				owner_under = GetTileOwner(tile);

   350

				break;

   351

   352

			default:

   353

not_valid_below:;

   354

				/* try and clear the middle landscape */

   355

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

   356

				if (CmdFailed(ret)) return ret;

   357

				cost += ret;

   358

				transport_under = INVALID_TRANSPORT;

   359

				break;

   360

		}

   361

   362

		if (flags & DC_EXEC) {

   363

			uint piece;

   364

   365

			//bridges pieces sequence (middle parts)

   366

			// bridge len 1: 0

   367

			// bridge len 2: 0 1

   368

			// bridge len 3: 0 4 1

   369

			// bridge len 4: 0 2 3 1

   370

			// bridge len 5: 0 2 5 3 1

   371

			// bridge len 6: 0 2 3 2 3 1

   372

			// bridge len 7: 0 2 3 4 2 3 1

   373

			// #0 - always as first, #1 - always as last (if len>1)

   374

			// #2,#3 are to pair in order

   375

			// for odd bridges: #5 is going in the bridge middle if on even position, #4 on odd (counting from 0)

   376

   377

			if (i == 0) { // first tile

   378

				piece = 0;

   379

			} else if (i == bridge_len - 1) { // last tile

   380

				piece = 1;

   381

			} else if (i == odd_middle_part) { // we are on the middle of odd bridge: #5 on even pos, #4 on odd

   382

				piece = 5 - (i % 2);

   383

			} else {

   384

					// generate #2 and #3 in turns [i%2==0], after the middle of odd bridge

   385

					// this sequence swaps [... XOR (i>odd_middle_part)],

   386

					// for even bridges XOR does not apply as odd_middle_part==bridge_len

   387

					piece = 2 + ((i % 2 == 0) ^ (i > odd_middle_part));

   388

			}

   389

   390

			if (transport == TRANSPORT_RAIL) {

   391

				MakeRailBridgeMiddle(tile, bridge_type, piece, direction, railtype);

   392

			} else {

   393

				MakeRoadBridgeMiddle(tile, bridge_type, piece, direction);

   394

			}

   395

			switch (transport_under) {

   396

				case TRANSPORT_RAIL: SetRailUnderBridge(tile, owner_under, rail_under); break;

   397

				case TRANSPORT_ROAD: SetRoadUnderBridge(tile, owner_under); break;

   398

   399

				case TRANSPORT_WATER:

   400

					if (owner_under == OWNER_WATER) {

   401

						SetWaterUnderBridge(tile);

   402

					} else {

   403

						SetCanalUnderBridge(tile, owner_under);

   404

					}

   405

					break;

   406

   407

				default: SetClearUnderBridge(tile); break;

   408

			}

   409

   410

			MarkTileDirtyByTile(tile);

   411

		}

   412

	}

   413

   414

	if (flags & DC_EXEC) {

   415

		Axis axis = AxisToTrack(direction);

   416

		SetSignalsOnBothDir(tile_start, axis);

   417

		YapfNotifyTrackLayoutChange(tile_start, axis);

   418

	}

   419

   420

	/* for human player that builds the bridge he gets a selection to choose from bridges (DC_QUERY_COST)

   421

	 * It's unnecessary to execute this command every time for every bridge. So it is done only

   422

	 * and cost is computed in "bridge_gui.c". For AI, Towns this has to be of course calculated

   423

	 */

   424

	if (!(flags & DC_QUERY_COST)) {

   425

		const Bridge *b = &_bridge[bridge_type];

   426

   427

		bridge_len += 2; // begin and end tiles/ramps

   428

   429

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   430

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   431

   432

		cost += (int64)bridge_len * _price.build_bridge * b->price >> 8;

   433

	}

   434

   435

	return cost;

   436

}

   437

   438

   439

/** Build Tunnel.

   440

 * @param tile start tile of tunnel

   441

 * @param p1 railtype, 0x200 for road tunnel

   442

 * @param p2 unused

   443

 */

   444

int32 CmdBuildTunnel(TileIndex start_tile, uint32 flags, uint32 p1, uint32 p2)

   445

{

   446

	TileIndexDiff delta;

   447

	TileIndex end_tile;

   448

	DiagDirection direction;

   449

	Slope start_tileh;

   450

	Slope end_tileh;

   451

	uint start_z;

   452

	uint end_z;

   453

	int32 cost;

   454

	int32 ret;

   455

	DiagDirection tunnel_in_way_dir;

   456

   457

	_build_tunnel_endtile = 0;

   458

   459

	if (p1 != 0x200 && !ValParamRailtype(p1)) return CMD_ERROR;

   460

   461

	start_tileh = GetTileSlope(start_tile, &start_z);

   462

   463

	switch (start_tileh) {

   464

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   465

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   466

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   467

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   468

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   469

	}

   470

   471

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

   472

	if (CmdFailed(ret)) return ret;

   473

   474

	/* XXX - do NOT change 'ret' in the loop, as it is used as the price

   475

	 * for the clearing of the entrance of the tunnel. Assigning it to

   476

	 * cost before the loop will yield different costs depending on start-

   477

	 * position, because of increased-cost-by-length: 'cost += cost >> 3' */

   478

	cost = 0;

   479

	delta = TileOffsByDiagDir(direction);

   480

	if (OtherAxis(DiagDirToAxis(direction)) == AXIS_X) {

   481

		tunnel_in_way_dir = (TileX(start_tile) < (MapMaxX() / 2)) ? DIAGDIR_SW : DIAGDIR_NE;

   482

	} else {

   483

		tunnel_in_way_dir = (TileY(start_tile) < (MapMaxX() / 2)) ? DIAGDIR_SE : DIAGDIR_NW;

   484

	}

   485

   486

	end_tile = start_tile;

   487

	for (;;) {

   488

		end_tile += delta;