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

extern const byte _track_sloped_sprites[14];

    34

extern const SpriteID _water_shore_sprites[15];

    35

    36

extern void DrawCanalWater(TileIndex tile);

    37

    38

const Bridge orig_bridge[] = {

    39

/*

    40

	   year of availablity

    41

	   |  minimum length

    42

	   |  |   maximum length

    43

	   |  |   |    price

    44

	   |  |   |    |    maximum speed

    45

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

    46

	   |  |   |    |    |  |                                   |                            */

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

};

    61

    62

Bridge _bridge[MAX_BRIDGES];

    63

    64

    65

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

    66

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

    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 {

    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

/**	check if bridge can be built on slope

   107

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

   108

 *	is_start_tile = false		<-- end tile

   109

 *	is_start_tile = true		<-- start tile

   110

 */

   111

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

   112

{

   113

	if (IsSteepSlope(tileh)) return CMD_ERROR;

   114

   115

	if (is_start_tile) {

   116

		/* check slope at start tile

   117

				- no extra cost

   118

		*/

   119

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

   120

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

   121

   122

		// disallow certain start tiles to avoid certain crooked bridges

   123

		if (tileh == SLOPE_S) return CMD_ERROR;

   124

	} else {

   125

		/*	check slope at end tile

   126

				- no extra cost

   127

		*/

   128

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

   129

#undef M

   130

   131

		// disallow certain end tiles to avoid certain crooked bridges

   132

		if (tileh == SLOPE_N) return CMD_ERROR;

   133

	}

   134

   135

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

   136

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

   137

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

   138

	 */

   139

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

   140

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

   141

		return CMD_ERROR;

   142

	}

   143

   144

	// slope foundations

   145

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION | BRIDGE_PARTLY_LEVELED_FOUNDATION, tileh)) {

   146

		return _price.terraform;

   147

	}

   148

   149

	return CMD_ERROR;

   150

}

   151

   152

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   153

{

   154

	int x1 = TileX(begin);

   155

	int y1 = TileY(begin);

   156

	int x2 = TileX(end);

   157

	int y2 = TileY(end);

   158

   159

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

   160

}

   161

   162

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   163

{

   164

	const Bridge *b = &_bridge[bridge_type];

   165

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

   166

   167

	if (bridge_type >= MAX_BRIDGES) return false;

   168

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

   169

   170

	max = b->max_length;

   171

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

   172

   173

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

   174

}

   175

   176

/** Build a Bridge

   177

 * @param end_tile end tile

   178

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

   179

 * @param p2 various bitstuffed elements

   180

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

   181

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

   182

 */

   183

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

   184

{

   185

	int bridge_type;

   186

	TransportType transport;

   187

	RailType railtype;

   188

	uint x;

   189

	uint y;

   190

	uint sx;

   191

	uint sy;

   192

	TileIndex tile_start;

   193

	TileIndex tile_end;

   194

	Slope tileh_start;

   195

	Slope tileh_end;

   196

	uint z_start;

   197

	uint z_end;

   198

	TileIndex tile;

   199

	TileIndexDiff delta;

   200

	uint bridge_len;

   201

	uint odd_middle_part;

   202

	Axis direction;

   203

	uint i;

   204

	int32 cost, terraformcost, ret;

   205

	bool allow_on_slopes;

   206

   207

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   208

   209

	/* unpack parameters */

   210

	bridge_type = GB(p2, 0, 8);

   211

   212

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

   213

   214

	// type of bridge

   215

	if (HASBIT(p2, 15)) {

   216

		railtype = 0;

   217

		transport = TRANSPORT_ROAD;

   218

	} else {

   219

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

   220

		railtype = GB(p2, 8, 8);

   221

		transport = TRANSPORT_RAIL;

   222

	}

   223

   224

	x = TileX(end_tile);

   225

	y = TileY(end_tile);

   226

	sx = TileX(p1);

   227

	sy = TileY(p1);

   228

   229

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

   230

	if (x == sx) {

   231

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

   232

		direction = AXIS_Y;

   233

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

   234

	} else if (y == sy) {

   235

		direction = AXIS_X;

   236

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

   237

	} else {

   238

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   239

	}

   240

   241

	/* set and test bridge length, availability */

   242

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

   243

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

   244

   245

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

   246

	tile_start = TileXY(x, y);

   247

	tile_end = TileXY(sx, sy);

   248

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

   249

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   250

	}

   251

   252

	tileh_start = GetTileSlope(tile_start, &z_start);

   253

	tileh_end = GetTileSlope(tile_end, &z_end);

   254

   255

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   256

		z_start += TILE_HEIGHT;

   257

		tileh_start = SLOPE_FLAT;

   258

	}

   259

   260

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   261

		z_end += TILE_HEIGHT;

   262

		tileh_end = SLOPE_FLAT;

   263

	}

   264

   265

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

   266

   267

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

   268

	allow_on_slopes = (!_is_old_ai_player

   269

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

   270

   271

	/* Try and clear the start landscape */

   272

   273

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

   274

	if (CmdFailed(ret)) return ret;

   275

	cost = ret;

   276

   277

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

   278

	terraformcost = CheckBridgeSlope(direction, tileh_start, true);

   279

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

   280

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   281

	cost += terraformcost;

   282

   283

	/* Try and clear the end landscape */

   284

   285

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

   286

	if (CmdFailed(ret)) return ret;

   287

	cost += ret;

   288

   289

	// false - end tile slope check

   290

	terraformcost = CheckBridgeSlope(direction, tileh_end, false);

   291

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

   292

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   293

	cost += terraformcost;

   294

   295

   296

	/* do the drill? */

   297

	if (flags & DC_EXEC) {

   298

		DiagDirection dir = AxisToDiagDir(direction);

   299

   300

		if (transport == TRANSPORT_RAIL) {

   301

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

   302

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

   303

		} else {

   304

			MakeRoadBridgeRamp(tile_start, _current_player, bridge_type, dir);

   305

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

   306

		}

   307

		MarkTileDirtyByTile(tile_start);

   308

		MarkTileDirtyByTile(tile_end);

   309

	}

   310

   311

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

   312

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

   313

   314

	tile = tile_start;

   315

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

   316

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

   317

		TransportType transport_under;

   318

		Owner owner_under = OWNER_NONE;

   319

		RailType rail_under = INVALID_RAILTYPE;

   320

		uint z;

   321

   322

		tile += delta;

   323

   324

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

   325

			return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   326

		}

   327

   328

		switch (GetTileType(tile)) {

   329

			case MP_WATER:

   330

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

   331

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

   332

				transport_under = TRANSPORT_WATER;

   333

				owner_under = GetTileOwner(tile);

   334

				break;

   335

   336

			case MP_RAILWAY:

   337

				if (GetRailTileType(tile) != RAIL_TILE_NORMAL ||

   338

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

   339

					goto not_valid_below;

   340

				}

   341

				transport_under = TRANSPORT_RAIL;

   342

				owner_under = GetTileOwner(tile);

   343

				rail_under = GetRailType(tile);

   344

				break;

   345

   346

			case MP_STREET:

   347

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

   348

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

   349

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

   350

					goto not_valid_below;

   351

				}

   352

				transport_under = TRANSPORT_ROAD;

   353

				owner_under = GetTileOwner(tile);

   354

				break;

   355

   356

			default:

   357

