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 "economy_func.h"

    39

#include "rail.h"

    40

#include "cheat_func.h"

    41

    42

#include "table/sprites.h"

    43

#include "table/strings.h"

    44

#include "table/bridge_land.h"

    45

    46

BridgeSpec _bridge[MAX_BRIDGES];

    47

TileIndex _build_tunnel_endtile;

    48

    49

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

    50

void ResetBridges()

    51

{

    52

	/* First, free sprite table data */

    53

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

    54

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

    55

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

    56

			free(_bridge[i].sprite_table);

    57

		}

    58

	}

    59

    60

	/* Then, wipe out current bidges */

    61

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

    62

	/* And finally, reinstall default data */

    63

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

    64

}

    65

    66

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

    67

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

    68

 */

    69

int CalcBridgeLenCostFactor(int x)

    70

{

    71

	int n;

    72

	int r;

    73

    74

	if (x < 2) return x;

    75

	x -= 2;

    76

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

    77

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

    78

		r += n * n;

    79

		x -= n;

    80

	}

    81

}

    82

    83

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    84

{

    85

	if ((tileh == SLOPE_FLAT) ||

    86

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

    87

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

    88

    89

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

    90

}

    91

    92

/**

    93

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

    94

 *

    95

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

    96

 * @param axis Orientation of bridge

    97

 * @return true iff the track is flat.

    98

 */

    99

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

   100

{

   101

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

   102

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

   103

	return (tileh != SLOPE_FLAT);

   104

}

   105

   106

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

   107

{

   108

	const BridgeSpec *bridge = GetBridgeSpec(index);

   109

	assert(table < 7);

   110

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

   111

		return _bridge_sprite_table[index][table];

   112

	} else {

   113

		return bridge->sprite_table[table];

   114

	}

   115

}

   116

   117

   118

/**

   119

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

   120

 *

   121

 * @param axis Axis of the bridge

   122

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

   123

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

   124

 * @return Error or cost for bridge foundation

   125

 */

   126

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

   127

{

   128

	Foundation f = GetBridgeFoundation(*tileh, axis);

   129

	*z += ApplyFoundationToSlope(f, tileh);

   130

   131

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

   132

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

   133

   134

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

   135

   136

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   137

}

   138

   139

/**

   140

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

   141

 *

   142

 * @param axis Axis of the bridge

   143

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

   144

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

   145

 * @return Error or cost for bridge foundation

   146

 */

   147

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

   148

{

   149

	Foundation f = GetBridgeFoundation(*tileh, axis);

   150

	*z += ApplyFoundationToSlope(f, tileh);

   151

   152

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

   153

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

   154

   155

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

   156

   157

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   158

}

   159

   160

bool CheckBridge_Stuff(BridgeType bridge_type, uint bridge_len)

   161

{

   162

	const BridgeSpec *b = GetBridgeSpec(bridge_type);

   163

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

   164

   165

	if (bridge_type >= MAX_BRIDGES) return false;

   166

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

   167

   168

	max = b->max_length;

   169

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

   170

   171

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

   172

}

   173

   174

/** Build a Bridge

   175

 * @param end_tile end tile

   176

 * @param flags type of operation

   177

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

   178

 * @param p2 various bitstuffed elements

   179

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

   180

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

   181

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

   182

 */

   183

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

   184

