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

    32

#include "table/bridge_land.h"

    33

    34

extern const byte _track_sloped_sprites[14];

    35

extern const SpriteID _water_shore_sprites[15];

    36

    37

extern void DrawCanalWater(TileIndex tile);

    38

    39

const Bridge orig_bridge[] = {

    40

/*

    41

	     year of availablity

    42

	     |  minimum length

    43

	     |  |   maximum length

    44

	     |  |   |    price

    45

	     |  |   |    |    maximum speed

    46

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

    47

	     |  |   |    |    |  |                                   |                            */

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

};

    62

    63

Bridge _bridge[MAX_BRIDGES];

    64

    65

    66

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

    67

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

    68

int CalcBridgeLenCostFactor(int x)

    69

{

    70

	int n;

    71

	int r;

    72

    73

	if (x < 2) return x;

    74

	x -= 2;

    75

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

    76

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

    77

		r += n * n;

    78

		x -= n;

    79

	}

    80

}

    81

    82

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

    83

enum {

    84

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

    85

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

    86

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

    87

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

    88

	// no foundations (X,Y direction)

    89

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

    90

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

    91

};

    92

#undef M

    93

    94

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

    95

{

    96

	const Bridge *bridge = &_bridge[index];

    97

	assert(table < 7);

    98

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

    99

		return _bridge_sprite_table[index][table];

   100

	} else {

   101

		return bridge->sprite_table[table];

   102

	}

   103

}

   104

   105

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

   106

   107

   108

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

   109

 * - valid slopes without foundation

   110

 * - valid slopes with foundation

   111

 * - rest is invalid

   112

 */

   113

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

   114

static int32 CheckBridgeSlopeNorth(Axis axis, Slope tileh)

   115

{

   116

	uint32 valid;

   117

   118

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

   119

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

   120

   121

	valid =

   122

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

   123

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

   124

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

   125

   126

	return CMD_ERROR;

   127

}

   128

   129

static int32 CheckBridgeSlopeSouth(Axis axis, Slope tileh)

   130

{

   131

	uint32 valid;

   132

   133

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

   134

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

   135

   136

	valid =

   137

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

   138

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

   139

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

   140

   141

	return CMD_ERROR;

   142

}

   143

#undef M

   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

	uint odd_middle_part;

   196

	Axis direction;

   197

	uint i;

   198

	int32 cost, terraformcost, ret;

   199

	bool allow_on_slopes;

   200

   201

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   202

   203

	/* unpack parameters */

   204

	bridge_type = GB(p2, 0, 8);

   205

   206

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

   207

   208

	// type of bridge

   209

	if (HASBIT(p2, 15)) {

   210

		railtype = 0;

   211

		transport = TRANSPORT_ROAD;

   212

	} else {

   213

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

   214

		railtype = GB(p2, 8, 8);

   215

		transport = TRANSPORT_RAIL;

   216

	}

   217

   218

	x = TileX(end_tile);

   219

	y = TileY(end_tile);

   220

	sx = TileX(p1);

   221

	sy = TileY(p1);

   222

   223

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

   224

	if (x == sx) {

   225

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

   226

		direction = AXIS_Y;

   227

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

   228

	} else if (y == sy) {

   229

		direction = AXIS_X;

   230

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

   231

	} else {

   232

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   233

	}

   234

   235

	/* set and test bridge length, availability */

   236

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

   237

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

   238

   239

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

   240

	tile_start = TileXY(x, y);

   241

	tile_end = TileXY(sx, sy);

   242

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

   243

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   244

	}

   245

   246

	tileh_start = GetTileSlope(tile_start, &z_start);

   247

	tileh_end = GetTileSlope(tile_end, &z_end);

   248

   249

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

   250

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   251

		z_start += TILE_HEIGHT;

   252

		tileh_start = SLOPE_FLAT;

   253

	}

   254

   255

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

   256

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   257

		z_end += TILE_HEIGHT;

   258

		tileh_end = SLOPE_FLAT;

   259

	}

   260

   261

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

   262

   263

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

   264

	allow_on_slopes = (!_is_old_ai_player

   265

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

   266

   267

	/* Try and clear the start landscape */

   268

   269

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

   270

	if (CmdFailed(ret)) return ret;

   271

	cost = ret;

   272

   273

	terraformcost = CheckBridgeSlopeNorth(direction, tileh_start);

   274

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

   275

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   276

	cost += terraformcost;

   277

   278

	/* Try and clear the end landscape */

   279

   280

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

   281

	if (CmdFailed(ret)) return ret;

   282

	cost += ret;

   283

   284

	// false - end tile slope check

   285

	terraformcost = CheckBridgeSlopeSouth(direction, tileh_end);

   286

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

   287

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   288

	cost += terraformcost;

   289

   290

   291

	/* do the drill? */

   292

	if (flags & DC_EXEC) {

   293

		DiagDirection dir = AxisToDiagDir(direction);

   294

   295

		if (transport == TRANSPORT_RAIL) {

   296

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

   297

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

   298

		} else {

   299

			MakeRoadBridgeRamp(tile_start, _current_player, bridge_type, dir);

   300

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

   301

		}

   302

		MarkTileDirtyByTile(tile_start);

   303

		MarkTileDirtyByTile(tile_end);

   304

	}

   305

   306

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

   307

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

   308

   309

	tile = tile_start;

   310

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

   311

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

   312

		TransportType transport_under;

   313

		Owner owner_under = OWNER_NONE;

   314

		RailType rail_under = INVALID_RAILTYPE;

   315

		uint z;

   316

   317

		tile += delta;

   318

   319

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

   320

			return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   321

		}

   322

   323

		switch (GetTileType(tile)) {

   324

			case MP_WATER:

   325

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

   326

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

   327

				transport_under = TRANSPORT_WATER;

   328

				owner_under = GetTileOwner(tile);

   329

				break;

   330

   331

			case MP_RAILWAY:

   332

				if (GetRailTileType(tile) != RAIL_TILE_NORMAL ||

   333

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

   334

					goto not_valid_below;

   335

				}

   336

				transport_under = TRANSPORT_RAIL;

   337

				owner_under = GetTileOwner(tile);

   338

				rail_under = GetRailType(tile);

   339

				break;

   340

   341

			case MP_STREET:

   342

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

   343

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

   344

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

   345

					goto not_valid_below;

   346

				}

   347

				transport_under = TRANSPORT_ROAD;

   348

				owner_under = GetTileOwner(tile);

   349

				break;

   350

   351

			default:

   352

