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

    18

#include "tile.h"

    19

#include "tunnel_map.h"

    20

#include "unmovable_map.h"

    21

#include "vehicle.h"

    22

#include "viewport.h"

    23

#include "command.h"

    24

#include "player.h"

    25

#include "town.h"

    26

#include "sound.h"

    27

#include "variables.h"

    28

#include "bridge.h"

    29

#include "train.h"

    30

#include "water_map.h"

    31

#include "yapf/yapf.h"

    32

#include "date.h"

    33

#include "newgrf_sound.h"

    34

    35

#include "table/bridge_land.h"

    36

    37

const Bridge orig_bridge[] = {

    38

/*

    39

	     year of availablity

    40

	     |  minimum length

    41

	     |  |   maximum length

    42

	     |  |   |    price

    43

	     |  |   |    |    maximum speed

    44

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

    45

	     |  |   |    |    |  |                                   |                            */

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

};

    60

    61

Bridge _bridge[MAX_BRIDGES];

    62

    63

    64

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

    65

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

    66

 */

    67

int CalcBridgeLenCostFactor(int x)

    68

{

    69

	int n;

    70

	int r;

    71

    72

	if (x < 2) return x;

    73

	x -= 2;

    74

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

    75

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

    76

		r += n * n;

    77

		x -= n;

    78

	}

    79

}

    80

    81

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

    82

enum BridgeFoundation {

    83

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

    84

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

    85

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

    86

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

    87

	/* no foundations (X,Y direction) */

    88

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

    89

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

    90

};

    91

#undef M

    92

    93

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

    94

{

    95

	const Bridge *bridge = &_bridge[index];

    96

	assert(table < 7);

    97

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

    98

		return _bridge_sprite_table[index][table];

    99

	} else {

   100

		return bridge->sprite_table[table];

   101

	}

   102

}

   103

   104

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

   105

   106

   107

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

   108

 * - valid slopes without foundation

   109

 * - valid slopes with foundation

   110

 * - rest is invalid

   111

 */

   112

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

   113

static int32 CheckBridgeSlopeNorth(Axis axis, Slope tileh)

   114

{

   115

	uint32 valid;

   116

   117

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

   118

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

   119

   120

	valid =

   121

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

   122

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

   123

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

   124

   125

	return CMD_ERROR;

   126

}

   127

   128

static int32 CheckBridgeSlopeSouth(Axis axis, Slope tileh)

   129

{

   130

	uint32 valid;

   131

   132

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

   133

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

   134

   135

	valid =

   136

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

   137

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

   138

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

   139

   140

	return CMD_ERROR;

   141

}

   142

#undef M

   143

   144

   145

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   146

{

   147

	int x1 = TileX(begin);

   148

	int y1 = TileY(begin);

   149

	int x2 = TileX(end);

   150

	int y2 = TileY(end);

   151

   152

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

   153

}

   154

   155

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   156

{

   157

	const Bridge *b = &_bridge[bridge_type];

   158

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

   159

   160

	if (bridge_type >= MAX_BRIDGES) return false;

   161

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

   162

   163

	max = b->max_length;

   164

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

   165

   166

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

   167

}

   168

   169

/** Build a Bridge

   170

 * @param end_tile end tile

   171

 * @param flags type of operation

   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 or road types.

   176

 * - p2 = (bit 15  ) - set means road bridge.

   177

 */

   178

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

   179

