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"

    40

    41

#include "table/sprites.h"

    42

#include "table/strings.h"

    43

#include "table/bridge_land.h"

    44

    45

BridgeSpec _bridge[MAX_BRIDGES];

    46

    47

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

    48

void ResetBridges()

    49

{

    50

	/* First, free sprite table data */

    51

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

    52

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

    53

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

    54

			free(_bridge[i].sprite_table);

    55

		}

    56

	}

    57

    58

	/* Then, wipe out current bidges */

    59

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

    60

	/* And finally, reinstall default data */

    61

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

    62

}

    63

    64

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

    65

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

    66

 */

    67

int CalcBridgeLenCostFactor(int x)

    68

{

    69

	int n;

    70

	int r;

    71

    72

	if (x < 2) return x;

    73

	x -= 2;

    74

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

    75

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

    76

		r += n * n;

    77

		x -= n;

    78

	}

    79

}

    80

    81

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

    82

{

    83

	if ((tileh == SLOPE_FLAT) ||

    84

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

    85

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

    86

    87

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

    88

}

    89

    90

/**

    91

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

    92

 *

    93

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

    94

 * @param axis Orientation of bridge

    95

 * @return true iff the track is flat.

    96

 */

    97

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

    98

{

    99

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

   100

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

   101

	return (tileh != SLOPE_FLAT);

   102

}

   103

   104

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

   105

{

   106

	const BridgeSpec *bridge = GetBridgeSpec(index);

   107

	assert(table < 7);

   108

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

   109

		return _bridge_sprite_table[index][table];

   110

	} else {

   111

		return bridge->sprite_table[table];

   112

	}

   113

}

   114

   115

   116

/**

   117

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

   118

 *

   119

 * @param axis Axis of the bridge

   120

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

   121

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

   122

 * @return Error or cost for bridge foundation

   123

 */

   124

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

   125

{

   126

	Foundation f = GetBridgeFoundation(*tileh, axis);

   127

	*z += ApplyFoundationToSlope(f, tileh);

   128

   129

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

   130

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

   131

   132

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

   133

   134

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   135

}

   136

   137

/**

   138

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

   139

 *

   140

 * @param axis Axis of the bridge

   141

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

   142

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

   143

 * @return Error or cost for bridge foundation

   144

 */

   145

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

   146

{

   147

	Foundation f = GetBridgeFoundation(*tileh, axis);

   148

	*z += ApplyFoundationToSlope(f, tileh);

   149

   150

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

   151

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

   152

   153

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

   154

   155

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   156

}

   157

   158

bool CheckBridge_Stuff(BridgeType bridge_type, uint bridge_len)

   159

{

   160

	const BridgeSpec *b = GetBridgeSpec(bridge_type);

   161

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

   162

   163

	if (bridge_type >= MAX_BRIDGES) return false;

   164

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

   165

   166

	max = b->max_length;

   167

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

   168

   169

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

   170

}

   171

   172

/** Build a Bridge

   173

 * @param end_tile end tile

   174

 * @param flags type of operation

   175

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

   176

 * @param p2 various bitstuffed elements

   177

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

   178

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

   179

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

   180

 */

   181

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

   182

