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

BridgeSpec _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 (BridgeType 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

{

   102

	const BridgeSpec *bridge = GetBridgeSpec(index);

   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(BridgeType bridge_type, uint bridge_len)

   155

{

   156

	const BridgeSpec *b = GetBridgeSpec(bridge_type);

   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

	BridgeType bridge_type;

   180

	RailType railtype = INVALID_RAILTYPE;

   181

	RoadTypes roadtypes = ROADTYPES_NONE;

   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

	BridgeType replaced_bridge_type;

   200

	TransportType transport_type;

   201

   202

	/* unpack parameters */

   203

	bridge_type = GB(p2, 0, 8);

   204

   205

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

   206

   207

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

   208

   209

	/* type of bridge */

   210

	switch (transport_type) {

   211

		case TRANSPORT_ROAD:

   212

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

   213

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

   214

			break;

   215

   216

		case TRANSPORT_RAIL:

   217

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

   218

			if (!ValParamRailtype(railtype)) return CMD_ERROR;

   219

			break;

   220

   221

		default:

   222

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

   223

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

   224

			return CMD_ERROR;

   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) || IsWaterTile(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

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

   264

			GetOtherBridgeEnd(tile_start) == tile_end &&

   265

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   266

		/* Replace a current bridge. */

   267

   268

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

   269

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

   270

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   271

		}

   272

   273

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

   274

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

   275

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

   276

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   277

   278

			if (t == NULL) {

   279

				return CMD_ERROR;

   280

			} else {

   281

				SetDParam(0, t->index);

   282

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   283

			}

   284

		}

   285

   286

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

   287

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

   288

			return_cmd_error(STR_1007_ALREADY_BUILT);

   289

		}

   290

   291

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

   292

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

   293

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   294

		}

   295

   296

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

   297

		replace_bridge = true;

   298

		replaced_bridge_type = GetBridgeType(tile_start);

   299

   300

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

   301

		roadtypes |= GetRoadTypes(tile_start);

   302

	} else {

   303

		/* Build a new bridge. */

   304

   305

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

   306

   307

		/* Try and clear the start landscape */

   308

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

   309

		if (CmdFailed(ret)) return ret;

   310

		cost = ret;

   311

   312

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

   313

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   314

		cost.AddCost(terraform_cost_north);

   315

   316

		/* Try and clear the end landscape */

   317

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

   318

		if (CmdFailed(ret)) return ret;

   319

		cost.AddCost(ret);

   320

   321

		/* false - end tile slope check */

   322

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

   323

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   324

		cost.AddCost(terraform_cost_south);

   325

	}

   326

   327

	if (!replace_bridge) {

   328

		TileIndex Heads[] = {tile_start, tile_end};

   329

		int i;

   330

   331

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

   332

			if (MayHaveBridgeAbove(Heads[i])) {

   333

				if (IsBridgeAbove(Heads[i])) {

   334

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   335

   336

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

   337

   338

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

   339

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   340

					}

   341

				}

   342

			}

   343

		}

   344

	}

   345

   346

	/* do the drill? */

   347

	if (flags & DC_EXEC) {

   348

		DiagDirection dir = AxisToDiagDir(direction);

   349

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

   350

   351

		switch (transport_type) {

   352

			case TRANSPORT_RAIL:

   353

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

   354

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

   355

				break;

   356

   357

			case TRANSPORT_ROAD:

   358

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

   359

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

   360

				break;

   361

   362

			default:

   363

				NOT_REACHED();

   364

				break;

   365

		}

   366

		MarkTileDirtyByTile(tile_start);

   367

		MarkTileDirtyByTile(tile_end);

   368

	}

   369

   370

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

   371

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

   372

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

   373

   374

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

   375

			/* Disallow crossing bridges for the time being */

   376

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   377

		}

   378

   379

		switch (GetTileType(tile)) {

   380

			case MP_WATER:

   381

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

   382

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

   383

				break;

   384

   385

			case MP_RAILWAY:

   386

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   387

				break;

   388

   389

			case MP_ROAD:

   390

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

   391

				break;

   392

   393

			case MP_TUNNELBRIDGE:

   394

				if (IsTunnel(tile)) break;

   395

				if (replace_bridge) break;

   396

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

   397

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

   398

				break;

   399

   400

			case MP_UNMOVABLE:

   401

				if (!IsOwnedLand(tile)) goto not_valid_below;

   402

				break;

   403

   404

			case MP_CLEAR:

   405

				break;

   406

   407

			default:

   408

not_valid_below:;

   409

				/* try and clear the middle landscape */

   410

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

   411

				if (CmdFailed(ret)) return ret;

   412

				cost.AddCost(ret);

   413

				break;

   414

		}

   415

   416

		if (flags & DC_EXEC) {

   417

			SetBridgeMiddle(tile, direction);

   418

			MarkTileDirtyByTile(tile);

   419

		}

   420

	}

   421

   422

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

   423

		Track track = AxisToTrack(direction);

   424

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   425

		YapfNotifyTrackLayoutChange(tile_start, track);

   426

	}

   427

   428

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

   429

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

   430

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

   431

	 */

   432

	if (!(flags & DC_QUERY_COST)) {

   433

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

   434

   435

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   436

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   437

   438

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

   439

	}

   440

   441

	return cost;

   442

}

   443

   444

   445

/** Build Tunnel.

   446

 * @param start_tile start tile of tunnel

   447

 * @param flags type of operation

   448

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

   449

 * @param p2 unused

   450

 */

   451

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

   452

{

   453

	TileIndexDiff delta;

   454

	TileIndex end_tile;

   455

	DiagDirection direction;

   456

	Slope start_tileh;

   457

	Slope end_tileh;

   458

	uint start_z;

   459

	uint end_z;

   460

	CommandCost cost(EXPENSES_CONSTRUCTION);

   461

	CommandCost ret;

   462

   463

	_build_tunnel_endtile = 0;

   464

	if (!HasBit(p1, 9)) {

   465

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

   466

	} else {

   467

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

   468

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

   469

	}

   470

   471

	start_tileh = GetTileSlope(start_tile, &start_z);

   472

	direction = GetInclinedSlopeDirection(start_tileh);

   473

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

   474

   475

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

   476

   477

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

   478

	if (CmdFailed(ret)) return ret;

   479

   480

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

   481

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

   482

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

   483

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

   484

   485

	delta = TileOffsByDiagDir(direction);