{

   185

	BridgeType bridge_type;

   186

	RailType railtype = INVALID_RAILTYPE;

   187

	RoadTypes roadtypes = ROADTYPES_NONE;

   188

	uint x;

   189

	uint y;

   190

	uint sx;

   191

	uint sy;

   192

	TileIndex tile_start;

   193

	TileIndex tile_end;

   194

	Slope tileh_start;

   195

	Slope tileh_end;

   196

	uint z_start;

   197

	uint z_end;

   198

	TileIndex tile;

   199

	TileIndexDiff delta;

   200

	uint bridge_len;

   201

	Axis direction;

   202

	CommandCost cost(EXPENSES_CONSTRUCTION);

   203

	CommandCost ret;

   204

	bool replace_bridge = false;

   205

	BridgeType replaced_bridge_type;

   206

	TransportType transport_type;

   207

   208

	/* unpack parameters */

   209

	bridge_type = GB(p2, 0, 8);

   210

   211

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

   212

   213

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

   214

   215

	/* type of bridge */

   216

	switch (transport_type) {

   217

		case TRANSPORT_ROAD:

   218

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

   219

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

   220

			break;

   221

   222

		case TRANSPORT_RAIL:

   223

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

   224

			if (!ValParamRailtype(railtype)) return CMD_ERROR;

   225

			break;

   226

   227

		default:

   228

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

   229

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

   230

			return CMD_ERROR;

   231

	}

   232

   233

	x = TileX(end_tile);

   234

	y = TileY(end_tile);

   235

	sx = TileX(p1);

   236

	sy = TileY(p1);

   237

   238

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

   239

	if (x == sx) {

   240

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

   241

		direction = AXIS_Y;

   242

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

   243

	} else if (y == sy) {

   244

		direction = AXIS_X;

   245

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

   246

	} else {

   247

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   248

	}

   249

   250

	/* set and test bridge length, availability */

   251

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

   252

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

   253

   254

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

   255

	tile_start = TileXY(x, y);

   256

	tile_end = TileXY(sx, sy);

   257

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

   258

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   259

	}

   260

   261

	tileh_start = GetTileSlope(tile_start, &z_start);

   262

	tileh_end = GetTileSlope(tile_end, &z_end);

   263

   264

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

   265

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

   266

   267

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

   268

   269

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

   270

			GetOtherBridgeEnd(tile_start) == tile_end &&

   271

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   272

		/* Replace a current bridge. */

   273

   274

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

   275

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

   276

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   277

		}

   278

   279

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

   280

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

   281

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

   282

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   283

   284

			if (t == NULL) {

   285

				return CMD_ERROR;

   286

			} else {

   287

				SetDParam(0, t->index);

   288

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   289

			}

   290

		}

   291

   292

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

   293

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

   294

			return_cmd_error(STR_1007_ALREADY_BUILT);

   295

		}

   296

   297

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

   298

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

   299

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   300

		}

   301

   302

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

   303

		replace_bridge = true;

   304

		replaced_bridge_type = GetBridgeType(tile_start);

   305

   306

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

   307

		roadtypes |= GetRoadTypes(tile_start);

   308

	} else {

   309

		/* Build a new bridge. */

   310

   311

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

   312

   313

		/* Try and clear the start landscape */

   314

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

   315

		if (CmdFailed(ret)) return ret;

   316

		cost = ret;

   317

   318

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

   319

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   320

		cost.AddCost(terraform_cost_north);

   321

   322

		/* Try and clear the end landscape */

   323

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

   324

		if (CmdFailed(ret)) return ret;

   325

		cost.AddCost(ret);

   326

   327

		/* false - end tile slope check */

   328

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

   329

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   330

		cost.AddCost(terraform_cost_south);

   331

	}

   332

   333

	if (!replace_bridge) {

   334

		TileIndex Heads[] = {tile_start, tile_end};

   335

		int i;

   336

   337

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

   338

			if (MayHaveBridgeAbove(Heads[i])) {

   339

				if (IsBridgeAbove(Heads[i])) {

   340

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   341

   342

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

   343

   344

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

   345

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   346

					}

   347

				}

   348

			}

   349

		}

   350

	}

   351

   352

	/* do the drill? */

   353

	if (flags & DC_EXEC) {

   354

		DiagDirection dir = AxisToDiagDir(direction);

   355

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

   356

   357

		switch (transport_type) {

   358

			case TRANSPORT_RAIL:

   359

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

   360

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

   361

				break;

   362

   363

			case TRANSPORT_ROAD:

   364

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

   365

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

   366

				break;

   367

   368

			default:

   369

				NOT_REACHED();

   370

				break;

   371

		}

   372

		MarkTileDirtyByTile(tile_start);

   373

		MarkTileDirtyByTile(tile_end);

   374

	}

   375

   376

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

   377

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

   378

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

   379

   380

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

   381

			/* Disallow crossing bridges for the time being */

   382

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   383

		}

   384

   385

		switch (GetTileType(tile)) {

   386

			case MP_WATER:

   387

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

   388

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

   389

				break;

   390

   391

			case MP_RAILWAY:

   392

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   393

				break;

   394

   395

			case MP_ROAD:

   396

				if (IsRoadDepot(tile)) goto not_valid_below;

   397

				break;

   398

   399

			case MP_TUNNELBRIDGE:

   400

				if (IsTunnel(tile)) break;

   401

				if (replace_bridge) break;

   402

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

   403

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

   404

				break;

   405

   406

			case MP_UNMOVABLE:

   407

				if (!IsOwnedLand(tile)) goto not_valid_below;

   408

				break;

   409

   410

			case MP_CLEAR:

   411

				break;

   412

   413

			default:

   414

not_valid_below:;

   415

				/* try and clear the middle landscape */

   416

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

   417

				if (CmdFailed(ret)) return ret;

   418

				cost.AddCost(ret);

   419

				break;

   420

		}

   421

   422

		if (flags & DC_EXEC) {

   423

			SetBridgeMiddle(tile, direction);

   424

			MarkTileDirtyByTile(tile);

   425

		}

   426

	}

   427

   428

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

   429

		Track track = AxisToTrack(direction);

   430

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   431

		YapfNotifyTrackLayoutChange(tile_start, track);

   432

	}

   433

   434

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

   435

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

   436

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

   437

	 */

   438

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

   439

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

   440

   441

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   442

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   443

   444

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

   445

	}

   446

   447

	return cost;

   448

}

   449

   450

   451

/** Build Tunnel.

   452

 * @param start_tile start tile of tunnel

   453

 * @param flags type of operation

   454

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

   455

 * @param p2 unused

   456

 */

   457

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

   458

{

   459

	TileIndexDiff delta;

   460

	TileIndex end_tile;

   461

	DiagDirection direction;

   462

	Slope start_tileh;

   463

	Slope end_tileh;

   464

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

   465

	uint start_z;

   466

	uint end_z;

   467

	CommandCost cost(EXPENSES_CONSTRUCTION);

   468

	CommandCost ret;

   469

   470

	_build_tunnel_endtile = 0;

   471

	if (transport_type == TRANSPORT_RAIL) {

   472

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

   473

	} else {

   474

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

   475

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

   476

	}

   477

   478

	start_tileh = GetTileSlope(start_tile, &start_z);

   479

	direction = GetInclinedSlopeDirection(start_tileh);

   480

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

   481

   482

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

   483

   484

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