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

#include "table/tunnel_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 _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              },

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    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,r;

    63

	if (x < 2) return x;

    64

	x -= 2;

    65

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

    66

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

    67

		r += n * n;

    68

		x -= n;

    69

	}

    70

}

    71

    72

enum {

    73

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

    74

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

    75

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

    76

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

    77

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

    78

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

    79

};

    80

    81

/**

    82

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

    83

 * @param tile The tile to analyze

    84

 * @return the piece

    85

 */

    86

static inline int GetBridgePiece(TileIndex tile)

    87

{

    88

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

    89

}

    90

    91

/**

    92

 * Determines the type of bridge on a tile

    93

 * @param tile The tile to analyze

    94

 * @return The bridge type

    95

 */

    96

static inline int GetBridgeType(TileIndex tile)

    97

{

    98

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

    99

}

   100

   101

/**	check if bridge can be built on slope

   102

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

   103

 *	is_start_tile = false		<-- end tile

   104

 *	is_start_tile = true		<-- start tile

   105

 */

   106

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

   107

{

   108

	if (!IsSteepTileh(tileh)) {	// disable building on very steep slopes

   109

   110

		if (is_start_tile) {

   111

			/* check slope at start tile

   112

					- no extra cost

   113

					- direction X: tiles 0,12

   114

					- direction Y: tiles 0, 9

   115

			*/

   116

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

   117

				return 0;

   118

   119

			// disallow certain start tiles to avoid certain crooked bridges

   120

			if (tileh == 2)

   121

				return CMD_ERROR;

   122

   123

		}

   124

		else {

   125

			/*	check slope at end tile

   126

					- no extra cost

   127

					- direction X: tiles 0, 3

   128

					- direction Y: tiles 0, 6

   129

			*/

   130

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

   131

				return 0;

   132

   133

			// disallow certain end tiles to avoid certain crooked bridges

   134

			if (tileh == 8)

   135

				return CMD_ERROR;

   136

   137

		}

   138

   139

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

   140

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

   141

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

   142

		 */

   143

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

   144

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

   145

			return CMD_ERROR;

   146

   147

		// slope foundations

   148

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

   149

			return _price.terraform;

   150

	}

   151

   152

	return CMD_ERROR;

   153

}

   154

   155

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   156

{

   157

	int x1, y1, x2, y2;	// coordinates of starting and end tiles

   158

	x1 = TileX(begin);

   159

	y1 = TileY(begin);

   160

	x2 = TileX(end);

   161

	y2 = TileY(end);

   162

   163

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

   164

}

   165

   166

bool CheckBridge_Stuff(byte bridge_type, int bridge_len)

   167

{

   168

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

   169

	const Bridge *b = &_bridge[bridge_type];

   170

   171

	if (bridge_type >= MAX_BRIDGES) return false;

   172

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

   173

   174

	max = b->max_length;

   175

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

   176

		max = 100;

   177

   178

	if (bridge_len < b->min_length || bridge_len > max) return false;

   179

   180

	return true;

   181

}

   182

   183

/** Build a Bridge

   184

 * @param x,y end tile coord

   185

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

   186

 * @param p2 various bitstuffed elements

   187

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

   188

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

   189

 */

   190

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

   191

