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

    37

#include "table/sprites.h"

    38

#include "table/strings.h"

    39

#include "table/bridge_land.h"

    40

    41

Bridge _bridge[MAX_BRIDGES];

    42

    43

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

    44

void ResetBridges()

    45

{

    46

	/* First, free sprite table data */

    47

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

    48

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

    49

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

    50

			free(_bridge[i].sprite_table);

    51

		}

    52

	}

    53

    54

	/* Then, wipe out current bidges */

    55

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

    56

	/* And finally, reinstall default data */

    57

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

    58

}

    59

    60

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

    61

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

    62

 */

    63

int CalcBridgeLenCostFactor(int x)

    64

{

    65

	int n;

    66

	int r;

    67

    68

	if (x < 2) return x;

    69

	x -= 2;

    70

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

    71

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

    72

		r += n * n;

    73

		x -= n;

    74

	}

    75

}

    76

    77

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    78

{

    79

	if ((tileh == SLOPE_FLAT) ||

    80

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

    81

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

    82

    83

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

    84

}

    85

    86

/**

    87

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

    88

 *

    89

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

    90

 * @param axis Orientation of bridge

    91

 * @return true iff the track is flat.

    92

 */

    93

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

    94

{

    95

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

    96

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

    97

	return (tileh != SLOPE_FLAT);

    98

}

    99

   100

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

   101

{

   103

	assert(table < 7);

   104

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

   105

		return _bridge_sprite_table[index][table];

   106

	} else {

   107

		return bridge->sprite_table[table];

   108

	}

   109

}

   110

   111

   112

/**

   113

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

   114

 *

   115

 * @param axis Axis of the bridge

   116

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

   117

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

   118

 * @return Error or cost for bridge foundation

   119

 */

   120

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

   121

{

   122

	Foundation f = GetBridgeFoundation(*tileh, axis);

   123

	*z += ApplyFoundationToSlope(f, tileh);

   124

   125

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

   126

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

   127

   128

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

   129

   130

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   131

}

   132

   133

/**

   134

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

   135

 *

   136

 * @param axis Axis of the bridge

   137

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

   138

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

   139

 * @return Error or cost for bridge foundation

   140

 */

   141

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

   142

{

   143

	Foundation f = GetBridgeFoundation(*tileh, axis);

   144

	*z += ApplyFoundationToSlope(f, tileh);

   145

   146

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

   147

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

   148

   149

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

   150

   151

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   152

}

   153

   154

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   155

{

   157

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

   158

   159

	if (bridge_type >= MAX_BRIDGES) return false;

   160

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

   161

   162

	max = b->max_length;

   163

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

   164

   165

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

   166

}

   167

   168

/** Build a Bridge

   169

 * @param end_tile end tile

   170

 * @param flags type of operation

   171

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

   172

 * @param p2 various bitstuffed elements

   173

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

   174

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

   175

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

   176

 */

   177

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

   178

