1

/* $Id$ */

     2

     3

/** @file tunnelbridge_cmd.cpp

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

    14

#include "landscape.h"

    15

#include "tunnel_map.h"

    16

#include "unmovable_map.h"

    17

#include "viewport_func.h"

    18

#include "command_func.h"

    19

#include "town.h"

    20

#include "variables.h"

    21

#include "bridge.h"

    22

#include "train.h"

    23

#include "water_map.h"

    24

#include "yapf/yapf.h"

    25

#include "newgrf_sound.h"

    26

#include "autoslope.h"

    27

#include "transparency.h"

    28

#include "tunnelbridge_map.h"

    29

#include "strings_func.h"

    30

#include "date_func.h"

    31

#include "functions.h"

    32

#include "vehicle_func.h"

    33

#include "sound_func.h"

    34

#include "signal_func.h"

    35

    36

#include "table/sprites.h"

    37

#include "table/strings.h"

    38

#include "table/bridge_land.h"

    39

    40

const Bridge orig_bridge[] = {

    41

/*

    42

	     year of availablity

    43

	     |  minimum length

    44

	     |  |   maximum length

    45

	     |  |   |    price

    46

	     |  |   |    |    maximum speed

    47

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

    48

	     |  |   |    |    |  |                                   |                            */

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

};

    63

    64

Bridge _bridge[MAX_BRIDGES];

    65

    66

    67

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

    68

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

    69

 */

    70

int CalcBridgeLenCostFactor(int x)

    71

{

    72

	int n;

    73

	int r;

    74

    75

	if (x < 2) return x;

    76

	x -= 2;

    77

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

    78

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

    79

		r += n * n;

    80

		x -= n;

    81

	}

    82

}

    83

    84

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    85

{

    86

	if ((tileh == SLOPE_FLAT) ||

    87

	    (((tileh == SLOPE_NE) || (tileh == SLOPE_SW)) && (axis == AXIS_X)) ||

    88

	    (((tileh == SLOPE_NW) || (tileh == SLOPE_SE)) && (axis == AXIS_Y))) return FOUNDATION_NONE;

    89

    90

	return (HasSlopeHighestCorner(tileh) ? InclinedFoundation(axis) : FlatteningFoundation(tileh));

    91

}

    92

    93

/**

    94

 * Determines if the track on a bridge ramp is flat or goes up/down.

    95

 *

    96

 * @param tileh Slope of the tile under the bridge head

    97

 * @param axis Orientation of bridge

    98

 * @return true iff the track is flat.

    99

 */

   100

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

   101

{

   102

	ApplyFoundationToSlope(GetBridgeFoundation(tileh, axis), &tileh);

   103

	/* If the foundation slope is flat the bridge has a non-flat ramp and vice versa. */

   104

	return (tileh != SLOPE_FLAT);

   105

}

   106

   107

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

   108

{

   109

	const Bridge *bridge = &_bridge[index];

   110

	assert(table < 7);

   111

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

   112

		return _bridge_sprite_table[index][table];

   113

	} else {

   114

		return bridge->sprite_table[table];

   115

	}

   116

}

   117

   118

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

   119

   120

   121

/**

   122

 * Determines the foundation for the north bridge head, and tests if the resulting slope is valid.

   123

 *

   124

 * @param axis Axis of the bridge

   125

 * @param tileh Slope of the tile under the north bridge head; returns slope on top of foundation

   126

 * @param z TileZ corresponding to tileh, gets modified as well

   127

 * @return Error or cost for bridge foundation

   128

 */

   129

static CommandCost CheckBridgeSlopeNorth(Axis axis, Slope *tileh, uint *z)

   130

{

   131

	Foundation f = GetBridgeFoundation(*tileh, axis);

   132

	*z += ApplyFoundationToSlope(f, tileh);

   133

   134

	Slope valid_inclined = (axis == AXIS_X ? SLOPE_NE : SLOPE_NW);

   135

	if ((*tileh != SLOPE_FLAT) && (*tileh != valid_inclined)) return CMD_ERROR;

   136

   137

	if (f == FOUNDATION_NONE) return CommandCost();

   138

   139

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   140

}

   141

   142

