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

#define M(x) (1 << (x))

    81

enum {

    82

	// foundation, whole tile is leveled up --> 3 corners raised

    83

	BRIDGE_FULL_LEVELED_FOUNDATION = M(SLOPE_WSE) | M(SLOPE_NWS) | M(SLOPE_ENW) | M(SLOPE_SEN),

    84

	// foundation, tile is partly leveled up --> 1 corner raised

    85

	BRIDGE_PARTLY_LEVELED_FOUNDATION = M(SLOPE_W) | M(SLOPE_S) | M(SLOPE_E) | M(SLOPE_N),

    86

	// no foundations (X,Y direction)

    87

	BRIDGE_NO_FOUNDATION = M(SLOPE_FLAT) | M(SLOPE_SW) | M(SLOPE_SE) | M(SLOPE_NW) | M(SLOPE_NE),

    88

	BRIDGE_HORZ_RAMP = (BRIDGE_PARTLY_LEVELED_FOUNDATION | BRIDGE_NO_FOUNDATION) & ~M(SLOPE_FLAT)

    89

};

    90

#undef M

    91

    92

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

    93

{

    94

	const Bridge *bridge = &_bridge[index];

    95

	assert(table < 7);

    96

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

    97

		return _bridge_sprite_table[index][table];

    98

	} else {

    99

		return bridge->sprite_table[table];

   100

	}

   101

}

   102

   103

static inline byte GetBridgeFlags(int index) { return _bridge[index].flags;}

   104

   105

/**	check if bridge can be built on slope

   106

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

   107

 *	is_start_tile = false		<-- end tile

   108

 *	is_start_tile = true		<-- start tile

   109

 */

   110

static uint32 CheckBridgeSlope(Axis direction, Slope tileh, bool is_start_tile)

   111

{

   112

	if (IsSteepSlope(tileh)) return CMD_ERROR;

   113

   114

	if (is_start_tile) {

   115

		/* check slope at start tile

   116

				- no extra cost

   117

		*/

   118

#define M(x) (1 << (x))

   119

		if (HASBIT(M(SLOPE_FLAT) | (direction == AXIS_X ? M(SLOPE_NE) : M(SLOPE_NW)), tileh)) return 0;

   120

   121

		// disallow certain start tiles to avoid certain crooked bridges

   122

		if (tileh == SLOPE_S) return CMD_ERROR;

   123

	} else {

   124

		/*	check slope at end tile

   125

				- no extra cost

   126

		*/

   127

		if (HASBIT(M(SLOPE_FLAT) | (direction == AXIS_X ? M(SLOPE_SW) : M(SLOPE_SE)), tileh)) return 0;

   128

#undef M

   129

   130

		// disallow certain end tiles to avoid certain crooked bridges

   131

		if (tileh == SLOPE_N) return CMD_ERROR;

   132

	}

   133

   134

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

   135

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

   136

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

   137

	 */

   138

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

   139

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

   140

		return CMD_ERROR;

   141

	}

   142

   143

	// slope foundations

   144

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION | BRIDGE_PARTLY_LEVELED_FOUNDATION, tileh))

   145

		return _price.terraform;

   146

   147

	return CMD_ERROR;

   148

}

   149

   150

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   151

{

   152

	int x1 = TileX(begin);

   153

	int y1 = TileY(begin);

   154

	int x2 = TileX(end);

   155

	int y2 = TileY(end);

   156

   157

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

   158

}

   159

   160

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   161

{

   162

	const Bridge *b = &_bridge[bridge_type];

   163

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

   164

   165

	if (bridge_type >= MAX_BRIDGES) return false;

   166

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

   167

   168

	max = b->max_length;

   169

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

   170

   171

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

   172

}

   173

   174

/** Build a Bridge

   175

 * @param end_tile end tile

   176

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

   177

 * @param p2 various bitstuffed elements

   178

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

   179

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

   180

 */

   181

int32 CmdBuildBridge(TileIndex end_tile, uint32 flags, uint32 p1, uint32 p2)

   182

