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"

    38

    39

#include "table/sprites.h"

    40

#include "table/strings.h"

    41

#include "table/bridge_land.h"

    42

    43

BridgeSpec _bridge[MAX_BRIDGES];

    44

    45

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

    46

void ResetBridges()

    47

{

    48

	/* First, free sprite table data */

    49

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

    50

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

    51

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

    52

			free(_bridge[i].sprite_table);

    53

		}

    54

	}

    55

    56

	/* Then, wipe out current bidges */

    57

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

    58

	/* And finally, reinstall default data */

    59

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

    60

}

    61

    62

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

    63

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

    64

 */

    65

int CalcBridgeLenCostFactor(int x)

    66

{

    67

	int n;

    68

	int r;

    69

    70

	if (x < 2) return x;

    71

	x -= 2;

    72

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

    73

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

    74

		r += n * n;

    75

		x -= n;

    76

	}

    77

}

    78

    79

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    80

{

    81

	if ((tileh == SLOPE_FLAT) ||

    82

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

    83

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

    84

    85

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

    86

}

    87

    88

/**

    89

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

    90

 *

    91

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

    92

 * @param axis Orientation of bridge

    93

 * @return true iff the track is flat.

    94

 */

    95

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

    96

{

    97

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

    98

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

    99

	return (tileh != SLOPE_FLAT);

   100

}

   101

   102

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

   103

{

   104

	const BridgeSpec *bridge = GetBridgeSpec(index);

   105

	assert(table < 7);

   106

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

   107

		return _bridge_sprite_table[index][table];

   108

	} else {

   109

		return bridge->sprite_table[table];

   110

	}

   111

}

   112

   113

   114

/**

   115

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

   116

 *

   117

 * @param axis Axis of the bridge

   118

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

   119

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

   120

 * @return Error or cost for bridge foundation

   121

 */

   122

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

   123

{

   124

	Foundation f = GetBridgeFoundation(*tileh, axis);

   125

	*z += ApplyFoundationToSlope(f, tileh);

   126

   127

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

   128

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

   129

   130

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

   131

   132

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   133

}

   134

   135

/**

   136

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

   137

 *

   138

 * @param axis Axis of the bridge

   139

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

   140

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

   141

 * @return Error or cost for bridge foundation

   142

 */

   143

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

   144

{

   145

	Foundation f = GetBridgeFoundation(*tileh, axis);

   146

	*z += ApplyFoundationToSlope(f, tileh);

   147

   148

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

   149

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

   150

   151

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

   152

   153

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   154

}

   155

   156

bool CheckBridge_Stuff(BridgeType bridge_type, uint bridge_len)

   157

{

   158

	const BridgeSpec *b = GetBridgeSpec(bridge_type);

   159

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

   160

   161

	if (bridge_type >= MAX_BRIDGES) return false;

   162

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

   163

   164

	max = b->max_length;

   165

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

   166

   167

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

   168

}

   169

   170

/** Build a Bridge

   171

 * @param end_tile end tile

   172

 * @param flags type of operation

   173

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

   174

 * @param p2 various bitstuffed elements

   175

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

   176

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

   177

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

   178

 */

   179

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

   180