{

   183

	BridgeType bridge_type;

   184

	RailType railtype = INVALID_RAILTYPE;

   185

	RoadTypes roadtypes = ROADTYPES_NONE;

   186

	uint x;

   187

	uint y;

   188

	uint sx;

   189

	uint sy;

   190

	TileIndex tile_start;

   191

	TileIndex tile_end;

   192

	Slope tileh_start;

   193

	Slope tileh_end;

   194

	uint z_start;

   195

	uint z_end;

   196

	TileIndex tile;

   197

	TileIndexDiff delta;

   198

	uint bridge_len;

   199

	Axis direction;

   200

	CommandCost cost(EXPENSES_CONSTRUCTION);

   201

	CommandCost ret;

   202

	bool replace_bridge = false;

   203

	BridgeType replaced_bridge_type;

   204

	TransportType transport_type;

   205

   206

	/* unpack parameters */

   207

	bridge_type = GB(p2, 0, 8);

   208

   209

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

   210

   211

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

   212

   213

	/* type of bridge */

   214

	switch (transport_type) {

   215

		case TRANSPORT_ROAD:

   216

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

   217

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

   218

			break;

   219

   220

		case TRANSPORT_RAIL:

   221

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

   222

			if (!ValParamRailtype(railtype)) return CMD_ERROR;

   223

			break;

   224

   225

		default:

   226

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

   227

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

   228

			return CMD_ERROR;

   229

	}

   230

   231

	x = TileX(end_tile);

   232

	y = TileY(end_tile);

   233

	sx = TileX(p1);

   234

	sy = TileY(p1);

   235

   236

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

   237

	if (x == sx) {

   238

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

   239

		direction = AXIS_Y;

   240

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

   241

	} else if (y == sy) {

   242

		direction = AXIS_X;

   243

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

   244

	} else {

   245

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   246

	}

   247

   248

	/* set and test bridge length, availability */

   249

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

   250

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

   251

   252

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

   253

	tile_start = TileXY(x, y);

   254

	tile_end = TileXY(sx, sy);

   255

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

   256

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   257

	}

   258

   259

	tileh_start = GetTileSlope(tile_start, &z_start);

   260

	tileh_end = GetTileSlope(tile_end, &z_end);

   261

   262

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

   263

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

   264

   265

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

   266

   267

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

   268

			GetOtherBridgeEnd(tile_start) == tile_end &&

   269

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   270

		/* Replace a current bridge. */

   271

   272

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

   273

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

   274

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   275

		}

   276

   277

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

   278

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

   279

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

   280

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   281

   282

			if (t == NULL) {

   283

				return CMD_ERROR;

   284

			} else {

   285

				SetDParam(0, t->index);

   286

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   287

			}

   288

		}

   289

   290

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

   291

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

   292

			return_cmd_error(STR_1007_ALREADY_BUILT);

   293

		}

   294

   295

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

   296

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

   297

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   298

		}

   299

   300

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

   301

		replace_bridge = true;

   302

		replaced_bridge_type = GetBridgeType(tile_start);

   303

   304

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

   305

		roadtypes |= GetRoadTypes(tile_start);

   306

	} else {

   307

		/* Build a new bridge. */

   308

   309

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

   310

   311

		/* Try and clear the start landscape */

   312

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

   313

		if (CmdFailed(ret)) return ret;

   314

		cost = ret;

   315

   316

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

   317

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   318

		cost.AddCost(terraform_cost_north);

   319

   320

		/* Try and clear the end landscape */

   321

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

   322

		if (CmdFailed(ret)) return ret;

   323

		cost.AddCost(ret);

   324

   325

		/* false - end tile slope check */

   326

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

   327

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   328

		cost.AddCost(terraform_cost_south);

   329

	}

   330

   331

	if (!replace_bridge) {

   332

		TileIndex Heads[] = {tile_start, tile_end};

   333

		int i;

   334

   335

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

   336

			if (MayHaveBridgeAbove(Heads[i])) {

   337

				if (IsBridgeAbove(Heads[i])) {

   338

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   339

   340

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

   341

   342

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

   343

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   344

					}

   345

				}

   346

			}

   347

		}

   348

	}

   349

   350

	/* do the drill? */

   351

	if (flags & DC_EXEC) {

   352

		DiagDirection dir = AxisToDiagDir(direction);

   353

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

   354

   355

		switch (transport_type) {

   356

			case TRANSPORT_RAIL:

   357

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

   358

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

   359

				break;

   360

   361

			case TRANSPORT_ROAD:

   362

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

   363

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

   364

				break;

   365

   366

			default:

   367

				NOT_REACHED();

   368

				break;

   369

		}

   370

		MarkTileDirtyByTile(tile_start);

   371

		MarkTileDirtyByTile(tile_end);

   372

	}

   373

   374

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

   375

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

   376

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

   377

   378

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

   379

			/* Disallow crossing bridges for the time being */

   380

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   381

		}

   382

   383

		switch (GetTileType(tile)) {

   384

			case MP_WATER:

   385

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

   386

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

   387

				break;

   388

   389

			case MP_RAILWAY:

   390

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   391

				break;

   392

   393

			case MP_ROAD:

   394

				if (IsRoadDepot(tile)) goto not_valid_below;

   395

				break;

   396

   397

			case MP_TUNNELBRIDGE:

   398

				if (IsTunnel(tile)) break;

   399

				if (replace_bridge) break;

   400

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

   401

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

   402

				break;

   403

   404

			case MP_UNMOVABLE:

   405

				if (!IsOwnedLand(tile)) goto not_valid_below;

   406

				break;

   407

   408

			case MP_CLEAR:

   409

				break;

   410

   411

			default:

   412

not_valid_below:;

   413

				/* try and clear the middle landscape */

   414

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

   415

				if (CmdFailed(ret)) return ret;

   416

				cost.AddCost(ret);

   417

				break;

   418

		}

   419

   420

		if (flags & DC_EXEC) {

   421

			SetBridgeMiddle(tile, direction);

   422

			MarkTileDirtyByTile(tile);

   423

		}

   424

	}

   425

   426

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

   427

		Track track = AxisToTrack(direction);

   428

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   429

		YapfNotifyTrackLayoutChange(tile_start, track);

   430

	}

   431

   432

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

   433

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

   434

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

   435

	 */

   436

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

   437

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

   438

   439

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   440

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   441

   442

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

   443

	}

   444

   445

	return cost;

   446

}

   447

   448

   449

/** Build Tunnel.

   450

 * @param start_tile start tile of tunnel

   451

 * @param flags type of operation

   452

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

   453

 * @param p2 unused

   454

 */

   455

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

   456

{

   457

	TileIndexDiff delta;

   458

	TileIndex end_tile;

   459

	DiagDirection direction;

   460

	Slope start_tileh;

   461

	Slope end_tileh;

   462

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

   463

	uint start_z;

   464

	uint end_z;

   465

	CommandCost cost(EXPENSES_CONSTRUCTION);

   466

	CommandCost ret;

   467

   468

	_build_tunnel_endtile = 0;

   469

	if (transport_type == TRANSPORT_RAIL) {

   470

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

   471

	} else {

   472

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

   473

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

   474

	}

   475

   476

	start_tileh = GetTileSlope(start_tile, &start_z);

   477

	direction = GetInclinedSlopeDirection(start_tileh);

   478

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

   479

   480

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

   481

   482

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

   483

	if (CmdFailed(ret)) return ret;

   484