/**

   143

 * Determines the foundation for the south bridge head, and tests if the resulting slope is valid.

   144

 *

   145

 * @param axis Axis of the bridge

   146

 * @param tileh Slope of the tile under the south bridge head; returns slope on top of foundation

   147

 * @param z TileZ corresponding to tileh, gets modified as well

   148

 * @return Error or cost for bridge foundation

   149

 */

   150

static CommandCost CheckBridgeSlopeSouth(Axis axis, Slope *tileh, uint *z)

   151

{

   152

	Foundation f = GetBridgeFoundation(*tileh, axis);

   153

	*z += ApplyFoundationToSlope(f, tileh);

   154

   155

	Slope valid_inclined = (axis == AXIS_X ? SLOPE_SW : SLOPE_SE);

   156

	if ((*tileh != SLOPE_FLAT) && (*tileh != valid_inclined)) return CMD_ERROR;

   157

   158

	if (f == FOUNDATION_NONE) return CommandCost();

   159

   160

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   161

}

   162

   163

   164

uint32 GetBridgeLength(TileIndex begin, TileIndex end)

   165

{

   166

	int x1 = TileX(begin);

   167

	int y1 = TileY(begin);

   168

	int x2 = TileX(end);

   169

	int y2 = TileY(end);

   170

   171

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

   172

}

   173

   174

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   175

{

   176

	const Bridge *b = &_bridge[bridge_type];

   177

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

   178

   179

	if (bridge_type >= MAX_BRIDGES) return false;

   180

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

   181

   182

	max = b->max_length;

   183

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

   184

   185

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

   186

}

   187

   188

/** Build a Bridge

   189

 * @param end_tile end tile

   190

 * @param flags type of operation

   191

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

   192

 * @param p2 various bitstuffed elements

   193

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

   194

 * - p2 = (bit 8-..) - rail type or road types.

   195

 * - p2 = (bit 15  ) - set means road bridge.

   196

 */

   197

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

   198

