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"

    11

#include "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "functions.h"

    14

#include "map.h"

    15

#include "tile.h"

    16

#include "vehicle.h"

    17

#include "viewport.h"

    18

#include "command.h"

    19

#include "player.h"

    20

#include "town.h"

    21

#include "sound.h"

    22

#include "variables.h"

    23

#include "bridge.h"

    24

#include "train.h"

    25

    26

#include "table/bridge_land.h"

    27

    28

extern const byte _track_sloped_sprites[14];

    29

extern const SpriteID _water_shore_sprites[15];

    30

    31

extern void DrawCanalWater(TileIndex tile);

    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

enum {

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

};

    84

    85

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

    86

{

    87

	const Bridge *bridge = &_bridge[index];

    88

	assert(table < 7);

    89

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

    90

		return _bridge_sprite_table[index][table];

    91

	} else {

    92

		return bridge->sprite_table[table];

    93

	}

    94

}

    95

    96

/**

    97

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

    98

 * @param tile The tile to analyze

    99

 * @return the piece

   100

 */

   101

static inline int GetBridgePiece(TileIndex tile)

   102

{

   103

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

   104

}

   105

   106

/**

   107

 * Determines the type of bridge on a tile

   108

 * @param tile The tile to analyze

   109

 * @return The bridge type

   110

 */

   111

static inline int GetBridgeType(TileIndex tile)

   112

{

   113

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

   114

}

   115

   116

/**	check if bridge can be built on slope

   117

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

   118

 *	is_start_tile = false		<-- end tile

   119

 *	is_start_tile = true		<-- start tile

   120

 */

   121

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

   122

{

   123

	if (IsSteepTileh(tileh)) return CMD_ERROR;

   124

   125

	if (is_start_tile) {

   126

		/* check slope at start tile

   127

				- no extra cost

   128

				- direction X: tiles 0, 12

   129

				- direction Y: tiles 0,  9

   130

		*/

   131

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

   132

   133

		// disallow certain start tiles to avoid certain crooked bridges

   134

		if (tileh == 2) return CMD_ERROR;

   135

	} else {

   136

		/*	check slope at end tile

   137

				- no extra cost

   138

				- direction X: tiles 0, 3

   139

				- direction Y: tiles 0, 6

   140

		*/

   141

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

   142

   143

		// disallow certain end tiles to avoid certain crooked bridges

   144

		if (tileh == 8) return CMD_ERROR;

   145

	}

   146

   147

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

   148

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

   149

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

   150

	 */

   151

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

   152

			(tileh == 4 && is_start_tile == (bool)direction)) {

   153

		return CMD_ERROR;

   154

	}

   155

   156

	// slope foundations

   157

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

   158

		return _price.terraform;

   159

   160

	return CMD_ERROR;

   161

}

   162

   163

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   164

{

   165

	int x1 = TileX(begin);

   166

	int y1 = TileY(begin);

   167

	int x2 = TileX(end);

   168

	int y2 = TileY(end);

   169

   170

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

   171

}

   172

   173

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   174

{

   175

	const Bridge *b = &_bridge[bridge_type];

   176

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

   177

   178

	if (bridge_type >= MAX_BRIDGES) return false;

   179

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

   180

   181

	max = b->max_length;

   182

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

   183

   184

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

   185

}

   186

   187

/** Build a Bridge

   188

 * @param x,y end tile coord

   189

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

   190

 * @param p2 various bitstuffed elements

   191

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

   192

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

   193

 */

   194

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

   195