{

   192

	int bridge_type;

   193

	byte rail_or_road, railtype, m5;

   194

	int sx,sy;

   195

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

   196

	int bridge_len, odd_middle_part;

   197

	uint direction;

   198

	int i;

   199

	int32 cost, terraformcost, ret;

   200

	bool allow_on_slopes;

   201

   202

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   203

   204

	/* unpack parameters */

   205

	bridge_type = GB(p2, 0, 8);

   206

	railtype    = GB(p2, 8, 8);

   207

   208

	if (p1 > MapSize()) return CMD_ERROR;

   209

   210

	// type of bridge

   211

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

   212

		railtype = 0;

   213

		rail_or_road = 2;

   214

	} else {

   215

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   216

		rail_or_road = 0;

   217

	}

   218

   219

	sx = TileX(p1) * 16;

   220

	sy = TileY(p1) * 16;

   221

   222

	direction = 0;

   223

   224

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

   225

	if (x == sx) {

   226

		if (y == sy)

   227

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   228

		direction = 1;

   229

		if (y > sy) {

   230

			intswap(y,sy);

   231

			intswap(x,sx);

   232

		}

   233

	} else if (y == sy) {

   234

		if (x > sx) {

   235

			intswap(y,sy);

   236

			intswap(x,sx);

   237

		}

   238

	} else

   239

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   240

   241

	/* set and test bridge length, availability */

   242

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

   243

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

   244

   245

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

   246

	if (

   247

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

   248

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

   249

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

   250

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

   251

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   252

   253

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

   254

		ti_start.z += 8;

   255

		ti_start.tileh = 0;

   256

	}

   257

   258

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

   259

		ti_end.z += 8;

   260

		ti_end.tileh = 0;

   261

	}

   262

   263

	if (ti_start.z != ti_end.z)

   264

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   265

   266

   267

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

   268

	allow_on_slopes = (!_is_old_ai_player

   269

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

   270

   271

	/* Try and clear the start landscape */

   272

   273

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

   274

		return CMD_ERROR;

   275

	cost = ret;

   276

   277

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

   278

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

   279

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

   280

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   281

	cost += terraformcost;

   282

   283

	/* Try and clear the end landscape */

   284

   285

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

   286

		return CMD_ERROR;

   287

	cost += ret;

   288

   289

	// false - end tile slope check

   290

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

   291

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

   292

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   293

	cost += terraformcost;

   294

   295

   296

	/* do the drill? */

   297

	if (flags & DC_EXEC) {

   298

		/* build the start tile */

   299

		ModifyTile(ti_start.tile,

   300

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   301

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   302

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

   303

			railtype, /* map3_lo */

   304

			0x80 | direction | rail_or_road /* map5 */

   305

		);

   306

   307

		/* build the end tile */

   308

		ModifyTile(ti_end.tile,

   309

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   310

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   311

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

   312

			railtype, /* map3_lo */

   313

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

   314

		);

   315

	}

   316

   317

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

   318

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

   319

   320

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

   321

		if (direction != 0) {

   322

			y += 16;

   323

		} else

   324

			x += 16;

   325

   326

		FindLandscapeHeight(&ti, x, y);

   327

   328

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   329

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

   330

			return CMD_ERROR;

   331

   332

		// Find ship below

   333

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

   334

		{

   335

			_error_message = STR_980E_SHIP_IN_THE_WAY;

   336

			return CMD_ERROR;

   337

		}

   338

   339

		if (ti.type == MP_WATER) {

   340

			if (ti.map5 > 1) goto not_valid_below;

   341

			m5 = 0xC8;

   342

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

   343

			if (direction == 0) {

   344

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

   345

			} else {

   346

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

   347

			}

   348

			m5 = 0xE0;

   349

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

   350

			if (direction == 0) {

   351

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

   352

			} else {

   353

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

   354

			}

   355

			m5 = 0xE8;

   356

		} else {

   357

not_valid_below:;

   358

			/* try and clear the middle landscape */

   359

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

   360

				return CMD_ERROR;

   361

			cost += ret;

   362

			m5 = 0xC0;

   363

		}

   364

   365

		/* do middle part of bridge */

   366

		if (flags & DC_EXEC) {

   367

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

   368

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   369

   370

			//bridges pieces sequence (middle parts)

   371

			// bridge len 1: 0

   372

			// bridge len 2: 0 1

   373

			// bridge len 3: 0 4 1

   374

			// bridge len 4: 0 2 3 1

   375

			// bridge len 5: 0 2 5 3 1

   376

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

   377

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

   378

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

   379

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

   380

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

   381

   382

			if(i==0)                    //first tile

   383

				m5 = 0;

   384

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

   385

				m5 = 1;

   386

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

   387

				m5 = 5 - (i%2);

   388

			else {

   389

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

   390

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

   391

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

   392

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

   393

			}

   394

   395

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

   396

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

   397

   398

			MarkTileDirtyByTile(ti.tile);

   399

		}

   400

	}

   401

   402

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

   403

   404

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

   405

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

   406

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

   407

	*/

   408

	if (!(flags & DC_QUERY_COST)) {

   409

		const Bridge *b = &_bridge[bridge_type];

   410

   411

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

   412

   413

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   414

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   415

   416

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

   417

	}

   418

   419

	return cost;

   420

}

   421

   422

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

   423

{

   424

	TileIndexDiff delta = TileOffsByDir(dir);

   425

	TileInfo ti;

   426

   427

	do {

   428

		tile -= delta;

   429

		FindLandscapeHeightByTile(&ti, tile);

   430

	} while (z < ti.z);

   431

   432

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

   433

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   434

		return false;

   435

	}

   436

   437

	return true;

   438

}

   439

   440

bool CheckTunnelInWay(TileIndex tile, int z)

   441

{

   442

	return DoCheckTunnelInWay(tile,z,0) &&

   443

		DoCheckTunnelInWay(tile,z,1) &&

   444

		DoCheckTunnelInWay(tile,z,2) &&

   445

		DoCheckTunnelInWay(tile,z,3);

   446

}

   447

   448

static byte _build_tunnel_bh;

   449

static byte _build_tunnel_railtype;

   450

   451

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

   452

{

   453

	TileIndex end_tile;

   454

	int direction;

   455

	int32 cost, ret;

   456

	TileInfo ti;

   457

	uint z;

   458

   459

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

   460

		return CMD_ERROR;

   461

   462

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

   463

	direction = 0;

   464

	if (x == x2) {

   465

		if (y == y2)

   466

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   467

		direction++;

   468

		if (y > y2) {

   469

			intswap(y,y2);

   470

			intswap(x,x2);

   471

			exc_tile|=2;

   472

		}

   473

	} else if (y == y2) {

   474

		if (x > x2) {

   475

			intswap(y,y2);

   476

			intswap(x,x2);

   477

			exc_tile|=2;

   478

		}

   479

	} else

   480

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   481

   482

	cost = 0;

   483

   484

	FindLandscapeHeight(&ti, x2, y2);

   485

	end_tile = ti.tile;

   486

	z = ti.z;

   487

   488

	if (exc_tile != 3) {

   489

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

   490

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   491

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

   492

		if (CmdFailed(ret)) return CMD_ERROR;

   493

		cost += ret;

   494

	}

   495

	cost += _price.build_tunnel;

   496

   497

	for(;;) {

   498

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

   499

   500

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

   501

			break;

   502

   503

		FindLandscapeHeight(&ti, x2, y2);

   504

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

   505

   506

		if (!_cheats.crossing_tunnels.value && !CheckTunnelInWay(ti.tile, z))

   507

			return CMD_ERROR;

   508

   509

		cost += _price.build_tunnel;

   510

		cost += (cost >> 3);

   511