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

    62

	if (x < 2) return x;

    63

	x -= 2;

    64

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

    65

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

    66

		r += n * n;

    67

		x -= n;

    68

	}

    69

}

    70

    71

enum {

    72

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

    73

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

    74

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

    75

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

    76

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

    77

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

    78

};

    79

    80

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

    81

{

    82

	const Bridge *bridge = &_bridge[index];

    83

	assert(table < 7);

    84

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

    85

		return _bridge_sprite_table[index][table];

    86

	} else {

    87

		return bridge->sprite_table[table];

    88

	}

    89

}

    90

    91

/**

    92

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

    93

 * @param tile The tile to analyze

    94

 * @return the piece

    95

 */

    96

static inline int GetBridgePiece(TileIndex tile)

    97

{

    98

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

    99

}

   100

   101

/**

   102

 * Determines the type of bridge on a tile

   103

 * @param tile The tile to analyze

   104

 * @return The bridge type

   105

 */

   106

static inline int GetBridgeType(TileIndex tile)

   107

{

   108

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

   109

}

   110

   111

/**	check if bridge can be built on slope

   112

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

   113

 *	is_start_tile = false		<-- end tile

   114

 *	is_start_tile = true		<-- start tile

   115

 */

   116

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

   117

{

   118

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

   119

   120

		if (is_start_tile) {

   121

			/* check slope at start tile

   122

					- no extra cost

   123

					- direction X: tiles 0,12

   124

					- direction Y: tiles 0, 9

   125

			*/

   126

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

   127

				return 0;

   128

   129

			// disallow certain start tiles to avoid certain crooked bridges

   130

			if (tileh == 2)

   131

				return CMD_ERROR;

   132

   133

		}

   134

		else {

   135

			/*	check slope at end tile

   136

					- no extra cost

   137

					- direction X: tiles 0, 3

   138

					- direction Y: tiles 0, 6

   139

			*/

   140

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

   141

				return 0;

   142

   143

			// disallow certain end tiles to avoid certain crooked bridges

   144

			if (tileh == 8)

   145

				return CMD_ERROR;

   146

   147

		}

   148

   149

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

   150

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

   151

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

   152

		 */

   153

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

   154

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

   155

			return CMD_ERROR;

   156

   157

		// slope foundations

   158

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

   159

			return _price.terraform;

   160

	}

   161

   162

	return CMD_ERROR;

   163

}

   164

   165

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   166

{

   167

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

   168

	x1 = TileX(begin);

   169

	y1 = TileY(begin);

   170

	x2 = TileX(end);

   171

	y2 = TileY(end);

   172

   173

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

   174

}

   175

   176

bool CheckBridge_Stuff(byte bridge_type, int bridge_len)

   177

{

   178

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

   179

	const Bridge *b = &_bridge[bridge_type];

   180

   181

	if (bridge_type >= MAX_BRIDGES) return false;

   182

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

   183

   184

	max = b->max_length;

   185

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

   186

		max = 100;

   187

   188

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

   189

   190

	return true;

   191

}

   192

   193

/** Build a Bridge

   194

 * @param x,y end tile coord

   195

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

   196

 * @param p2 various bitstuffed elements

   197

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

   198

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

   199

 */

   200

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

   201

