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

    30

#include "table/bridge_land.h"

    31

    32

extern const byte _track_sloped_sprites[14];

    33

extern const SpriteID _water_shore_sprites[15];

    34

    35

extern void DrawCanalWater(TileIndex tile);

    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                             , STR_5012_WOODEN             , NULL, 0 },

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

	{ 90, 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

int CalcBridgeLenCostFactor(int x)

    67

{

    68

	int n;

    69

	int r;

    70

    71

	if (x < 2) return x;

    72

	x -= 2;

    73

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

    74

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

    75

		r += n * n;

    76

		x -= n;

    77

	}

    78

}

    79

    80

enum {

    81

	// foundation, whole tile is leveled up (tileh's 7, 11, 13, 14) --> 3 corners raised

    82

	BRIDGE_FULL_LEVELED_FOUNDATION = 1 << 7 | 1 << 11 | 1 << 13 | 1 << 14,

    83

	// foundation, tile is partly leveled up (tileh's 1, 2, 4, 8) --> 1 corner raised

    84

	BRIDGE_PARTLY_LEVELED_FOUNDATION = 1 << 1 | 1 << 2 | 1 << 4 | 1 << 8,

    85

	// no foundations (X,Y direction) (tileh's 0, 3, 6, 9, 12)

    86

	BRIDGE_NO_FOUNDATION = 1 << 0 | 1 << 3 | 1 << 6 | 1 << 9 | 1 << 12,

    87

};

    88

    89

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

    90

{

    91

	const Bridge *bridge = &_bridge[index];

    92

	assert(table < 7);

    93

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

    94

		return _bridge_sprite_table[index][table];

    95

	} else {

    96

		return bridge->sprite_table[table];

    97

	}

    98

}

    99

   100

/**

   101

 * Determines which piece of a bridge is contained in the current tile

   102

 * @param tile The tile to analyze

   103

 * @return the piece

   104

 */

   105

static inline int GetBridgePiece(TileIndex tile)

   106

{

   107

	return GB(_m[tile].m2, 0, 4);

   108

}

   109

   110

/**

   111

 * Determines the type of bridge on a tile

   112

 * @param tile The tile to analyze

   113

 * @return The bridge type

   114

 */

   115

static inline int GetBridgeType(TileIndex tile)

   116

{

   117

	return GB(_m[tile].m2, 4, 4);

   118

}

   119

   120

/**	check if bridge can be built on slope

   121

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

   122

 *	is_start_tile = false		<-- end tile

   123

 *	is_start_tile = true		<-- start tile

   124

 */

   125

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

   126

{

   127

	if (IsSteepTileh(tileh)) return CMD_ERROR;

   128

   129

	if (is_start_tile) {

   130

		/* check slope at start tile

   131

				- no extra cost

   132

				- direction X: tiles 0, 12

   133

				- direction Y: tiles 0,  9

   134

		*/

   135

		if ((direction == AXIS_X ? 0x1001 : 0x201) & (1 << tileh)) return 0;

   136

   137

		// disallow certain start tiles to avoid certain crooked bridges

   138

		if (tileh == 2) return CMD_ERROR;

   139

	} else {

   140

		/*	check slope at end tile

   141

				- no extra cost

   142

				- direction X: tiles 0, 3

   143

				- direction Y: tiles 0, 6

   144

		*/

   145

		if ((direction == AXIS_X ? 0x9 : 0x41) & (1 << tileh)) return 0;

   146

   147

		// disallow certain end tiles to avoid certain crooked bridges

   148

		if (tileh == 8) return CMD_ERROR;

   149

	}

   150

   151

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

   152

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

   153

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

   154

	 */

   155

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

   156

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

   157

		return CMD_ERROR;

   158

	}

   159

   160

	// slope foundations

   161

	if (BRIDGE_FULL_LEVELED_FOUNDATION & (1 << tileh) || BRIDGE_PARTLY_LEVELED_FOUNDATION & (1 << tileh))

   162

		return _price.terraform;

   163

   164

	return CMD_ERROR;

   165

}

   166

   167

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   168

{

   169

	int x1 = TileX(begin);

   170

	int y1 = TileY(begin);

   171

	int x2 = TileX(end);

   172

	int y2 = TileY(end);

   173

   174

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

   175

}

   176

   177

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   178

{

   179

	const Bridge *b = &_bridge[bridge_type];

   180

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

   181

   182

	if (bridge_type >= MAX_BRIDGES) return false;

   183

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

   184

   185

	max = b->max_length;

   186

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

   187

   188

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

   189

}

   190

   191

