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"

    38

#include "engine_base.h"

    39

#include "economy_func.h"

    40

#include "rail.h"

    41

#include "cheat_func.h"

    42

#include "elrail_func.h"

    43

#include "landscape_type.h"

    44

    45

#include "table/sprites.h"

    46

#include "table/strings.h"

    47

#include "table/bridge_land.h"

    48

    49

BridgeSpec _bridge[MAX_BRIDGES];

    50

TileIndex _build_tunnel_endtile;

    51

    52

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

    53

void ResetBridges()

    54

{

    55

	/* First, free sprite table data */

    56

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

    57

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

    58

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

    59

			free(_bridge[i].sprite_table);

    60

		}

    61

	}

    62

    63

	/* Then, wipe out current bidges */

    64

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

    65

	/* And finally, reinstall default data */

    66

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

    67

}

    68

    69

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

    70

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

    71

 */

    72

int CalcBridgeLenCostFactor(int x)

    73

{

    74

	int n;

    75

	int r;

    76

    77

	if (x < 2) return x;

    78

	x -= 2;

    79

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

    80

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

    81

		r += n * n;

    82

		x -= n;

    83

	}

    84

}

    85

    86

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    87

{

    88

	if ((tileh == SLOPE_FLAT) ||

    89

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

    90

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

    91

    92

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

    93

}

    94

    95

/**

    96

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

    97

 *

    98

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

    99

 * @param axis Orientation of bridge

   100

 * @return true iff the track is flat.

   101

 */

   102

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

   103

{

   104

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

   105

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

   106

	return (tileh != SLOPE_FLAT);

   107

}

   108

   109

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

   110

{

   111

	const BridgeSpec *bridge = GetBridgeSpec(index);

   112

	assert(table < 7);

   113

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

   114

		return _bridge_sprite_table[index][table];

   115

	} else {

   116

		return bridge->sprite_table[table];

   117

	}

   118

}

   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

bool CheckBridge_Stuff(BridgeType bridge_type, uint bridge_len)

   164

{

   165

	const BridgeSpec *b = GetBridgeSpec(bridge_type);

   166

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

   167

   168

	if (bridge_type >= MAX_BRIDGES) return false;

   169

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

   170

   171

	max = b->max_length;

   172

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

   173

   174

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

   175

}

   176

   177

/** Build a Bridge

   178

 * @param end_tile end tile

   179

 * @param flags type of operation

   180

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

   181

 * @param p2 various bitstuffed elements

   182

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

   183

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

   184

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

   185

 */

   186

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

   187

