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 "pbs.h"

    22

#include "debug.h"

    23

#include "variables.h"

    24

#include "bridge.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

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

    58

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

    59

int CalcBridgeLenCostFactor(int x)

    60

{

    61

	int n;

    62

	int r;

    63

    64

	if (x < 2) return x;

    65

	x -= 2;

    66

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

    67

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

    68

		r += n * n;

    69

		x -= n;

    70

	}

    71

}

    72

    73

enum {

    74

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

    75

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

    76

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

    77

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

    78

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

    79

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

    80

};

    81

    82

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

    83

{

    84

	const Bridge *bridge = &_bridge[index];

    85

	assert(table < 7);

    86

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

    87

		return _bridge_sprite_table[index][table];

    88

	} else {

    89

		return bridge->sprite_table[table];

    90

	}

    91

}

    92

    93

/**

    94

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

    95

 * @param tile The tile to analyze

    96

 * @return the piece

    97

 */

    98

static inline int GetBridgePiece(TileIndex tile)

    99

{

   100

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

   101

}

   102

   103

/**

   104

 * Determines the type of bridge on a tile

   105

 * @param tile The tile to analyze

   106

 * @return The bridge type

   107

 */

   108

static inline int GetBridgeType(TileIndex tile)

   109

{

   110

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

   111

}

   112

   113

/**	check if bridge can be built on slope

   114

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

   115

 *	is_start_tile = false		<-- end tile

   116

 *	is_start_tile = true		<-- start tile

   117

 */

   118

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

   119

{

   120

	if (IsSteepTileh(tileh)) return CMD_ERROR;

   121

   122

	if (is_start_tile) {

   123

		/* check slope at start tile

   124

				- no extra cost

   125

				- direction X: tiles 0, 12

   126

				- direction Y: tiles 0,  9

   127

		*/

   128

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

   129

   130

		// disallow certain start tiles to avoid certain crooked bridges

   131

		if (tileh == 2) return CMD_ERROR;

   132

	} else {

   133

		/*	check slope at end tile

   134

				- no extra cost

   135

				- direction X: tiles 0, 3

   136

				- direction Y: tiles 0, 6

   137

		*/

   138

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

   139

   140

		// disallow certain end tiles to avoid certain crooked bridges

   141

		if (tileh == 8) return CMD_ERROR;

   142

	}

   143

   144

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

   145

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

   146

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

   147

	 */

   148

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

   149

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

   150

		return CMD_ERROR;

   151

	}

   152

   153

	// slope foundations

   154

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

   155

		return _price.terraform;

   156

   157

	return CMD_ERROR;

   158

}

   159

   160

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   161

{

   162

	int x1 = TileX(begin);

   163

	int y1 = TileY(begin);

   164

	int x2 = TileX(end);

   165

	int y2 = TileY(end);

   166

   167

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

   168

}

   169

   170

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   171

{

   172

	const Bridge *b = &_bridge[bridge_type];

   173

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

   174

   175

	if (bridge_type >= MAX_BRIDGES) return false;

   176

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

   177

   178

	max = b->max_length;

   179

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

   180

   181

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

   182

}

   183

   184

/** Build a Bridge

   185

 * @param x,y end tile coord

   186

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

   187

 * @param p2 various bitstuffed elements

   188

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

   189

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

   190

 */

   191

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

   192

