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

    38

#include "table/sprites.h"

    39

#include "table/strings.h"

    40

#include "table/bridge_land.h"

    41

    42

BridgeSpec _bridge[MAX_BRIDGES];

    43

    44

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

    45

void ResetBridges()

    46

{

    47

	/* First, free sprite table data */

    48

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

    49

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

    50

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

    51

			free(_bridge[i].sprite_table);

    52

		}

    53

	}

    54

    55

	/* Then, wipe out current bidges */

    56

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

    57

	/* And finally, reinstall default data */

    58

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

    59

}

    60

    61

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

    62

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

    63

 */

    64

int CalcBridgeLenCostFactor(int x)

    65

{

    66

	int n;

    67

	int r;

    68

    69

	if (x < 2) return x;

    70

	x -= 2;

    71

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

    72

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

    73

		r += n * n;

    74

		x -= n;

    75

	}

    76

}

    77

    78

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    79

{

    80

	if ((tileh == SLOPE_FLAT) ||

    81

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

    82

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

    83

    84

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

    85

}

    86

    87

/**

    88

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

    89

 *

    90

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

    91

 * @param axis Orientation of bridge

    92

 * @return true iff the track is flat.

    93

 */

    94

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

    95

{

    96

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

    97

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

    98

	return (tileh != SLOPE_FLAT);

    99

}

   100

   101

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

   102

{

   103

	const BridgeSpec *bridge = GetBridgeSpec(index);

   104

	assert(table < 7);

   105

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

   106

		return _bridge_sprite_table[index][table];

   107

	} else {

   108

		return bridge->sprite_table[table];

   109

	}

   110

}

   111

   112

   113

/**

   114

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

   115

 *

   116

 * @param axis Axis of the bridge

   117

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

   118

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

   119

 * @return Error or cost for bridge foundation

   120

 */

   121

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

   122

{

   123

	Foundation f = GetBridgeFoundation(*tileh, axis);

   124

	*z += ApplyFoundationToSlope(f, tileh);

   125

   126

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

   127

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

   128

   129

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

   130

   131

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   132

}

   133

   134

/**

   135

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

   136

 *

   137

 * @param axis Axis of the bridge

   138

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

   139

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

   140

 * @return Error or cost for bridge foundation

   141

 */

   142

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

   143

{

   144

	Foundation f = GetBridgeFoundation(*tileh, axis);

   145

	*z += ApplyFoundationToSlope(f, tileh);

   146

   147

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

   148

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

   149

   150

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

   151

   152

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   153

}

   154

   155

bool CheckBridge_Stuff(BridgeType bridge_type, uint bridge_len)

   156

{

   157

	const BridgeSpec *b = GetBridgeSpec(bridge_type);

   158

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

   159

   160

	if (bridge_type >= MAX_BRIDGES) return false;

   161

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

   162

   163

	max = b->max_length;

   164

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

   165

   166

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

   167

}

   168

   169

/** Build a Bridge

   170

 * @param end_tile end tile

   171

 * @param flags type of operation

   172

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

   173

 * @param p2 various bitstuffed elements

   174

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

   175

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

   176

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

   177

 */

   178

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

   179

