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

    58

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

    59

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

    60

int CalcBridgeLenCostFactor(int x)

    61

{

    62

	int n;

    63

	int r;

    64

    65

	if (x < 2) return x;

    66

	x -= 2;

    67

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

    68

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

    69

		r += n * n;

    70

		x -= n;

    71

	}

    72

}

    73

    74

enum {

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

};

    82

    83

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

    84

{

    85

	const Bridge *bridge = &_bridge[index];

    86

	assert(table < 7);

    87

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

    88

		return _bridge_sprite_table[index][table];

    89

	} else {

    90

		return bridge->sprite_table[table];

    91

	}

    92

}

    93

    94

/**

    95

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

    96

 * @param tile The tile to analyze

    97

 * @return the piece

    98

 */

    99

static inline int GetBridgePiece(TileIndex tile)

   100

{

   101

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

   102

}

   103

   104

/**

   105

 * Determines the type of bridge on a tile

   106

 * @param tile The tile to analyze

   107

 * @return The bridge type

   108

 */

   109

static inline int GetBridgeType(TileIndex tile)

   110

{

   111

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

   112

}

   113

   114

/**	check if bridge can be built on slope

   115

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

   116

 *	is_start_tile = false		<-- end tile

   117

 *	is_start_tile = true		<-- start tile

   118

 */

   119

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

   120

{

   121

	if (IsSteepTileh(tileh)) return CMD_ERROR;

   122

   123

	if (is_start_tile) {

   124

		/* check slope at start tile

   125

				- no extra cost

   126

				- direction X: tiles 0, 12

   127

				- direction Y: tiles 0,  9

   128

		*/

   129

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

   130

   131

		// disallow certain start tiles to avoid certain crooked bridges

   132

		if (tileh == 2) return CMD_ERROR;

   133

	} else {

   134

		/*	check slope at end tile

   135

				- no extra cost

   136

				- direction X: tiles 0, 3

   137

				- direction Y: tiles 0, 6

   138

		*/

   139

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

   140

   141

		// disallow certain end tiles to avoid certain crooked bridges

   142

		if (tileh == 8) return CMD_ERROR;

   143

	}

   144

   145

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

   146

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

   147

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

   148

	 */

   149

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

   150

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

   151

		return CMD_ERROR;

   152

	}

   153

   154

	// slope foundations

   155

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

   156

		return _price.terraform;

   157

   158

	return CMD_ERROR;

   159

}

   160

   161

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   162

{

   163

	int x1 = TileX(begin);

   164

	int y1 = TileY(begin);

   165

	int x2 = TileX(end);

   166

	int y2 = TileY(end);

   167

   168

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

   169

}

   170

   171

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   172

{

   173

	const Bridge *b = &_bridge[bridge_type];

   174

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

   175

   176

	if (bridge_type >= MAX_BRIDGES) return false;

   177

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

   178

   179

	max = b->max_length;

   180

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

   181

   182

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

   183

}

   184

   185

/** Build a Bridge

   186

 * @param x,y end tile coord

   187

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

   188

 * @param p2 various bitstuffed elements

   189

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

   190

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

   191

 */

   192

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

   193

