1

/* $Id$ */

     2

     3

/** @file bridge_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 "unmovable_map.h"

    20

#include "vehicle.h"

    21

#include "viewport.h"

    22

#include "command.h"

    23

#include "player.h"

    24

#include "town.h"

    25

#include "sound.h"

    26

#include "variables.h"

    27

#include "bridge.h"

    28

#include "train.h"

    29

#include "water_map.h"

    30

#include "yapf/yapf.h"

    31

#include "date.h"

    32

#include "newgrf_sound.h"

    33

    34

#include "table/bridge_land.h"

    35

    36

const Bridge orig_bridge[] = {

    37

/*

    38

	     year of availablity

    39

	     |  minimum length

    40

	     |  |   maximum length

    41

	     |  |   |    price

    42

	     |  |   |    |    maximum speed

    43

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

    44

	     |  |   |    |    |  |                                   |                            */

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

};

    59

    60

Bridge _bridge[MAX_BRIDGES];

    61

    62

    63

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

    64

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

    65

int CalcBridgeLenCostFactor(int x)

    66

{

    67

	int n;

    68

	int r;

    69

    70

	if (x < 2) return x;

    71

	x -= 2;

    72

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

    73

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

    74

		r += n * n;

    75

		x -= n;

    76

	}

    77

}

    78

    79

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

    80

{

    81

	const Bridge *bridge = &_bridge[index];

    82

	assert(table < 7);

    83

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

    84

		return _bridge_sprite_table[index][table];

    85

	} else {

    86

		return bridge->sprite_table[table];

    87

	}

    88

}

    89

    90

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

    91

    92

    93

/** Check the slope at the bridge ramps in three easy steps:

    94

 * - valid slopes without foundation

    95

 * - valid slopes with foundation

    96

 * - rest is invalid

    97

 */

    98

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

    99

static int32 CheckBridgeSlopeNorth(Axis axis, Slope tileh)

   100

{

   101

	uint32 valid;

   102

   103

	valid = M(SLOPE_FLAT) | (axis == AXIS_X ? M(SLOPE_NE) : M(SLOPE_NW));

   104

	if (HASBIT(valid, tileh)) return 0;

   105

   106

	valid =

   107

		BRIDGE_FULL_LEVELED_FOUNDATION | M(SLOPE_N) | M(SLOPE_STEEP_N) |

   108

		(axis == AXIS_X ? M(SLOPE_E) | M(SLOPE_STEEP_E) : M(SLOPE_W) | M(SLOPE_STEEP_W));

   109

	if (HASBIT(valid, tileh)) return _price.terraform;

   110

   111

	return CMD_ERROR;

   112

}

   113

   114

static int32 CheckBridgeSlopeSouth(Axis axis, Slope tileh)

   115

{

   116

	uint32 valid;

   117

   118

	valid = M(SLOPE_FLAT) | (axis == AXIS_X ? M(SLOPE_SW) : M(SLOPE_SE));

   119

	if (HASBIT(valid, tileh)) return 0;

   120

   121

	valid =

   122

		BRIDGE_FULL_LEVELED_FOUNDATION | M(SLOPE_S) | M(SLOPE_STEEP_S) |

   123

		(axis == AXIS_X ? M(SLOPE_W) | M(SLOPE_STEEP_W) : M(SLOPE_E) | M(SLOPE_STEEP_E));

   124

	if (HASBIT(valid, tileh)) return _price.terraform;

   125

   126

	return CMD_ERROR;

   127

}

   128

#undef M

   129

   130

   131

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   132

{

   133

	int x1 = TileX(begin);

   134

	int y1 = TileY(begin);

   135

	int x2 = TileX(end);

   136

	int y2 = TileY(end);

   137

   138

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

   139

}

   140

   141

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   142

{

   143

	const Bridge *b = &_bridge[bridge_type];

   144

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

   145

   146

	if (bridge_type >= MAX_BRIDGES) return false;

   147

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

   148

   149

	max = b->max_length;

   150

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

   151

   152

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

   153

}

   154

   155