{

   181

	BridgeType bridge_type;

   182

	RailType railtype = INVALID_RAILTYPE;

   183

	RoadTypes roadtypes = ROADTYPES_NONE;

   184

	uint x;

   185

	uint y;

   186

	uint sx;

   187

	uint sy;

   188

	TileIndex tile_start;

   189

	TileIndex tile_end;

   190

	Slope tileh_start;

   191

	Slope tileh_end;

   192

	uint z_start;

   193

	uint z_end;

   194

	TileIndex tile;

   195

	TileIndexDiff delta;

   196

	uint bridge_len;

   197

	Axis direction;

   198

	CommandCost cost(EXPENSES_CONSTRUCTION);

   199

	CommandCost ret;

   200

	bool replace_bridge = false;

   201

	BridgeType replaced_bridge_type;

   202

	TransportType transport_type;

   203

   204

	/* unpack parameters */

   205

	bridge_type = GB(p2, 0, 8);

   206

   207

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

   208

   209

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

   210

   211

	/* type of bridge */

   212

	switch (transport_type) {

   213

		case TRANSPORT_ROAD:

   214

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

   215

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

   216

			break;

   217

   218

		case TRANSPORT_RAIL:

   219

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

   220

			if (!ValParamRailtype(railtype)) return CMD_ERROR;

   221

			break;

   222

   223

		default:

   224

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

   225

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

   226

			return CMD_ERROR;

   227

	}

   228

   229

	x = TileX(end_tile);

   230

	y = TileY(end_tile);

   231

	sx = TileX(p1);

   232

	sy = TileY(p1);

   233

   234

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

   235

	if (x == sx) {

   236

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

   237

		direction = AXIS_Y;

   238

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

   239

	} else if (y == sy) {

   240

		direction = AXIS_X;

   241

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

   242

	} else {

   243

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   244

	}

   245

   246

	/* set and test bridge length, availability */

   247

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

   248

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

   249

   250

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

   251

	tile_start = TileXY(x, y);

   252

	tile_end = TileXY(sx, sy);

   253

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

   254

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   255

	}

   256

   257

	tileh_start = GetTileSlope(tile_start, &z_start);

   258

	tileh_end = GetTileSlope(tile_end, &z_end);

   259

   260

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

   261

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

   262

   263

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

   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

				GetBridgeSpec(bridge_type)->speed < GetBridgeSpec(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

		switch (transport_type) {

   354

			case TRANSPORT_RAIL:

   355

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

   356

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

   357

				break;

   358

   359

			case TRANSPORT_ROAD:

   360

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

   361

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

   362

				break;

   363

   364

			default:

   365

				NOT_REACHED();

   366

				break;

   367

		}

   368

		MarkTileDirtyByTile(tile_start);

   369

		MarkTileDirtyByTile(tile_end);

   370

	}

   371

   372

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

   373

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

   374

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

   375

   376

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

   377

			/* Disallow crossing bridges for the time being */

   378

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   379

		}

   380

   381

		switch (GetTileType(tile)) {

   382

			case MP_WATER:

   383

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

   384

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

   385

				break;

   386

   387

			case MP_RAILWAY:

   388

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   389

				break;

   390

   391

			case MP_ROAD:

   392

				if (IsRoadDepot(tile)) goto not_valid_below;

   393

				break;

   394

   395

			case MP_TUNNELBRIDGE:

   396

				if (IsTunnel(tile)) break;

   397

				if (replace_bridge) break;

   398

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

   399

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

   400

				break;

   401

   402

			case MP_UNMOVABLE:

   403

				if (!IsOwnedLand(tile)) goto not_valid_below;

   404

				break;

   405

   406

			case MP_CLEAR:

   407

				break;

   408

   409

			default:

   410

not_valid_below:;

   411

				/* try and clear the middle landscape */

   412

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

   413

				if (CmdFailed(ret)) return ret;

   414

				cost.AddCost(ret);

   415

				break;

   416

		}

   417

   418

		if (flags & DC_EXEC) {

   419

			SetBridgeMiddle(tile, direction);

   420

			MarkTileDirtyByTile(tile);

   421

		}

   422

	}

   423

   424

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

   425

		Track track = AxisToTrack(direction);

   426

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   427

		YapfNotifyTrackLayoutChange(tile_start, track);

   428

	}

   429

   430

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

   431

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

   432

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

   433

	 */

   434

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

   435

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

   436

   437

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   438

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   439

   440

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

   441

	}

   442

   443

	return cost;

   444

}

   445

   446

   447

/** Build Tunnel.

   448

 * @param start_tile start tile of tunnel

   449

 * @param flags type of operation

   450

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

   451

 * @param p2 unused

   452

 */

   453

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

   454

{

   455

	TileIndexDiff delta;

   456

	TileIndex end_tile;

   457

	DiagDirection direction;

   458

	Slope start_tileh;

   459

	Slope end_tileh;

   460

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

   461

	uint start_z;

   462

	uint end_z;

   463

	CommandCost cost(EXPENSES_CONSTRUCTION);

   464

	CommandCost ret;

   465

   466

	_build_tunnel_endtile = 0;

   467

	if (transport_type == TRANSPORT_RAIL) {

   468

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

   469

	} else {

   470

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

   471

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

   472

	}

   473

   474

	start_tileh = GetTileSlope(start_tile, &start_z);

   475

	direction = GetInclinedSlopeDirection(start_tileh);

   476

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

   477

   478

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

   479

   480

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

   481

	if (CmdFailed(ret)) return ret;

   482

   483

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

   484

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

   485

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

   486