{

   179

	uint bridge_type;

   180

	RailType railtype;

   181

	RoadTypes roadtypes;

   182

	uint x;

   183

	uint y;

   184

	uint sx;

   185

	uint sy;

   186

	TileIndex tile_start;

   187

	TileIndex tile_end;

   188

	Slope tileh_start;

   189

	Slope tileh_end;

   190

	uint z_start;

   191

	uint z_end;

   192

	TileIndex tile;

   193

	TileIndexDiff delta;

   194

	uint bridge_len;

   195

	Axis direction;

   196

	CommandCost cost(EXPENSES_CONSTRUCTION);

   197

	CommandCost ret;

   198

	bool replace_bridge = false;

   199

	uint replaced_bridge_type;

   200

   201

	/* unpack parameters */

   202

	bridge_type = GB(p2, 0, 8);

   203

   204

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

   205

   206

	/* type of bridge */

   207

	if (HasBit(p2, 15)) {

   208

		railtype = INVALID_RAILTYPE; // road bridge

   209

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

   210

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

   211

	} else {

   212

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

   213

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

   214

		roadtypes = ROADTYPES_NONE;

   215

	}

   216

   217

	x = TileX(end_tile);

   218

	y = TileY(end_tile);

   219

	sx = TileX(p1);

   220

	sy = TileY(p1);

   221

   222

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

   223

	if (x == sx) {

   224

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

   225

		direction = AXIS_Y;

   226

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

   227

	} else if (y == sy) {

   228

		direction = AXIS_X;

   229

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

   230

	} else {

   231

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   232

	}

   233

   234

	/* set and test bridge length, availability */

   235

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

   236

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

   237

   238

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

   239

	tile_start = TileXY(x, y);

   240

	tile_end = TileXY(sx, sy);

   241

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

   242

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   243

	}

   244

   245

	tileh_start = GetTileSlope(tile_start, &z_start);

   246

	tileh_end = GetTileSlope(tile_end, &z_end);

   247

   248

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

   249

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

   250

   251

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

   252

   253

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

   254

   255

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

   256

			GetOtherBridgeEnd(tile_start) == tile_end &&

   257

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   258

		/* Replace a current bridge. */

   259

   260

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

   261

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

   262

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   263

		}

   264

   265

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

   266

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

   268

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   269

   270

			if (t == NULL) {

   271

				return CMD_ERROR;

   272

			} else {

   273

				SetDParam(0, t->index);

   274

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   275

			}

   276

		}

   277

   278

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

   279

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

   280

			return_cmd_error(STR_1007_ALREADY_BUILT);

   281

		}

   282

   283

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

   284

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

   285

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   286

		}

   287

   288

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

   289

		replace_bridge = true;

   290

		replaced_bridge_type = GetBridgeType(tile_start);

   291

   292

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

   293

		roadtypes |= GetRoadTypes(tile_start);

   294

	} else {

   295

		/* Build a new bridge. */

   296

   297

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

   298

   299

		/* Try and clear the start landscape */

   300

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

   301

		if (CmdFailed(ret)) return ret;

   302

		cost = ret;

   303

   304

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

   305

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   306

		cost.AddCost(terraform_cost_north);

   307

   308

		/* Try and clear the end landscape */

   309

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

   310

		if (CmdFailed(ret)) return ret;

   311

		cost.AddCost(ret);

   312

   313

		/* false - end tile slope check */

   314

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

   315

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   316

		cost.AddCost(terraform_cost_south);

   317

	}

   318

   319

	if (!replace_bridge) {

   320

		TileIndex Heads[] = {tile_start, tile_end};

   321

		int i;

   322

   323

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

   324

			if (MayHaveBridgeAbove(Heads[i])) {

   325

				if (IsBridgeAbove(Heads[i])) {

   326

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   327

   328

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

   329

   330

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

   331

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   332

					}

   333

				}

   334

			}

   335

		}

   336

	}

   337

   338

	/* do the drill? */

   339

	if (flags & DC_EXEC) {

   340

		DiagDirection dir = AxisToDiagDir(direction);

   341

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

   342

   343

		if (railtype != INVALID_RAILTYPE) {

   344

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

   345

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

   346

		} else {

   347

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

   348

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

   349

		}

   350

		MarkTileDirtyByTile(tile_start);

   351

		MarkTileDirtyByTile(tile_end);

   352

	}

   353

   354

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

   355

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

   356

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

   357

   358

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

   359

			/* Disallow crossing bridges for the time being */

   360

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   361

		}

   362

   363

		switch (GetTileType(tile)) {

   364

			case MP_WATER:

   365

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

   366

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

   367

				break;

   368

   369

			case MP_RAILWAY:

   370

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   371

				break;

   372

   373

			case MP_ROAD:

   374

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

   375

				break;

   376

   377

			case MP_TUNNELBRIDGE:

   378

				if (IsTunnel(tile)) break;

   379

				if (replace_bridge) break;

   380

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

   381

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

   382

				break;

   383

   384

			case MP_UNMOVABLE:

   385

				if (!IsOwnedLand(tile)) goto not_valid_below;

   386

				break;

   387

   388

			case MP_CLEAR:

   389

				break;

   390

   391

			default:

   392

not_valid_below:;

   393

				/* try and clear the middle landscape */

   394

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

   395

				if (CmdFailed(ret)) return ret;

   396

				cost.AddCost(ret);

   397

				break;

   398

		}

   399

   400

		if (flags & DC_EXEC) {

   401

			SetBridgeMiddle(tile, direction);

   402

			MarkTileDirtyByTile(tile);

   403

		}

   404

	}

   405

   406

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

   407

		Track track = AxisToTrack(direction);

   408

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   409

		YapfNotifyTrackLayoutChange(tile_start, track);

   410

	}

   411

   412

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

   413

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

   414

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

   415

	 */

   416

	if (!(flags & DC_QUERY_COST)) {

   417

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

   418

   419

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   420

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   421

   423

	}

   424

   425

	return cost;

   426

}

   427

   428

   429

/** Build Tunnel.

   430

 * @param start_tile start tile of tunnel

   431

 * @param flags type of operation

   432

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

   433

 * @param p2 unused

   434

 */

   435

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

   436

{

   437

	TileIndexDiff delta;

   438

	TileIndex end_tile;

   439

	DiagDirection direction;

   440

	Slope start_tileh;

   441

	Slope end_tileh;

   442

	uint start_z;

   443

	uint end_z;

   444

	CommandCost cost(EXPENSES_CONSTRUCTION);

   445

	CommandCost ret;

   446

   447

	_build_tunnel_endtile = 0;

   448

	if (!HasBit(p1, 9)) {

   449

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

   450

	} else {

   451

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

   452

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

   453

	}

   454

   455

	start_tileh = GetTileSlope(start_tile, &start_z);

   456

	direction = GetInclinedSlopeDirection(start_tileh);

   457

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

   458

   459

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

   460

   461

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

   462

	if (CmdFailed(ret)) return ret;

   463

   464

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

   465

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

   466

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

   467

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

   468

   469

	delta = TileOffsByDiagDir(direction);

   470

	DiagDirection tunnel_in_way_dir;

   471

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

   472

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

   473

	} else {

   474

		tunnel_in_way_dir = (TileY(start_tile) < (MapMaxX() / 2)) ? DIAGDIR_SE : DIAGDIR_NW;

   475

	}

   476

   477

	end_tile = start_tile;

   478

   479

	/** Tile shift coeficient. Will decrease for very long tunnels to avoid exponential growth of price*/

   480

	int tiles_coef = 3;

   481

	/** Number of tiles from start of tunnel */

   482

	int tiles = 0;

   483

	/** Number of tiles at which the cost increase coefficient per tile is halved */

   484

	int tiles_bump = 25;