{

   196

	int bridge_type;

   197

	byte rail_or_road, railtype, m5;

   198

	int sx,sy;

   199

	TileInfo ti_start, ti_end, ti; /* OPT: only 2 of those are ever used */

   200

	uint bridge_len;

   201

	uint odd_middle_part;

   202

	uint 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

	railtype    = GB(p2, 8, 8);

   212

   213

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

   214

   215

	// type of bridge

   216

	if (HASBIT(railtype, 7)) { // bit 15 of original p2 param

   217

		railtype = 0;

   218

		rail_or_road = 2;

   219

	} else {

   220

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   221

		rail_or_road = 0;

   222

	}

   223

   224

	sx = TileX(p1) * 16;

   225

	sy = TileY(p1) * 16;

   226

   227

	direction = 0;

   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 = 1;

   233

		if (y > sy) {

   234

			intswap(y,sy);

   235

			intswap(x,sx);

   236

		}

   237

	} else if (y == sy) {

   238

		if (x > sx) {

   239

			intswap(y,sy);

   240

			intswap(x,sx);

   241

		}

   242

	} else {

   243

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   244

	}

   245

   246

	/* set and test bridge length, availability */

   247

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

   248

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

   249

   250

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

   251

	if ((

   252

				FindLandscapeHeight(&ti_end, sx, sy),

   253

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

   254

			) || (

   255

				FindLandscapeHeight(&ti_start, x, y),

   256

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

   257

			)) {

   258

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   259

	}

   260

   261

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

   262

		ti_start.z += 8;

   263

		ti_start.tileh = 0;

   264

	}

   265

   266

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

   267

		ti_end.z += 8;

   268

		ti_end.tileh = 0;

   269

	}

   270

   271

	if (ti_start.z != ti_end.z)

   272

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   273

   274

   275

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

   276

	allow_on_slopes = (!_is_old_ai_player

   277

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

   278

   279

	/* Try and clear the start landscape */

   280

   281

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

   282

		return CMD_ERROR;

   283

	cost = ret;

   284

   285

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

   286

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

   287

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

   288

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   289

	cost += terraformcost;

   290

   291

	/* Try and clear the end landscape */

   292

   293

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

   294

	if (CmdFailed(ret)) return CMD_ERROR;

   295

	cost += ret;

   296

   297

	// false - end tile slope check

   298

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

   299

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

   300

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   301

	cost += terraformcost;

   302

   303

   304

	/* do the drill? */

   305

	if (flags & DC_EXEC) {

   306

		/* build the start tile */

   307

		ModifyTile(ti_start.tile,

   308

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   309

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   310

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

   311

			railtype, /* map3_lo */

   312

			0x80 | direction | rail_or_road /* map5 */

   313

		);

   314

   315

		/* build the end tile */

   316

		ModifyTile(ti_end.tile,

   317

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   318

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   319

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

   320

			railtype, /* map3_lo */

   321

			0x80 | 0x20 | direction | rail_or_road /* map5 */

   322

		);

   323

	}

   324

   325

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

   326

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

   327

   328

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

   329

		if (direction != 0) {

   330

			y += 16;

   331

		} else {

   332

			x += 16;

   333

		}

   334

   335

		FindLandscapeHeight(&ti, x, y);

   336

   337

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   338

		if (ti.tileh != 0 && ti.z >= ti_start.z) return CMD_ERROR;

   339

   340

		switch (ti.type){

   341

			case MP_WATER:

   342

				if (!EnsureNoVehicle(ti.tile)) {

   343

					_error_message = STR_980E_SHIP_IN_THE_WAY;

   344

					return CMD_ERROR;

   345

				}

   346

				if (ti.map5 > 1) goto not_valid_below;

   347

				m5 = 0xC8;

   348

				break;

   349

   350

			case MP_RAILWAY:

   351

				if (ti.map5 != (direction == 0 ? 2 : 1)) goto not_valid_below;

   352

				m5 = 0xE0;

   353

				break;

   354

   355

			case MP_STREET:

   356

				if (GetRoadType(ti.tile) != ROAD_NORMAL ||

   357

						GetRoadBits(ti.tile) != (direction == 0 ? ROAD_Y : ROAD_X)) {

   358

					goto not_valid_below;

   359

				}

   360

				m5 = 0xE8;

   361

				break;

   362

   363

			default:

   364

not_valid_below:;

   365

				/* try and clear the middle landscape */

   366

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

   367

				if (CmdFailed(ret)) return CMD_ERROR;

   368

				cost += ret;

   369

				m5 = 0xC0;

   370

				break;

   371

		}

   372

   373

		/* do middle part of bridge */

   374

		if (flags & DC_EXEC) {

   375

			_m[ti.tile].m5 = (byte)(m5 | direction | rail_or_road);

   376

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   377

   378

			//bridges pieces sequence (middle parts)

   379

			// bridge len 1: 0

   380

			// bridge len 2: 0 1

   381

			// bridge len 3: 0 4 1

   382

			// bridge len 4: 0 2 3 1

   383

			// bridge len 5: 0 2 5 3 1

   384

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

   385

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

   386

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

   387

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

   388

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

   389

   390

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

   391

				m5 = 0;

   392

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

   393

				m5 = 1;

   394

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

   395

				m5 = 5 - (i % 2);

   396

			} else {

   397

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

   398

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

   399

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

   400

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

   401

			}

   402

   403

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

   404

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

   405

   406

			MarkTileDirtyByTile(ti.tile);

   407

		}

   408

	}

   409

   410

	SetSignalsOnBothDir(ti_start.tile, (direction & 1) ? 1 : 0);

   411

   412

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

   413

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

   414

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

   415

	*/

   416

	if (!(flags & DC_QUERY_COST)) {

   417

		const Bridge *b = &_bridge[bridge_type];

   418

   419

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

   420

   421

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   422

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   423

   424

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

   425

	}

   426

   427

	return cost;

   428

}

   429

   430