{

   183

	int bridge_type;

   184

	TransportType transport;

   185

	RailType railtype;

   186

	int x;

   187

	int y;

   188

	int sx,sy;

   189

	TileIndex tile_start;

   190

	TileIndex tile_end;

   191

	Slope tileh_start;

   192

	Slope tileh_end;

   193

	uint z_start;

   194

	uint z_end;

   195

	TileIndex tile;

   196

	TileIndexDiff delta;

   197

	uint bridge_len;

   198

	uint odd_middle_part;

   199

	Axis direction;

   200

	uint i;

   201

	int32 cost, terraformcost, ret;

   202

	bool allow_on_slopes;

   203

   204

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   205

   206

	/* unpack parameters */

   207

	bridge_type = GB(p2, 0, 8);

   208

   209

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

   210

   211

	// type of bridge

   212

	if (HASBIT(p2, 15)) {

   213

		railtype = 0;

   214

		transport = TRANSPORT_ROAD;

   215

	} else {

   216

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

   217

		railtype = GB(p2, 8, 8);

   218

		transport = TRANSPORT_RAIL;

   219

	}

   220

   221

	x = TileX(end_tile);

   222

	y = TileY(end_tile);

   223

	sx = TileX(p1);

   224

	sy = TileY(p1);

   225

   226

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

   227

	if (x == sx) {

   228

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

   229

		direction = AXIS_Y;

   230

		if (y > sy) {

   231

			intswap(y,sy);

   232

			intswap(x,sx);

   233

		}

   234

	} else if (y == sy) {

   235

		direction = AXIS_X;

   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) - 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

	tile_start = TileXY(x, y);

   250

	tile_end = TileXY(sx, sy);

   251

	if (IsClearWaterTile(tile_start) || IsClearWaterTile(tile_end)) return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   252

   253

	tileh_start = GetTileSlope(tile_start, &z_start);

   254

	tileh_end = GetTileSlope(tile_end, &z_end);

   255

   256

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   257

		z_start += TILE_HEIGHT;

   258

		tileh_start = SLOPE_FLAT;

   259

	}

   260

   261

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   262

		z_end += TILE_HEIGHT;

   263

		tileh_end = SLOPE_FLAT;

   264

	}

   265

   266

	if (z_start != z_end) return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   267

   268

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

   269

	allow_on_slopes = (!_is_old_ai_player

   270

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

   271

   272

	/* Try and clear the start landscape */

   273

   274

	ret = DoCommand(tile_start, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   275

	if (CmdFailed(ret)) return ret;

   276

	cost = ret;

   277

   278

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

   279

	terraformcost = CheckBridgeSlope(direction, tileh_start, true);

   280

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

   281

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   282

	cost += terraformcost;

   283

   284

	/* Try and clear the end landscape */

   285

   286

	ret = DoCommand(tile_end, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   287

	if (CmdFailed(ret)) return ret;

   288

	cost += ret;

   289

   290

	// false - end tile slope check

   291

	terraformcost = CheckBridgeSlope(direction, tileh_end, false);

   292

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

   293

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   294

	cost += terraformcost;

   295

   296

   297

	/* do the drill? */

   298

	if (flags & DC_EXEC) {

   299

		DiagDirection dir = AxisToDiagDir(direction);

   300

   301

		if (transport == TRANSPORT_RAIL) {

   302

			MakeRailBridgeRamp(tile_start, _current_player, bridge_type, dir, railtype);

   303

			MakeRailBridgeRamp(tile_end,   _current_player, bridge_type, ReverseDiagDir(dir), railtype);

   304

		} else {

   305

			MakeRoadBridgeRamp(tile_start, _current_player, bridge_type, dir);

   306

			MakeRoadBridgeRamp(tile_end,   _current_player, bridge_type, ReverseDiagDir(dir));

   307

		}

   308

		MarkTileDirtyByTile(tile_start);

   309

		MarkTileDirtyByTile(tile_end);

   310

	}

   311

   312

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

   313

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

   314

   315

	tile = tile_start;

   316

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

   317

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

   318

		TransportType transport_under;

   319

		Owner owner_under = OWNER_NONE;

   320

		RailType rail_under = INVALID_RAILTYPE;

   321

		uint z;

   322

   323

		tile += delta;

   324

   325

		if (GetTileSlope(tile, &z) != SLOPE_FLAT && z >= z_start) {

   326

			return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   327

		}

   328

   329

		switch (GetTileType(tile)) {

   330

			case MP_WATER:

   331

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

   332

				if (!(IsWater(tile) || IsCoast(tile))) goto not_valid_below;

   333

				transport_under = TRANSPORT_WATER;

   334

				break;

   335

   336

			case MP_RAILWAY:

   337

				if (GetRailTileType(tile) != RAIL_TILE_NORMAL ||

   338

						GetTrackBits(tile) != (direction == AXIS_X ? TRACK_BIT_Y : TRACK_BIT_X)) {

   339

					goto not_valid_below;

   340

				}

   341

				transport_under = TRANSPORT_RAIL;

   342

				owner_under = GetTileOwner(tile);

   343

				rail_under = GetRailType(tile);

   344

				break;

   345

   346

			case MP_STREET:

   347

				if (GetRoadTileType(tile) != ROAD_TILE_NORMAL ||

   348

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

   349

					goto not_valid_below;

   350

				}

   351

				transport_under = TRANSPORT_ROAD;

   352

				owner_under = GetTileOwner(tile);

   353

				break;

   354

   355

			default:

   356

not_valid_below:;

   357

				/* try and clear the middle landscape */

   358

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

   359

				if (CmdFailed(ret)) return ret;

   360

				cost += ret;

   361

				transport_under = INVALID_TRANSPORT;

   362

				break;

   363

		}

   364

   365

		if (flags & DC_EXEC) {

   366

			uint piece;

   367

   368

			//bridges pieces sequence (middle parts)

   369

			// bridge len 1: 0

   370

			// bridge len 2: 0 1

   371

			// bridge len 3: 0 4 1

   372

			// bridge len 4: 0 2 3 1

   373

			// bridge len 5: 0 2 5 3 1

   374

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

   375

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

   376

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

   377

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

   378

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

   379

   380

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

   381

				piece = 0;

   382

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

   383

				piece = 1;

   384

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

   385

				piece = 5 - (i % 2);

   386

			} else {

   387

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

   388

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

   389

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

   390

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

   391

			}

   392

   393

			if (transport == TRANSPORT_RAIL) {

   394

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

   395

			} else {

   396

				MakeRoadBridgeMiddle(tile, bridge_type, piece, direction);

   397

			}

   398

			switch (transport_under) {

   399

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

   400

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

   401

				case TRANSPORT_WATER: SetWaterUnderBridge(tile); break;

   402

				default:              SetClearUnderBridge(tile); break;

   403

			}

   404

   405

			MarkTileDirtyByTile(tile);

   406

		}

   407

	}

   408

   409

	SetSignalsOnBothDir(tile_start, direction == AXIS_X ? TRACK_X : TRACK_Y);

   410

   411

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

   412

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

   413

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

   414

	*/

   415

	if (!(flags & DC_QUERY_COST)) {

   416

		const Bridge *b = &_bridge[bridge_type];

   417

   418

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

   419

   420

		if (_current_player < MAX_PLAYERS && !_is_old_ai_player)

   421

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   422

   423

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

   424

	}

   425

   426

	return cost;

   427

}

   428

   429

   430