{

   193

	int bridge_type;

   194

	byte rail_or_road, railtype, m5;

   195

	int sx,sy;

   196

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

   197

	uint bridge_len;

   198

	uint odd_middle_part;

   199

	uint direction;

   200

	uint i;

   201

	int32 cost, terraformcost, ret;

   202

	bool allow_on_slopes;

   203

   204

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   205

   206

	/* unpack parameters */

   207

	bridge_type = GB(p2, 0, 8);

   208

	railtype    = GB(p2, 8, 8);

   209

   210

	if (p1 > MapSize()) return CMD_ERROR;

   211

   212

	// type of bridge

   213

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

   214

		railtype = 0;

   215

		rail_or_road = 2;

   216

	} else {

   217

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   218

		rail_or_road = 0;

   219

	}

   220

   221

	sx = TileX(p1) * 16;

   222

	sy = TileY(p1) * 16;

   223

   224

	direction = 0;

   225

   226

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

   227

	if (x == sx) {

   228

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

   229

		direction = 1;

   230

		if (y > sy) {

   231

			intswap(y,sy);

   232

			intswap(x,sx);

   233

		}

   234

	} else if (y == sy) {

   235

		if (x > sx) {

   236

			intswap(y,sy);

   237

			intswap(x,sx);

   238

		}

   239

	} else {

   240

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   241

	}

   242

   243

	/* set and test bridge length, availability */

   244

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

   245

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

   246

   247

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

   248

	if (

   249

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

   250

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

   251

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

   252

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

   253

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   254

   255

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

   256

		ti_start.z += 8;

   257

		ti_start.tileh = 0;

   258

	}

   259

   260

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

   261

		ti_end.z += 8;

   262

		ti_end.tileh = 0;

   263

	}

   264

   265

	if (ti_start.z != ti_end.z)

   266

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   267

   268

   269

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

   270

	allow_on_slopes = (!_is_old_ai_player

   271

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

   272

   273

	/* Try and clear the start landscape */

   274

   275

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

   276

		return CMD_ERROR;

   277

	cost = ret;

   278

   279

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

   280

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

   281

	if (terraformcost == CMD_ERROR || (terraformcost && !allow_on_slopes))

   282

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   283

	cost += terraformcost;

   284

   285

	/* Try and clear the end landscape */

   286

   287

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

   288

	if (CmdFailed(ret)) return CMD_ERROR;

   289

	cost += ret;

   290

   291

	// false - end tile slope check

   292

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

   293

	if (terraformcost == CMD_ERROR || (terraformcost && !allow_on_slopes))

   294

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   295

	cost += terraformcost;

   296

   297

   298

	/* do the drill? */

   299

	if (flags & DC_EXEC) {

   300

		/* build the start tile */

   301

		ModifyTile(ti_start.tile,

   302

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   303

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   304

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

   305

			railtype, /* map3_lo */

   306

			0x80 | direction | rail_or_road /* map5 */

   307

		);

   308

   309

		/* build the end tile */

   310

		ModifyTile(ti_end.tile,

   311

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   312

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   313

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

   314

			railtype, /* map3_lo */

   315

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

   316

		);

   317

	}

   318

   319

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

   320

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

   321

   322

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

   323

		if (direction != 0) {

   324

			y += 16;

   325

		} else {

   326

			x += 16;

   327

		}

   328

   329

		FindLandscapeHeight(&ti, x, y);

   330

   331

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   332

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

   333

   334

		// Find ship below

   335

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

   336

			_error_message = STR_980E_SHIP_IN_THE_WAY;

   337

			return CMD_ERROR;

   338

		}

   339

   340

		if (ti.type == MP_WATER) {

   341

			if (ti.map5 > 1) goto not_valid_below;

   342

			m5 = 0xC8;

   343

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

   344

			if (direction == 0) {

   345

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

   346

			} else {

   347

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

   348

			}

   349

			m5 = 0xE0;

   350

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

   351

			if (direction == 0) {

   352

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

   353

			} else {

   354

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

   355

			}

   356

			m5 = 0xE8;

   357

		} else {

   358

not_valid_below:;

   359

			/* try and clear the middle landscape */

   360

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

   361

			if (CmdFailed(ret)) return CMD_ERROR;

   362

			cost += ret;

   363

			m5 = 0xC0;

   364

		}

   365

   366

		/* do middle part of bridge */

   367

		if (flags & DC_EXEC) {

   368

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

   369

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   370

   371

			//bridges pieces sequence (middle parts)

   372

			// bridge len 1: 0

   373

			// bridge len 2: 0 1

   374

			// bridge len 3: 0 4 1

   375

			// bridge len 4: 0 2 3 1

   376

			// bridge len 5: 0 2 5 3 1

   377

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

   378

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

   379

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

   380

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

   381

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

   382

   383

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

   384

				m5 = 0;

   385

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

   386

				m5 = 1;

   387

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

   388

				m5 = 5 - (i % 2);

   389

			} else {

   390

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

   391

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

   392

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

   393

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

   394

			}

   395

   396

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

   397

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

   398

   399

			MarkTileDirtyByTile(ti.tile);

   400

		}

   401

	}

   402

   403

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

   404

   405

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

   406

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

   407

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

   408

	*/

   409

	if (!(flags & DC_QUERY_COST)) {

   410

		const Bridge *b = &_bridge[bridge_type];

   411

   412

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

   413

   414

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   415

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   416

   417

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

   418

	}

   419

   420

	return cost;

   421

}

   422

   423

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

   424

{

   425

	TileIndexDiff delta = TileOffsByDir(dir);

   426

	TileInfo ti;

   427

   428

	do {

   429

		tile -= delta;

   430

		FindLandscapeHeightByTile(&ti, tile);

   431

	} while (z < ti.z);

   432

   433

	if (z == ti.z && ti.type == MP_TUNNELBRIDGE && (ti.map5&0xF0) == 0 && (ti.map5&3) == dir) {

   434

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   435

		return false;

   436

	}

   437

   438

	return true;

   439

}

   440

   441

bool CheckTunnelInWay(TileIndex tile, int z)

   442

{

   443

	return DoCheckTunnelInWay(tile,z,0) &&

   444

		DoCheckTunnelInWay(tile,z,1) &&

   445

		DoCheckTunnelInWay(tile,z,2) &&

   446

		DoCheckTunnelInWay(tile,z,3);

   447

}

   448

   449

static byte _build_tunnel_bh;

   450

static byte _build_tunnel_railtype;

   451

   452

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

   453

{

   454

	TileIndex end_tile;

   455

	int direction;

   456

	int32 cost, ret;

   457

	TileInfo ti;

   458

	uint z;

   459

   460

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

   461

		return CMD_ERROR;

   462

   463

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

   464

	direction = 0;

   465

	if (x == x2) {

   466

		if (y == y2)

   467

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   468

		direction++;

   469

		if (y > y2) {

   470

			intswap(y,y2);

   471

			intswap(x,x2);

   472

			exc_tile|=2;

   473

		}

   474

	} else if (y == y2) {

   475

		if (x > x2) {

   476

			intswap(y,y2);

   477

			intswap(x,x2);

   478

			exc_tile|=2;

   479

		}

   480

	} else

   481

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   482

   483

	cost = 0;

   484

   485

	FindLandscapeHeight(&ti, x2, y2);

   486

	end_tile = ti.tile;

   487

	z = ti.z;

   488

   489

	if (exc_tile != 3) {

   490

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

   491

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   492

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

   493

		if (CmdFailed(ret)) return CMD_ERROR;

   494

		cost += ret;

   495

	}

   496

	cost += _price.build_tunnel;

   497

   498

	for (;;) {

   499

		if (direction) y2-=16; else x2-=16;

   500

   501

		if (x2 == x && y2 == y) break;

   502

   503

		FindLandscapeHeight(&ti, x2, y2);

   504

		if (ti.z <= z) return CMD_ERROR;