{

   188

	BridgeType bridge_type;

   189

	RailType railtype = INVALID_RAILTYPE;

   190

	RoadTypes roadtypes = ROADTYPES_NONE;

   191

	uint x;

   192

	uint y;

   193

	uint sx;

   194

	uint sy;

   195

	TileIndex tile_start;

   196

	TileIndex tile_end;

   197

	Slope tileh_start;

   198

	Slope tileh_end;

   199

	uint z_start;

   200

	uint z_end;

   201

	TileIndex tile;

   202

	TileIndexDiff delta;

   203

	uint bridge_len;

   204

	Axis direction;

   205

	CommandCost cost(EXPENSES_CONSTRUCTION);

   206

	CommandCost ret;

   207

	bool replace_bridge = false;

   208

	BridgeType replaced_bridge_type;

   209

	TransportType transport_type;

   210

   211

	/* unpack parameters */

   212

	bridge_type = GB(p2, 0, 8);

   213

   214

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

   215

   216

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

   217

   218

	/* type of bridge */

   219

	switch (transport_type) {

   220

		case TRANSPORT_ROAD:

   221

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

   222

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

   223

			break;

   224

   225

		case TRANSPORT_RAIL:

   226

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

   227

			if (!ValParamRailtype(railtype)) return CMD_ERROR;

   228

			break;

   229

   230

		default:

   231

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

   232

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

   233

			return CMD_ERROR;

   234

	}

   235

   236

	x = TileX(end_tile);

   237

	y = TileY(end_tile);

   238

	sx = TileX(p1);

   239

	sy = TileY(p1);

   240

   241

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

   242

	if (x == sx) {

   243

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

   244

		direction = AXIS_Y;

   245

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

   246

	} else if (y == sy) {

   247

		direction = AXIS_X;

   248

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

   249

	} else {

   250

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   251

	}

   252

   253

	/* set and test bridge length, availability */

   254

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

   255

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

   256

   257

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

   258

	tile_start = TileXY(x, y);

   259

	tile_end = TileXY(sx, sy);

   260

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

   261

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   262

	}

   263

   264

	tileh_start = GetTileSlope(tile_start, &z_start);

   265

	tileh_end = GetTileSlope(tile_end, &z_end);

   266

   267

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

   268

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

   269

   270

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

   271

   272

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

   273

			GetOtherBridgeEnd(tile_start) == tile_end &&

   274

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   275

		/* Replace a current bridge. */

   276

   277

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

   278

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

   279

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   280

		}

   281

   282

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

   283

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

   284

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

   285

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   286

   287

			if (t == NULL) {

   288

				return CMD_ERROR;

   289

			} else {

   290

				SetDParam(0, t->index);

   291

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   292

			}

   293

		}

   294

   295

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

   296

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

   297

			return_cmd_error(STR_1007_ALREADY_BUILT);

   298

		}

   299

   300

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

   301

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

   302

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   303

		}

   304

   305

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

   306

		replace_bridge = true;

   307

		replaced_bridge_type = GetBridgeType(tile_start);

   308

   309

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

   310

		roadtypes |= GetRoadTypes(tile_start);

   311

	} else {

   312

		/* Build a new bridge. */

   313

   314

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

   315

   316

		/* Try and clear the start landscape */

   317

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

   318

		if (CmdFailed(ret)) return ret;

   319

		cost = ret;

   320

   321

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

   322

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   323

		cost.AddCost(terraform_cost_north);

   324

   325

		/* Try and clear the end landscape */

   326

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

   327

		if (CmdFailed(ret)) return ret;

   328

		cost.AddCost(ret);

   329

   330

		/* false - end tile slope check */

   331

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

   332

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   333

		cost.AddCost(terraform_cost_south);

   334

	}

   335

   336

	if (!replace_bridge) {

   337

		TileIndex Heads[] = {tile_start, tile_end};

   338

		int i;

   339

   340

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

   341

			if (MayHaveBridgeAbove(Heads[i])) {

   342

				if (IsBridgeAbove(Heads[i])) {

   343

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   344

   345

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

   346

   347

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

   348

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   349

					}

   350

				}

   351

			}

   352

		}

   353

	}

   354

   355

	/* do the drill? */

   356

	if (flags & DC_EXEC) {

   357

		DiagDirection dir = AxisToDiagDir(direction);

   358

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

   359

   360

		switch (transport_type) {

   361

			case TRANSPORT_RAIL:

   362

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

   363

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

   364

				break;

   365

   366

			case TRANSPORT_ROAD:

   367

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

   368

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

   369

				break;

   370

   371

			default:

   372

				NOT_REACHED();

   373

				break;

   374

		}

   375

		MarkTileDirtyByTile(tile_start);

   376

		MarkTileDirtyByTile(tile_end);

   377

	}

   378

   379

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

   380

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

   381

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

   382

   383

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

   384

			/* Disallow crossing bridges for the time being */

   385

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   386

		}

   387

   388

		switch (GetTileType(tile)) {

   389

			case MP_WATER:

   390

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

   391

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

   392

				break;

   393

   394

			case MP_RAILWAY:

   395

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   396

				break;

   397

   398

			case MP_ROAD:

   399

				if (IsRoadDepot(tile)) goto not_valid_below;

   400

				break;

   401

   402

			case MP_TUNNELBRIDGE:

   403

				if (IsTunnel(tile)) break;

   404

				if (replace_bridge) break;

   405

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

   406

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

   407

				break;

   408

   409

			case MP_UNMOVABLE:

   410

				if (!IsOwnedLand(tile)) goto not_valid_below;

   411

				break;

   412

   413

			case MP_CLEAR:

   414

				break;

   415

   416

			default:

   417

not_valid_below:;

   418

				/* try and clear the middle landscape */

   419

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

   420

				if (CmdFailed(ret)) return ret;

   421

				cost.AddCost(ret);

   422

				break;

   423

		}

   424

   425

		if (flags & DC_EXEC) {

   426

			SetBridgeMiddle(tile, direction);

   427

			MarkTileDirtyByTile(tile);

   428

		}

   429

	}

   430

   431

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

   432

		Track track = AxisToTrack(direction);

   433

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   434

		YapfNotifyTrackLayoutChange(tile_start, track);

   435

	}

   436

   437

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

   438

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

   439

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

   440

	 */

   441

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

   442

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

   443

   444

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   445

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   446

   447

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

   448

	}

   449

   450

	return cost;

   451

}

   452

   453

   454

/** Build Tunnel.

   455

 * @param start_tile start tile of tunnel

   456

 * @param flags type of operation

   457

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

   458

 * @param p2 unused

   459

 */

   460

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

   461

{

   462

	TileIndexDiff delta;

   463

	TileIndex end_tile;

   464

	DiagDirection direction;

   465

	Slope start_tileh;

   466

	Slope end_tileh;

   467

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

   468

	uint start_z;

   469

	uint end_z;

   470

	CommandCost cost(EXPENSES_CONSTRUCTION);

   471

	CommandCost ret;

   472

   473

	_build_tunnel_endtile = 0;

   474

	if (transport_type == TRANSPORT_RAIL) {

   475

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

   476

	} else {

   477

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

   478

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

   479

	}

   480

   481

	start_tileh = GetTileSlope(start_tile, &start_z);

   482

	direction = GetInclinedSlopeDirection(start_tileh);

   483

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

   484