{

   202

	int bridge_type;

   203

	byte rail_or_road, railtype, m5;

   204

	int sx,sy;

   205

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

   206

	int bridge_len, odd_middle_part;

   207

	uint direction;

   208

	int i;

   209

	int32 cost, terraformcost, ret;

   210

	bool allow_on_slopes;

   211

   212

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   213

   214

	/* unpack parameters */

   215

	bridge_type = GB(p2, 0, 8);

   216

	railtype    = GB(p2, 8, 8);

   217

   218

	if (p1 > MapSize()) return CMD_ERROR;

   219

   220

	// type of bridge

   221

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

   222

		railtype = 0;

   223

		rail_or_road = 2;

   224

	} else {

   225

		if (!ValParamRailtype(railtype)) return CMD_ERROR;

   226

		rail_or_road = 0;

   227

	}

   228

   229

	sx = TileX(p1) * 16;

   230

	sy = TileY(p1) * 16;

   231

   232

	direction = 0;

   233

   234

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

   235

	if (x == sx) {

   236

		if (y == sy)

   237

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   238

		direction = 1;

   239

		if (y > sy) {

   240

			intswap(y,sy);

   241

			intswap(x,sx);

   242

		}

   243

	} else if (y == sy) {

   244

		if (x > sx) {

   245

			intswap(y,sy);

   246

			intswap(x,sx);

   247

		}

   248

	} else

   249

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   250

   251

	/* set and test bridge length, availability */

   252

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

   253

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

   254

   255

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

   256

	if (

   257

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

   258

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

   259

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

   260

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

   261

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   262

   263

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

   264

		ti_start.z += 8;

   265

		ti_start.tileh = 0;

   266

	}

   267

   268

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

   269

		ti_end.z += 8;

   270

		ti_end.tileh = 0;

   271

	}

   272

   273

	if (ti_start.z != ti_end.z)

   274

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   275

   276

   277

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

   278

	allow_on_slopes = (!_is_old_ai_player

   279

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

   280

   281

	/* Try and clear the start landscape */

   282

   283

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

   284

		return CMD_ERROR;

   285

	cost = ret;

   286

   287

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

   288

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

   289

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

   290

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   291

	cost += terraformcost;

   292

   293

	/* Try and clear the end landscape */

   294

   295

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

   296

		return CMD_ERROR;

   297

	cost += ret;

   298

   299

	// false - end tile slope check

   300

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

   301

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

   302

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   303

	cost += terraformcost;

   304

   305

   306

	/* do the drill? */

   307

	if (flags & DC_EXEC) {

   308

		/* build the start tile */

   309

		ModifyTile(ti_start.tile,

   310

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   311

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   312

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

   313

			railtype, /* map3_lo */

   314

			0x80 | direction | rail_or_road /* map5 */

   315

		);

   316

   317

		/* build the end tile */

   318

		ModifyTile(ti_end.tile,

   319

			MP_SETTYPE(MP_TUNNELBRIDGE) |

   320

			MP_MAP2 | MP_MAP3LO | MP_MAPOWNER_CURRENT | MP_MAP5,

   321

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

   322

			railtype, /* map3_lo */

   323

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

   324

		);

   325

	}

   326

   327

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

   328

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

   329

   330

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

   331

		if (direction != 0) {

   332

			y += 16;

   333

		} else

   334

			x += 16;

   335

   336

		FindLandscapeHeight(&ti, x, y);

   337

   338

		_error_message = STR_5009_LEVEL_LAND_OR_WATER_REQUIRED;

   339

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

   340

			return CMD_ERROR;

   341

   342

		// Find ship below

   343

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

   344

		{

   345

			_error_message = STR_980E_SHIP_IN_THE_WAY;

   346

			return CMD_ERROR;

   347

		}

   348

   349

		if (ti.type == MP_WATER) {

   350

			if (ti.map5 > 1) goto not_valid_below;

   351

			m5 = 0xC8;

   352

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

   353

			if (direction == 0) {

   354

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

   355

			} else {

   356

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

   357

			}

   358

			m5 = 0xE0;

   359

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

   360

			if (direction == 0) {

   361

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

   362

			} else {

   363

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

   364

			}

   365

			m5 = 0xE8;

   366

		} else {

   367

not_valid_below:;

   368

			/* try and clear the middle landscape */

   369

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

   370

				return CMD_ERROR;

   371

			cost += ret;

   372

			m5 = 0xC0;

   373

		}

   374

   375

		/* do middle part of bridge */

   376

		if (flags & DC_EXEC) {

   377

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

   378

			SetTileType(ti.tile, MP_TUNNELBRIDGE);

   379

   380

			//bridges pieces sequence (middle parts)

   381

			// bridge len 1: 0

   382

			// bridge len 2: 0 1

   383

			// bridge len 3: 0 4 1

   384

			// bridge len 4: 0 2 3 1

   385

			// bridge len 5: 0 2 5 3 1

   386

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

   387

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

   388

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

   389

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

   390

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

   391

   392

			if(i==0)                    //first tile

   393

				m5 = 0;

   394

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

   395

				m5 = 1;

   396

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

   397

				m5 = 5 - (i%2);

   398

			else {

   399

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

   400

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

   401

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

   402

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

   403

			}

   404

   405

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

   406

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

   407

   408

			MarkTileDirtyByTile(ti.tile);

   409

		}

   410

	}

   411

   412

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

   413

   414

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

   415

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

   416

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

   417

	*/

   418

	if (!(flags & DC_QUERY_COST)) {

   419

		const Bridge *b = &_bridge[bridge_type];

   420

   421

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

   422

   423

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   424

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   425

   426

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

   427

	}

   428

   429

	return cost;

   430

}

   431

   432

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

   433

{

   434

	TileIndexDiff delta = TileOffsByDir(dir);

   435

	TileInfo ti;

   436

   437

	do {

   438

		tile -= delta;

   439

		FindLandscapeHeightByTile(&ti, tile);

   440

	} while (z < ti.z);

   441

   442

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

   443

		_error_message = STR_5003_ANOTHER_TUNNEL_IN_THE_WAY;

   444

		return false;

   445

	}

   446

   447

	return true;

   448

}

   449

   450

bool CheckTunnelInWay(TileIndex tile, int z)

   451

{

   452

	return DoCheckTunnelInWay(tile,z,0) &&

   453

		DoCheckTunnelInWay(tile,z,1) &&

   454

		DoCheckTunnelInWay(tile,z,2) &&

   455

		DoCheckTunnelInWay(tile,z,3);

   456

}

   457

   458

static byte _build_tunnel_bh;

   459

static byte _build_tunnel_railtype;

   460

   461

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

   462

{

   463

	TileIndex end_tile;

   464

	int direction;

   465

	int32 cost, ret;

   466

	TileInfo ti;

   467

	uint z;

   468

   469

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

   470

		return CMD_ERROR;

   471

   472

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

   473

	direction = 0;

   474

	if (x == x2) {

   475

		if (y == y2)

   476

			return_cmd_error(STR_5008_CANNOT_START_AND_END_ON);

   477

		direction++;

   478

		if (y > y2) {

   479

			intswap(y,y2);

   480

			intswap(x,x2);

   481

			exc_tile|=2;

   482

		}

   483

	} else if (y == y2) {

   484

		if (x > x2) {

   485

			intswap(y,y2);

   486

			intswap(x,x2);

   487

			exc_tile|=2;

   488

		}

   489

	} else

   490

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   491

   492

	cost = 0;

   493

   494

	FindLandscapeHeight(&ti, x2, y2);

   495

	end_tile = ti.tile;

   496

	z = ti.z;

   497

   498

	if (exc_tile != 3) {

   499

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

   500

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   501

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

   502

		if (CmdFailed(ret)) return CMD_ERROR;

   503

		cost += ret;

   504

	}

   505

	cost += _price.build_tunnel;

   506

   507

	for(;;) {

   508

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

   509

   510

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