/** Build a Bridge

   156

 * @param end_tile end tile

   157

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

   158

 * @param p2 various bitstuffed elements

   159

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

   160

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

   161

 */

   162

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

   163

{

   164

	int bridge_type;

   165

	TransportType transport;

   166

	RailType railtype;

   167

	uint x;

   168

	uint y;

   169

	uint sx;

   170

	uint sy;

   171

	TileIndex tile_start;

   172

	TileIndex tile_end;

   173

	Slope tileh_start;

   174

	Slope tileh_end;

   175

	uint z_start;

   176

	uint z_end;

   177

	TileIndex tile;

   178

	TileIndexDiff delta;

   179

	uint bridge_len;

   180

	Axis direction;

   181

	int32 cost, terraformcost, ret;

   182

	bool allow_on_slopes;

   183

   184

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   185

   186

	/* unpack parameters */

   187

	bridge_type = GB(p2, 0, 8);

   188

   189

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

   190

   191

	// type of bridge

   192

	if (HASBIT(p2, 15)) {

   193

		railtype = RAILTYPE_BEGIN;

   194

		transport = TRANSPORT_ROAD;

   195

	} else {

   196

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

   197

		railtype = (RailType)GB(p2, 8, 8);

   198

		transport = TRANSPORT_RAIL;

   199

	}

   200

   201

	x = TileX(end_tile);

   202

	y = TileY(end_tile);

   203

	sx = TileX(p1);

   204

	sy = TileY(p1);

   205

   206

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

   207

	if (x == sx) {

   208

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

   209

		direction = AXIS_Y;

   210

		if (y > sy) uintswap(y,sy);

   211

	} else if (y == sy) {

   212

		direction = AXIS_X;

   213

		if (x > sx) uintswap(x,sx);

   214

	} else {

   215

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   216

	}

   217

   218

	/* set and test bridge length, availability */

   219

	bridge_len = sx + sy - x - y - 1;

   220

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

   221

   222

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

   223

	tile_start = TileXY(x, y);

   224

	tile_end = TileXY(sx, sy);

   225

	if (IsClearWaterTile(tile_start) || IsClearWaterTile(tile_end)) {

   226

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   227

	}

   228

   229

	tileh_start = GetTileSlope(tile_start, &z_start);

   230

	tileh_end = GetTileSlope(tile_end, &z_end);

   231

   232

	if (IsSteepSlope(tileh_start)) z_start += TILE_HEIGHT;

   233

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_start)) {

   234

		z_start += TILE_HEIGHT;

   235

		tileh_start = SLOPE_FLAT;

   236

	}

   237

   238

	if (IsSteepSlope(tileh_end)) z_end += TILE_HEIGHT;

   239

	if (HASBIT(BRIDGE_FULL_LEVELED_FOUNDATION, tileh_end)) {

   240

		z_end += TILE_HEIGHT;

   241

		tileh_end = SLOPE_FLAT;

   242

	}

   243

   244

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

   245

   246

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

   247

	allow_on_slopes = (!_is_old_ai_player

   248

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

   249

   250

	/* Try and clear the start landscape */

   251

   252

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

   253

	if (CmdFailed(ret)) return ret;

   254

	cost = ret;

   255

   256

	terraformcost = CheckBridgeSlopeNorth(direction, tileh_start);

   257

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

   258

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   259

	cost += terraformcost;

   260

   261

	/* Try and clear the end landscape */

   262

   263

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

   264

	if (CmdFailed(ret)) return ret;

   265

	cost += ret;

   266

   267

	// false - end tile slope check

   268

	terraformcost = CheckBridgeSlopeSouth(direction, tileh_end);

   269

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

   270

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   271

	cost += terraformcost;

   272

   273

	{

   274

		TileIndex Heads[] = {tile_start, tile_end};

   275

		int i;

   276

   277

		for (i = 0; i < 2; i++) {

   278

			if (MayHaveBridgeAbove(Heads[i])) {

   279

				if (IsBridgeAbove(Heads[i])) {

   280

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   281

   282

					if (direction == GetBridgeAxis(Heads[i])) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   283

   284

					if (z_start + TILE_HEIGHT == GetBridgeHeight(north_head)) {

   285

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   286

					}

   287

				}

   288

			}

   289

		}

   290

	}

   291

   292

	/* do the drill? */

   293

	if (flags & DC_EXEC) {

   294

		DiagDirection dir = AxisToDiagDir(direction);

   295

   296

		if (transport == TRANSPORT_RAIL) {

   297

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

   298

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

   299

		} else {

   300

			MakeRoadBridgeRamp(tile_start, _current_player, bridge_type, dir);

   301

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

   302

		}

   303

		MarkTileDirtyByTile(tile_start);

   304

		MarkTileDirtyByTile(tile_end);

   305

	}

   306

   307

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

   308

	for (tile = tile_start + delta; tile != tile_end; tile += delta) {

   309

		uint z;

   310

   311

		if (GetTileSlope(tile, &z) != SLOPE_FLAT && z >= z_start) return_cmd_error(STR_5009_LEVEL_LAND_OR_WATER_REQUIRED);

   312

   313

		if (MayHaveBridgeAbove(tile) && IsBridgeAbove(tile)) {

   314

			/* Disallow crossing bridges for the time being */

   315

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   316

		}

   317

   318

		switch (GetTileType(tile)) {

   319

			case MP_WATER:

   320

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

   321

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

   322

				break;

   323

   324

			case MP_RAILWAY:

   325

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   326

				break;

   327

   328

			case MP_STREET:

   329

				if (GetRoadTileType(tile) == ROAD_TILE_DEPOT) goto not_valid_below;

   330

				break;

   331

   332

			case MP_TUNNEL:

   333

				break;

   334

   335

			case MP_STREET_BRIDGE:

   336

			case MP_RAILWAY_BRIDGE:

   337

				if (direction == DiagDirToAxis(GetBridgeRampDirection(tile))) goto not_valid_below;

   338

				if (z_start < GetBridgeHeight(tile)) goto not_valid_below;

   339

				break;

   340

   341

			case MP_UNMOVABLE:

   342

				if (!IsOwnedLand(tile)) goto not_valid_below;

   343

				break;

   344

   345

			case MP_CLEAR:

   346

				if (IsBridgeAbove(tile)) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   347

				break;

   348

   349

			default:

   350

not_valid_below:;

   351

				/* try and clear the middle landscape */

   352

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

   353

				if (CmdFailed(ret)) return ret;

   354

				cost += ret;

   355

				break;

   356

		}

   357

   358

		if (flags & DC_EXEC) {

   359

			SetBridgeMiddle(tile, direction);

   360

			MarkTileDirtyByTile(tile);

   361

		}

   362

	}

   363

   364

	if (flags & DC_EXEC) {

   365

		Track track = AxisToTrack(direction);

   366

		SetSignalsOnBothDir(tile_start, track);

   367

		YapfNotifyTrackLayoutChange(tile_start, track);

   368

	}

   369

   370

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

   371

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

   372

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

   373

	 */

   374

	if (!(flags & DC_QUERY_COST)) {

   375

		const Bridge *b = &_bridge[bridge_type];

   376

   377

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

   378

   379

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   380

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   381

   382

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

   383

	}

   384

   385

	return cost;

   386

}

   387

   388

   389

