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

#include "train.h"

    26

    27

#include "table/bridge_land.h"

    28

    29

extern const byte _track_sloped_sprites[14];

    30

extern const SpriteID _water_shore_sprites[15];

    31

    32

extern void DrawCanalWater(TileIndex tile);

    33

    34

const Bridge orig_bridge[] = {

    35

/*

    36

	   year of availablity

    37

	   |  minimum length

    38

	   |  |   maximum length

    39

	   |  |   |    price

    40

	   |  |   |    |    maximum speed

    41

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

    42

	   |  |   |    |    |  |                                   |                            */

    43

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

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

};

    57

    61

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

    62

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

    63

int CalcBridgeLenCostFactor(int x)

    64

{

    65

	int n;

    66

	int r;

    67

    68

	if (x < 2) return x;

    69

	x -= 2;

    70

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

    71

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

    72

		r += n * n;

    73

		x -= n;

    74

	}

    75

}

    76

    77

enum {

    78

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

    79

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

    80

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

    81

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

    82

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

    83

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

    84

};

    85

    86

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

    87

{

    88

	const Bridge *bridge = &_bridge[index];

    89

	assert(table < 7);

    90

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

    91

		return _bridge_sprite_table[index][table];

    92

	} else {

    93

		return bridge->sprite_table[table];

    94

	}

    95

}

    96

    97

/**

    98

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

    99

 * @param tile The tile to analyze

   100

 * @return the piece

   101

 */

   102

static inline int GetBridgePiece(TileIndex tile)

   103

{

   104

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

   105

}

   106

   107

/**

   108

 * Determines the type of bridge on a tile

   109

 * @param tile The tile to analyze

   110

 * @return The bridge type

   111

 */

   112

static inline int GetBridgeType(TileIndex tile)

   113

{

   114

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

   115

}

   116

   117

/**	check if bridge can be built on slope

   118

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

   119

 *	is_start_tile = false		<-- end tile

   120

 *	is_start_tile = true		<-- start tile

   121

 */

   122

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

   123

{

   124

	if (IsSteepTileh(tileh)) return CMD_ERROR;

   125

   126

	if (is_start_tile) {

   127

		/* check slope at start tile

   128

				- no extra cost

   129

				- direction X: tiles 0, 12

   130

				- direction Y: tiles 0,  9

   131

		*/

   132

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

   133

   134

		// disallow certain start tiles to avoid certain crooked bridges

   135

		if (tileh == 2) return CMD_ERROR;

   136

	} else {

   137

		/*	check slope at end tile

   138

				- no extra cost

   139

				- direction X: tiles 0, 3

   140

				- direction Y: tiles 0, 6

   141

		*/

   142

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

   143

   144

		// disallow certain end tiles to avoid certain crooked bridges

   145

		if (tileh == 8) return CMD_ERROR;

   146

	}

   147

   148

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

   149

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

   150

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

   151

	 */

   152

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

   153

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

   154

		return CMD_ERROR;

   155

	}

   156

   157

	// slope foundations

   158

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

   159

		return _price.terraform;

   160

   161

	return CMD_ERROR;

   162

}

   163

   164

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   165

{

   166

	int x1 = TileX(begin);

   167

	int y1 = TileY(begin);

   168

	int x2 = TileX(end);

   169

	int y2 = TileY(end);

   170

   171

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

   172

}

   173

   174

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   175

{

   176

	const Bridge *b = &_bridge[bridge_type];

   177

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

   178

   179

	if (bridge_type >= MAX_BRIDGES) return false;

   180

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

   181

   182

	max = b->max_length;

   183

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

   184

   185

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

   186

}

   187

   188

/** Build a Bridge

   189

 * @param x,y end tile coord

   190

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

   191

 * @param p2 various bitstuffed elements

   192

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

   193

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

   194

 */

   195

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

   196