{

   180

	BridgeType bridge_type;

   181

	RailType railtype = INVALID_RAILTYPE;

   182

	RoadTypes roadtypes = ROADTYPES_NONE;

   183

	uint x;

   184

	uint y;

   185

	uint sx;

   186

	uint sy;

   187

	TileIndex tile_start;

   188

	TileIndex tile_end;

   189

	Slope tileh_start;

   190

	Slope tileh_end;

   191

	uint z_start;

   192

	uint z_end;

   193

	TileIndex tile;

   194

	TileIndexDiff delta;

   195

	uint bridge_len;

   196

	Axis direction;

   197

	CommandCost cost(EXPENSES_CONSTRUCTION);

   198

	CommandCost ret;

   199

	bool replace_bridge = false;

   200

	BridgeType replaced_bridge_type;

   201

	TransportType transport_type;

   202

   203

	/* unpack parameters */

   204

	bridge_type = GB(p2, 0, 8);

   205

   206

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

   207

   208

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

   209

   210

	/* type of bridge */

   211

	switch (transport_type) {

   212

		case TRANSPORT_ROAD:

   213

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

   214

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

   215

			break;

   216

   217

		case TRANSPORT_RAIL:

   218

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

   219

			if (!ValParamRailtype(railtype)) return CMD_ERROR;

   220

			break;

   221

   222

		default:

   223

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

   224

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

   225

			return CMD_ERROR;

   226

	}

   227

   228

	x = TileX(end_tile);

   229

	y = TileY(end_tile);

   230

	sx = TileX(p1);

   231

	sy = TileY(p1);

   232

   233

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

   234

	if (x == sx) {

   235

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

   236

		direction = AXIS_Y;

   237

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

   238

	} else if (y == sy) {

   239

		direction = AXIS_X;

   240

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

   241

	} else {

   242

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   243

	}

   244

   245

	/* set and test bridge length, availability */

   246

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

   247

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

   248

   249

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

   250

	tile_start = TileXY(x, y);

   251

	tile_end = TileXY(sx, sy);

   252

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

   253

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   254

	}

   255

   256

	tileh_start = GetTileSlope(tile_start, &z_start);

   257

	tileh_end = GetTileSlope(tile_end, &z_end);

   258

   259

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

   261

   262

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

   263

   264

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

   265

			GetOtherBridgeEnd(tile_start) == tile_end &&

   266

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   267

		/* Replace a current bridge. */

   268

   269

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

   270

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

   271

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   272

		}

   273

   274

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

   275

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

   276

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

   277

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   278

   279

			if (t == NULL) {

   280

				return CMD_ERROR;

   281

			} else {

   282

				SetDParam(0, t->index);

   283

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   284

			}

   285

		}

   286

   287

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

   288

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

   289

			return_cmd_error(STR_1007_ALREADY_BUILT);

   290

		}

   291

   292

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

   293

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

   294

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   295

		}

   296

   297

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

   298

		replace_bridge = true;

   299

		replaced_bridge_type = GetBridgeType(tile_start);

   300

   301

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

   302

		roadtypes |= GetRoadTypes(tile_start);

   303

	} else {

   304

		/* Build a new bridge. */

   305

   306

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

   307

   308

		/* Try and clear the start landscape */

   309

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

   310

		if (CmdFailed(ret)) return ret;

   311

		cost = ret;

   312

   313

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

   314

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   315

		cost.AddCost(terraform_cost_north);

   316

   317

		/* Try and clear the end landscape */

   318

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

   319

		if (CmdFailed(ret)) return ret;

   320

		cost.AddCost(ret);

   321

   322

		/* false - end tile slope check */

   323

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

   324

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   325

		cost.AddCost(terraform_cost_south);

   326

	}

   327

   328

	if (!replace_bridge) {

   329

		TileIndex Heads[] = {tile_start, tile_end};

   330

		int i;

   331

   332

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

   333

			if (MayHaveBridgeAbove(Heads[i])) {

   334

				if (IsBridgeAbove(Heads[i])) {

   335

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   336

   337

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

   338

   339

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

   340

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   341

					}

   342

				}

   343

			}

   344

		}

   345

	}

   346

   347

	/* do the drill? */

   348

	if (flags & DC_EXEC) {

   349

		DiagDirection dir = AxisToDiagDir(direction);

   350

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

   351

   352

		switch (transport_type) {

   353

			case TRANSPORT_RAIL:

   355

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

   356

				break;

   357

   358

			case TRANSPORT_ROAD:

   360

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

   361

				break;

   362

   363

			default:

   364

				NOT_REACHED();

   365

				break;

   366

		}

   367

		MarkTileDirtyByTile(tile_start);

   368

		MarkTileDirtyByTile(tile_end);

   369

	}

   370

   371

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

   372

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

   373

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

   374

   375

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

   376

			/* Disallow crossing bridges for the time being */

   377

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   378

		}

   379

   380

		switch (GetTileType(tile)) {

   381

			case MP_WATER:

   382

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

   383

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

   384

				break;

   385

   386

			case MP_RAILWAY:

   387

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   388

				break;

   389

   390

			case MP_ROAD:

   391

				if (IsRoadDepot(tile)) goto not_valid_below;

   392

				break;

   393

   394

			case MP_TUNNELBRIDGE:

   395

				if (IsTunnel(tile)) break;

   396

				if (replace_bridge) break;

   397

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

   398

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

   399

				break;

   400

   401

			case MP_UNMOVABLE:

   402

				if (!IsOwnedLand(tile)) goto not_valid_below;

   403

				break;

   404

   405

			case MP_CLEAR:

   406

				break;

   407

   408

			default:

   409

not_valid_below:;

   410

				/* try and clear the middle landscape */

   411

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

   412

				if (CmdFailed(ret)) return ret;

   413

				cost.AddCost(ret);

   414

				break;

   415

		}

   416

   417

		if (flags & DC_EXEC) {

   418

			SetBridgeMiddle(tile, direction);

   419

			MarkTileDirtyByTile(tile);

   420

		}

   421

	}

   422

   423

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

   424

		Track track = AxisToTrack(direction);

   425

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   426

		YapfNotifyTrackLayoutChange(tile_start, track);

   427

	}

   428

   429

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

   430

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

   431

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

   432

	 */

   433

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

   434

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

   435

   436

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   437

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   438

   439

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

   440

	}

   441

   442

	return cost;

   443

}

   444

   445

   446

/** Build Tunnel.

   447

 * @param start_tile start tile of tunnel

   448

 * @param flags type of operation

   449

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

   450

 * @param p2 unused

   451

 */

   452

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

   453

{

   454

	TileIndexDiff delta;

   455

	TileIndex end_tile;

   456

	DiagDirection direction;

   457

	Slope start_tileh;

   458

	Slope end_tileh;

   459

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

   460

	uint start_z;

   461

	uint end_z;

   462

	CommandCost cost(EXPENSES_CONSTRUCTION);

   463

	CommandCost ret;

   464

   465

	_build_tunnel_endtile = 0;

   466

	if (transport_type == TRANSPORT_RAIL) {

   467

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

   468

	} else {

   469

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

   470

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

   471

	}

   472

   473

	start_tileh = GetTileSlope(start_tile, &start_z);

   474

	direction = GetInclinedSlopeDirection(start_tileh);

   475

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

   476

   477

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

   478

   479

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

   480

	if (CmdFailed(ret)) return ret;

   481

   482

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

   483

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

   484

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