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

    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

	   |  |   |    |    |  |                                   |                            */

    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

    92

/**

    93

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

    94

 * @param tile The tile to analyze

    95

 * @return the piece

    96

 */

    97

static inline int GetBridgePiece(TileIndex tile)

    98

{

    99

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

   100

}

   101

   102

/**

   103

 * Determines the type of bridge on a tile

   104

 * @param tile The tile to analyze

   105

 * @return The bridge type

   106

 */

   107

static inline int GetBridgeType(TileIndex tile)

   108

{

   109

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

   110

}

   111

   112

/**	check if bridge can be built on slope

   113

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

   114

 *	is_start_tile = false		<-- end tile

   115

 *	is_start_tile = true		<-- start tile

   116

 */

   117

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

   118

{

   119

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

   120

   121

		if (is_start_tile) {

   122

			/* check slope at start tile

   123

					- no extra cost

   124

					- direction X: tiles 0,12

   125

					- direction Y: tiles 0, 9

   126

			*/

   127

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

   128

				return 0;

   129

   130

			// disallow certain start tiles to avoid certain crooked bridges

   131

			if (tileh == 2)

   132

				return CMD_ERROR;

   133

   134

		}

   135

		else {

   136

			/*	check slope at end tile

   137

					- no extra cost

   138

					- direction X: tiles 0, 3

   139

					- direction Y: tiles 0, 6

   140

			*/

   141

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

   142

				return 0;

   143

   144

			// disallow certain end tiles to avoid certain crooked bridges

   145

			if (tileh == 8)

   146

				return CMD_ERROR;

   147

   148

		}

   149

   150

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

   151

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

   152

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

   153

		 */

   154

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

   155

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

   156

			return CMD_ERROR;

   157

   158

		// slope foundations

   159

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

   160

			return _price.terraform;

   161

	}

   162

   163

	return CMD_ERROR;

   164

}

   165

   166

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   167

{

   168

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

   169

	x1 = TileX(begin);

   170

	y1 = TileY(begin);

   171

	x2 = TileX(end);

   172

	y2 = TileY(end);

   173

   174

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

   175

}

   176

   177

bool CheckBridge_Stuff(byte bridge_type, int bridge_len)

   178

{

   179

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

   180

	const Bridge *b = &_bridge[bridge_type];

   181

   182

	if (bridge_type >= MAX_BRIDGES) return false;

   183

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

   184

   185

	max = b->max_length;

   186

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

   187

		max = 100;

   188

   189

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

   190

   191

	return true;

   192

}

   193

   194

/** Build a Bridge

   195

 * @param x,y end tile coord

   196

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

   197

 * @param p2 various bitstuffed elements

   198

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

   199

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

   200

 */

   201

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

   202