static inline bool CheckAllowRemoveBridge(TileIndex tile)

   390

{

   391

	/* Floods can remove anything as well as the scenario editor */

   392

	if (_current_player == OWNER_WATER || _game_mode == GM_EDITOR) return true;

   393

	/* Obviously if the bridge/tunnel belongs to us, or no-one, we can remove it */

   394

	if (CheckTileOwnership(tile) || IsTileOwner(tile, OWNER_NONE)) return true;

   395

	/* Otherwise we can only remove town-owned stuff with extra patch-settings, or cheat */

   396

	if (IsTileOwner(tile, OWNER_TOWN) && (_patches.extra_dynamite || _cheats.magic_bulldozer.value)) return true;

   397

	return false;

   398

}

   399

   400

static bool IsVehicleOnBridge(TileIndex starttile, TileIndex endtile, uint z)

   401

{

   402

	const Vehicle *v;

   403

	FOR_ALL_VEHICLES(v) {

   404

		if ((v->tile == starttile || v->tile == endtile) && v->z_pos == z) {

   405

			_error_message = VehicleInTheWayErrMsg(v);

   406

			return true;

   407

		}

   408

	}

   409

	return false;

   410

}

   411

   412

static int32 DoClearBridge(TileIndex tile, uint32 flags)

   413

