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 "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "functions.h"

    13

#include "map.h"

    14

#include "tile.h"

    15

#include "vehicle.h"

    16

#include "viewport.h"

    17

#include "command.h"

    18

#include "player.h"

    19

#include "town.h"

    20

#include "sound.h"

    21

#include "variables.h"

    22

#include "bridge.h"

    23

#include "train.h"

    24

    25

#include "table/bridge_land.h"

    26

    27

extern const byte _track_sloped_sprites[14];

    28

extern const SpriteID _water_shore_sprites[15];

    29

    30

extern void DrawCanalWater(TileIndex tile);

    31

    32

const Bridge orig_bridge[] = {

    33

/*

    34

	   year of availablity

    35

	   |  minimum length

    36

	   |  |   maximum length

    37

	   |  |   |    price

    38

	   |  |   |    |    maximum speed

    39

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

    40

	   |  |   |    |    |  |                                   |                            */

    41

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

    42

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

    43

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

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

};

    55

    56

Bridge _bridge[MAX_BRIDGES];

    57

    58

    59

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

    60

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

    61

int CalcBridgeLenCostFactor(int x)

    62

{

    63

	int n;

    64

	int r;

    65

    66

	if (x < 2) return x;

    67

	x -= 2;

    68

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

    69

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

    70

		r += n * n;

    71

		x -= n;

    72

	}

    73

}

    74

    75

enum {

    76

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

    77

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

    78

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

    79

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

    80

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

    81

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

    82

};

    83

    84

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

    85

{

    86

	const Bridge *bridge = &_bridge[index];

    87

	assert(table < 7);

    88

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

    89

		return _bridge_sprite_table[index][table];

    90

	} else {

    91

		return bridge->sprite_table[table];

    92

	}

    93

}

    94

    95

/**

    96

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

    97

 * @param tile The tile to analyze

    98

 * @return the piece

    99

 */

   100

static inline int GetBridgePiece(TileIndex tile)

   101

{

   102

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

   103

}

   104

   105

/**

   106

 * Determines the type of bridge on a tile

   107

 * @param tile The tile to analyze

   108

 * @return The bridge type

   109

 */

   110

static inline int GetBridgeType(TileIndex tile)

   111

{

   112

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

   113

}

   114

   115

/**	check if bridge can be built on slope

   116

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

   117

 *	is_start_tile = false		<-- end tile

   118

 *	is_start_tile = true		<-- start tile

   119

 */

   120

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

   121

{

   122

	if (IsSteepTileh(tileh)) return CMD_ERROR;

   123

   124

	if (is_start_tile) {

   125

		/* check slope at start tile

   126

				- no extra cost

   127

				- direction X: tiles 0, 12

   128

				- direction Y: tiles 0,  9

   129

		*/

   130

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

   131

   132

		// disallow certain start tiles to avoid certain crooked bridges

   133

		if (tileh == 2) return CMD_ERROR;

   134

	} else {

   135

		/*	check slope at end tile

   136

				- no extra cost

   137

				- direction X: tiles 0, 3

   138

				- direction Y: tiles 0, 6

   139

		*/

   140

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

   141

   142

		// disallow certain end tiles to avoid certain crooked bridges

   143

		if (tileh == 8) return CMD_ERROR;

   144

	}

   145

   146

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

   147

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

   148

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

   149

	 */

   150

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

   151

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

   152

		return CMD_ERROR;

   153

	}

   154

   155

	// slope foundations

   156

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

   157

		return _price.terraform;

   158

   159

	return CMD_ERROR;

   160

}

   161

   162

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   163

{

   164

	int x1 = TileX(begin);

   165

	int y1 = TileY(begin);

   166

	int x2 = TileX(end);

   167

	int y2 = TileY(end);

   168

   169

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

   170

}

   171

   172

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   173

{

   174

	const Bridge *b = &_bridge[bridge_type];

   175

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

   176

   177

	if (bridge_type >= MAX_BRIDGES) return false;

   178

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

   179

   180

	max = b->max_length;

   181

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

   182

   183

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

   184

}

   185

   186

/** Build a Bridge

   187

 * @param x,y end tile coord

   188

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

   189

 * @param p2 various bitstuffed elements

   190

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

   191

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

   192

 */

   193

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

   194

