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

    31

#include "table/bridge_land.h"

    32

    33

const Bridge orig_bridge[] = {

    34

/*

    35

	   year of availablity

    36

	   |  minimum length

    37

	   |  |   maximum length

    38

	   |  |   |    price

    39

	   |  |   |    |    maximum speed

    40

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

    41

	   |  |   |    |    |  |                                   |                            */

    42

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

    43

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

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

};

    56

    57

Bridge _bridge[MAX_BRIDGES];

    58

    59

    60

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

    61

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

    62

int CalcBridgeLenCostFactor(int x)

    63

{

    64

	int n;

    65

	int r;

    66

    67

	if (x < 2) return x;

    68

	x -= 2;

    69

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

    70

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

    71

		r += n * n;

    72

		x -= n;

    73

	}

    74

}

    75

    76

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

    77

enum {

    78

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

    79

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

    80

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

    81

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

    82

	// no foundations (X,Y direction)

    83

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

    84

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

    85

};

    86

#undef M

    87

    88

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

    89

{

    90

	const Bridge *bridge = &_bridge[index];

    91

	assert(table < 7);

    92

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

    93

		return _bridge_sprite_table[index][table];

    94

	} else {

    95

		return bridge->sprite_table[table];

    96

	}

    97

}

    98

    99

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

   100

   101

/**	check if bridge can be built on slope

   102

 *	direction 0 = X-axis, direction 1 = Y-axis

   103

 *	is_start_tile = false		<-- end tile

   104

 *	is_start_tile = true		<-- start tile

   105

 */

   106

static uint32 CheckBridgeSlope(Axis direction, Slope tileh, bool is_start_tile)

   107

{

   108

	if (IsSteepSlope(tileh)) return CMD_ERROR;

   109

   110

	if (is_start_tile) {

   111

		/* check slope at start tile

   112

				- no extra cost

   113

		*/

   114

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

   115

		if (HASBIT(M(SLOPE_FLAT) | (direction == AXIS_X ? M(SLOPE_NE) : M(SLOPE_NW)), tileh)) return 0;

   116

   117

		// disallow certain start tiles to avoid certain crooked bridges

   118

		if (tileh == SLOPE_S) return CMD_ERROR;

   119

	} else {

   120

		/*	check slope at end tile

   121

				- no extra cost

   122

		*/

   123

		if (HASBIT(M(SLOPE_FLAT) | (direction == AXIS_X ? M(SLOPE_SW) : M(SLOPE_SE)), tileh)) return 0;

   124

#undef M

   125

   126

		// disallow certain end tiles to avoid certain crooked bridges

   127

		if (tileh == SLOPE_N) return CMD_ERROR;

   128

	}

   129

   130

	/*	disallow common start/end tiles to avoid certain crooked bridges e.g.

   131

	 *	start-tile:	X 2,1 Y 2,4 (2 was disabled before)

   132

	 *	end-tile:		X 8,4 Y 8,1 (8 was disabled before)

   133

	 */

   134

	if ((tileh == SLOPE_W && is_start_tile != (direction != AXIS_X)) ||

   135

			(tileh == SLOPE_E && is_start_tile == (direction != AXIS_X))) {

   136

		return CMD_ERROR;

   137

	}

   138

   139

	// slope foundations

   140

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION | BRIDGE_PARTLY_LEVELED_FOUNDATION, tileh))

   141

		return _price.terraform;

   142

   143

	return CMD_ERROR;

   144

}

   145

   146

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   147

{

   148

	int x1 = TileX(begin);

   149

	int y1 = TileY(begin);

   150

	int x2 = TileX(end);

   151

	int y2 = TileY(end);

   152

   153

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

   154

}

   155

   156

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   157

{

   158

	const Bridge *b = &_bridge[bridge_type];

   159

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

   160

   161

	if (bridge_type >= MAX_BRIDGES) return false;

   162

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

   163

   164

	max = b->max_length;

   165

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

   166

   167

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

   168

}

   169

   170

/** Build a Bridge

   171

 * @param end_tile end tile

   172

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

   173

 * @param p2 various bitstuffed elements

   174

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

   175

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

   176

 */

   177

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

   178

