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 "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

	     |  |   |    |    |  |                                   |                            */

    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 {

    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

	int bridge_type;

   177

	TransportType transport;

   178

	RailType railtype;

   179

	uint x;

   180

	uint y;

   181

	uint sx;

   182

	uint sy;

   183

	TileIndex tile_start;

   184

	TileIndex tile_end;

   185

	Slope tileh_start;

   186

	Slope tileh_end;

   187

	uint z_start;

   188

	uint z_end;

   189

	TileIndex tile;

   190

	TileIndexDiff delta;

   191

	uint bridge_len;

   192

	Axis direction;

   193

	int32 cost, terraformcost, ret;

   194

	bool allow_on_slopes;

   195

   196

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   197

   198

	/* unpack parameters */

   199

	bridge_type = GB(p2, 0, 8);

   200

   201

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

   202

   203

	// type of bridge

   204

	if (HASBIT(p2, 15)) {

   205

		railtype = RAILTYPE_BEGIN; // ??

   206

		transport = TRANSPORT_ROAD;

   207

	} else {

   208

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

   209

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

   210

		transport = TRANSPORT_RAIL;

   211

	}

   212

   213

	x = TileX(end_tile);

   214

	y = TileY(end_tile);

   215

	sx = TileX(p1);

   216

	sy = TileY(p1);

   217

   218

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

   219

	if (x == sx) {

   220

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

   221

		direction = AXIS_Y;

   222

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

   223

	} else if (y == sy) {

   224

		direction = AXIS_X;

   225

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

   226

	} else {

   227

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   228

	}

   229

   230

	/* set and test bridge length, availability */

   231

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

   232

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

   233

   234

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

   235

	tile_start = TileXY(x, y);

   236

	tile_end = TileXY(sx, sy);

   237

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

   238

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   239

	}

   240

   241

	tileh_start = GetTileSlope(tile_start, &z_start);

   242

	tileh_end = GetTileSlope(tile_end, &z_end);

   243

   244

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

   245

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   246

		z_start += TILE_HEIGHT;

   247

		tileh_start = SLOPE_FLAT;

   248

	}

   249

   250

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

   251

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   252

		z_end += TILE_HEIGHT;

   253

		tileh_end = SLOPE_FLAT;

   254

	}

   255

   256

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

   257

   258

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

   259

	allow_on_slopes = (!_is_old_ai_player

   260

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

   261

   262

	/* Try and clear the start landscape */

   263

   264

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

   265

	if (CmdFailed(ret)) return ret;

   266

	cost = ret;

   267

   268

	terraformcost = CheckBridgeSlopeNorth(direction, tileh_start);

   269

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

   270

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   271

	cost += terraformcost;

   272

   273

	/* Try and clear the end landscape */

   274

   275

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

   276

	if (CmdFailed(ret)) return ret;

   277

	cost += ret;

   278

   279

	// false - end tile slope check

   280

	terraformcost = CheckBridgeSlopeSouth(direction, tileh_end);

   281

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

   282

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   283

	cost += terraformcost;

   284

   285

	{

   286

		TileIndex Heads[] = {tile_start, tile_end};

   287

		int i;

   288

   289

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

   290

			if (MayHaveBridgeAbove(Heads[i])) {

   291

				if (IsBridgeAbove(Heads[i])) {

   292

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   293

   294

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

   295

   296

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

   297

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   298

					}

   299

				}

   300

			}

   301

		}

   302

	}

   303

   304

	/* do the drill? */

   305

	if (flags & DC_EXEC) {

   306

		DiagDirection dir = AxisToDiagDir(direction);

   307

   308

		if (transport == TRANSPORT_RAIL) {

   309

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

   310

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

   311

		} else {

   312

			MakeRoadBridgeRamp(tile_start, _current_player, bridge_type, dir);

   313

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

   314

		}

   315

		MarkTileDirtyByTile(tile_start);

   316

		MarkTileDirtyByTile(tile_end);

   317

	}

   318

   319

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

   320

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

   321

		uint z;

   322

   323

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

   324

   325

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

   326

			/* Disallow crossing bridges for the time being */

   327

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   328

		}

   329

   330

		switch (GetTileType(tile)) {

   331

			case MP_WATER:

   332

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

   333

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

   334

				break;

   335

   336

			case MP_RAILWAY:

   337

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   338

				break;

   339

   340

			case MP_STREET:

   341

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

   342

				break;

   343

   344

			case MP_TUNNELBRIDGE:

   345

				if (IsTunnel(tile)) break;

   346

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

   347

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

   348

				break;

   349

   350

			case MP_UNMOVABLE:

   351

				if (!IsOwnedLand(tile)) goto not_valid_below;

   352

				break;

   353

   354

			case MP_CLEAR:

   355

				if (IsBridgeAbove(tile)) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   356

				break;

   357

   358

			default:

   359

not_valid_below:;

   360

				/* try and clear the middle landscape */

   361

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

   362

				if (CmdFailed(ret)) return ret;

   363

				cost += ret;

   364

				break;

   365

		}

   366

   367

		if (flags & DC_EXEC) {

   368

			SetBridgeMiddle(tile, direction);

   369

			MarkTileDirtyByTile(tile);

   370

		}

   371

	}

   372

   373

	if (flags & DC_EXEC) {

   374

		Track track = AxisToTrack(direction);

   375

		SetSignalsOnBothDir(tile_start, track);

   376

		YapfNotifyTrackLayoutChange(tile_start, track);

   377

	}

   378

   379

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

   380

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

   381

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

   382

	 */

   383

	if (!(flags & DC_QUERY_COST)) {

   384

		const Bridge *b = &_bridge[bridge_type];

   385

   386

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

   387

   388

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   389

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   390

   391

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

   392

	}

   393

   394

	return cost;

   395

}

   396

   397

   398