not_valid_below:;

   353

				/* try and clear the middle landscape */

   354

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

   355

				if (CmdFailed(ret)) return ret;

   356

				cost += ret;

   357

				transport_under = INVALID_TRANSPORT;

   358

				break;

   359

		}

   360

   361

		if (flags & DC_EXEC) {

   362

			uint piece;

   363

   364

			//bridges pieces sequence (middle parts)

   365

			// bridge len 1: 0

   366

			// bridge len 2: 0 1

   367

			// bridge len 3: 0 4 1

   368

			// bridge len 4: 0 2 3 1

   369

			// bridge len 5: 0 2 5 3 1

   370

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

   371

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

   372

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

   373

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

   374

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

   375

   376

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

   377

				piece = 0;

   378

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

   379

				piece = 1;

   380

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

   381

				piece = 5 - (i % 2);

   382

			} else {

   383

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

   384

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

   385

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

   386

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

   387

			}

   388

   389

			if (transport == TRANSPORT_RAIL) {

   390

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

   391

			} else {

   392

				MakeRoadBridgeMiddle(tile, bridge_type, piece, direction);

   393

			}

   394

			switch (transport_under) {

   395

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

   396

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

   397

   398

				case TRANSPORT_WATER:

   399

					if (owner_under == OWNER_WATER) {

   400

						SetWaterUnderBridge(tile);

   401

					} else {

   402

						SetCanalUnderBridge(tile, owner_under);

   403

					}

   404

					break;

   405

   406

				default: SetClearUnderBridge(tile); break;

   407

			}

   408

   409

			MarkTileDirtyByTile(tile);

   410

		}

   411

	}

   412

   413

	SetSignalsOnBothDir(tile_start, AxisToTrack(direction));

   414

	YapfNotifyTrackLayoutChange(tile_start, AxisToTrack(direction));

   415

   416

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

   417

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

   418

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

   419

	*/

   420

	if (!(flags & DC_QUERY_COST)) {

   421

		const Bridge *b = &_bridge[bridge_type];

   422

   423

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

   424

   425

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   426

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   427

   428

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

   429

	}

   430

   431

	return cost;

   432

}

   433

   434

   435

/** Build Tunnel.

   436

 * @param tile start tile of tunnel

   437

 * @param p1 railtype, 0x200 for road tunnel

   438

 * @param p2 unused

   439

 */

   440

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

   441

{

   442

	TileIndexDiff delta;

   443

	TileIndex end_tile;

   444

	DiagDirection direction;

   445

	Slope start_tileh;

   446

	Slope end_tileh;

   447

	uint start_z;

   448

	uint end_z;

   449

	int32 cost;

   450

	int32 ret;

   451

   452

	_build_tunnel_endtile = 0;

   453

   454

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

   455

   456

	start_tileh = GetTileSlope(start_tile, &start_z);

   457

   458

	switch (start_tileh) {

   459

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   460

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   461

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   462

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   463

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   464

	}

   465

   466

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

   467

	if (CmdFailed(ret)) return ret;

   468

   469

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

   470

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

   471

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

   472

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

   473

	cost = 0;

   474

	delta = TileOffsByDir(direction);

   475

	end_tile = start_tile;

   476

	for (;;) {

   477

		end_tile += delta;

   478

		end_tileh = GetTileSlope(end_tile, &end_z);

   479

   480

		if (start_z == end_z) break;

   481

   482

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

   483

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

   484

		}

   485

   486

		cost += _price.build_tunnel;

   487

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

   488

		if (cost >= 400000000) cost = 400000000;