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"

    36

    37

#include "table/sprites.h"

    38

#include "table/strings.h"

    39

#include "table/bridge_land.h"

    40

    57

const Bridge orig_bridge[] = {

    58

/*

   106

};

   107

   110

Bridge _bridge[MAX_BRIDGES];

   111

   112

   113

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

   114

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

   115

 */

   116

int CalcBridgeLenCostFactor(int x)

   117

{

   118

	int n;

   119

	int r;

   120

   121

	if (x < 2) return x;

   122

	x -= 2;

   123

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

   124

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

   125

		r += n * n;

   126

		x -= n;

   127

	}

   128

}

   129

   130

Foundation GetBridgeFoundation(Slope tileh, Axis axis)

   131

{

   132

	if ((tileh == SLOPE_FLAT) ||

   133

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

   134

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

   135

   136

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

   137

}

   138

   139

/**

   140

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

   141

 *

   142

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

   143

 * @param axis Orientation of bridge

   144

 * @return true iff the track is flat.

   145

 */

   146

bool HasBridgeFlatRamp(Slope tileh, Axis axis)

   147

{

   148

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

   149

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

   150

	return (tileh != SLOPE_FLAT);

   151

}

   152

   153

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

   154

{

   155

	const Bridge *bridge = &_bridge[index];

   156

	assert(table < 7);

   157

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

   158

		return _bridge_sprite_table[index][table];

   159

	} else {

   160

		return bridge->sprite_table[table];

   161

	}

   162

}

   163

   164

static inline byte GetBridgeFlags(int index) { return _bridge[index].flags;}

   165

   166

   167

/**

   168

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

   169

 *

   170

 * @param axis Axis of the bridge

   171

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

   172

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

   173

 * @return Error or cost for bridge foundation

   174

 */

   175

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

   176

{

   177

	Foundation f = GetBridgeFoundation(*tileh, axis);

   178

	*z += ApplyFoundationToSlope(f, tileh);

   179

   180

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

   181

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

   182

   183

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

   184

   185

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   186

}

   187

   188

/**

   189

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

   190

 *

   191

 * @param axis Axis of the bridge

   192

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

   193

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

   194

 * @return Error or cost for bridge foundation

   195

 */

   196

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

   197

{

   198

	Foundation f = GetBridgeFoundation(*tileh, axis);

   199

	*z += ApplyFoundationToSlope(f, tileh);

   200

   201

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

   202

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

   203

   204

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

   205

   206

	return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   207

}

   208

   209

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len)

   210

{

   211

	const Bridge *b = &_bridge[bridge_type];

   212

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

   213

   214

	if (bridge_type >= MAX_BRIDGES) return false;

   215

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

   216

   217

	max = b->max_length;

   218

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

   219

   220

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

   221

}

   222

   223

/** Build a Bridge

   224

 * @param end_tile end tile

   225

 * @param flags type of operation

   226

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

   227

 * @param p2 various bitstuffed elements

   228

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

   229

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

   230

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

   231

 */

   232

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

   233

