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

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

    94

{

    95

	const Bridge *bridge = &_bridge[index];

    96

	assert(table < 7);

    97

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

    98

		return _bridge_sprite_table[index][table];

    99

	} else {

   100

		return bridge->sprite_table[table];

   101

	}

   102

}

   103

   104

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

   105

   106

   107

/**

   108

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

   109

 *

   110

 * @param axis Axis of the bridge

   111

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

   112

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

   113

 * @return Error or cost for bridge foundation

   114

 */

   115

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

   116

{

   117

	Foundation f = GetBridgeFoundation(*tileh, axis);

   118

	*z += ApplyFoundationToSlope(f, tileh);

   119

   120

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

   121

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

   122

   123

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

   124

   125

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   126

}

   127

   128

/**

   129

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

   130

 *

   131

 * @param axis Axis of the bridge

   132

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

   133

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

   134

 * @return Error or cost for bridge foundation

   135

 */

   136

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

   137

{

   138

	Foundation f = GetBridgeFoundation(*tileh, axis);

   139

	*z += ApplyFoundationToSlope(f, tileh);

   140

   141

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

   142

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

   143

   144

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

   145

   146

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   147

}

   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 flags type of operation

   177

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

   178

 * @param p2 various bitstuffed elements

   179

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

   180

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

   181

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

   182

 */

   183

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

   184

{

   185

	uint bridge_type;

   186

	RailType railtype;

   187

	RoadTypes roadtypes;

   188

	uint x;

   189

	uint y;

   190

	uint sx;

   191

	uint sy;

   192

	TileIndex tile_start;

   193

	TileIndex tile_end;

   194

	Slope tileh_start;

   195

	Slope tileh_end;

   196

	uint z_start;

   197

	uint z_end;

   198

	TileIndex tile;

   199

	TileIndexDiff delta;

   200

	uint bridge_len;

   201

	Axis direction;

   202

	CommandCost cost(EXPENSES_CONSTRUCTION);

   203

	CommandCost ret;

   204

	bool replace_bridge = false;

   205

	uint replaced_bridge_type;

   206

   207

	/* unpack parameters */

   208

	bridge_type = GB(p2, 0, 8);

   209

   210

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

   211

   212

	/* type of bridge */

   213

	if (HasBit(p2, 15)) {

   214

		railtype = INVALID_RAILTYPE; // road bridge

   215

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

   216

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

   217

	} else {

   218

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

   219

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

   220

		roadtypes = ROADTYPES_NONE;

   221

	}

   222

   223

	x = TileX(end_tile);

   224

	y = TileY(end_tile);

   225

	sx = TileX(p1);

   226

	sy = TileY(p1);

   227

   228

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

   229

	if (x == sx) {

   230

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

   231

		direction = AXIS_Y;

   232

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

   233

	} else if (y == sy) {

   234

		direction = AXIS_X;

   235

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

   236

	} else {

   237

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   238

	}

   239

   240

	/* set and test bridge length, availability */

   241

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

   242

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

   243

   244

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

   245

	tile_start = TileXY(x, y);

   246

	tile_end = TileXY(sx, sy);

   247

	if (IsWaterTile(tile_start) || IsWaterTile(tile_end)) {

   248

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   249

	}

   250

   251

	tileh_start = GetTileSlope(tile_start, &z_start);

   252

	tileh_end = GetTileSlope(tile_end, &z_end);

   253

   254

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

   255

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

   256

   257

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

   258

   259

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

   260

   261

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

   262

			GetOtherBridgeEnd(tile_start) == tile_end &&

   263

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   264

		/* Replace a current bridge. */

   265

   266

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

   267

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

   268

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   269

		}

   270

   271

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

   272

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

   273

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

   274

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   275

   276

			if (t == NULL) {

   277

				return CMD_ERROR;

   278

			} else {

   279

				SetDParam(0, t->index);

   280

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   281

			}

   282

		}

   283

   284

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

   285

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

   286

			return_cmd_error(STR_1007_ALREADY_BUILT);

   287

		}

   288

   289

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

   290

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

   291

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   292

		}

   293

   294

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

   295

		replace_bridge = true;

   296

		replaced_bridge_type = GetBridgeType(tile_start);

   297

   298

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

   299

		roadtypes |= GetRoadTypes(tile_start);

   300

	} else {

   301

		/* Build a new bridge. */

   302

   303

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

   304

   305

		/* Try and clear the start landscape */

   306

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

   307

		if (CmdFailed(ret)) return ret;

   308

		cost = ret;

   309

   310

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

   311

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   312

		cost.AddCost(terraform_cost_north);

   313

   314

		/* Try and clear the end landscape */

   315

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

   316

		if (CmdFailed(ret)) return ret;

   317

		cost.AddCost(ret);

   318

   319

		/* false - end tile slope check */

   320

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

   321

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   322

		cost.AddCost(terraform_cost_south);

   323

	}

   324

   325

	if (!replace_bridge) {

   326

		TileIndex Heads[] = {tile_start, tile_end};

   327

		int i;

   328

   329

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

   330

			if (MayHaveBridgeAbove(Heads[i])) {

   331

				if (IsBridgeAbove(Heads[i])) {

   332

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   333

   334

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

   335

   336

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

   337

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   338

					}

   339

				}

   340

			}

   341

		}

   342

	}

   343

   344

	/* do the drill? */

   345

	if (flags & DC_EXEC) {

   346

		DiagDirection dir = AxisToDiagDir(direction);

   347

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

   348

   349

		if (railtype != INVALID_RAILTYPE) {

   350

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

   351

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

   352

		} else {

   353

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

   354

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

   355

		}

   356

		MarkTileDirtyByTile(tile_start);

   357

		MarkTileDirtyByTile(tile_end);

   358

	}

   359

   360

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

   361

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

   362

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

   363

   364

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

   365

			/* Disallow crossing bridges for the time being */

   366

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   367

		}

   368

   369

		switch (GetTileType(tile)) {

   370

			case MP_WATER:

   371

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

   372

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

   373

				break;

   374

   375

			case MP_RAILWAY:

   376

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   377

				break;

   378

   379

			case MP_ROAD:

   380

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

   381

				break;

   382

   383

			case MP_TUNNELBRIDGE:

   384

				if (IsTunnel(tile)) break;

   385

				if (replace_bridge) break;

   386

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

   387

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

   388

				break;

   389

   390

			case MP_UNMOVABLE:

   391

				if (!IsOwnedLand(tile)) goto not_valid_below;

   392

				break;

   393

   394

			case MP_CLEAR:

   395

				break;

   396

   397

			default:

   398

not_valid_below:;

   399

				/* try and clear the middle landscape */

   400

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

   401

				if (CmdFailed(ret)) return ret;

   402

				cost.AddCost(ret);

   403

				break;

   404

		}

   405

   406

		if (flags & DC_EXEC) {

   407

			SetBridgeMiddle(tile, direction);

   408

			MarkTileDirtyByTile(tile);

   409

		}

   410

	}

   411

   412

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

   413

		Track track = AxisToTrack(direction);

   414

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   415

		YapfNotifyTrackLayoutChange(tile_start, track);

   416

	}

   417

   418

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

   419

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

   420

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

   421

	 */

   422

	if (!(flags & DC_QUERY_COST)) {

   423

		const Bridge *b = &_bridge[bridge_type];

   424

   425

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

   426

   427

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   428

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   429

   430

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

   431

	}

   432

   433

	return cost;

   434

}

   435

   436

   437

