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 "bridge_map.h"

    11

#include "rail_map.h"

    12

#include "road_map.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "functions.h"

    16

#include "map.h"

    17

#include "tile.h"

    18

#include "tunnel_map.h"

    19

#include "vehicle.h"

    20

#include "viewport.h"

    21

#include "command.h"

    22

#include "player.h"

    23

#include "town.h"

    24

#include "sound.h"

    25

#include "variables.h"

    26

#include "bridge.h"

    27

#include "train.h"

    28

#include "water_map.h"

    29

    30

#include "table/bridge_land.h"

    31

    32

extern const byte _track_sloped_sprites[14];

    33

extern const SpriteID _water_shore_sprites[15];

    34

    35

extern void DrawCanalWater(TileIndex tile);

    36

    37

const Bridge orig_bridge[] = {

    38

/*

    39

	   year of availablity

    40

	   |  minimum length

    41

	   |  |   maximum length

    42

	   |  |   |    price

    43

	   |  |   |    |    maximum speed

    44

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

    45

	   |  |   |    |    |  |                                   |                            */

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

};

    60

    61

Bridge _bridge[MAX_BRIDGES];

    62

    63

    64

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

    65

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

    66

int CalcBridgeLenCostFactor(int x)

    67

{

    68

	int n;

    69

	int r;

    70

    71

	if (x < 2) return x;

    72

	x -= 2;

    73

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

    74

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

    75

		r += n * n;

    76

		x -= n;

    77

	}

    78

}

    79

    80

enum {

    81

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

    82

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

    83

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

    84

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

    85

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

    86

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

    87

};

    88

    89

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

    90

{

    91

	const Bridge *bridge = &_bridge[index];

    92

	assert(table < 7);

    93

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

    94

		return _bridge_sprite_table[index][table];

    95

	} else {

    96

		return bridge->sprite_table[table];

    97

	}

    98

}

    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(Axis direction, uint tileh, bool is_start_tile)

   107

{

   108

	if (IsSteepTileh(tileh)) return CMD_ERROR;

   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 == AXIS_X ? 0x1001 : 0x201) & (1 << tileh)) return 0;

   117

   118

		// disallow certain start tiles to avoid certain crooked bridges

   119

		if (tileh == 2) return CMD_ERROR;

   120

	} else {

   121

		/*	check slope at end tile

   122

				- no extra cost

   123

				- direction X: tiles 0, 3

   124

				- direction Y: tiles 0, 6

   125

		*/

   126

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

   127

   128

		// disallow certain end tiles to avoid certain crooked bridges

   129

		if (tileh == 8) return CMD_ERROR;

   130

	}

   131

   132

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

   133

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

   134

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

   135

	 */

   136

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

   137

			(tileh == 4 && is_start_tile == (direction != AXIS_X))) {

   138

		return CMD_ERROR;

   139

	}

   140

   141

	// slope foundations

   142

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

   143

		return _price.terraform;

   144

   145

	return CMD_ERROR;

   146

}

   147

   148

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   149

{

   150

	int x1 = TileX(begin);

   151

	int y1 = TileY(begin);

   152

	int x2 = TileX(end);

   153

	int y2 = TileY(end);

   154

   155

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

   156

}

   157

   158

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   159

{

   160

	const Bridge *b = &_bridge[bridge_type];

   161

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

   162

   163

	if (bridge_type >= MAX_BRIDGES) return false;

   164

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

   165

   166

	max = b->max_length;

   167

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

   168

   169

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

   170

}

   171

   172

/** Build a Bridge

   173

 * @param x,y end tile coord

   174

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

   175

 * @param p2 various bitstuffed elements

   176

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

   177

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

   178

 */

   179

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

   180