{

   199

	uint bridge_type;

   200

	RailType railtype;

   201

	RoadTypes roadtypes;

   202

	uint x;

   203

	uint y;

   204

	uint sx;

   205

	uint sy;

   206

	TileIndex tile_start;

   207

	TileIndex tile_end;

   208

	Slope tileh_start;

   209

	Slope tileh_end;

   210

	uint z_start;

   211

	uint z_end;

   212

	TileIndex tile;

   213

	TileIndexDiff delta;

   214

	uint bridge_len;

   215

	Axis direction;

   216

	CommandCost cost(EXPENSES_CONSTRUCTION);

   217

	CommandCost ret;

   218

	bool replace_bridge = false;

   219

	uint replaced_bridge_type;

   220

   221

	/* unpack parameters */

   222

	bridge_type = GB(p2, 0, 8);

   223

   224

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

   225

   226

	/* type of bridge */

   227

	if (HasBit(p2, 15)) {

   228

		railtype = INVALID_RAILTYPE; // road bridge

   229

		roadtypes = (RoadTypes)GB(p2, 8, 3);

   230

		if (!AreValidRoadTypes(roadtypes) || !HasRoadTypesAvail(_current_player, roadtypes)) return CMD_ERROR;

   231

	} else {

   232

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

   233

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

   234

		roadtypes = ROADTYPES_NONE;

   235

	}

   236

   237

	x = TileX(end_tile);

   238

	y = TileY(end_tile);

   239

	sx = TileX(p1);

   240

	sy = TileY(p1);

   241

   242

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

   243

	if (x == sx) {

   244

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

   245

		direction = AXIS_Y;

   246

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

   247

	} else if (y == sy) {

   248

		direction = AXIS_X;

   249

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

   250

	} else {

   251

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   252

	}

   253

   254

	/* set and test bridge length, availability */

   255

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

   256

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

   257

   258

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

   259

	tile_start = TileXY(x, y);

   260

	tile_end = TileXY(sx, sy);

   262

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   263

	}

   264

   265

	tileh_start = GetTileSlope(tile_start, &z_start);

   266

	tileh_end = GetTileSlope(tile_end, &z_end);

   267

   268

	CommandCost terraform_cost_north = CheckBridgeSlopeNorth(direction, &tileh_start, &z_start);

   269

	CommandCost terraform_cost_south = CheckBridgeSlopeSouth(direction, &tileh_end, &z_end);

   270

   271

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

   272

   273

	TransportType transport_type = railtype == INVALID_RAILTYPE ? TRANSPORT_ROAD : TRANSPORT_RAIL;

   274

   275

	if (IsBridgeTile(tile_start) && IsBridgeTile(tile_end) &&

   276

			GetOtherBridgeEnd(tile_start) == tile_end &&

   277

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   278

		/* Replace a current bridge. */

   279

   280

		/* If this is a railway bridge, make sure the railtypes match. */

   281

		if (transport_type == TRANSPORT_RAIL && GetRailType(tile_start) != railtype) {

   282

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   283

		}

   284

   285

		/* Do not replace town bridges with lower speed bridges. */

   286

		if (!(flags & DC_QUERY_COST) && IsTileOwner(tile_start, OWNER_TOWN) &&

   287

				_bridge[bridge_type].speed < _bridge[GetBridgeType(tile_start)].speed) {

   288

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   289

   290

			if (t == NULL) {

   291

				return CMD_ERROR;

   292

			} else {

   293

				SetDParam(0, t->index);

   294

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   295

			}

   296

		}

   297

   298

		/* Do not replace the bridge with the same bridge type. */

   299

		if (!(flags & DC_QUERY_COST) && bridge_type == GetBridgeType(tile_start)) {

   300

			return_cmd_error(STR_1007_ALREADY_BUILT);

   301

		}

   302

   303

		/* Do not allow replacing another player's bridges. */

   304

		if (!IsTileOwner(tile_start, _current_player) && !IsTileOwner(tile_start, OWNER_TOWN)) {

   305

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   306

		}

   307

   308

		cost.AddCost((bridge_len + 1) * _price.clear_bridge); // The cost of clearing the current bridge.

   309

		replace_bridge = true;

   310

		replaced_bridge_type = GetBridgeType(tile_start);

   311

   312

		/* Do not remove road types when upgrading a bridge */

   313

		roadtypes |= GetRoadTypes(tile_start);

   314

	} else {

   315

		/* Build a new bridge. */

   316

   317

		bool allow_on_slopes = (!_is_old_ai_player && _patches.build_on_slopes);

   318

   319

		/* Try and clear the start landscape */

   320

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

   321

		if (CmdFailed(ret)) return ret;

   322

		cost = ret;

   323

   324

		if (CmdFailed(terraform_cost_north) || (terraform_cost_north.GetCost() != 0 && !allow_on_slopes))

   325

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   326

		cost.AddCost(terraform_cost_north);

   327

   328

		/* Try and clear the end landscape */

   329

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

   330

		if (CmdFailed(ret)) return ret;

   331

		cost.AddCost(ret);

   332

   333

		/* false - end tile slope check */

   334

		if (CmdFailed(terraform_cost_south) || (terraform_cost_south.GetCost() != 0 && !allow_on_slopes))

   335

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   336

		cost.AddCost(terraform_cost_south);

   337

	}

   338

   339

	if (!replace_bridge) {

   340

		TileIndex Heads[] = {tile_start, tile_end};

   341

		int i;

   342

   343

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

   344

			if (MayHaveBridgeAbove(Heads[i])) {

   345

				if (IsBridgeAbove(Heads[i])) {

   346

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   347

   348

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

   349

   350

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

   351

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   352

					}

   353

				}

   354

			}

   355

		}

   356

	}

   357

   358

	/* do the drill? */

   359

	if (flags & DC_EXEC) {

   360

		DiagDirection dir = AxisToDiagDir(direction);

   361

		Owner owner = (replace_bridge && IsTileOwner(tile_start, OWNER_TOWN)) ? OWNER_TOWN : _current_player;

   362

   363

		if (railtype != INVALID_RAILTYPE) {

   364

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

   365

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

   366

		} else {

   367

			MakeRoadBridgeRamp(tile_start, owner, bridge_type, dir, roadtypes);

   368

			MakeRoadBridgeRamp(tile_end,   owner, bridge_type, ReverseDiagDir(dir), roadtypes);

   369

		}

   370

		MarkTileDirtyByTile(tile_start);

   371

		MarkTileDirtyByTile(tile_end);

   372

	}

   373

   374

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

   375

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

   376

		if (GetTileMaxZ(tile) > z_start) return_cmd_error(STR_BRIDGE_TOO_LOW_FOR_TERRAIN);

   377

   378

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

   379

			/* Disallow crossing bridges for the time being */

   380

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   381

		}

   382

   383

		switch (GetTileType(tile)) {

   384

			case MP_WATER:

   385

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

   386

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

   387

				break;

   388

   389

			case MP_RAILWAY:

   390

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   391

				break;

   392

   393

			case MP_ROAD:

   394

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

   395

				break;

   396

   397

			case MP_TUNNELBRIDGE:

   398

				if (IsTunnel(tile)) break;

   399

				if (replace_bridge) break;

   400

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

   401

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

   402

				break;

   403

   404

			case MP_UNMOVABLE:

   405

				if (!IsOwnedLand(tile)) goto not_valid_below;

   406

				break;

   407

   408

			case MP_CLEAR:

   409

				break;

   410

   411

			default:

   412

not_valid_below:;

   413

				/* try and clear the middle landscape */

   414

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

   415

				if (CmdFailed(ret)) return ret;

   416

				cost.AddCost(ret);

   417

				break;

   418

		}

   419

   420

		if (flags & DC_EXEC) {

   421

			SetBridgeMiddle(tile, direction);

   422

			MarkTileDirtyByTile(tile);

   423

		}

   424

	}

   425

   426

	if (flags & DC_EXEC && railtype != INVALID_RAILTYPE) {

   427

		Track track = AxisToTrack(direction);

   428

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   429

		YapfNotifyTrackLayoutChange(tile_start, track);

   430

	}

   431

   432

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

   433

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

   434

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

   435

	 */

   436

	if (!(flags & DC_QUERY_COST)) {

   437

		const Bridge *b = &_bridge[bridge_type];

   438

   439

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

   440

   441

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   442

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   443

   444

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

   445

	}

   446

   447

	return cost;

   448

}

   449

   450

   451

/** Build Tunnel.

   452

 * @param start_tile start tile of tunnel

   453

 * @param flags type of operation

   454

 * @param p1 railtype or roadtypes. bit 9 set means road tunnel

   455

 * @param p2 unused

   456

 */

   457

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

   458

{

   459

	TileIndexDiff delta;

   460

	TileIndex end_tile;

   461

	DiagDirection direction;

   462

	Slope start_tileh;

   463

	Slope end_tileh;

   464

	uint start_z;

   465

	uint end_z;

   466

	CommandCost cost(EXPENSES_CONSTRUCTION);

   467

	CommandCost ret;

   468

   469

	_build_tunnel_endtile = 0;

   470

	if (!HasBit(p1, 9)) {

   471

		if (!ValParamRailtype((RailType)p1)) return CMD_ERROR;

   472

	} else {

   473

		const RoadTypes rts = (RoadTypes)GB(p1, 0, 3);

   474

		if (!AreValidRoadTypes(rts) || !HasRoadTypesAvail(_current_player, rts)) return CMD_ERROR;

   475

	}

   476

   477

	start_tileh = GetTileSlope(start_tile, &start_z);

   478

   479

	switch (start_tileh) {

   480

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   481

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   482

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   483

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   484

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   485

	}