/** Build Tunnel.

   399

 * @param tile start tile of tunnel

   400

 * @param p1 railtype, 0x200 for road tunnel

   401

 * @param p2 unused

   402

 */

   403

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

   404

{

   405

	TileIndexDiff delta;

   406

	TileIndex end_tile;

   407

	DiagDirection direction;

   408

	Slope start_tileh;

   409

	Slope end_tileh;

   410

	uint start_z;

   411

	uint end_z;

   412

	int32 cost;

   413

	int32 ret;

   414

   415

	_build_tunnel_endtile = 0;

   416

   417

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

   418

   419

	start_tileh = GetTileSlope(start_tile, &start_z);

   420

   421

	switch (start_tileh) {

   422

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   423

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   424

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   425

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   426

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   427

	}

   428

   429

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

   430

	if (CmdFailed(ret)) return ret;

   431

   432

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

   433

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

   434

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

   435

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

   436

	cost = 0;

   437

	delta = TileOffsByDiagDir(direction);

   438

	end_tile = start_tile;

   439

	for (;;) {

   440

		end_tile += delta;

   441

		end_tileh = GetTileSlope(end_tile, &end_z);

   442

   443

		if (start_z == end_z) break;

   444

   445

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

   446

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

   447

		}

   448

   449

		cost += _price.build_tunnel;

   450

		cost += cost >> 3; // add a multiplier for longer tunnels

   451

		if (cost >= 400000000) cost = 400000000;

   452

	}

   453

   454

	/* Add the cost of the entrance */

   455

	cost += _price.build_tunnel + ret;

   456

   457

	// if the command fails from here on we want the end tile to be highlighted

   458

	_build_tunnel_endtile = end_tile;

   459

   460

	// slope of end tile must be complementary to the slope of the start tile

   461

	if (end_tileh != ComplementSlope(start_tileh)) {

   462

		ret = DoCommand(end_tile, end_tileh & start_tileh, 0, flags, CMD_TERRAFORM_LAND);

   463

		if (CmdFailed(ret)) return_cmd_error(STR_5005_UNABLE_TO_EXCAVATE_LAND);

   464

	} else {

   465

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

   466

		if (CmdFailed(ret)) return ret;

   467

	}

   468

	cost += _price.build_tunnel + ret;

   469

   470

	if (flags & DC_EXEC) {

   471

		if (GB(p1, 9, 1) == TRANSPORT_RAIL) {

   472

			MakeRailTunnel(start_tile, _current_player, direction,                 (RailType)GB(p1, 0, 4));

   473

			MakeRailTunnel(end_tile,   _current_player, ReverseDiagDir(direction), (RailType)GB(p1, 0, 4));

   474

			UpdateSignalsOnSegment(start_tile, direction);

   475

			YapfNotifyTrackLayoutChange(start_tile, AxisToTrack(DiagDirToAxis(direction)));

   476

		} else {

   477

			MakeRoadTunnel(start_tile, _current_player, direction);

   478

			MakeRoadTunnel(end_tile,   _current_player, ReverseDiagDir(direction));

   479

		}

   480

	}

   481

   482

	return cost;

   483

}

   484

   485

TileIndex CheckTunnelBusy(TileIndex tile, uint *length)

   486

{

   487

	uint z = GetTileZ(tile);