{

   194

	int bridge_type;

   195

	byte rail_or_road, railtype, m5;

   196

	int sx,sy;

   197

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

   198

	uint bridge_len;

   199

	uint odd_middle_part;

   200

	uint direction;

   201

	uint i;

   202

	int32 cost, terraformcost, ret;

   203

	bool allow_on_slopes;

   204

   205

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   206

   207

	/* unpack parameters */

   208

	bridge_type = GB(p2, 0, 8);

   209

	railtype    = GB(p2, 8, 8);

   210

   211

	if (p1 > MapSize()) return CMD_ERROR;

   212

   213

	// type of bridge

   214

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

   215

		railtype = 0;

   216

		rail_or_road = 2;

   217

	} else {

   218

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   219

		rail_or_road = 0;

   220

	}

   221

   222

	sx = TileX(p1) * 16;

   223

	sy = TileY(p1) * 16;

   224

   225

	direction = 0;

   226

   227

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

   228

	if (x == sx) {

   229

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

   230

		direction = 1;

   231

		if (y > sy) {

   232

			intswap(y,sy);

   233

			intswap(x,sx);

   234

		}

   235

	} else if (y == sy) {

   236

		if (x > sx) {

   237

			intswap(y,sy);

   238

			intswap(x,sx);

   239

		}

   240

	} else {

   241

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   242

	}

   243

   244

	/* set and test bridge length, availability */

   245

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

   246

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

   247

   248

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

   249

	if (

   250

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

   251

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

   252

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

   253

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

   254

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   255

   256

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

   257

		ti_start.z += 8;

   258

		ti_start.tileh = 0;

   259

	}

   260

   261

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

   262

		ti_end.z += 8;

   263

		ti_end.tileh = 0;

   264

	}

   265

   266

	if (ti_start.z != ti_end.z)

   267

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   268

   269

   270

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

   271

	allow_on_slopes = (!_is_old_ai_player

   272

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

   273

   274

	/* Try and clear the start landscape */

   275

   276

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

   277

		return CMD_ERROR;

   278

	cost = ret;

   279

   280

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

   281

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

   282

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

   283

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   284

	cost += terraformcost;

   285

   286

	/* Try and clear the end landscape */

   287

   288

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

   289

	if (CmdFailed(ret)) return CMD_ERROR;

   290

	cost += ret;

   291

   292

	// false - end tile slope check

   293

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

   294

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

   295

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   296

	cost += terraformcost;

   297

   298

   299

	/* do the drill? */

   300

	if (flags & DC_EXEC) {

   301

		/* build the start tile */

   302

		ModifyTile(ti_start.tile,

   303

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   304

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   305

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

   306

			railtype, /* map3_lo */

   307

			0x80 | direction | rail_or_road /* map5 */

   308

		);

   309

   310

		/* build the end tile */

   311

		ModifyTile(ti_end.tile,

   312

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   313

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   314

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

   315

			railtype, /* map3_lo */

   316

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

   317

		);

   318

	}

   319

   320

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

   321

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

   322

   323

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

   324

		if (direction != 0) {

   325

			y += 16;

   326

		} else {

   327

			x += 16;

   328

		}

   329

   330

		FindLandscapeHeight(&ti, x, y);

   331

   332

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   333

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

   334

   335

		// Find ship below

   336

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

   337

			_error_message = STR_980E_SHIP_IN_THE_WAY;

   338

			return CMD_ERROR;

   339

		}

   340

   341

		if (ti.type == MP_WATER) {

   342

			if (ti.map5 > 1) goto not_valid_below;

   343

			m5 = 0xC8;

   344

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

   345

			if (direction == 0) {

   346

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

   347

			} else {

   348

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

   349

			}

   350

			m5 = 0xE0;

   351

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

   352

			if (direction == 0) {

   353

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

   354

			} else {

   355

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

   356

			}

   357

			m5 = 0xE8;

   358

		} else {

   359

not_valid_below:;

   360

			/* try and clear the middle landscape */

   361

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

   362

			if (CmdFailed(ret)) return CMD_ERROR;

   363

			cost += ret;

   364

			m5 = 0xC0;

   365

		}

   366

   367

		/* do middle part of bridge */

   368

		if (flags & DC_EXEC) {

   369

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

   370

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   371

   372

			//bridges pieces sequence (middle parts)

   373

			// bridge len 1: 0

   374

			// bridge len 2: 0 1

   375

			// bridge len 3: 0 4 1

   376

			// bridge len 4: 0 2 3 1

   377

			// bridge len 5: 0 2 5 3 1

   378

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

   379

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

   380

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

   381

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

   382

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

   383

   384

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

   385

				m5 = 0;

   386

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

   387

				m5 = 1;

   388

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

   389

				m5 = 5 - (i % 2);

   390

			} else {

   391

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

   392

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

   393

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

   394

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

   395

			}

   396

   397

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

   398

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

   399

   400

			MarkTileDirtyByTile(ti.tile);

   401

		}

   402

	}

   403

   404

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

   405

   406

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

   407

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

   408

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

   409

	*/

   410

	if (!(flags & DC_QUERY_COST)) {

   411

		const Bridge *b = &_bridge[bridge_type];

   412

   413

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

   414

   415

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   416

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   417

   418

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

   419

	}

   420

   421

	return cost;

   422

}

   423

   424

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

   425

{

   426

	TileIndexDiff delta = TileOffsByDir(dir);

   427

	TileInfo ti;

   428

   429

	do {

   430

		tile -= delta;

   431

		FindLandscapeHeightByTile(&ti, tile);

   432

	} while (z < ti.z);

   433

   434

	if (z == ti.z &&

   435

			ti.type == MP_TUNNELBRIDGE &&

   436

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

   437

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

   438

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   439

		return false;

   440

	}

   441

   442

	return true;

   443

}

   444

   445

bool CheckTunnelInWay(TileIndex tile, int z)

   446

{

   447

	return DoCheckTunnelInWay(tile,z,0) &&

   448

		DoCheckTunnelInWay(tile,z,1) &&

   449

		DoCheckTunnelInWay(tile,z,2) &&

   450

		DoCheckTunnelInWay(tile,z,3);

   451

}

   452

   453

static byte _build_tunnel_bh;

   454

static byte _build_tunnel_railtype;

   455

   456

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

   457

{

   458

	TileIndex end_tile;

   459

	int direction;

   460

	int32 cost, ret;

   461

	TileInfo ti;

   462

	uint z;

   463

   464

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

   465

		return CMD_ERROR;

   466

   467

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

   468

	direction = 0;

   469

	if (x == x2) {

   470

		if (y == y2)

   471

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   472

		direction++;

   473

		if (y > y2) {

   474

			intswap(y,y2);

   475

			intswap(x,x2);

   476

			exc_tile|=2;

   477

		}

   478

	} else if (y == y2) {

   479

		if (x > x2) {

   480

			intswap(y,y2);

   481

			intswap(x,x2);

   482

			exc_tile|=2;

   483

		}

   484

	} else

   485

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   486

   487

	cost = 0;

   488

   489

	FindLandscapeHeight(&ti, x2, y2);

   490

	end_tile = ti.tile;

   491

	z = ti.z;

   492

   493

	if (exc_tile != 3) {

   494

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

   495

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   496

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

   497

		if (CmdFailed(ret)) return CMD_ERROR;

   498

		cost += ret;

   499

	}

   500

	cost += _price.build_tunnel;

   501

   502

	for (;;) {

   503

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

   504