{

   414

	DiagDirection direction;

   415

	TileIndexDiff delta;

   416

	TileIndex endtile;

   417

	Town *t = NULL;

   418

   419

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   420

   421

	if (!CheckAllowRemoveBridge(tile)) return CMD_ERROR;

   422

   423

	endtile = GetOtherBridgeEnd(tile);

   424

   425

	if (!EnsureNoVehicle(tile) ||

   426

			!EnsureNoVehicle(endtile) ||

   427

			IsVehicleOnBridge(tile, endtile, GetBridgeHeight(tile))) {

   428

		return CMD_ERROR;

   429

	}

   430

   431

	direction = GetBridgeRampDirection(tile);

   432

	delta = TileOffsByDiagDir(direction);

   433

   434

	if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR) {

   435

		t = ClosestTownFromTile(tile, (uint)-1); // town penalty rating

   436

   437

		/* Check if you are allowed to remove the bridge owned by a town

   438

		 * Removal depends on difficulty settings */

   439

		if (!CheckforTownRating(flags, t, TUNNELBRIDGE_REMOVE)) {

   440

			SetDParam(0, t->index);

   441

			return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   442

		}

   443

	}

   444

   445

	if (flags & DC_EXEC) {

   446

		TileIndex c;

   447

		Track track;

   448

   449

		//checks if the owner is town then decrease town rating by RATING_TUNNEL_BRIDGE_DOWN_STEP until

   450

		// you have a "Poor" (0) town rating

   451

		if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR)

   452

			ChangeTownRating(t, RATING_TUNNEL_BRIDGE_DOWN_STEP, RATING_TUNNEL_BRIDGE_MINIMUM);

   453

   454

		DoClearSquare(tile);

   455

		DoClearSquare(endtile);

   456

		for (c = tile + delta; c != endtile; c += delta) {

   457

				ClearBridgeMiddle(c);

   458

			MarkTileDirtyByTile(c);

   459

		}

   460

   461

		UpdateSignalsOnSegment(tile, ReverseDiagDir(direction));

   462

		UpdateSignalsOnSegment(endtile, direction);

   463

		track = AxisToTrack(DiagDirToAxis(direction));

   464

		YapfNotifyTrackLayoutChange(tile, track);

   465

		YapfNotifyTrackLayoutChange(endtile, track);

   466

	}

   467

   468

	return (DistanceManhattan(tile, endtile) + 1) * _price.clear_bridge;

   469

}

   470

   471

   472

static int32 ClearTile_Bridge(TileIndex tile, byte flags)

   473

{

   474

	assert(IsBridgeTile(tile));

   475

	if (flags & DC_AUTO) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   476

	return DoClearBridge(tile, flags);

   477

}

   478

   479

int32 DoConvertBridgeRail(TileIndex tile, RailType totype, bool exec)

   480

{

   481

	TileIndex endtile;

   482

   483

	if (GetBridgeTransportType(tile) == TRANSPORT_RAIL) {

   484

		if (!CheckTileOwnership(tile)) return CMD_ERROR;

   485

   486

		endtile = GetOtherBridgeEnd(tile);

   487

   488

		if (!EnsureNoVehicle(tile) ||