{

   181

	int bridge_type;

   182

	TransportType transport;

   183

	RailType railtype;

   184

	int sx,sy;

   185

	TileInfo ti_start, ti_end;

   186

	TileIndex tile;

   187

	TileIndexDiff delta;

   188

	uint bridge_len;

   189

	uint odd_middle_part;

   190

	Axis direction;

   191

	uint i;

   192

	int32 cost, terraformcost, ret;

   193

	bool allow_on_slopes;

   194

   195

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   196

   197

	/* unpack parameters */

   198

	bridge_type = GB(p2, 0, 8);

   199

   200

	if (p1 >= MapSize()) return CMD_ERROR;

   201

   202

	// type of bridge

   203

	if (HASBIT(p2, 15)) {

   204

		railtype = 0;

   205

		transport = TRANSPORT_ROAD;

   206

	} else {

   207

		if (!ValParamRailtype(GB(p2, 8, 8))) return CMD_ERROR;

   208

		railtype = GB(p2, 8, 8);

   209

		transport = TRANSPORT_RAIL;

   210

	}

   211

   212

	sx = TileX(p1) * 16;

   213

	sy = TileY(p1) * 16;

   214

   215

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

   216

	if (x == sx) {

   217

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

   218

		direction = AXIS_Y;

   219

		if (y > sy) {

   220

			intswap(y,sy);

   221

			intswap(x,sx);

   222

		}

   223

	} else if (y == sy) {

   224

		direction = AXIS_X;

   225

		if (x > sx) {

   226

			intswap(y,sy);

   227

			intswap(x,sx);

   228

		}

   229

	} else {

   230

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   231

	}

   232

   233

	/* set and test bridge length, availability */

   234

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

   235

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

   236

   237

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

   238

	if ((

   239

				FindLandscapeHeight(&ti_end, sx, sy),

   240

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

   241

			) || (

   242

				FindLandscapeHeight(&ti_start, x, y),

   243

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

   244

			)) {

   245

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   246

	}

   247

   248

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

   249

		ti_start.z += 8;

   250

		ti_start.tileh = 0;

   251

	}

   252

   253

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

   254

		ti_end.z += 8;

   255

		ti_end.tileh = 0;

   256

	}

   257

   258

	if (ti_start.z != ti_end.z)

   259

		return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   260

   261

   262

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

   263

	allow_on_slopes = (!_is_old_ai_player

   264

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

   265

   266

	/* Try and clear the start landscape */

   267

   268

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

   269

	if (CmdFailed(ret)) return ret;

   270

	cost = ret;

   271

   272

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

   273

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

   274

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

   275

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   276

	cost += terraformcost;

   277

   278

	/* Try and clear the end landscape */

   279

   280

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

   281

	if (CmdFailed(ret)) return ret;

   282

	cost += ret;

   283

   284

	// false - end tile slope check

   285

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

   286

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

   287

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   288

	cost += terraformcost;

   289

   290

   291

	/* do the drill? */

   292

	if (flags & DC_EXEC) {

   293

		DiagDirection dir = AxisToDiagDir(direction);

   294

   295

		if (transport == TRANSPORT_RAIL) {

   296

			MakeRailBridgeRamp(ti_start.tile, _current_player, bridge_type, dir, railtype);

   297

			MakeRailBridgeRamp(ti_end.tile,   _current_player, bridge_type, ReverseDiagDir(dir), railtype);

   298

		} else {

   299

			MakeRoadBridgeRamp(ti_start.tile, _current_player, bridge_type, dir);

   300

			MakeRoadBridgeRamp(ti_end.tile,   _current_player, bridge_type, ReverseDiagDir(dir));

   301

		}

   302

		MarkTileDirtyByTile(ti_start.tile);

   303

		MarkTileDirtyByTile(ti_end.tile);

   304

	}

   305

   306

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

   307

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

   308

   309

	tile = ti_start.tile;

   310

	delta = (direction == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));

   311

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

   312

		TransportType transport_under;

   313

		Owner owner_under = OWNER_NONE;

   314

		RailType rail_under = INVALID_RAILTYPE;

   315

		uint z;

   316

   317

		tile += delta;

   318

   319

		if (GetTileSlope(tile, &z) != 0 && z >= ti_start.z) {

   320

			return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   321

		}

   322

   323

		switch (GetTileType(tile)) {

   324

			case MP_WATER:

   325

				if (!EnsureNoVehicle(tile)) return_cmd_error(STR_980E_SHIP_IN_THE_WAY);

   326

				if (_m[tile].m5 > 1) goto not_valid_below;

   327

				transport_under = TRANSPORT_WATER;

   328

				break;

   329

   330

			case MP_RAILWAY:

   331

				if (_m[tile].m5 != (direction == AXIS_X ? TRACK_BIT_Y : TRACK_BIT_X)) {

   332

					goto not_valid_below;

   333

				}

   334

				transport_under = TRANSPORT_RAIL;

   335

				owner_under = GetTileOwner(tile);

   336

				rail_under = GetRailType(tile);

   337

				break;

   338

   339

			case MP_STREET:

   340

				if (GetRoadType(tile) != ROAD_NORMAL ||

   341

						GetRoadBits(tile) != (direction == AXIS_X ? ROAD_Y : ROAD_X)) {

   342

					goto not_valid_below;

   343

				}

   344

				transport_under = TRANSPORT_ROAD;

   345

				owner_under = GetTileOwner(tile);

   346

				break;

   347

   348

			default:

   349

not_valid_below:;

   350

				/* try and clear the middle landscape */

   351

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

   352

				if (CmdFailed(ret)) return ret;

   353

				cost += ret;

   354

				transport_under = INVALID_TRANSPORT;

   355

				break;

   356

		}

   357

   358

		if (flags & DC_EXEC) {

   359

			uint piece;

   360

   361

			//bridges pieces sequence (middle parts)

   362

			// bridge len 1: 0

   363

			// bridge len 2: 0 1

   364

			// bridge len 3: 0 4 1

   365

			// bridge len 4: 0 2 3 1

   366

			// bridge len 5: 0 2 5 3 1

   367

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

   368

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

   369

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

   370

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

   371

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

   372

   373

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

   374

				piece = 0;

   375

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

   376

				piece = 1;

   377

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

   378

				piece = 5 - (i % 2);

   379

			} else {

   380

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

   381

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

   382

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

   383

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

   384

			}

   385

   386

			if (transport == TRANSPORT_RAIL) {

   387

				MakeRailBridgeMiddle(tile, bridge_type, piece, direction, railtype);

   388

			} else {

   389

				MakeRoadBridgeMiddle(tile, bridge_type, piece, direction);

   390

			}

   391

			switch (transport_under) {

   392

				case TRANSPORT_RAIL:  SetRailUnderBridge(tile, owner_under, rail_under); break;

   393

				case TRANSPORT_ROAD:  SetRoadUnderBridge(tile, owner_under); break;

   394

				case TRANSPORT_WATER: SetWaterUnderBridge(tile); break;

   395

				default:              SetClearUnderBridge(tile); break;

   396

			}

   397

   398

			MarkTileDirtyByTile(tile);

   399

		}

   400

	}

   401

   402

	SetSignalsOnBothDir(ti_start.tile, direction == AXIS_X ? TRACK_X : TRACK_Y);

   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

   423