/** Build Tunnel.

   438

 * @param start_tile start tile of tunnel

   439

 * @param flags type of operation

   440

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

   441

 * @param p2 unused

   442

 */

   443

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

   444

{

   445

	TileIndexDiff delta;

   446

	TileIndex end_tile;

   447

	DiagDirection direction;

   448

	Slope start_tileh;

   449

	Slope end_tileh;

   450

	uint start_z;

   451

	uint end_z;

   452

	CommandCost cost(EXPENSES_CONSTRUCTION);

   453

	CommandCost ret;

   454

   455

	_build_tunnel_endtile = 0;

   456

	if (!HasBit(p1, 9)) {

   457

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

   458

	} else {

   459

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

   460

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

   461

	}

   462

   463

	start_tileh = GetTileSlope(start_tile, &start_z);

   464

   465

	switch (start_tileh) {

   466

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   467

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   468

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   469

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   470

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   471

	}

   472

   473

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

   474

	if (CmdFailed(ret)) return ret;

   475

   476

	/* XXX - do NOT change 'ret' in the loop, as it is used as the price

   477

	 * for the clearing of the entrance of the tunnel. Assigning it to

   478

	 * cost before the loop will yield different costs depending on start-

   479

	 * position, because of increased-cost-by-length: 'cost += cost >> 3' */

   480

   481

	delta = TileOffsByDiagDir(direction);

   482

	DiagDirection tunnel_in_way_dir;

   483

	if (OtherAxis(DiagDirToAxis(direction)) == AXIS_X) {

   484

		tunnel_in_way_dir = (TileX(start_tile) < (MapMaxX() / 2)) ? DIAGDIR_SW : DIAGDIR_NE;

   485

	} else {