{

   197

	int bridge_type;

   198

	byte rail_or_road, railtype, m5;

   199

	int sx,sy;

   200

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

   201

	uint bridge_len;

   202

	uint odd_middle_part;

   203

	uint direction;

   204

	uint i;

   205

	int32 cost, terraformcost, ret;

   206

	bool allow_on_slopes;

   207

   208

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   209

   210

	/* unpack parameters */

   211

	bridge_type = GB(p2, 0, 8);

   212

	railtype    = GB(p2, 8, 8);

   213

   214

	if (p1 > MapSize()) return CMD_ERROR;

   215

   216

	// type of bridge

   217

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

   218

		railtype = 0;

   219

		rail_or_road = 2;

   220

	} else {

   221

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   222

		rail_or_road = 0;

   223

	}

   224

   225

	sx = TileX(p1) * 16;

   226

	sy = TileY(p1) * 16;

   227

   228

	direction = 0;

   229

   230

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

   231

	if (x == sx) {

   232

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

   233

		direction = 1;

   234

		if (y > sy) {

   235

			intswap(y,sy);

   236

			intswap(x,sx);

   237

		}

   238

	} else if (y == sy) {

   239

		if (x > sx) {

   240

			intswap(y,sy);

   241

			intswap(x,sx);

   242

		}

   243

	} else {

   244

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   245

	}

   246

   247

	/* set and test bridge length, availability */

   248

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

   249

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

   250

   251

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

   252

	if (

   253

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

   254

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

   255

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

   256

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

   257

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   258

   259

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

   260

		ti_start.z += 8;

   261

		ti_start.tileh = 0;

   262

	}

   263

   264

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

   265

		ti_end.z += 8;

   266

		ti_end.tileh = 0;

   267

	}

   268

   269

	if (ti_start.z != ti_end.z)

   270

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   271

   272

   273

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

   274

	allow_on_slopes = (!_is_old_ai_player

   275

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

   276

   277

	/* Try and clear the start landscape */

   278

   279

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

   280

		return CMD_ERROR;

   281

	cost = ret;

   282

   283

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

   284

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

   285

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

   286

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   287

	cost += terraformcost;

   288

   289

	/* Try and clear the end landscape */

   290

   291

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

   292

	if (CmdFailed(ret)) return CMD_ERROR;

   293

	cost += ret;

   294

   295

	// false - end tile slope check

   296

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

   297

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

   298

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   299

	cost += terraformcost;

   300

   301

   302

	/* do the drill? */

   303

	if (flags & DC_EXEC) {

   304

		/* build the start tile */

   305

		ModifyTile(ti_start.tile,

   306

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   307

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   308

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

   309

			railtype, /* map3_lo */

   310

			0x80 | direction | rail_or_road /* map5 */

   311

		);

   312

   313

		/* build the end tile */

   314

		ModifyTile(ti_end.tile,

   315

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   316

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   317

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

   318

			railtype, /* map3_lo */

   319

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

   320

		);

   321

	}

   322

   323

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

   324

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

   325

   326

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

   327

		if (direction != 0) {

   328

			y += 16;

   329

		} else {

   330

			x += 16;

   331

		}

   332

   333

		FindLandscapeHeight(&ti, x, y);

   334

   335

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   336

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

   337

   338

		// Find ship below

   339

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

   340

			_error_message = STR_980E_SHIP_IN_THE_WAY;

   341

			return CMD_ERROR;

   342

		}

   343

   344

		if (ti.type == MP_WATER) {

   345

			if (ti.map5 > 1) goto not_valid_below;

   346

			m5 = 0xC8;

   347

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

   348

			if (direction == 0) {

   349

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

   350

			} else {

   351

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

   352

			}

   353

			m5 = 0xE0;

   354

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

   355

			if (direction == 0) {

   356

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

   357

			} else {

   358

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

   359

			}

   360

			m5 = 0xE8;

   361

		} else {

   362

not_valid_below:;

   363

			/* try and clear the middle landscape */

   364

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

   365

			if (CmdFailed(ret)) return CMD_ERROR;

   366

			cost += ret;

   367

			m5 = 0xC0;

   368

		}

   369

   370

		/* do middle part of bridge */

   371

		if (flags & DC_EXEC) {

   372

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

   373

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   374

   375

			//bridges pieces sequence (middle parts)

   376

			// bridge len 1: 0

   377

			// bridge len 2: 0 1

   378

			// bridge len 3: 0 4 1

   379

			// bridge len 4: 0 2 3 1

   380

			// bridge len 5: 0 2 5 3 1

   381

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

   382

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

   383

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

   384

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

   385

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

   386

   387

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

   388

				m5 = 0;

   389

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

   390

				m5 = 1;

   391

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

   392

				m5 = 5 - (i % 2);

   393

			} else {

   394

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

   395

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

   396

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

   397

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

   398

			}

   399

   400

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

   401

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

   402

   403

			MarkTileDirtyByTile(ti.tile);

   404

		}

   405

	}

   406

   407

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

   408

   409

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

   410

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

   411

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

   412

	*/

   413

	if (!(flags & DC_QUERY_COST)) {

   414

		const Bridge *b = &_bridge[bridge_type];

   415

   416

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

   417

   418

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   419

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   420

   421

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

   422

	}

   423

   424

	return cost;

   425

}

   426

   427

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

   428

{

   429

	TileIndexDiff delta = TileOffsByDir(dir);

   430

	TileInfo ti;

   431

   432

	do {

   433

		tile -= delta;

   434

		FindLandscapeHeightByTile(&ti, tile);

   435

	} while (z < ti.z);

   436

   437

	if (z == ti.z &&

   438

			ti.type == MP_TUNNELBRIDGE &&

   439

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

   440

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

   441

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   442

		return false;

   443

	}

   444

   445

	return true;

   446

}

   447

   448

bool CheckTunnelInWay(TileIndex tile, int z)

   449

{

   450

	return DoCheckTunnelInWay(tile,z,0) &&

   451

		DoCheckTunnelInWay(tile,z,1) &&

   452

		DoCheckTunnelInWay(tile,z,2) &&

   453

		DoCheckTunnelInWay(tile,z,3);

   454

}

   455

   456

static byte _build_tunnel_bh;

   457

static byte _build_tunnel_railtype;

   458

   459

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

   460

{

   461

	TileIndex end_tile;

   462

	int direction;

   463

	int32 cost, ret;

   464

	TileInfo ti;

   465

	uint z;

   466

   467

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

   468

		return CMD_ERROR;

   469

   470

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

   471

	direction = 0;

   472

	if (x == x2) {

   473

		if (y == y2)

   474

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   475

		direction++;

   476

		if (y > y2) {

   477

			intswap(y,y2);

   478

			intswap(x,x2);

   479

			exc_tile|=2;

   480

		}

   481

	} else if (y == y2) {

   482

		if (x > x2) {

   483

			intswap(y,y2);

   484

			intswap(x,x2);

   485

			exc_tile|=2;

   486

		}

   487

	} else

   488

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   489

   490

	cost = 0;

   491

   492

	FindLandscapeHeight(&ti, x2, y2);

   493

	end_tile = ti.tile;

   494

	z = ti.z;

   495

   496

	if (exc_tile != 3) {

   497

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

   498

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   499

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

   500

		if (CmdFailed(ret)) return CMD_ERROR;

   501

		cost += ret;

   502

	}

   503

	cost += _price.build_tunnel;