{

   203

	int bridge_type;

   204

	byte rail_or_road, railtype, m5;

   205

	int sx,sy;

   206

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

   207

	int bridge_len, odd_middle_part;

   208

	uint direction;

   209

	int i;

   210

	int32 cost, terraformcost, ret;

   211

	bool allow_on_slopes;

   212

   213

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   214

   215

	/* unpack parameters */

   216

	bridge_type = GB(p2, 0, 8);

   217

	railtype    = GB(p2, 8, 8);

   218

   219

	if (p1 > MapSize()) return CMD_ERROR;

   220

   221

	// type of bridge

   222

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

   223

		railtype = 0;

   224

		rail_or_road = 2;

   225

	} else {

   226

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   227

		rail_or_road = 0;

   228

	}

   229

   230

	sx = TileX(p1) * 16;

   231

	sy = TileY(p1) * 16;

   232

   233

	direction = 0;

   234

   235

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

   236

	if (x == sx) {

   237

		if (y == sy)

   238

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   239

		direction = 1;

   240

		if (y > sy) {

   241

			intswap(y,sy);

   242

			intswap(x,sx);

   243

		}

   244

	} else if (y == sy) {

   245

		if (x > sx) {

   246

			intswap(y,sy);

   247

			intswap(x,sx);

   248

		}

   249

	} else

   250

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   251

   252

	/* set and test bridge length, availability */

   253

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

   254

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

   255

   256

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

   257

	if (

   258

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

   259

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

   260

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

   261

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

   262

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   263

   264

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

   265

		ti_start.z += 8;

   266

		ti_start.tileh = 0;

   267

	}

   268

   269

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

   270

		ti_end.z += 8;

   271

		ti_end.tileh = 0;

   272

	}

   273

   274

	if (ti_start.z != ti_end.z)

   275

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   276

   277

   278

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

   279

	allow_on_slopes = (!_is_old_ai_player

   280

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

   281

   282

	/* Try and clear the start landscape */

   283

   284

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

   285

		return CMD_ERROR;

   286

	cost = ret;

   287

   288

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

   289

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

   290

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

   291

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   292

	cost += terraformcost;

   293

   294

	/* Try and clear the end landscape */

   295

   296

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

   297

		return CMD_ERROR;

   298

	cost += ret;

   299

   300

	// false - end tile slope check

   301

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

   302

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

   303

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   304

	cost += terraformcost;

   305

   306

   307

	/* do the drill? */

   308

	if (flags & DC_EXEC) {

   309

		/* build the start tile */

   310

		ModifyTile(ti_start.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 | direction | rail_or_road /* map5 */

   316

		);

   317

   318

		/* build the end tile */

   319

		ModifyTile(ti_end.tile,

   320

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   321

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   322

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

   323

			railtype, /* map3_lo */

   324

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

   325

		);

   326

	}

   327

   328

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

   329

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

   330

   331

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

   332

		if (direction != 0) {

   333

			y += 16;

   334

		} else

   335

			x += 16;

   336

   337

		FindLandscapeHeight(&ti, x, y);

   338

   339

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   340

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

   341

			return CMD_ERROR;

   342

   343

		// Find ship below

   344

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

   345

		{

   346

			_error_message = STR_980E_SHIP_IN_THE_WAY;

   347

			return CMD_ERROR;

   348

		}

   349

   350

		if (ti.type == MP_WATER) {

   351

			if (ti.map5 > 1) goto not_valid_below;

   352

			m5 = 0xC8;

   353

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

   354

			if (direction == 0) {

   355

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

   356

			} else {

   357

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

   358

			}

   359

			m5 = 0xE0;

   360

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

   361

			if (direction == 0) {

   362

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

   363

			} else {

   364

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

   365

			}

   366

			m5 = 0xE8;

   367

		} else {

   368

not_valid_below:;

   369

			/* try and clear the middle landscape */

   370

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

   371

				return CMD_ERROR;

   372

			cost += ret;

   373

			m5 = 0xC0;

   374

		}

   375

   376

		/* do middle part of bridge */

   377

		if (flags & DC_EXEC) {

   378

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

   379

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   380

   381

			//bridges pieces sequence (middle parts)

   382

			// bridge len 1: 0

   383

			// bridge len 2: 0 1

   384

			// bridge len 3: 0 4 1

   385

			// bridge len 4: 0 2 3 1

   386

			// bridge len 5: 0 2 5 3 1

   387

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

   388

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

   389

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

   390

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

   391

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

   392

   393

			if(i==0)                    //first tile

   394

				m5 = 0;

   395

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

   396

				m5 = 1;

   397

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

   398

				m5 = 5 - (i%2);

   399

			else {

   400

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

   401

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

   402

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

   403

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

   404

			}

   405

   406

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

   407

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

   408

   409

			MarkTileDirtyByTile(ti.tile);

   410

		}

   411

	}

   412

   413

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

   414

   415

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

   416

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

   417

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

   418

	*/

   419

	if (!(flags & DC_QUERY_COST)) {

   420

		const Bridge *b = &_bridge[bridge_type];

   421

   422

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

   423

   424

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   425

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   426

   427

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

   428

	}

   429

   430

	return cost;

   431

}

   432

   433

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

   434

{

   435

	TileIndexDiff delta = TileOffsByDir(dir);

   436

	TileInfo ti;

   437

   438

	do {

   439

		tile -= delta;

   440

		FindLandscapeHeightByTile(&ti, tile);

   441

	} while (z < ti.z);

   442

   443

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

   444

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   445

		return false;

   446

	}

   447

   448

	return true;

   449

}

   450

   451

bool CheckTunnelInWay(TileIndex tile, int z)

   452

{

   453

	return DoCheckTunnelInWay(tile,z,0) &&

   454

		DoCheckTunnelInWay(tile,z,1) &&

   455

		DoCheckTunnelInWay(tile,z,2) &&

   456

		DoCheckTunnelInWay(tile,z,3);

   457

}

   458

   459

static byte _build_tunnel_bh;

   460

static byte _build_tunnel_railtype;

   461

   462

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

   463

{

   464

	TileIndex end_tile;

   465

	int direction;

   466

	int32 cost, ret;

   467

	TileInfo ti;

   468

	uint z;

   469

   470

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

   471

		return CMD_ERROR;

   472

   473

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

   474

	direction = 0;

   475

	if (x == x2) {

   476

		if (y == y2)

   477

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   478

		direction++;

   479

		if (y > y2) {

   480

			intswap(y,y2);

   481

			intswap(x,x2);

   482

			exc_tile|=2;

   483

		}

   484

	} else if (y == y2) {

   485

		if (x > x2) {

   486

			intswap(y,y2);

   487

			intswap(x,x2);

   488

			exc_tile|=2;

   489

		}

   490

	} else

   491

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   492

   493

	cost = 0;

   494

   495

	FindLandscapeHeight(&ti, x2, y2);

   496

	end_tile = ti.tile;

   497

	z = ti.z;

   498

   499

	if (exc_tile != 3) {

   500

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

   501

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   502

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

   503

		if (CmdFailed(ret)) return CMD_ERROR;

   504

		cost += ret;

   505

	}

   506

	cost += _price.build_tunnel;

   507

   508

	for(;;) {

   509

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

   510