1

/* $Id$ */

     2

     3

/** @file tunnelbridge_cmd.cpp

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

    20

#include "vehicle.h"

    21

#include "viewport.h"

    22

#include "command.h"

    23

#include "player.h"

    24

#include "town.h"

    25

#include "sound.h"

    26

#include "variables.h"

    27

#include "bridge.h"

    28

#include "train.h"

    29

#include "water_map.h"

    30

#include "yapf/yapf.h"

    31

#include "date.h"

    32

#include "newgrf_sound.h"

    33

    34

#include "table/bridge_land.h"

    35

    36

const Bridge orig_bridge[] = {

    37

/*

    38

	     year of availablity

    39

	     |  minimum length

    40

	     |  |   maximum length

    41

	     |  |   |    price

    42

	     |  |   |    |    maximum speed

    43

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

    44

	     |  |   |    |    |  |                                   |                            */

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

};

    59

    60

Bridge _bridge[MAX_BRIDGES];

    61

    62

    63

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

    64

// 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,

    65

int CalcBridgeLenCostFactor(int x)

    66

{

    67

	int n;

    68

	int r;

    69

    70

	if (x < 2) return x;

    71

	x -= 2;

    72

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

    73

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

    74

		r += n * n;

    75

		x -= n;

    76

	}

    77

}

    78

    79

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

    80

enum BridgeFoundation {

    81

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

    82

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

    83

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

    84

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

    85

	// no foundations (X,Y direction)

    86

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

    87

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

    88

};

    89

#undef M

    90

    91

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

    92

{

    93

	const Bridge *bridge = &_bridge[index];

    94

	assert(table < 7);

    95

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

    96

		return _bridge_sprite_table[index][table];

    97

	} else {

    98

		return bridge->sprite_table[table];

    99

	}

   100

}

   101

   102

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

   103

   104

   105

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

   106

 * - valid slopes without foundation

   107

 * - valid slopes with foundation

   108

 * - rest is invalid

   109

 */

   110

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

   111

static int32 CheckBridgeSlopeNorth(Axis axis, Slope tileh)

   112

{

   113

	uint32 valid;

   114

   115

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

   116

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

   117

   118

	valid =

   119

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

   120

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

   121

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

   122

   123

	return CMD_ERROR;

   124

}

   125

   126

static int32 CheckBridgeSlopeSouth(Axis axis, Slope tileh)

   127

{

   128

	uint32 valid;

   129

   130

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

   131

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

   132

   133

	valid =

   134

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

   135

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

   136

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

   137

   138

	return CMD_ERROR;

   139

}

   140

#undef M

   141

   142

   143

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   144

{

   145

	int x1 = TileX(begin);

   146

	int y1 = TileY(begin);

   147

	int x2 = TileX(end);

   148

	int y2 = TileY(end);

   149

   150

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

   151

}

   152

   153

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   154

{

   155

	const Bridge *b = &_bridge[bridge_type];

   156

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

   157

   158

	if (bridge_type >= MAX_BRIDGES) return false;

   159

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

   160

   161

	max = b->max_length;

   162

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

   163

   164

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

   165

}

   166

   167

/** Build a Bridge

   168

 * @param end_tile end tile

   169

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

   170

 * @param p2 various bitstuffed elements

   171

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

   172

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

   173

 */

   174

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

   175

