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

#include "tunnelbridge.h"

    36

#include "player_base.h"

    37

#include "engine_func.h"

    39

#include "economy_func.h"

    40

#include "rail.h"

    41

#include "cheat_func.h"

    43

    44

#include "table/sprites.h"

    45

#include "table/strings.h"

    46

#include "table/bridge_land.h"

    47

    48

BridgeSpec _bridge[MAX_BRIDGES];

    49

TileIndex _build_tunnel_endtile;

    50

    51

/** Reset the data been eventually changed by the grf loaded. */

    52

void ResetBridges()

    53

{

    54

	/* First, free sprite table data */

    55

	for (BridgeType i = 0; i < MAX_BRIDGES; i++) {

    56

		if (_bridge[i].sprite_table != NULL) {

    57

			for (uint j = 0; j < 7; j++) free(_bridge[i].sprite_table[j]);

    58

			free(_bridge[i].sprite_table);

    59

		}

    60

	}

    61

    62

	/* Then, wipe out current bidges */

    63

	memset(&_bridge, 0, sizeof(_bridge));

    64

	/* And finally, reinstall default data */

    65

	memcpy(&_bridge, &_orig_bridge, sizeof(_orig_bridge));

    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 BridgeSpec *bridge = GetBridgeSpec(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

   120

/**

   121

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

   122

 *

   123

 * @param axis Axis of the bridge

   124

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

   125

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

   126

 * @return Error or cost for bridge foundation

   127

 */

   128

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

   129

{

   130

	Foundation f = GetBridgeFoundation(*tileh, axis);

   131

	*z += ApplyFoundationToSlope(f, tileh);

   132

   133

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

   134

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

   135

   136

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

   137

   138

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   139

}

   140

   141

/**

   142

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

   143

 *

   144

 * @param axis Axis of the bridge

   145

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

   146

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

   147

 * @return Error or cost for bridge foundation

   148

 */

   149

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

   150

{

   151

	Foundation f = GetBridgeFoundation(*tileh, axis);

   152

	*z += ApplyFoundationToSlope(f, tileh);

   153

   154

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

   155

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

   156

   157

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

   158

   159

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   160

}

   161

   162

bool CheckBridge_Stuff(BridgeType bridge_type, uint bridge_len)

   163

{

   164

	const BridgeSpec *b = GetBridgeSpec(bridge_type);

   165

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

   166

   167

	if (bridge_type >= MAX_BRIDGES) return false;

   168

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

   169

   170

	max = b->max_length;

   171

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

   172

   173

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

   174

}

   175

   176

/** Build a Bridge

   177

 * @param end_tile end tile

   178

 * @param flags type of operation

   179

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

   180

 * @param p2 various bitstuffed elements

   181

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

   182

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

   183

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

   184

 */

   185

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

   186

{

   187

	BridgeType bridge_type;

   188

	RailType railtype = INVALID_RAILTYPE;

   189

	RoadTypes roadtypes = ROADTYPES_NONE;

   190

	uint x;

   191

	uint y;

   192

	uint sx;

   193

	uint sy;

   194

	TileIndex tile_start;

   195

	TileIndex tile_end;

   196

	Slope tileh_start;

   197

	Slope tileh_end;

   198

	uint z_start;

   199

	uint z_end;

   200

	TileIndex tile;

   201

	TileIndexDiff delta;

   202

	uint bridge_len;

   203

	Axis direction;

   204

	CommandCost cost(EXPENSES_CONSTRUCTION);

   205

	CommandCost ret;

   206

	bool replace_bridge = false;

   207

	BridgeType replaced_bridge_type;

   208

	TransportType transport_type;

   209

   210

	/* unpack parameters */

   211

	bridge_type = GB(p2, 0, 8);

   212

   213

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

   214

   215

	transport_type = (TransportType)GB(p2, 15, 2);

   216

   217

	/* type of bridge */

   218

	switch (transport_type) {

   219

		case TRANSPORT_ROAD:

   220

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

   221

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

   222

			break;

   223

   224

		case TRANSPORT_RAIL:

   225

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

   226

			if (!ValParamRailtype(railtype)) return CMD_ERROR;

   227

			break;

   228

   229

		default:

   230

			/* For now, only TRANSPORT_RAIL and TRANSPORT_ROAD are allowed.

   231

			 * But let not this stops us for preparing the future */

   232

			return CMD_ERROR;

   233

	}

   234

   235

	x = TileX(end_tile);

   236

	y = TileY(end_tile);

   237

	sx = TileX(p1);

   238

	sy = TileY(p1);

   239

   240

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

   241

	if (x == sx) {

   242

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

   243

		direction = AXIS_Y;

   244

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

   245

	} else if (y == sy) {

   246

		direction = AXIS_X;

   247

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

   248

	} else {

   249

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   250

	}

   251

   252

	/* set and test bridge length, availability */

   253

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

   254

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

   255

   256

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

   257

	tile_start = TileXY(x, y);

   258

	tile_end = TileXY(sx, sy);

   259

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

   260

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   261

	}

   262

   263

	tileh_start = GetTileSlope(tile_start, &z_start);

   264

	tileh_end = GetTileSlope(tile_end, &z_end);

   265

   266

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

   267

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

   268

   269

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

   270

   271

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

   272

			GetOtherBridgeEnd(tile_start) == tile_end &&

   273

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   274

		/* Replace a current bridge. */

   275

   276

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

   277

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

   278

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   279

		}

   280

   281

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

   282

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

   283

				GetBridgeSpec(bridge_type)->speed < GetBridgeSpec(GetBridgeType(tile_start))->speed) {

   284

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   285

   286

			if (t == NULL) {

   287

				return CMD_ERROR;

   288

			} else {

   289

				SetDParam(0, t->index);

   290

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   291

			}

   292

		}

   293

   294

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

   295

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

   296

			return_cmd_error(STR_1007_ALREADY_BUILT);

   297

		}

   298

   299

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

   300

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

   301

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   302

		}

   303

   304

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

   305

		replace_bridge = true;

   306

		replaced_bridge_type = GetBridgeType(tile_start);

   307

   308

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

   309

		roadtypes |= GetRoadTypes(tile_start);

   310

	} else {

   311

		/* Build a new bridge. */

   312

   313

		bool allow_on_slopes = _patches.build_on_slopes;

   314

   315

		/* Try and clear the start landscape */

   316

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

   317

		if (CmdFailed(ret)) return ret;

   318

		cost = ret;

   319

   320

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

   321

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   322

		cost.AddCost(terraform_cost_north);

   323

   324

		/* Try and clear the end landscape */

   325

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

   326

		if (CmdFailed(ret)) return ret;

   327

		cost.AddCost(ret);

   328

   329

		/* false - end tile slope check */

   330

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

   331

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   332

		cost.AddCost(terraform_cost_south);

   333

	}

   334

   335

	if (!replace_bridge) {

   336

		TileIndex Heads[] = {tile_start, tile_end};

   337

		int i;

   338

   339

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

   340

			if (MayHaveBridgeAbove(Heads[i])) {

   341

				if (IsBridgeAbove(Heads[i])) {

   342

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   343

   344

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

   345

   346

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

   347

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   348

					}

   349

				}

   350

			}

   351

		}

   352

	}

   353

   354

	/* do the drill? */

   355

	if (flags & DC_EXEC) {

   356

		DiagDirection dir = AxisToDiagDir(direction);

   357

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

   358

   359

		switch (transport_type) {

   360

			case TRANSPORT_RAIL:

   361

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

   362

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

   363

				break;

   364

   365

			case TRANSPORT_ROAD:

   366

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

   367

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

   368

				break;

   369

   370

			default:

   371

				NOT_REACHED();

   372

				break;

   373

		}

   374

		MarkTileDirtyByTile(tile_start);

   375

		MarkTileDirtyByTile(tile_end);

   376

	}

   377

   378

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

   379

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

   380

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

   381

   382

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

   383

			/* Disallow crossing bridges for the time being */

   384

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   385

		}

   386

   387

		switch (GetTileType(tile)) {

   388

			case MP_WATER:

   389

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

   390

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

   391

				break;

   392

   393

			case MP_RAILWAY:

   394

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   395

				break;

   396

   397

			case MP_ROAD:

   398

				if (IsRoadDepot(tile)) goto not_valid_below;

   399

				break;

   400

   401

			case MP_TUNNELBRIDGE:

   402

				if (IsTunnel(tile)) break;

   403

				if (replace_bridge) break;

   404

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

   405

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

   406

				break;

   407

   408

			case MP_UNMOVABLE:

   409

				if (!IsOwnedLand(tile)) goto not_valid_below;

   410

				break;

   411

   412

			case MP_CLEAR:

   413

				break;

   414

   415

			default:

   416

not_valid_below:;

   417

				/* try and clear the middle landscape */

   418

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

   419

				if (CmdFailed(ret)) return ret;

   420

				cost.AddCost(ret);

   421

				break;

   422

		}

   423

   424

		if (flags & DC_EXEC) {

   425

			SetBridgeMiddle(tile, direction);

   426

			MarkTileDirtyByTile(tile);

   427

		}

   428

	}

   429

   430

	if (flags & DC_EXEC && transport_type == TRANSPORT_RAIL) {

   431

		Track track = AxisToTrack(direction);

   432

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   433

		YapfNotifyTrackLayoutChange(tile_start, track);

   434

	}

   435

   436

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

   437

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

   438

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

   439

	 */

   440

	if (!(flags & DC_QUERY_COST) || (IsValidPlayer(_current_player) && GetPlayer(_current_player)->is_ai)) {

   441

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

   442

   443

		if (IsValidPlayer(_current_player))

   444

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   445

   446

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

   447

	}

   448

   449

	return cost;

   450

}

   451

   452

   453

/** Build Tunnel.

   454

 * @param start_tile start tile of tunnel

   455

 * @param flags type of operation

   456

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

   457

 * @param p2 unused

   458

 */

   459

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

   460

{

   461

	TileIndexDiff delta;

   462

	TileIndex end_tile;

   463

	DiagDirection direction;

   464

	Slope start_tileh;

   465

	Slope end_tileh;

   466

	TransportType transport_type = (TransportType)GB(p1, 9, 1);

   467

	uint start_z;

   468

	uint end_z;

   469

	CommandCost cost(EXPENSES_CONSTRUCTION);

   470

	CommandCost ret;

   471

   472

	_build_tunnel_endtile = 0;

   473

	if (transport_type == TRANSPORT_RAIL) {

   474

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

   475

	} else {

   476

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

   477

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

   478

	}

   479

   480

	start_tileh = GetTileSlope(start_tile, &start_z);

   481

	direction = GetInclinedSlopeDirection(start_tileh);

   482

	if (direction == INVALID_DIAGDIR) return_cmd_error(STR_500B_SITE_UNSUITABLE_FOR_TUNNEL);

   483

   484

	if (IsWaterTile(start_tile)) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   485