{

   179

	int bridge_type;

   180

	TransportType transport;

   181

	RailType railtype;

   182

	uint x;

   183

	uint y;

   184

	uint sx;

   185

	uint sy;

   186

	TileIndex tile_start;

   187

	TileIndex tile_end;

   188

	Slope tileh_start;

   189

	Slope tileh_end;

   190

	uint z_start;

   191

	uint z_end;

   192

	TileIndex tile;

   193

	TileIndexDiff delta;

   194

	uint bridge_len;

   195

	Axis direction;

   196

	uint i;

   197

	int32 cost, terraformcost, ret;

   198

	bool allow_on_slopes;

   199

   200

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   201

   202

	/* unpack parameters */

   203

	bridge_type = GB(p2, 0, 8);

   204

   205

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

   206

   207

	// type of bridge

   208

	if (HASBIT(p2, 15)) {

   209

		railtype = 0;

   210

		transport = TRANSPORT_ROAD;

   211

	} else {

   212

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

   213

		railtype = GB(p2, 8, 8);

   214

		transport = TRANSPORT_RAIL;

   215

	}

   216

   217

	x = TileX(end_tile);

   218

	y = TileY(end_tile);

   219

	sx = TileX(p1);

   220

	sy = TileY(p1);

   221

   222

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

   223

	if (x == sx) {

   224

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

   225

		direction = AXIS_Y;

   226

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

   227

	} else if (y == sy) {

   228

		direction = AXIS_X;

   229

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

   230

	} else {

   231

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   232

	}

   233

   234

	/* set and test bridge length, availability */

   235

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

   236

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

   237

   238

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

   239

	tile_start = TileXY(x, y);

   240

	tile_end = TileXY(sx, sy);

   241

	if (IsClearWaterTile(tile_start) || IsClearWaterTile(tile_end)) return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   242

   243

	tileh_start = GetTileSlope(tile_start, &z_start);

   244

	tileh_end = GetTileSlope(tile_end, &z_end);

   245

   246

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   247

		z_start += TILE_HEIGHT;

   248

		tileh_start = SLOPE_FLAT;

   249

	}

   250

   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

	// true - bridge-start-tile, false - bridge-end-tile

   269

	terraformcost = CheckBridgeSlope(direction, tileh_start, true);

   270

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

   271

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   272

	cost += terraformcost;

   273

   274

	/* Try and clear the end landscape */

   275

   276

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

   277

	if (CmdFailed(ret)) return ret;

   278

	cost += ret;

   279

   280

	// false - end tile slope check

   281

	terraformcost = CheckBridgeSlope(direction, tileh_end, false);

   282

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

   283

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   284

	cost += terraformcost;

   285

   286

	{

   287

		TileIndex Heads[] = {tile_start, tile_end};

   288

		int i;

   289

   290

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

   291

			if (MayHaveBridgeAbove(Heads[i])) {

   292

				if (IsBridgeAbove(Heads[i])) {

   293

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   294

					int z1, z2;

   295

   296

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

   297

   298

					z1 = GetBridgeHeight(north_head, GetBridgeAxis(Heads[i]));

   299

					z2 = GetBridgeHeight(Heads[i], direction);

   300

   301

					if (z1 == z2) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   302

				}

   303

			}

   304

		}

   305

	}

   306

   307

	/* do the drill? */

   308

	if (flags & DC_EXEC) {

   309

		DiagDirection dir = AxisToDiagDir(direction);

   310

   311

		if (transport == TRANSPORT_RAIL) {

   312

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

   313

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

   314

		} else {

   315

			MakeRoadBridgeRamp(tile_start, _current_player, bridge_type, dir);

   316

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

   317

		}

   318

		MarkTileDirtyByTile(tile_start);

   319

		MarkTileDirtyByTile(tile_end);

   320

	}

   321

   322

	tile = tile_start;

   323

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

   324

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

   325

		uint z;

   326

   327

		tile += delta;

   328

   329

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

   330

   331

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

   332

			/* Disallow crossing bridges for the time being */

   333

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   334

		}

   335

   336

		switch (GetTileType(tile)) {

   337

			case MP_WATER:

   338

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

   339

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

   340

				break;

   341

   342

			case MP_RAILWAY:

   343

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   344

				break;

   345

   346

			case MP_STREET:

   348

				break;

   349

   350

			case MP_TUNNELBRIDGE:

   351

				if (IsTunnel(tile)) break;

   352

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

   353

				if (GetBridgeHeight(tile_start, direction) == GetBridgeHeight(tile, DiagDirToAxis(GetBridgeRampDirection(tile)))) goto not_valid_below;

   354

				break;

   355

   356

			case MP_CLEAR:

   357

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

   358

				break;

   359

   360

			default:

   361

not_valid_below:;

   362

				/* try and clear the middle landscape */

   363

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

   364

				if (CmdFailed(ret)) return ret;

   365

				cost += ret;

   366

				break;

   367

		}

   368

   369

		if (flags & DC_EXEC) {

   370

			SetBridgeMiddle(tile, direction);

   371

			MarkTileDirtyByTile(tile);

   372

		}

   373

	}

   374

   375

	SetSignalsOnBothDir(tile_start, direction == AXIS_X ? TRACK_X : TRACK_Y);

   376

	YapfNotifyTrackLayoutChange(tile_start, direction == AXIS_X ? TRACK_X : TRACK_Y);

   377

   378

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

   379

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

   380

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

   381

	*/

   382

	if (!(flags & DC_QUERY_COST)) {

   383

		const Bridge *b = &_bridge[bridge_type];

   384

   385

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

   386

   387

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   388

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   389

   390

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

   391

	}

   392

   393

	return cost;

   394

}

   395

   396

   397