{

   176

	uint bridge_type;

   177

	RailType railtype;

   178

	uint x;

   179

	uint y;

   180

	uint sx;

   181

	uint sy;

   182

	TileIndex tile_start;

   183

	TileIndex tile_end;

   184

	Slope tileh_start;

   185

	Slope tileh_end;

   186

	uint z_start;

   187

	uint z_end;

   188

	TileIndex tile;

   189

	TileIndexDiff delta;

   190

	uint bridge_len;

   191

	Axis direction;

   192

	int32 cost, terraformcost, ret;

   193

	bool allow_on_slopes;

   194

	bool replace_bridge = false;

   195

	uint replaced_bridge_type;

   196

   197

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   198

   199

	/* unpack parameters */

   200

	bridge_type = GB(p2, 0, 8);

   201

   202

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

   203

   204

	// type of bridge

   205

	if (HASBIT(p2, 15)) {

   206

		railtype = INVALID_RAILTYPE; // road bridge

   207

	} else {

   208

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

   209

		railtype = (RailType)GB(p2, 8, 8);

   210

	}

   211

   212

	x = TileX(end_tile);

   213

	y = TileY(end_tile);

   214

	sx = TileX(p1);

   215

	sy = TileY(p1);

   216

   217

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

   218

	if (x == sx) {

   219

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

   220

		direction = AXIS_Y;

   221

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

   222

	} else if (y == sy) {

   223

		direction = AXIS_X;

   224

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

   225

	} else {

   226

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   227

	}

   228

   229

	/* set and test bridge length, availability */

   230

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

   231

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

   232

   233

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

   234

	tile_start = TileXY(x, y);

   235

	tile_end = TileXY(sx, sy);

   236

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

   237

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   238

	}

   239

   240

	tileh_start = GetTileSlope(tile_start, &z_start);

   241

	tileh_end = GetTileSlope(tile_end, &z_end);

   242

   243

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

   244

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   245

		z_start += TILE_HEIGHT;

   246

		tileh_start = SLOPE_FLAT;

   247

	}

   248

   249

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

   250

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   251

		z_end += TILE_HEIGHT;

   252

		tileh_end = SLOPE_FLAT;

   253

	}

   254

   255

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

   256

   257

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

   259

   260

	TransportType transport_type = railtype == INVALID_RAILTYPE ? TRANSPORT_ROAD : TRANSPORT_RAIL;

   261

   262

	if (IsBridgeTile(tile_start) && IsBridgeTile(tile_end) &&

   263

			GetOtherBridgeEnd(tile_start) == tile_end &&

   264

			GetBridgeTransportType(tile_start) == transport_type) {

   265

		/* Replace a current bridge. */

   266

   267

		/* If this is a railway bridge, make sure the railtypes match. */

   268

		if (transport_type == TRANSPORT_RAIL && GetRailType(tile_start) != railtype) {

   269

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   270

		}

   271

   272

		/* Do not replace town bridges with lower speed bridges. */

   273

		if (!(flags & DC_QUERY_COST) && IsTileOwner(tile_start, OWNER_TOWN) &&

   274

				_bridge[bridge_type].speed < _bridge[GetBridgeType(tile_start)].speed) {

   275

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   276

   277

			if (t == NULL) {

   278

				return CMD_ERROR;

   279

			} else {

   280

				SetDParam(0, t->index);

   281

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   282

			}

   283

		}

   284

   285

		/* Do not replace the bridge with the same bridge type. */

   286

		if (!(flags & DC_QUERY_COST) && bridge_type == GetBridgeType(tile_start)) {

   287

			return_cmd_error(STR_1007_ALREADY_BUILT);

   288

		}

   289

   290

		/* Do not allow replacing another player's bridges. */

   291

		if (!IsTileOwner(tile_start, _current_player) && !IsTileOwner(tile_start, OWNER_TOWN)) {

   292

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   293

		}

   294

   295

		cost = (bridge_len + 1) * _price.clear_bridge; // The cost of clearing the current bridge.

   296

		replace_bridge = true;

   297

		replaced_bridge_type = GetBridgeType(tile_start);

   298

	} else {

   299

		/* Build a new bridge. */

   300

   301

		/* Try and clear the start landscape */

   302

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

   303

		if (CmdFailed(ret)) return ret;

   304

		cost = ret;

   305

   306

		terraformcost = CheckBridgeSlopeNorth(direction, tileh_start);

   307

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

   308

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   309

		cost += terraformcost;

   310

   311

		/* Try and clear the end landscape */

   312

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

   313

		if (CmdFailed(ret)) return ret;

   314

		cost += ret;

   315

   316

		// false - end tile slope check

   317

		terraformcost = CheckBridgeSlopeSouth(direction, tileh_end);

   318

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

   319

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   320

		cost += terraformcost;

   321

	}

   322

   323

	if (!replace_bridge) {

   324

		TileIndex Heads[] = {tile_start, tile_end};

   325

		int i;

   326

   327

		for (i = 0; i < 2; i++) {

   328

			if (MayHaveBridgeAbove(Heads[i])) {

   329

				if (IsBridgeAbove(Heads[i])) {

   330

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   331

   332

					if (direction == GetBridgeAxis(Heads[i])) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   333

   334

					if (z_start + TILE_HEIGHT == GetBridgeHeight(north_head)) {

   335

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   336

					}

   337

				}

   338

			}

   339

		}

   340

	}

   341

   342

	/* do the drill? */

   343

	if (flags & DC_EXEC) {

   344

		DiagDirection dir = AxisToDiagDir(direction);

   345

		Owner owner = (replace_bridge && IsTileOwner(tile_start, OWNER_TOWN)) ? OWNER_TOWN : _current_player;

   346

   347

		if (railtype != INVALID_RAILTYPE) {

   348

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

   349

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

   350

		} else {

   351

			MakeRoadBridgeRamp(tile_start, owner, bridge_type, dir);

   352

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

   353

		}

   354

		MarkTileDirtyByTile(tile_start);

   355

		MarkTileDirtyByTile(tile_end);

   356

	}

   357

   358

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

   359

	for (tile = tile_start + delta; tile != tile_end; tile += delta) {

   360

		uint z;

   361

   362

		if (GetTileSlope(tile, &z) != SLOPE_FLAT && z >= z_start) return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   363

   364

		if (MayHaveBridgeAbove(tile) && IsBridgeAbove(tile) && !replace_bridge) {

   365

			/* Disallow crossing bridges for the time being */

   366

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   367

		}

   368

   369

		switch (GetTileType(tile)) {

   370

			case MP_WATER:

   371

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

   372

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

   373

				break;

   374

   375

			case MP_RAILWAY:

   376

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   377

				break;

   378

   379

			case MP_STREET:

   380

				if (GetRoadTileType(tile) == ROAD_TILE_DEPOT) goto not_valid_below;

   381

				break;

   382

   383

			case MP_TUNNELBRIDGE:

   384

				if (IsTunnel(tile)) break;

   385

				if (replace_bridge) break;

   386

				if (direction == DiagDirToAxis(GetBridgeRampDirection(tile))) goto not_valid_below;

   387

				if (z_start < GetBridgeHeight(tile)) goto not_valid_below;

   388

				break;

   389

   390

			case MP_UNMOVABLE:

   391

				if (!IsOwnedLand(tile)) goto not_valid_below;

   392

				break;

   393

   394

			case MP_CLEAR:

   395

				if (!replace_bridge && IsBridgeAbove(tile)) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   396

				break;

   397

   398

			default:

   399

not_valid_below:;

   400

				/* try and clear the middle landscape */

   401

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

   402

				if (CmdFailed(ret)) return ret;

   403

				cost += ret;

   404

				break;

   405

		}

   406

   407

		if (flags & DC_EXEC) {

   408

			SetBridgeMiddle(tile, direction);

   409

			MarkTileDirtyByTile(tile);

   410

		}

   411

	}

   412

   413

	if (flags & DC_EXEC) {

   414

		Track track = AxisToTrack(direction);

   415

		SetSignalsOnBothDir(tile_start, track);

   416

		YapfNotifyTrackLayoutChange(tile_start, track);

   417

	}

   418

   419

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

   420

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

   421

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

   422

	 */

   423

	if (!(flags & DC_QUERY_COST)) {

   424

		const Bridge *b = &_bridge[bridge_type];

   425

   426

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

   427

   429

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   430

   431

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

   432

	}

   433

   434

	return cost;

   435

}

   436

   437

   438