/** Build a Bridge

   192

 * @param x,y end tile coord

   193

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

   194

 * @param p2 various bitstuffed elements

   195

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

   196

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

   197

 */

   198

int32 CmdBuildBridge(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   199

{

   200

	int bridge_type;

   201

	TransportType transport;

   202

	RailType railtype;

   203

	int sx,sy;

   204

	TileInfo ti_start, ti_end;

   205

	TileIndex tile;

   206

	TileIndexDiff delta;

   207

	uint bridge_len;

   208

	uint odd_middle_part;

   209

	Axis direction;

   210

	uint i;

   211

	int32 cost, terraformcost, ret;

   212

	bool allow_on_slopes;

   213

   214

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   215

   216

	/* unpack parameters */

   217

	bridge_type = GB(p2, 0, 8);

   218

   219

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

   220

   221

	// type of bridge

   222

	if (HASBIT(p2, 15)) {

   223

		railtype = 0;

   224

		transport = TRANSPORT_ROAD;

   225

	} else {

   226

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

   227

		railtype = GB(p2, 8, 8);

   228

		transport = TRANSPORT_RAIL;

   229

	}

   230

   231

	sx = TileX(p1) * 16;

   232

	sy = TileY(p1) * 16;

   233

   234

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

   235

	if (x == sx) {

   236

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

   237

		direction = AXIS_Y;

   238

		if (y > sy) {

   239

			intswap(y,sy);

   240

			intswap(x,sx);

   241

		}

   242

	} else if (y == sy) {

   243

		direction = AXIS_X;

   244

		if (x > sx) {

   245

			intswap(y,sy);

   246

			intswap(x,sx);

   247

		}

   248

	} else {

   249

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   250

	}

   251

   252

	/* set and test bridge length, availability */

   253

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

   254

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

   255

   256

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

   257

	if ((

   258

				FindLandscapeHeight(&ti_end, sx, sy),

   259

				ti_end.type == MP_WATER && ti_end.map5 == 0

   260

			) || (

   261

				FindLandscapeHeight(&ti_start, x, y),

   262

				ti_start.type == MP_WATER && ti_start.map5 == 0

   263

			)) {

   264

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   265

	}

   266

   267

	if (BRIDGE_FULL_LEVELED_FOUNDATION & (1 << ti_start.tileh)) {

   268

		ti_start.z += 8;

   269

		ti_start.tileh = 0;

   270

	}

   271

   272

	if (BRIDGE_FULL_LEVELED_FOUNDATION & (1 << ti_end.tileh)) {

   273

		ti_end.z += 8;

   274

		ti_end.tileh = 0;

   275

	}

   276

   277

	if (ti_start.z != ti_end.z)

   278

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   279

   280

   281

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

   282

	allow_on_slopes = (!_is_old_ai_player

   283

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

   284

   285

	/* Try and clear the start landscape */

   286

   287

	ret = DoCommandByTile(ti_start.tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   288

	if (CmdFailed(ret)) return ret;

   289

	cost = ret;

   290

   291

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

   292

	terraformcost = CheckBridgeSlope(direction, ti_start.tileh, true);

   293

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

   294

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   295

	cost += terraformcost;

   296

   297

	/* Try and clear the end landscape */

   298

   299

	ret = DoCommandByTile(ti_end.tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   300

	if (CmdFailed(ret)) return ret;

   301

	cost += ret;

   302

   303

	// false - end tile slope check

   304

	terraformcost = CheckBridgeSlope(direction, ti_end.tileh, false);

   305

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

   306

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   307

	cost += terraformcost;

   308

   309

   310

	/* do the drill? */

   311

	if (flags & DC_EXEC) {

   312

		/* build the start tile */

   313

		ModifyTile(ti_start.tile,

   314

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   315

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   316

			(bridge_type << 4), /* map2 */

   317

			railtype, /* map3_lo */

   318

			0x80 | direction | transport << 1 /* map5 */

   319

		);

   320

   321

		/* build the end tile */

   322

		ModifyTile(ti_end.tile,

   323

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   324

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   325

			(bridge_type << 4), /* map2 */

   326

			railtype, /* map3_lo */

   327

			0x80 | 0x20 | direction | transport << 1 /* map5 */

   328

		);

   329

	}

   330

   331

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

   332

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

   333

   334

	tile = ti_start.tile;

   335

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

   336

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

   337

		TransportType transport_under;

   338

		Owner owner_under = OWNER_NONE;

   339

		RailType rail_under = INVALID_RAILTYPE;

   340

		uint z;

   341

   342

		tile += delta;

   343

   344

		if (GetTileSlope(tile, &z) != 0 && z >= ti_start.z) {

   345

			return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   346

		}

   347

   348

		switch (GetTileType(tile)) {

   349

			case MP_WATER:

   350

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

   351

				if (_m[tile].m5 > 1) goto not_valid_below;

   352

				transport_under = TRANSPORT_WATER;

   353

				break;

   354

   355

			case MP_RAILWAY:

   356

				if (_m[tile].m5 != (direction == AXIS_X ? TRACK_BIT_Y : TRACK_BIT_X)) {

   357

					goto not_valid_below;

   358

				}

   359

				transport_under = TRANSPORT_RAIL;

   360

				owner_under = GetTileOwner(tile);

   361

				rail_under = GB(_m[tile].m3, 0, 4);

   362

				break;

   363

   364

			case MP_STREET:

   365

				if (GetRoadType(tile) != ROAD_NORMAL ||

   366

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

   367

					goto not_valid_below;

   368

				}

   369

				transport_under = TRANSPORT_ROAD;

   370

				owner_under = GetTileOwner(tile);

   371

				break;

   372

   373

			default:

   374

not_valid_below:;

   375

				/* try and clear the middle landscape */

   376

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

   377

				if (CmdFailed(ret)) return ret;

   378

				cost += ret;

   379

				transport_under = INVALID_TRANSPORT;

   380

				break;

   381

		}

   382

   383

		/* do middle part of bridge */

   384

		if (flags & DC_EXEC) {

   385

			uint piece;

   386

   387

			SetTileType(tile, MP_TUNNELBRIDGE);

   388

   389

			//bridges pieces sequence (middle parts)

   390

			// bridge len 1: 0

   391

			// bridge len 2: 0 1

   392

			// bridge len 3: 0 4 1

   393

			// bridge len 4: 0 2 3 1

   394

			// bridge len 5: 0 2 5 3 1

   395

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

   396

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

   397

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

   398

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

   399

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

   400

   401

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

   402

				piece = 0;

   403

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

   404

				piece = 1;

   405

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

   406

				piece = 5 - (i % 2);

   407

			} else {

   408

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

   409

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

   410

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

   411

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

   412

			}

   413

   414

			_m[tile].m2 = (bridge_type << 4) | piece;

   415

			SB(_m[tile].m3, 4, 4, railtype);

   416

			_m[tile].m5 = 0xC0 | transport << 1 | direction;

   417

			switch (transport_under) {

   418

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

   419

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

   420

				case TRANSPORT_WATER: SetWaterUnderBridge(tile); break;

   421

				default:              SetClearUnderBridge(tile); break;

   422

			}

   423

   424

			MarkTileDirtyByTile(tile);

   425

		}

   426

	}

   427

   428

	SetSignalsOnBothDir(ti_start.tile, direction == AXIS_X ? TRACK_X : TRACK_Y);

   429

   430

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

   431

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

   432

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

   433

	*/

   434

	if (!(flags & DC_QUERY_COST)) {

   435

		const Bridge *b = &_bridge[bridge_type];

   436

   437

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

   438

   439

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   440

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   441

   442

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

   443

	}

   444

   445

	return cost;

   446

}

   447

   448

   449

/** Build Tunnel.

   450

 * @param x,y start tile coord of tunnel

   451

 * @param p1 railtype, 0x200 for road tunnel

   452

 * @param p2 unused

   453

 */

   454

int32 CmdBuildTunnel(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   455

{

   456

	TileIndexDiff delta;

   457

	TileIndex start_tile;

   458

	TileIndex end_tile;

   459

	DiagDirection direction;

   460

	uint start_tileh;

   461

	uint end_tileh;

   462

	uint start_z;

   463

	uint end_z;

   464

	int32 cost;

   465

	int32 ret;

   466

   467

	_build_tunnel_endtile = 0;

   468

   469

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

   470

   471

	start_tile = TileVirtXY(x, y);

   472

	start_tileh = GetTileSlope(start_tile, &start_z);

   473

   474

	switch (start_tileh) {

   475

		case  3: direction = DIAGDIR_SW; break;

   476

		case  6: direction = DIAGDIR_SE; break;

   477

		case  9: direction = DIAGDIR_NW; break;

   478

		case 12: direction = DIAGDIR_NE; break;

   479

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   480

	}

   481

   482

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

   483

	if (CmdFailed(ret)) return ret;

   484

	cost = _price.build_tunnel + ret;

   485

   486

	delta = TileOffsByDir(direction);

   487

	end_tile = start_tile;

   488

	for (;;) {

   489

		end_tile += delta;

   490

		end_tileh = GetTileSlope(end_tile, &end_z);

   491

   492

		if (start_z == end_z) break;

   493