/** Build Tunnel.

   431

 * @param tile start tile of tunnel

   432

 * @param p1 railtype, 0x200 for road tunnel

   433

 * @param p2 unused

   434

 */

   435

int32 CmdBuildTunnel(TileIndex start_tile, uint32 flags, uint32 p1, uint32 p2)

   436

{

   437

	TileIndexDiff delta;

   438

	TileIndex end_tile;

   439

	DiagDirection direction;

   440

	Slope start_tileh;

   441

	Slope end_tileh;

   442

	uint start_z;

   443

	uint end_z;

   444

	int32 cost;

   445

	int32 ret;

   446

   447

	_build_tunnel_endtile = 0;

   448

   449

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

   450

   451

	start_tileh = GetTileSlope(start_tile, &start_z);

   452

   453

	switch (start_tileh) {

   454

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   455

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   456

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   457

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   458

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   459

	}

   460

   461

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

   462

	if (CmdFailed(ret)) return ret;

   463

	cost = _price.build_tunnel + ret;

   464

   465

	delta = TileOffsByDir(direction);

   466

	end_tile = start_tile;

   467

	for (;;) {

   468

		end_tile += delta;

   469

		end_tileh = GetTileSlope(end_tile, &end_z);

   470

   471

		if (start_z == end_z) break;

   472

   473

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

   474

			return_cmd_error(STR_5003_ANOTHER_TUNNEL_IN_THE_WAY);

   475

		}

   476

   477

		cost += _price.build_tunnel;

   478

		cost += cost >> 3;

   479

		if (cost >= 400000000) cost = 400000000;

   480

	}

   481

   482

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

   483

	_build_tunnel_endtile = end_tile;

   484

   485

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

   486

	if (end_tileh != ComplementSlope(start_tileh)) {

   487

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

   488