/** Build Tunnel.

   439

 * @param tile start tile of tunnel

   440

 * @param p1 railtype, 0x200 for road tunnel

   441

 * @param p2 unused

   442

 */

   443

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

   444

{

   445

	TileIndexDiff delta;

   446

	TileIndex end_tile;

   447

	DiagDirection direction;

   448

	Slope start_tileh;

   449

	Slope end_tileh;

   450

	uint start_z;

   451

	uint end_z;

   452

	int32 cost;

   453

	int32 ret;

   454

   455

	_build_tunnel_endtile = 0;

   456

   457

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

   458

   459

	start_tileh = GetTileSlope(start_tile, &start_z);

   460

   461

	switch (start_tileh) {

   462

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   463

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   464

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   465

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   466

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   467

	}

   468

   469

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

   470

	if (CmdFailed(ret)) return ret;

   471

   472

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

   473

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

   474

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

   475

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

   476

	cost = 0;

   477

	delta = TileOffsByDiagDir(direction);

   478

	end_tile = start_tile;

   479

	for (;;) {

   480

		end_tile += delta;

   481

		end_tileh = GetTileSlope(end_tile, &end_z);

   482

   483

		if (start_z == end_z) break;

   484

   485

		if (!_cheats.crossing_tunnels.value && IsTunnelInWay(end_tile, start_z)) {

   486

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

   487

		}