{

   180

	uint bridge_type;

   181

	RailType railtype;

   182

	RoadTypes roadtypes;

   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

	Axis direction;

   197

	int32 cost, terraformcost, ret;

   198

	bool allow_on_slopes;

   199

	bool replace_bridge = false;

   200

	uint replaced_bridge_type;

   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 = INVALID_RAILTYPE; // road bridge

   212

		roadtypes = (RoadTypes)GB(p2, 8, 3);

   213

		if (!AreValidRoadTypes(roadtypes)) return CMD_ERROR;

   214

	} else {

   215

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

   216

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

   217

		roadtypes = ROADTYPES_NONE;

   218

	}

   219

   220

	x = TileX(end_tile);

   221

	y = TileY(end_tile);

   222

	sx = TileX(p1);

   223

	sy = TileY(p1);

   224

   225

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

   226

	if (x == sx) {

   227

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

   228

		direction = AXIS_Y;

   229

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

   230

	} else if (y == sy) {

   231

		direction = AXIS_X;

   232

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

   233

	} else {

   234

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   235

	}

   236

   237

	/* set and test bridge length, availability */

   238

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

   239

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

   240

   241

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

   242

	tile_start = TileXY(x, y);

   243

	tile_end = TileXY(sx, sy);

   244

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

   245

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   246

	}

   247

   248

	tileh_start = GetTileSlope(tile_start, &z_start);

   249

	tileh_end = GetTileSlope(tile_end, &z_end);

   250

   251

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

   252

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   253

		z_start += TILE_HEIGHT;

   254

		tileh_start = SLOPE_FLAT;

   255

	}

   256

   257

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

   258

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   259

		z_end += TILE_HEIGHT;

   260

		tileh_end = SLOPE_FLAT;

   261

	}

   262

   263

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

   264

   265

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

   266

	allow_on_slopes = (!_is_old_ai_player

   267

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

   268

   269

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

   270

   271

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

   272

			GetOtherBridgeEnd(tile_start) == tile_end &&

   273

			GetBridgeTransportType(tile_start) == transport_type) {

   274

		/* Replace a current bridge. */

   275

   276

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

   277

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

   278

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   279

		}

   280

   281

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

   282

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

   283

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

   284

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   285

   286

			if (t == NULL) {

   287

				return CMD_ERROR;

   288

			} else {

   289

				SetDParam(0, t->index);

   290

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   291

			}

   292

		}

   293

   294

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

   295

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

   296

			return_cmd_error(STR_1007_ALREADY_BUILT);

   297

		}

   298

   299

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

   300

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

   301

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   302

		}

   303

   304

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

   305

		replace_bridge = true;

   306

		replaced_bridge_type = GetBridgeType(tile_start);

   307

	} else {

   308

		/* Build a new bridge. */

   309

   310

		/* Try and clear the start landscape */

   311

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

   312

		if (CmdFailed(ret)) return ret;

   313

		cost = ret;

   314

   315

		terraformcost = CheckBridgeSlopeNorth(direction, tileh_start);

   316

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

   317

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   318

		cost += terraformcost;

   319

   320

		/* Try and clear the end landscape */

   321

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

   322

		if (CmdFailed(ret)) return ret;

   323

		cost += ret;

   324

   325

		/* false - end tile slope check */

   326

		terraformcost = CheckBridgeSlopeSouth(direction, tileh_end);

   327

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

   328

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   329

		cost += terraformcost;

   330

	}

   331

   332

	if (!replace_bridge) {

   333

		TileIndex Heads[] = {tile_start, tile_end};

   334

		int i;

   335

   336

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

   337

			if (MayHaveBridgeAbove(Heads[i])) {

   338

				if (IsBridgeAbove(Heads[i])) {

   339

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   340

   341

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

   342

   343

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

   344

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   345

					}

   346

				}

   347

			}

   348

		}

   349

	}

   350

   351

	/* do the drill? */

   352

	if (flags & DC_EXEC) {

   353

		DiagDirection dir = AxisToDiagDir(direction);

   354

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

   355

   356

		if (railtype != INVALID_RAILTYPE) {

   357

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

   358

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

   359

		} else {

   360

			MakeRoadBridgeRamp(tile_start, owner, bridge_type, dir, roadtypes);

   361

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

   362

		}

   363

		MarkTileDirtyByTile(tile_start);

   364

		MarkTileDirtyByTile(tile_end);

   365

	}

   366

   367

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

   368

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

   369

		uint z;

   370

   371

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

   372

   373

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

   374

			/* Disallow crossing bridges for the time being */

   375

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   376

		}

   377

   378

		switch (GetTileType(tile)) {

   379

			case MP_WATER:

   380

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

   381

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

   382

				break;

   383

   384

			case MP_RAILWAY:

   385

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   386

				break;

   387

   388

			case MP_STREET:

   389

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

   390

				break;

   391

   392

			case MP_TUNNELBRIDGE:

   393

				if (IsTunnel(tile)) break;

   394

				if (replace_bridge) break;

   395

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

   396

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

   397

				break;

   398

   399

			case MP_UNMOVABLE:

   400

				if (!IsOwnedLand(tile)) goto not_valid_below;

   401

				break;

   402

   403

			case MP_CLEAR:

   404

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

   405

				break;

   406

   407

			default:

   408

not_valid_below:;

   409

				/* try and clear the middle landscape */

   410

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

   411

				if (CmdFailed(ret)) return ret;

   412

				cost += ret;

   413

				break;

   414

		}

   415

   416

		if (flags & DC_EXEC) {

   417

			SetBridgeMiddle(tile, direction);

   418

			MarkTileDirtyByTile(tile);

   419

		}

   420

	}

   421

   422

	if (flags & DC_EXEC) {

   423

		Track track = AxisToTrack(direction);

   424

		SetSignalsOnBothDir(tile_start, track);

   425

		YapfNotifyTrackLayoutChange(tile_start, track);

   426

	}

   427

   428

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

   429

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

   430

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

   431

	 */

   432

	if (!(flags & DC_QUERY_COST)) {

   433

		const Bridge *b = &_bridge[bridge_type];

   434

   435

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

   436

   437

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   438

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   439

   440

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

   441

	}

   442

   443

	return cost;

   444

}

   445

   446

   447

/** Build Tunnel.

   448

 * @param start_tile start tile of tunnel

   449

 * @param flags type of operation

   450

 * @param p1 railtype or roadtypes. bit 9 set means road tunnel

   451

 * @param p2 unused

   452

 */

   453

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

   454

{

   455

	TileIndexDiff delta;

   456

	TileIndex end_tile;

   457

	DiagDirection direction;

   458

	Slope start_tileh;

   459

	Slope end_tileh;

   460

	uint start_z;

   461

	uint end_z;

   462

	int32 cost;

   463

	int32 ret;

   464

   465

	_build_tunnel_endtile = 0;

   466

	if (!HASBIT(p1, 9)) {

   467

		if (!ValParamRailtype(p1)) return CMD_ERROR;

   468

	} else if (!AreValidRoadTypes((RoadTypes)GB(p1, 0, 3))) {

   469

		return CMD_ERROR;

   470

	}

   471

   472

	start_tileh = GetTileSlope(start_tile, &start_z);

   473

   474

	switch (start_tileh) {

   475

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   476

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   477

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   478

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   479

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   480

	}

   481

   482

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

   483

	if (CmdFailed(ret)) return ret;

   484

   485

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

   486

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