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"

    36

    37

#include "table/sprites.h"

    38

#include "table/strings.h"

    39

#include "table/bridge_land.h"

    40

    41

const Bridge orig_bridge[] = {

    42

/*

    43

	     year of availablity

    44

	     |  minimum length

    45

	     |  |   maximum length

    46

	     |  |   |    price

    47

	     |  |   |    |    maximum speed

    48

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

    49

	     |  |   |    |    |  |                                   |                            */

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

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

    63

};

    64

    65

Bridge _bridge[MAX_BRIDGES];

    66

    67

    68

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

    69

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

    70

 */

    71

int CalcBridgeLenCostFactor(int x)

    72

{

    73

	int n;

    74

	int r;

    75

    76

	if (x < 2) return x;

    77

	x -= 2;

    78

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

    79

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

    80

		r += n * n;

    81

		x -= n;

    82

	}

    83

}

    84

    85

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    86

{

    87

	if ((tileh == SLOPE_FLAT) ||

    88

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

    89

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

    90

    91

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

    92

}

    93

    94

/**

    95

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

    96

 *

    97

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

    98

 * @param axis Orientation of bridge

    99

 * @return true iff the track is flat.

   100

 */

   101

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

   102

{

   103

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

   104

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

   105

	return (tileh != SLOPE_FLAT);

   106

}

   107

   108

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

   109

{

   110

	const Bridge *bridge = &_bridge[index];

   111

	assert(table < 7);

   112

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

   113

		return _bridge_sprite_table[index][table];

   114

	} else {

   115

		return bridge->sprite_table[table];

   116

	}

   117

}

   118

   119

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

   120

   121

   122

/**

   123

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

   124

 *

   125

 * @param axis Axis of the bridge

   126

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

   127

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

   128

 * @return Error or cost for bridge foundation

   129

 */

   130

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

   131

{

   132

	Foundation f = GetBridgeFoundation(*tileh, axis);

   133

	*z += ApplyFoundationToSlope(f, tileh);

   134

   135

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

   136

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

   137

   138

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

   139

   140

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   141

}

   142

   143

/**

   144

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

   145

 *

   146

 * @param axis Axis of the bridge

   147

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

   148

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

   149

 * @return Error or cost for bridge foundation

   150

 */

   151

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

   152

{

   153

	Foundation f = GetBridgeFoundation(*tileh, axis);

   154

	*z += ApplyFoundationToSlope(f, tileh);

   155

   156

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

   157

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

   158

   159

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

   160

   161

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   162

}

   163

   164

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   165

{

   166

	const Bridge *b = &_bridge[bridge_type];

   167

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

   168

   169

	if (bridge_type >= MAX_BRIDGES) return false;

   170

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

   171

   172

	max = b->max_length;

   173

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

   174

   175

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

   176

}

   177

   178

/** Build a Bridge

   179

 * @param end_tile end tile

   180

 * @param flags type of operation

   181

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

   182

 * @param p2 various bitstuffed elements

   183

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

   184

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

   185

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

   186

 */

   187

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

   188