not_valid_below:;

   358

				/* try and clear the middle landscape */

   359

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

   360

				if (CmdFailed(ret)) return ret;

   361

				cost += ret;

   362

				transport_under = INVALID_TRANSPORT;

   363

				break;

   364

		}

   365

   366

		if (flags & DC_EXEC) {

   367

			uint piece;

   368

   369

			//bridges pieces sequence (middle parts)

   370

			// bridge len 1: 0

   371

			// bridge len 2: 0 1

   372

			// bridge len 3: 0 4 1

   373

			// bridge len 4: 0 2 3 1

   374

			// bridge len 5: 0 2 5 3 1

   375

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

   376

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

   377

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

   378

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

   379

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

   380

   381

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

   382

				piece = 0;

   383

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

   384

				piece = 1;

   385

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

   386

				piece = 5 - (i % 2);

   387

			} else {

   388

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

   389

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

   390

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

   391

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

   392

			}

   393

   394

			if (transport == TRANSPORT_RAIL) {

   395

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

   396

			} else {

   397

				MakeRoadBridgeMiddle(tile, bridge_type, piece, direction);

   398

			}

   399

			switch (transport_under) {

   400

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

   401

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

   402

   403

				case TRANSPORT_WATER:

   404

					if (owner_under == OWNER_WATER) {

   405

						SetWaterUnderBridge(tile);

   406

					} else {

   407

						SetCanalUnderBridge(tile, owner_under);

   408

					}

   409

					break;

   410

   411

				default: SetClearUnderBridge(tile); break;

   412

			}

   413

   414

			MarkTileDirtyByTile(tile);

   415

		}

   416

	}

   417

   418

	SetSignalsOnBothDir(tile_start, AxisToTrack(direction));

   419

	YapfNotifyTrackLayoutChange(tile_start, AxisToTrack(direction));

   420

   421

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

   422

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

   423

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

   424

	*/

   425

	if (!(flags & DC_QUERY_COST)) {

   426

		const Bridge *b = &_bridge[bridge_type];

   427

   428

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

   429

   430

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   431

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   432

   433

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

   434

	}

   435

   436

	return cost;

   437

}

   438

   439

   440

/** Build Tunnel.

   441

 * @param tile start tile of tunnel

   442

 * @param p1 railtype, 0x200 for road tunnel

   443

 * @param p2 unused

   444

 */

   445

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

   446

{

   447

	TileIndexDiff delta;

   448

	TileIndex end_tile;

   449

	DiagDirection direction;

   450

	Slope start_tileh;

   451

	Slope end_tileh;

   452

	uint start_z;

   453

	uint end_z;

   454

	int32 cost;

   455

	int32 ret;

   456

   457

	_build_tunnel_endtile = 0;

   458

   459

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

   460

   461

	start_tileh = GetTileSlope(start_tile, &start_z);

   462

   463

	switch (start_tileh) {

   464

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   465

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   466

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   467

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   468

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   469

	}

   470

   471

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

   472

	if (CmdFailed(ret)) return ret;

   473

	cost = _price.build_tunnel + ret;

   474

   475

	delta = TileOffsByDir(direction);

   476

	end_tile = start_tile;

   477

	for (;;) {

   478

		end_tile += delta;

   479

		end_tileh = GetTileSlope(end_tile, &end_z);

   480

   481

		if (start_z == end_z) break;

   482

   483

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

   484

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

   485

		}

   486

   487

		cost += _price.build_tunnel;

   488

		cost += cost >> 3;