static bool DoCheckTunnelInWay(TileIndex tile, uint z, uint dir)

   431

{

   432

	TileIndexDiff delta = TileOffsByDir(dir);

   433

	uint height;

   434

   435

	do {

   436

		tile -= delta;

   437

		height = GetTileZ(tile);

   438

	} while (z < height);

   439

   440

	if (z == height &&

   441

			IsTileType(tile, MP_TUNNELBRIDGE) &&

   442

			GB(_m[tile].m5, 4, 4) == 0 &&

   443

			GB(_m[tile].m5, 0, 2) == dir) {

   444

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   445

		return false;

   446

	}

   447

   448

	return true;

   449

}

   450

   451

bool CheckTunnelInWay(TileIndex tile, int z)

   452

{

   453

	return DoCheckTunnelInWay(tile,z,0) &&

   454

		DoCheckTunnelInWay(tile,z,1) &&

   455

		DoCheckTunnelInWay(tile,z,2) &&

   456

		DoCheckTunnelInWay(tile,z,3);

   457

}

   458

   459

   460

/** Build Tunnel.

   461

 * @param x,y start tile coord of tunnel

   462

 * @param p1 railtype, 0x200 for road tunnel

   463

 * @param p2 unused

   464

 */

   465

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

   466

{

   467

	TileIndexDiff delta;

   468

	TileIndex start_tile;

   469

	TileIndex end_tile;

   470

	DiagDirection direction;

   471

	uint start_tileh;

   472

	uint end_tileh;

   473

	uint start_z;

   474

	uint end_z;

   475

	int32 cost;

   476

	int32 ret;

   477

   478

	_build_tunnel_endtile = 0;

   479

   480

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

   481

   482

	start_tile = TileVirtXY(x, y);

   483

	start_tileh = GetTileSlope(start_tile, &start_z);

   484

   485

	switch (start_tileh) {

   486

		case  3: direction = DIAGDIR_SW; break;

   487

		case  6: direction = DIAGDIR_SE; break;

   488

		case  9: direction = DIAGDIR_NW; break;

   489

		case 12: direction = DIAGDIR_NE; break;

   490

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   491

	}

   492

   493

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

   494

	if (CmdFailed(ret)) return ret;

   495

	cost = _price.build_tunnel + ret;

   496

   497

	delta = TileOffsByDir(direction);

   498

	end_tile = start_tile;