{

   189

	uint bridge_type;

   190

	RailType railtype;

   191

	RoadTypes roadtypes;

   192

	uint x;

   193

	uint y;

   194

	uint sx;

   195

	uint sy;

   196

	TileIndex tile_start;

   197

	TileIndex tile_end;

   198

	Slope tileh_start;

   199

	Slope tileh_end;

   200

	uint z_start;

   201

	uint z_end;

   202

	TileIndex tile;

   203

	TileIndexDiff delta;

   204

	uint bridge_len;

   205

	Axis direction;

   206

	CommandCost cost(EXPENSES_CONSTRUCTION);

   207

	CommandCost ret;

   208

	bool replace_bridge = false;

   209

	uint replaced_bridge_type;

   210

   211

	/* unpack parameters */

   212

	bridge_type = GB(p2, 0, 8);

   213

   214

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

   215

   216

	/* type of bridge */

   217

	if (HasBit(p2, 15)) {

   218

		railtype = INVALID_RAILTYPE; // road bridge

   219

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

   220

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

   221

	} else {

   222

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

   223

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

   224

		roadtypes = ROADTYPES_NONE;

   225

	}

   226

   227

	x = TileX(end_tile);

   228

	y = TileY(end_tile);

   229

	sx = TileX(p1);

   230

	sy = TileY(p1);

   231

   232

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

   233

	if (x == sx) {

   234

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

   235

		direction = AXIS_Y;

   236

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

   237

	} else if (y == sy) {

   238

		direction = AXIS_X;

   239

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

   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 (IsWaterTile(tile_start) || IsRiverTile(tile_start) || IsWaterTile(tile_end) || IsRiverTile(tile_end)) {

   252

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   253

	}

   254

   255

	tileh_start = GetTileSlope(tile_start, &z_start);

   256

	tileh_end = GetTileSlope(tile_end, &z_end);

   257

   258

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

   259

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

   260

   261

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

   262

   263

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

   264

   265

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

   266

			GetOtherBridgeEnd(tile_start) == tile_end &&

   267

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   268

		/* Replace a current bridge. */

   269

   270

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

   271

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

   272

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   273

		}

   274

   275

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

   276

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

   277

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

   278

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   279

   280

			if (t == NULL) {

   281

				return CMD_ERROR;

   282

			} else {

   283

				SetDParam(0, t->index);

   284

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   285

			}

   286

		}

   287

   288

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

   289

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

   290

			return_cmd_error(STR_1007_ALREADY_BUILT);

   291

		}

   292

   293

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

   294

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

   295

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   296

		}

   297

   298

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

   299

		replace_bridge = true;

   300

		replaced_bridge_type = GetBridgeType(tile_start);

   301

   302

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

   303

		roadtypes |= GetRoadTypes(tile_start);

   304

	} else {

   305

		/* Build a new bridge. */

   306

   307

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

   308

   309

		/* Try and clear the start landscape */

   310

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

   311

		if (CmdFailed(ret)) return ret;

   312

		cost = ret;

   313

   314

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

   315

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   316

		cost.AddCost(terraform_cost_north);

   317

   318

		/* Try and clear the end landscape */

   319

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

   320

		if (CmdFailed(ret)) return ret;

   321

		cost.AddCost(ret);

   322

   323

		/* false - end tile slope check */

   324

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

   325

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   326

		cost.AddCost(terraform_cost_south);

   327

	}

   328

   329

	if (!replace_bridge) {

   330

		TileIndex Heads[] = {tile_start, tile_end};

   331

		int i;

   332

   333

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

   334

			if (MayHaveBridgeAbove(Heads[i])) {

   335

				if (IsBridgeAbove(Heads[i])) {

   336

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   337

   338

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

   339

   340

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

   341

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   342

					}

   343

				}

   344

			}

   345

		}

   346

	}

   347

   348

	/* do the drill? */

   349

	if (flags & DC_EXEC) {

   350

		DiagDirection dir = AxisToDiagDir(direction);

   351

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

   352

   353

		if (railtype != INVALID_RAILTYPE) {

   354

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

   355

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

   356

		} else {

   357

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

   358

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

   359

		}

   360

		MarkTileDirtyByTile(tile_start);

   361

		MarkTileDirtyByTile(tile_end);

   362

	}

   363

   364

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

   365

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

   366

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

   367

   368

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

   369

			/* Disallow crossing bridges for the time being */

   370

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   371

		}

   372

   373

		switch (GetTileType(tile)) {

   374

			case MP_WATER:

   375

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

   376

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

   377

				break;

   378

   379

			case MP_RAILWAY:

   380

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   381

				break;

   382

   383

			case MP_ROAD:

   384

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

   385

				break;

   386

   387

			case MP_TUNNELBRIDGE:

   388

				if (IsTunnel(tile)) break;

   389

				if (replace_bridge) break;

   390

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

   391

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

   392

				break;

   393

   394

			case MP_UNMOVABLE:

   395

				if (!IsOwnedLand(tile)) goto not_valid_below;

   396

				break;

   397

   398

			case MP_CLEAR:

   399

				break;

   400

   401

			default:

   402

not_valid_below:;

   403

				/* try and clear the middle landscape */

   404

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

   405

				if (CmdFailed(ret)) return ret;

   406

				cost.AddCost(ret);

   407

				break;

   408

		}

   409

   410

		if (flags & DC_EXEC) {

   411

			SetBridgeMiddle(tile, direction);

   412

			MarkTileDirtyByTile(tile);

   413

		}

   414

	}

   415

   416

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

   417

		Track track = AxisToTrack(direction);

   418

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   419

		YapfNotifyTrackLayoutChange(tile_start, track);

   420

	}

   421

   422

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

   423

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

   424

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

   425

	 */

   426

	if (!(flags & DC_QUERY_COST)) {

   427

		const Bridge *b = &_bridge[bridge_type];

   428

   429

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

   430

   431

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   432

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   433

   434

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

   435

	}

   436

   437

	return cost;

   438

}

   439

   440

   441

/** Build Tunnel.

   442

 * @param start_tile start tile of tunnel

   443

 * @param flags type of operation

   444

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

   445

 * @param p2 unused

   446

 */

   447

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

   448

{

   449

	TileIndexDiff delta;

   450

	TileIndex end_tile;

   451

	DiagDirection direction;

   452

	Slope start_tileh;

   453

	Slope end_tileh;

   454

	uint start_z;

   455

	uint end_z;

   456

	CommandCost cost(EXPENSES_CONSTRUCTION);

   457

	CommandCost ret;

   458

   459

	_build_tunnel_endtile = 0;

   460

	if (!HasBit(p1, 9)) {

   461

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

   462

	} else {

   463

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

   464

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

   465

	}

   466

   467

	start_tileh = GetTileSlope(start_tile, &start_z);

   468

   469

	switch (start_tileh) {

   470

		case SLOPE_SW: direction = DIAGDIR_SW; break;

   471

		case SLOPE_SE: direction = DIAGDIR_SE; break;

   472

		case SLOPE_NW: direction = DIAGDIR_NW; break;

   473

		case SLOPE_NE: direction = DIAGDIR_NE; break;

   474

		default: return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   475

	}

   476

   477

	if (IsRiverTile(start_tile)) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   478

   479

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

   480

	if (CmdFailed(ret)) return ret;

   481

   482

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

   483

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

   484

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

   485

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