{

   195

	int bridge_type;

   196

	byte rail_or_road, railtype, m5;

   197

	int sx,sy;

   198

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

   199

	uint bridge_len;

   200

	uint odd_middle_part;

   201

	uint direction;

   202

	uint i;

   203

	int32 cost, terraformcost, ret;

   204

	bool allow_on_slopes;

   205

   206

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   207

   208

	/* unpack parameters */

   209

	bridge_type = GB(p2, 0, 8);

   210

	railtype    = GB(p2, 8, 8);

   211

   212

	if (p1 > MapSize()) return CMD_ERROR;

   213

   214

	// type of bridge

   215

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

   216

		railtype = 0;

   217

		rail_or_road = 2;

   218

	} else {

   219

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   220

		rail_or_road = 0;

   221

	}

   222

   223

	sx = TileX(p1) * 16;

   224

	sy = TileY(p1) * 16;

   225

   226

	direction = 0;

   227

   228

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

   229

	if (x == sx) {

   230

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

   231

		direction = 1;

   232

		if (y > sy) {

   233

			intswap(y,sy);

   234

			intswap(x,sx);

   235

		}

   236

	} else if (y == sy) {

   237

		if (x > sx) {

   238

			intswap(y,sy);

   239

			intswap(x,sx);

   240

		}

   241

	} else {

   242

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   243

	}

   244

   245

	/* set and test bridge length, availability */

   246

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

   247

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

   248

   249

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

   250

	if (

   251

		((FindLandscapeHeight(&ti_end, sx, sy),

   252

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

   253

		((FindLandscapeHeight(&ti_start, x, y),

   254

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

   255

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   256

   257

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

   258

		ti_start.z += 8;

   259

		ti_start.tileh = 0;

   260

	}

   261

   262

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

   263

		ti_end.z += 8;

   264

		ti_end.tileh = 0;

   265

	}

   266

   267

	if (ti_start.z != ti_end.z)

   268

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   269

   270

   271

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

   272

	allow_on_slopes = (!_is_old_ai_player

   273

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

   274

   275

	/* Try and clear the start landscape */

   276

   277

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

   278

		return CMD_ERROR;

   279

	cost = ret;

   280

   281

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

   282

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

   283

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

   284

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   285

	cost += terraformcost;

   286

   287

	/* Try and clear the end landscape */

   288

   289

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

   290

	if (CmdFailed(ret)) return CMD_ERROR;

   291

	cost += ret;

   292

   293

	// false - end tile slope check

   294

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

   295

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

   296

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   297

	cost += terraformcost;

   298

   299

   300

	/* do the drill? */

   301

	if (flags & DC_EXEC) {

   302

		/* build the start tile */

   303

		ModifyTile(ti_start.tile,

   304

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   305

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   306

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

   307

			railtype, /* map3_lo */

   308

			0x80 | direction | rail_or_road /* map5 */

   309

		);

   310

   311

		/* build the end tile */

   312

		ModifyTile(ti_end.tile,

   313

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   314

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   315

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

   316

			railtype, /* map3_lo */

   317

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

   318

		);

   319

	}

   320

   321

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

   322

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

   323

   324

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

   325

		if (direction != 0) {

   326

			y += 16;

   327

		} else {

   328

			x += 16;

   329

		}

   330

   331

		FindLandscapeHeight(&ti, x, y);

   332

   333

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   334

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

   335

   336

		// Find ship below

   337

		if (ti.type == MP_WATER && !EnsureNoVehicle(ti.tile)) {

   338

			_error_message = STR_980E_SHIP_IN_THE_WAY;

   339

			return CMD_ERROR;

   340

		}

   341

   342

		if (ti.type == MP_WATER) {

   343

			if (ti.map5 > 1) goto not_valid_below;

   344

			m5 = 0xC8;

   345

		} else if (ti.type == MP_RAILWAY) {

   346

			if (direction == 0) {

   347

				if (ti.map5 != 2) goto not_valid_below;

   348

			} else {

   349

				if (ti.map5 != 1) goto not_valid_below;

   350

			}

   351

			m5 = 0xE0;

   352

		} else if (ti.type == MP_STREET) {

   353

			if (direction == 0) {

   354

				if (ti.map5 != 5) goto not_valid_below;

   355

			} else {

   356

				if (ti.map5 != 10) goto not_valid_below;

   357

			}

   358

			m5 = 0xE8;

   359

		} else {

   360

not_valid_below:;

   361

			/* try and clear the middle landscape */

   362

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

   363

			if (CmdFailed(ret)) return CMD_ERROR;

   364

			cost += ret;

   365

			m5 = 0xC0;

   366

		}

   367

   368

		/* do middle part of bridge */

   369

		if (flags & DC_EXEC) {

   370

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

   371

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   372

   373

			//bridges pieces sequence (middle parts)

   374

			// bridge len 1: 0

   375

			// bridge len 2: 0 1

   376

			// bridge len 3: 0 4 1

   377

			// bridge len 4: 0 2 3 1

   378

			// bridge len 5: 0 2 5 3 1

   379

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

   380

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

   381

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

   382

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

   383

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

   384

   385

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

   386

				m5 = 0;

   387

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

   388

				m5 = 1;

   389

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

   390

				m5 = 5 - (i % 2);

   391

			} else {

   392

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

   393

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

   394

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

   395

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

   396

			}

   397

   398

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

   399

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

   400

   401

			MarkTileDirtyByTile(ti.tile);

   402

		}

   403

	}

   404

   405

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

   406

   407

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

   408

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

   409

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

   410

	*/

   411

	if (!(flags & DC_QUERY_COST)) {

   412

		const Bridge *b = &_bridge[bridge_type];

   413

   414

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

   415

   416

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   417

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   418

   419

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

   420

	}

   421

   422

	return cost;

   423

}

   424

   425

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

   426

{

   427

	TileIndexDiff delta = TileOffsByDir(dir);

   428

	TileInfo ti;

   429

   430

	do {

   431

		tile -= delta;

   432

		FindLandscapeHeightByTile(&ti, tile);

   433

	} while (z < ti.z);

   434

   435

	if (z == ti.z &&

   436

			ti.type == MP_TUNNELBRIDGE &&

   437

			GB(ti.map5, 4, 4) == 0 &&

   438

			GB(ti.map5, 0, 2) == dir) {

   439

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   440

		return false;

   441

	}

   442

   443

	return true;

   444

}

   445

   446

bool CheckTunnelInWay(TileIndex tile, int z)

   447

{

   448

	return DoCheckTunnelInWay(tile,z,0) &&

   449

		DoCheckTunnelInWay(tile,z,1) &&

   450

		DoCheckTunnelInWay(tile,z,2) &&

   451

		DoCheckTunnelInWay(tile,z,3);

   452

}

   453

   454

static byte _build_tunnel_bh;

   455

static byte _build_tunnel_railtype;

   456

   457

static int32 DoBuildTunnel(int x, int y, int x2, int y2, uint32 flags, uint exc_tile)

   458

{

   459

	TileIndex end_tile;

   460

	int direction;

   461

	int32 cost, ret;

   462

	TileInfo ti;

   463

	uint z;

   464

   465

	if ((uint)x > MapMaxX() * 16 - 1 || (uint)y > MapMaxY() * 16 - 1)

   466

		return CMD_ERROR;

   467

   468

	/* check if valid, and make sure that (x,y) is smaller than (x2,y2) */

   469

	direction = 0;

   470

	if (x == x2) {

   471

		if (y == y2)

   472

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   473

		direction++;

   474

		if (y > y2) {

   475

			intswap(y,y2);

   476

			intswap(x,x2);

   477

			exc_tile|=2;

   478

		}

   479

	} else if (y == y2) {

   480

		if (x > x2) {

   481

			intswap(y,y2);

   482

			intswap(x,x2);

   483

			exc_tile|=2;

   484

		}

   485

	} else

   486

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   487

   488

	cost = 0;

   489

   490

	FindLandscapeHeight(&ti, x2, y2);

   491

	end_tile = ti.tile;

   492

	z = ti.z;

   493

   494

	if (exc_tile != 3) {

   495

		if ((direction ? 9U : 12U) != ti.tileh)

   496

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   497

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

   498

		if (CmdFailed(ret)) return CMD_ERROR;

   499

		cost += ret;

   500

	}

   501

	cost += _price.build_tunnel;

   502

   503

	for (;;) {