/** Build Tunnel.

   424

 * @param x,y start tile coord of tunnel

   425

 * @param p1 railtype, 0x200 for road tunnel

   426

 * @param p2 unused

   427

 */

   428

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

   429

{

   430

	TileIndexDiff delta;

   431

	TileIndex start_tile;

   432

	TileIndex end_tile;

   433

	DiagDirection direction;

   434

	uint start_tileh;

   435

	uint end_tileh;

   436

	uint start_z;

   437

	uint end_z;

   438

	int32 cost;

   439

	int32 ret;

   440

   441

	_build_tunnel_endtile = 0;

   442

   443

	if (p1 != 0x200 && !ValParamRailtype(p1)) return CMD_ERROR;

   444

   445

	start_tile = TileVirtXY(x, y);

   446

	start_tileh = GetTileSlope(start_tile, &start_z);

   447

   448

	switch (start_tileh) {

   449

		case  3: direction = DIAGDIR_SW; break;

   450

		case  6: direction = DIAGDIR_SE; break;

   451

		case  9: direction = DIAGDIR_NW; break;

   452

		case 12: direction = DIAGDIR_NE; break;

   453

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   454

	}

   455

   456

	ret = DoCommandByTile(start_tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   457

	if (CmdFailed(ret)) return ret;

   458

	cost = _price.build_tunnel + ret;

   459

   460

	delta = TileOffsByDir(direction);

   461

	end_tile = start_tile;

   462

	for (;;) {

   463

		end_tile += delta;

   464

		end_tileh = GetTileSlope(end_tile, &end_z);

   465

   466

		if (start_z == end_z) break;

   467

   468

		if (!_cheats.crossing_tunnels.value && IsTunnelInWay(end_tile, start_z)) {

   469

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

   470

		}

   471

   472

		cost += _price.build_tunnel;

   473

		cost += cost >> 3;

   474

		if (cost >= 400000000) cost = 400000000;

   475

	}

   476

   477

	// if the command fails from here on we want the end tile to be highlighted

   478

	_build_tunnel_endtile = end_tile;

   479

   480

	// slope of end tile must be complementary to the slope of the start tile

   481

	if (end_tileh != (15 ^ start_tileh)) {

   482

		ret = DoCommandByTile(end_tile, end_tileh & start_tileh, 0, flags, CMD_TERRAFORM_LAND);

   483

		if (CmdFailed(ret)) return_cmd_error(STR_5005_UNABLE_TO_EXCAVATE_LAND);

   484

	} else {

   485

		ret = DoCommandByTile(end_tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   486

		if (CmdFailed(ret)) return ret;

   487

	}

   488

	cost += _price.build_tunnel + ret;

   489

   490

	if (flags & DC_EXEC) {

   491

		if (GB(p1, 9, 1) == TRANSPORT_RAIL) {

   492

			MakeRailTunnel(start_tile, _current_player, direction,                 GB(p1, 0, 4));