{

   234

	uint bridge_type;

   235

	RailType railtype;

   236

	RoadTypes roadtypes;

   237

	uint x;

   238

	uint y;

   239

	uint sx;

   240

	uint sy;

   241

	TileIndex tile_start;

   242

	TileIndex tile_end;

   243

	Slope tileh_start;

   244

	Slope tileh_end;

   245

	uint z_start;

   246

	uint z_end;

   247

	TileIndex tile;

   248

	TileIndexDiff delta;

   249

	uint bridge_len;

   250

	Axis direction;

   251

	CommandCost cost(EXPENSES_CONSTRUCTION);

   252

	CommandCost ret;

   253

	bool replace_bridge = false;

   254

	uint replaced_bridge_type;

   255

   256

	/* unpack parameters */

   257

	bridge_type = GB(p2, 0, 8);

   258

   259

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

   260

   261

	/* type of bridge */

   262

	if (HasBit(p2, 15)) {

   263

		railtype = INVALID_RAILTYPE; // road bridge

   264

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

   265

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

   266

	} else {

   267

		if (!ValParamRailtype((RailType)GB(p2, 8, 8))) return CMD_ERROR;

   268

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

   269

		roadtypes = ROADTYPES_NONE;

   270

	}

   271

   272

	x = TileX(end_tile);

   273

	y = TileY(end_tile);

   274

	sx = TileX(p1);

   275

	sy = TileY(p1);

   276

   277

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

   278

	if (x == sx) {

   279

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

   280

		direction = AXIS_Y;

   281

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

   282

	} else if (y == sy) {

   283

		direction = AXIS_X;

   284

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

   285

	} else {

   286

		return_cmd_error(STR_500A_START_AND_END_MUST_BE_IN);

   287

	}

   288

   289

	/* set and test bridge length, availability */

   290

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

   291

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

   292

   293

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

   294

	tile_start = TileXY(x, y);

   295

	tile_end = TileXY(sx, sy);

   296

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

   297

		return_cmd_error(STR_02A0_ENDS_OF_BRIDGE_MUST_BOTH);

   298

	}

   299

   300

	tileh_start = GetTileSlope(tile_start, &z_start);

   301

	tileh_end = GetTileSlope(tile_end, &z_end);

   302

   303

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

   304

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

   305

   306

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

   307

   308

	TransportType transport_type = railtype == INVALID_RAILTYPE ? TRANSPORT_ROAD : TRANSPORT_RAIL;

   309

   310

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

   311

			GetOtherBridgeEnd(tile_start) == tile_end &&

   312

			GetTunnelBridgeTransportType(tile_start) == transport_type) {

   313

		/* Replace a current bridge. */

   314

   315

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

   316

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

   317

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   318

		}

   319

   320

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

   321

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

   322

				_bridge[bridge_type].speed < _bridge[GetBridgeType(tile_start)].speed) {

   323

			Town *t = ClosestTownFromTile(tile_start, UINT_MAX);

   324

   325

			if (t == NULL) {

   326

				return CMD_ERROR;

   327

			} else {

   328

				SetDParam(0, t->index);

   329

				return_cmd_error(STR_2009_LOCAL_AUTHORITY_REFUSES);

   330

			}

   331

		}

   332

   333

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

   334

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

   335

			return_cmd_error(STR_1007_ALREADY_BUILT);

   336

		}

   337

   338

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

   339

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

   340

			return_cmd_error(STR_1024_AREA_IS_OWNED_BY_ANOTHER);

   341

		}

   342

   343

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

   344

		replace_bridge = true;

   345

		replaced_bridge_type = GetBridgeType(tile_start);

   346

   347

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

   348

		roadtypes |= GetRoadTypes(tile_start);

   349

	} else {

   350

		/* Build a new bridge. */

   351

   352

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

   353

   354

		/* Try and clear the start landscape */

   355

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

   356

		if (CmdFailed(ret)) return ret;

   357

		cost = ret;

   358

   359

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

   360

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   361

		cost.AddCost(terraform_cost_north);

   362

   363

		/* Try and clear the end landscape */

   364

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

   365

		if (CmdFailed(ret)) return ret;

   366

		cost.AddCost(ret);

   367

   368

		/* false - end tile slope check */

   369

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

   370

			return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   371

		cost.AddCost(terraform_cost_south);

   372

	}

   373

   374

	if (!replace_bridge) {

   375

		TileIndex Heads[] = {tile_start, tile_end};

   376

		int i;

   377

   378

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

   379

			if (MayHaveBridgeAbove(Heads[i])) {

   380

				if (IsBridgeAbove(Heads[i])) {

   381

					TileIndex north_head = GetNorthernBridgeEnd(Heads[i]);

   382

   383

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

   384

   385

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

   386

						return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   387

					}

   388

				}

   389

			}

   390

		}

   391

	}

   392

   393

	/* do the drill? */

   394

	if (flags & DC_EXEC) {

   395

		DiagDirection dir = AxisToDiagDir(direction);

   396

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

   397

   398

		if (railtype != INVALID_RAILTYPE) {

   399

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

   400

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

   401

		} else {

   402

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

   403

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

   404

		}

   405

		MarkTileDirtyByTile(tile_start);

   406

		MarkTileDirtyByTile(tile_end);

   407

	}

   408

   409

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

   410

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

   411

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

   412

   413

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

   414

			/* Disallow crossing bridges for the time being */

   415

			return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   416

		}

   417

   418

		switch (GetTileType(tile)) {

   419

			case MP_WATER:

   420

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

   422

				break;

   423

   424

			case MP_RAILWAY:

   425

				if (!IsPlainRailTile(tile)) goto not_valid_below;

   426

				break;

   427

   428

			case MP_ROAD:

   429

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

   430

				break;

   431

   432

			case MP_TUNNELBRIDGE:

   433

				if (IsTunnel(tile)) break;

   434

				if (replace_bridge) break;

   435

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

   436

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

   437

				break;

   438

   439

			case MP_UNMOVABLE:

   440

				if (!IsOwnedLand(tile)) goto not_valid_below;

   441

				break;

   442

   443

			case MP_CLEAR:

   444

				break;

   445

   446

			default:

   447

not_valid_below:;

   448

				/* try and clear the middle landscape */

   449

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

   450

				if (CmdFailed(ret)) return ret;

   451

				cost.AddCost(ret);

   452

				break;

   453

		}

   454

   455

		if (flags & DC_EXEC) {

   456

			SetBridgeMiddle(tile, direction);

   457

			MarkTileDirtyByTile(tile);

   458

		}

   459

	}

   460

   461

	if (flags & DC_EXEC && railtype != INVALID_RAILTYPE) {

   462

		Track track = AxisToTrack(direction);

   463

		AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, _current_player);

   464

		YapfNotifyTrackLayoutChange(tile_start, track);

   465

	}

   466

   467

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

   468

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

   469

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

   470

	 */

   471

	if (!(flags & DC_QUERY_COST)) {

   472

		const Bridge *b = &_bridge[bridge_type];

   473

   474

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

   475

   476

		if (IsValidPlayer(_current_player) && !_is_old_ai_player)

   477

			bridge_len = CalcBridgeLenCostFactor(bridge_len);

   478

   479

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

   480

	}

   481

   482

	return cost;

   483

}

   484

   485

   486

/** Build Tunnel.

   487