/** Build Tunnel.

   398

 * @param tile start tile of tunnel

   399

 * @param p1 railtype, 0x200 for road tunnel

   400

 * @param p2 unused

   401

 */

   402

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

   403

{

   404

	TileIndexDiff delta;

   405

	TileIndex end_tile;

   406

	DiagDirection direction;

   407

	Slope start_tileh;

   408

	Slope end_tileh;

   409

	uint start_z;

   410

	uint end_z;

   411

	int32 cost;

   412

	int32 ret;

   413

   414

	_build_tunnel_endtile = 0;

   415

   416

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

   417

   418

	start_tileh = GetTileSlope(start_tile, &start_z);

   419

   420

	switch (start_tileh) {

   421

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   422

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   423

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   424

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   425

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   426

	}

   427

   428

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

   429

	if (CmdFailed(ret)) return ret;

   430

	cost = _price.build_tunnel + ret;

   431

   432

	delta = TileOffsByDir(direction);

   433

	end_tile = start_tile;

   434

	for (;;) {

   435

		end_tile += delta;

   436

		end_tileh = GetTileSlope(end_tile, &end_z);

   437

   438

		if (start_z == end_z) break;

   439

   440

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

   441

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

   442

		}

   443

   444

		cost += _price.build_tunnel;

   445

		cost += cost >> 3;

   446

		if (cost >= 400000000) cost = 400000000;

   447

	}

   448

   449

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

   450

	_build_tunnel_endtile = end_tile;

   451

   452

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

   453

	if (end_tileh != ComplementSlope(start_tileh)) {

   454

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

   455

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

   456

	} else {

   457

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

   458

		if (CmdFailed(ret)) return ret;

   459

	}

   460

	cost += _price.build_tunnel + ret;

   461

   462

	if (flags & DC_EXEC) {

   463

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

   464

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

   465

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

   466

			UpdateSignalsOnSegment(start_tile, direction);

   467

			YapfNotifyTrackLayoutChange(start_tile, DiagDirToAxis(direction) == AXIS_X ? TRACK_X : TRACK_Y);

   468

		} else {

   469

			MakeRoadTunnel(start_tile, _current_player, direction);

   470

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

   471

		}

   472

   473

	}

   474

   475

	return cost;

   476

}

   477

   478

TileIndex CheckTunnelBusy(TileIndex tile, uint *length)

   479

{

   480

	uint z = GetTileZ(tile);

   481

	DiagDirection dir = GetTunnelDirection(tile);

   482

	TileIndexDiff delta = TileOffsByDir(dir);

   483

	uint len = 0;

   484

	TileIndex starttile = tile;

   485

	Vehicle *v;

   486

   487

	do {