This file deals with tunnels and bridges (non-gui stuff). More...

#include "stdafx.h"
#include "viewport_func.h"
#include "command_func.h"
#include "town.h"
#include "train.h"
#include "ship.h"
#include "roadveh.h"
#include "pathfinder/yapf/yapf_cache.h"
#include "newgrf_sound.h"
#include "autoslope.h"
#include "tunnelbridge_map.h"
#include "strings_func.h"
#include "timer/timer_game_calendar.h"
#include "clear_func.h"
#include "vehicle_func.h"
#include "sound_func.h"
#include "tunnelbridge.h"
#include "cheat_type.h"
#include "elrail_func.h"
#include "pbs.h"
#include "company_base.h"
#include "newgrf_railtype.h"
#include "newgrf_roadtype.h"
#include "object_base.h"
#include "water.h"
#include "company_gui.h"
#include "tunnelbridge_cmd.h"
#include "landscape_cmd.h"
#include "terraform_cmd.h"
#include "table/strings.h"
#include "table/bridge_land.h"
#include "safeguards.h"

Functions
void	MarkBridgeDirty (TileIndex begin, TileIndex end, DiagDirection direction, uint bridge_height)
	Mark bridge tiles dirty.
void	MarkBridgeDirty (TileIndex tile)
	Mark bridge tiles dirty.
void	ResetBridges ()
	Reset the data been eventually changed by the grf loaded.
int	CalcBridgeLenCostFactor (int length)
	Calculate the price factor for building a long bridge.
Foundation	GetBridgeFoundation (Slope tileh, Axis axis)
	Get the foundation for a bridge.
bool	HasBridgeFlatRamp (Slope tileh, Axis axis)
	Determines if the track on a bridge ramp is flat or goes up/down.
static bool	BridgeHasCustomSpriteTable (BridgeType bridge_type, BridgePieces piece)
	Test if bridge piece uses a custom sprite table.
static std::span< const PalSpriteID >	GetBridgeSpriteTable (BridgeType bridge_type, BridgePieces piece)
	Get the sprite table for a rail/road bridge piece.
static uint8_t	GetBridgeSpriteTableBaseOffset (TransportType transport_type, TileIndex ramp)
	Get the sprite table transport type base offset for a rail/road bridge.
static uint8_t	GetBridgeRampDirectionBaseOffset (DiagDirection diagdir)
	Get bridge sprite table base offset for the ramp part of bridge.
static uint8_t	GetBridgeMiddleAxisBaseOffset (Axis axis)
	Get bridge sprite table base offset for the middle part of bridge.
static CommandCost	CheckBridgeSlope (BridgePieces bridge_piece, Axis axis, Slope &tileh, int &z)
	Determines the foundation for the bridge head, and tests if the resulting slope is valid.
CommandCost	CheckBridgeAvailability (BridgeType bridge_type, uint bridge_len, DoCommandFlags flags)
	Is a bridge of the specified type and length available?
static Money	TunnelBridgeClearCost (TileIndex tile, Price base_price)
	Calculate the base cost of clearing a tunnel/bridge per tile.
static CommandCost	CheckBuildAbove (TileIndex tile, DoCommandFlags flags, Axis axis, int height)
CommandCost	CmdBuildBridge (DoCommandFlags flags, TileIndex tile_end, TileIndex tile_start, TransportType transport_type, BridgeType bridge_type, uint8_t road_rail_type)
	Build a Bridge.
CommandCost	CmdBuildTunnel (DoCommandFlags flags, TileIndex start_tile, TransportType transport_type, uint8_t road_rail_type)
	Build Tunnel.
static CommandCost	CheckAllowRemoveTunnelBridge (TileIndex tile)
	Are we allowed to remove the tunnel or bridge at tile?
static CommandCost	DoClearTunnel (TileIndex tile, DoCommandFlags flags)
	Remove a tunnel from the game, update town rating, etc.
static CommandCost	DoClearBridge (TileIndex tile, DoCommandFlags flags)
	Remove a bridge from the game, update town rating, etc.
static CommandCost	ClearTile_TunnelBridge (TileIndex tile, DoCommandFlags flags)
	Remove a tunnel or a bridge from the game.
static void	DrawPillar (const PalSpriteID &psid, int x, int y, int z, uint8_t w, uint8_t h, const SubSprite *subsprite)
	Draw a single pillar sprite.
static int	DrawPillarColumn (int z_bottom, int z_top, const PalSpriteID &psid, int x, int y, int w, int h)
	Draw two bridge pillars (north and south).
static void	DrawBridgePillars (const PalSpriteID &psid, const TileInfo *ti, Axis axis, bool drawfarpillar, int x, int y, int z_bridge)
	Draws the pillars under high bridges.
static void	GetBridgeRoadCatenary (const RoadTypeInfo *rti, TileIndex head_tile, int offset, bool head, SpriteID &spr_back, SpriteID &spr_front)
	Retrieve the sprites required for catenary on a road/tram bridge.
static void	DrawBridgeRoadBits (TileIndex head_tile, int x, int y, int z, int offset, bool head, bool is_custom_layout)
	Draws the road and trambits over an already drawn (lower end) of a bridge.
static void	DrawTile_TunnelBridge (TileInfo *ti)
	Draws a tunnel of bridge tile.
static BridgePieces	CalcBridgePiece (uint north, uint south)
	Compute bridge piece.
static BridgePillarFlags	GetBridgeTilePillarFlags (TileIndex tile, TileIndex rampnorth, TileIndex rampsouth, BridgeType type, TransportType transport_type)
	Get pillar information for a bridge middle tile.
void	DrawBridgeMiddle (const TileInfo *ti, BridgePillarFlags blocked_pillars)
	Draw the middle bits of a bridge.
static int	GetSlopePixelZ_TunnelBridge (TileIndex tile, uint x, uint y, bool ground_vehicle)
static Foundation	GetFoundation_TunnelBridge (TileIndex tile, Slope tileh)
static void	GetTileDesc_TunnelBridge (TileIndex tile, TileDesc &td)
static void	TileLoop_TunnelBridge (TileIndex tile)
static TrackStatus	GetTileTrackStatus_TunnelBridge (TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
static void	ChangeTileOwner_TunnelBridge (TileIndex tile, Owner old_owner, Owner new_owner)
template<typename T>
static void	PrepareToEnterBridge (T *gv)
	Helper to prepare the ground vehicle when entering a bridge.
static VehicleEnterTileStates	VehicleEnter_TunnelBridge (Vehicle *v, TileIndex tile, int x, int y)
static CommandCost	TerraformTile_TunnelBridge (TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new)
static CommandCost	CheckBuildAbove_TunnelBridge (TileIndex tile, DoCommandFlags flags, Axis axis, int height)

Variables
BridgeSpec	_bridge [MAX_BRIDGES]
	The specification of all bridges.
TileIndex	_build_tunnel_endtile
	The end of a tunnel; as hidden return from the tunnel build command for GUI purposes.
static const int	BRIDGE_Z_START = 3
	Z position of the bridge sprites relative to bridge height (downwards).
static const uint8_t	TUNNEL_SOUND_FRAME = 1
	Frame when the 'enter tunnel' sound should be played.
const uint8_t	_tunnel_visibility_frame [DIAGDIR_END] = {12, 8, 8, 12}
	Frame when a vehicle should be hidden in a tunnel with a certain direction.
const TileTypeProcs	_tile_type_tunnelbridge_procs

Detailed Description

This file deals with tunnels and bridges (non-gui stuff).

Todo: separate this file into two.

Definition in file tunnelbridge_cmd.cpp.

Function Documentation

◆ BridgeHasCustomSpriteTable()

bool BridgeHasCustomSpriteTable	(	BridgeType	bridge_type,
		BridgePieces	piece )

static

Test if bridge piece uses a custom sprite table.

Parameters

bridge_type	Bridge type.
piece	Bridge piece.

Returns: True iff a custom sprite table is used for the bridge piece.

Definition at line 143 of file tunnelbridge_cmd.cpp.

References GetBridgeSpec(), and BridgeSpec::sprite_table.

Referenced by DrawBridgeMiddle(), and DrawTile_TunnelBridge().

◆ CalcBridgeLenCostFactor()

int CalcBridgeLenCostFactor ( int length )

Calculate the price factor for building a long bridge.

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,

Parameters

length Length of the bridge.

Returns: Price factor for the bridge.

Definition at line 93 of file tunnelbridge_cmd.cpp.

Referenced by CmdBuildBridge(), and ShowBuildBridgeWindow().

◆ CalcBridgePiece()

BridgePieces CalcBridgePiece	(	uint	north,
		uint	south )

static

Compute bridge piece.

Computes the bridge piece to display depending on the position inside the bridge. bridges pieces sequence (middle parts). Note that it is not covering the bridge heads, which are always referenced by the same sprite table. bridge len 1: BRIDGE_PIECE_NORTH bridge len 2: BRIDGE_PIECE_NORTH BRIDGE_PIECE_SOUTH bridge len 3: BRIDGE_PIECE_NORTH BRIDGE_PIECE_MIDDLE_ODD BRIDGE_PIECE_SOUTH bridge len 4: BRIDGE_PIECE_NORTH BRIDGE_PIECE_INNER_NORTH BRIDGE_PIECE_INNER_SOUTH BRIDGE_PIECE_SOUTH bridge len 5: BRIDGE_PIECE_NORTH BRIDGE_PIECE_INNER_NORTH BRIDGE_PIECE_MIDDLE_EVEN BRIDGE_PIECE_INNER_SOUTH BRIDGE_PIECE_SOUTH bridge len 6: BRIDGE_PIECE_NORTH BRIDGE_PIECE_INNER_NORTH BRIDGE_PIECE_INNER_SOUTH BRIDGE_PIECE_INNER_NORTH BRIDGE_PIECE_INNER_SOUTH BRIDGE_PIECE_SOUTH bridge len 7: BRIDGE_PIECE_NORTH BRIDGE_PIECE_INNER_NORTH BRIDGE_PIECE_INNER_SOUTH BRIDGE_PIECE_MIDDLE_ODD BRIDGE_PIECE_INNER_NORTH BRIDGE_PIECE_INNER_SOUTH BRIDGE_PIECE_SOUTH #0 - always as first, #1 - always as last (if len>1) #2,#3 are to pair in order for odd bridges: #5 is going in the bridge middle if on even position, #4 on odd (counting from 0)

Parameters

north	Northernmost tile of bridge
south	Southernmost tile of bridge

Returns: Index of bridge piece

Definition at line 1570 of file tunnelbridge_cmd.cpp.

Referenced by DrawBridgeMiddle(), and GetBridgeTilePillarFlags().

◆ ChangeTileOwner_TunnelBridge()

void ChangeTileOwner_TunnelBridge	(	TileIndex	tile,
		Owner	old_owner,
		Owner	new_owner )

static

Definition at line 1869 of file tunnelbridge_cmd.cpp.

◆ CheckAllowRemoveTunnelBridge()

CommandCost CheckAllowRemoveTunnelBridge ( TileIndex tile )

inlinestatic

Are we allowed to remove the tunnel or bridge at tile?

Parameters

tile	End point of the tunnel or bridge.

Returns: A succeeded command if the tunnel or bridge may be removed, a failed command otherwise.

Definition at line 821 of file tunnelbridge_cmd.cpp.

References _cheats, _current_company, _settings_game, CheckOwnership(), CheckTileOwnership(), GetRoadOwner(), GetTileOwner(), GetTunnelBridgeTransportType(), INVALID_ROADTYPE, OWNER_NONE, OWNER_TOWN, OWNER_WATER, RTT_ROAD, RTT_TRAM, CommandCost::Succeeded(), TRANSPORT_RAIL, TRANSPORT_ROAD, and TRANSPORT_WATER.

Referenced by DoClearBridge(), and DoClearTunnel().

◆ CheckBridgeAvailability()

CommandCost CheckBridgeAvailability	(	BridgeType	bridge_type,
		uint	bridge_len,
		DoCommandFlags	flags )

Is a bridge of the specified type and length available?

Parameters

bridge_type	Wanted type of bridge.
bridge_len	Wanted length of the bridge.
flags	Type of operation.

Returns: A succeeded (the requested bridge is available) or failed (it cannot be built) command.

Definition at line 239 of file tunnelbridge_cmd.cpp.

References _settings_game, BridgeSpec::avail_year, CMD_ERROR, GetBridgeSpec(), MAX_BRIDGES, BridgeSpec::max_length, BridgeSpec::min_length, QueryCost, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and TimerGameCalendar::year.

Referenced by CmdBuildBridge(), and ShowBuildBridgeWindow().

◆ CheckBridgeSlope()

CommandCost CheckBridgeSlope	(	BridgePieces	bridge_piece,
		Axis	axis,
		Slope &	tileh,
		int &	z )

static

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

Parameters

bridge_piece	Direction of the bridge head.
axis	Axis of the bridge
tileh	Slope of the tile under the north bridge head; returns slope on top of foundation
z	TileZ corresponding to tileh, gets modified as well

Returns: Error or cost for bridge foundation

Definition at line 212 of file tunnelbridge_cmd.cpp.

References ApplyFoundationToSlope(), AXIS_X, BuildFoundation, CMD_ERROR, EXPENSES_CONSTRUCTION, FOUNDATION_NONE, GetBridgeFoundation(), SLOPE_FLAT, SLOPE_NE, SLOPE_NW, SLOPE_SE, and SLOPE_SW.

Referenced by CmdBuildBridge().

◆ CheckBuildAbove()

CommandCost CheckBuildAbove	(	TileIndex	tile,
		DoCommandFlags	flags,
		Axis	axis,
		int	height )

static

Definition at line 291 of file tunnelbridge_cmd.cpp.

◆ CheckBuildAbove_TunnelBridge()

CommandCost CheckBuildAbove_TunnelBridge	(	TileIndex	tile,
		DoCommandFlags	flags,
		Axis	axis,
		int	height )

static

Definition at line 2127 of file tunnelbridge_cmd.cpp.

◆ ClearTile_TunnelBridge()

CommandCost ClearTile_TunnelBridge	(	TileIndex	tile,
		DoCommandFlags	flags )

static

Remove a tunnel or a bridge from the game.

Parameters

tile	Tile containing one of the endpoints.
flags	Command flags.

Returns: Succeeded or failed command.

Definition at line 1040 of file tunnelbridge_cmd.cpp.

References Auto, DoClearBridge(), DoClearTunnel(), IsTunnel(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

◆ CmdBuildBridge()

CommandCost CmdBuildBridge	(	DoCommandFlags	flags,
		TileIndex	tile_end,
		TileIndex	tile_start,
		TransportType	transport_type,
		BridgeType	bridge_type,
		uint8_t	road_rail_type )

Build a Bridge.

Parameters

flags	type of operation
tile_end	end tile
tile_start	start tile
transport_type	transport type.
bridge_type	bridge type (hi bh)
road_rail_type	rail type or road types.

Returns: the cost of this operation or an error

Definition at line 310 of file tunnelbridge_cmd.cpp.

References _current_company, _local_company, _settings_game, CommandCost::AddCost(), AddSideToSignalBuffer(), AXIS_X, AXIS_Y, AxisToDiagDir(), AxisToTrack(), BuildAqueduct, BuildBridge, Town::cache, CalcBridgeLenCostFactor(), CalcClosestTownFromTile(), ChangeTownRating(), CheckBridgeAvailability(), CheckBridgeSlope(), CheckForDockingTile(), ClearBridge, ClosestTownFromTile(), CMD_ERROR, CommandCostWithParam(), DirtyCompanyInfrastructureWindows(), DistanceSquare(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), GetBridgeAxis(), GetBridgeHeight(), GetBridgeSpec(), GetBridgeType(), CommandCost::GetCost(), GetNorthernBridgeEnd(), GetOtherBridgeEnd(), GetRailType(), GetRoadOwner(), GetTileMaxZ(), GetTileOwner(), GetTileSlopeZ(), GetTileZ(), GetTunnelBridgeLength(), GetTunnelBridgeTransportType(), HasTunnelBridgeReservation(), Company::infrastructure, INVALID_DIAGDIR, INVALID_RAILTYPE, INVALID_ROADTYPE, CompanyProperties::is_ai, IsBridgeAbove(), IsBridgeTile(), IsTileOwner(), IsValidTile(), MakeAqueductBridgeRamp(), MakeRailBridgeRamp(), MakeRoadBridgeRamp(), MarkBridgeDirty(), OWNER_DEITY, OWNER_NONE, OWNER_TOWN, QueryCost, CompanyInfrastructure::rail, RailBuildCost(), RATING_TUNNEL_BRIDGE_UP_STEP, ReverseDiagDir(), CompanyInfrastructure::road, RoadBuildCost(), RTT_ROAD, RTT_TRAM, SetBridgeMiddle(), SetTunnelBridgeReservation(), SLOPE_FLAT, TownCache::squared_town_zone_radius, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TileDiffXY(), TileOffsByAxis(), TileX(), TileY(), to_underlying(), TownEdge, TRANSPORT_RAIL, TRANSPORT_ROAD, TRANSPORT_WATER, TUNNELBRIDGE_TRACKBIT_FACTOR, TunnelBridgeClearCost(), ValParamRailType(), ValParamRoadType(), CompanyInfrastructure::water, Town::xy, and YapfNotifyTrackLayoutChange().

◆ CmdBuildTunnel()

CommandCost CmdBuildTunnel	(	DoCommandFlags	flags,
		TileIndex	start_tile,
		TransportType	transport_type,
		uint8_t	road_rail_type )

Build Tunnel.

Parameters

flags	type of operation
start_tile	start tile of tunnel
transport_type	transport type
road_rail_type	railtype or roadtype

Returns: the cost of this operation or an error

Definition at line 647 of file tunnelbridge_cmd.cpp.

References _build_tunnel_endtile, _cheats, _current_company, _settings_game, CommandCost::AddCost(), AddSideToSignalBuffer(), AXIS_Y, BuildTunnel, Town::cache, CalcClosestTownFromTile(), CMD_ERROR, ComplementSlope(), DIAGDIR_NE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_SW, DiagDirToAxis(), DiagDirToDiagTrack(), DirtyCompanyInfrastructureWindows(), DistanceSquare(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), FindClearedObject(), ClearedObjectArea::first_tile, CommandCost::GetCost(), GetInclinedSlopeDirection(), GetTileSlopeZ(), HasTileWaterGround(), Company::infrastructure, INVALID_DIAGDIR, INVALID_RAILTYPE, INVALID_ROADTYPE, INVALID_TILE, IsTunnelInWayDir(), IsValidTile(), MakeRailTunnel(), MakeRoadTunnel(), Map::MaxX(), OWNER_DEITY, OWNER_NONE, OWNER_TOWN, CompanyInfrastructure::rail, RailBuildCost(), ReverseDiagDir(), CompanyInfrastructure::road, RoadBuildCost(), TownCache::squared_town_zone_radius, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TileOffsByDiagDir(), TileX(), TileY(), to_underlying(), TownEdge, TRANSPORT_RAIL, TRANSPORT_ROAD, TUNNELBRIDGE_TRACKBIT_FACTOR, ValParamRailType(), ValParamRoadType(), Town::xy, and YapfNotifyTrackLayoutChange().

◆ DoClearBridge()

CommandCost DoClearBridge	(	TileIndex	tile,
		DoCommandFlags	flags )

static

Remove a bridge from the game, update town rating, etc.

Parameters

tile	Tile containing one of the endpoints of the bridge.
flags	Command flags.

Returns: Succeeded or failed command.

Definition at line 949 of file tunnelbridge_cmd.cpp.

References AddSideToSignalBuffer(), ChangeTownRating(), CheckAllowRemoveTunnelBridge(), CheckforTownRating(), ClearBridge, ClearBridgeMiddle(), ClosestTownFromTile(), DiagDirToDiagTrack(), DirtyCompanyInfrastructureWindows(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), FreeTrainTrackReservation(), GetBridgeHeight(), GetOtherBridgeEnd(), GetRailType(), GetRoadOwner(), GetRoadside(), GetTileMaxZ(), GetTileOwner(), GetTrainForReservation(), GetTunnelBridgeDirection(), GetTunnelBridgeLength(), GetTunnelBridgeTransportType(), HasTunnelBridgeReservation(), IsNormalRoadTile(), IsTileOwner(), MarkTileDirtyByTile(), OWNER_TOWN, Paved, RATING_TUNNEL_BRIDGE_DOWN_STEP, RATING_TUNNEL_BRIDGE_MINIMUM, ReverseDiagDir(), RTT_ROAD, RTT_TRAM, SetRoadside(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TileHeight(), TileOffsByDiagDir(), TRANSPORT_RAIL, TRANSPORT_ROAD, Trees, TryPathReserve(), TUNNELBRIDGE_TRACKBIT_FACTOR, TunnelBridgeClearCost(), TunnelBridgeIsFree(), TunnelBridgeRemove, UpdateCompanyRoadInfrastructure(), and YapfNotifyTrackLayoutChange().

Referenced by ClearTile_TunnelBridge().

◆ DoClearTunnel()

CommandCost DoClearTunnel	(	TileIndex	tile,
		DoCommandFlags	flags )

static

Remove a tunnel from the game, update town rating, etc.

Parameters

tile	Tile containing one of the endpoints of the tunnel.
flags	Command flags.

Returns: Succeeded or failed command.

Definition at line 869 of file tunnelbridge_cmd.cpp.

References _build_tunnel_endtile, AddSideToSignalBuffer(), ChangeTownRating(), CheckAllowRemoveTunnelBridge(), CheckforTownRating(), ClearTunnel, ClosestTownFromTile(), DiagDirToDiagTrack(), DirtyCompanyInfrastructureWindows(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), FreeTrainTrackReservation(), GetOtherTunnelEnd(), GetRailType(), GetRoadOwner(), GetTileOwner(), GetTrainForReservation(), GetTunnelBridgeDirection(), GetTunnelBridgeLength(), GetTunnelBridgeTransportType(), HasTunnelBridgeReservation(), IsTileOwner(), OWNER_TOWN, RATING_TUNNEL_BRIDGE_DOWN_STEP, RATING_TUNNEL_BRIDGE_MINIMUM, ReverseDiagDir(), RTT_ROAD, RTT_TRAM, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TRANSPORT_RAIL, TryPathReserve(), TUNNELBRIDGE_TRACKBIT_FACTOR, TunnelBridgeClearCost(), TunnelBridgeIsFree(), TunnelBridgeRemove, UpdateCompanyRoadInfrastructure(), and YapfNotifyTrackLayoutChange().

Referenced by ClearTile_TunnelBridge().

◆ DrawBridgeMiddle()

void DrawBridgeMiddle	(	const TileInfo *	ti,
		BridgePillarFlags	blocked_pillars )

Draw the middle bits of a bridge.

Parameters

ti	Tile information of the tile to draw it on.
blocked_pillars	Mask of pillar corners and edges blocked by tile below the bridge.

Definition at line 1614 of file tunnelbridge_cmd.cpp.

References _settings_client, AddSortableSpriteToDraw(), AXIS_X, RailTypeInfo::base_sprites, BB_Z_SEPARATOR, RailTypeInfo::bridge_deck, BRIDGE_Z_START, BridgeHasCustomSpriteTable(), CalcBridgePiece(), DrawBridgeRoadBits(), GetBridgeAxis(), GetBridgeMiddleAxisBaseOffset(), GetBridgePixelHeight(), GetBridgeSpec(), GetBridgeSpriteTable(), GetBridgeSpriteTableBaseOffset(), GetBridgeTilePillarFlags(), GetBridgeType(), GetCustomRailSprite(), GetNorthernBridgeEnd(), GetRailType(), GetRailTypeInfo(), GetSouthernBridgeEnd(), GetTunnelBridgeLength(), GetTunnelBridgeTransportType(), HasBit(), HasTunnelBridgeReservation(), IsBridgeAbove(), IsInvisibilitySet(), IsTransparencySet(), PALETTE_CRASH, RTO_X, RTSG_BRIDGE, RTSG_OVERLAY, RailTypeInfo::single_x, RailTypeInfo::single_y, StartSpriteCombine(), TCX_ON_BRIDGE, TileInfo::tile, TILE_HEIGHT, TILE_SIZE, TO_BRIDGES, TRANSPORT_RAIL, TRANSPORT_ROAD, TRANSPORT_WATER, Coord3D< T >::x, and Coord3D< T >::y.

Referenced by DrawTile_Road(), and DrawTile_TunnelBridge().

◆ DrawBridgePillars()

void DrawBridgePillars	(	const PalSpriteID &	psid,
		const TileInfo *	ti,
		Axis	axis,
		bool	drawfarpillar,
		int	x,
		int	y,
		int	z_bridge )

static

Draws the pillars under high bridges.

Parameters

psid	Image and palette of a bridge pillar.
ti	TileInfo of current bridge-middle-tile.
axis	Orientation of bridge.
drawfarpillar	Whether to draw the pillar at the back
x	Sprite X position of front pillar.
y	Sprite Y position of front pillar.
z_bridge	Absolute height of bridge bottom.

< bounding box size of pillars along bridge direction

< sprite position offset of back facing pillar

< big number compared to sprite size

Definition at line 1098 of file tunnelbridge_cmd.cpp.

References AxisToDiagDir(), DrawPillar(), DrawPillarColumn(), GetSlopePixelZOnEdge(), OtherAxis(), ReverseDiagDir(), PalSpriteID::sprite, TILE_HEIGHT, TileInfo::tileh, and Coord3D< T >::z.

◆ DrawBridgeRoadBits()

void DrawBridgeRoadBits	(	TileIndex	head_tile,
		int	x,
		int	y,
		int	z,
		int	offset,
		bool	head,
		bool	is_custom_layout )

static

Draws the road and trambits over an already drawn (lower end) of a bridge.

Parameters

head_tile	bridge head tile with roadtype information
x	the x of the bridge
y	the y of the bridge
z	the z of the bridge
offset	sprite offset identifying flat to sloped bridge tiles
head	are we drawing bridge head?
is_custom_layout	Set if the bridge uses a custom sprite layout.

Definition at line 1181 of file tunnelbridge_cmd.cpp.

References AddSortableSpriteToDraw(), EndSpriteCombine(), GetBridgeRoadCatenary(), GetCustomRoadSprite(), GetRoadTypeInfo(), HasRoadCatenaryDrawn(), INVALID_ROADTYPE, IsInvisibilitySet(), IsTransparencySet(), lengthof, ROTSG_BRIDGE, ROTSG_OVERLAY, StartSpriteCombine(), TCX_NORMAL, TCX_ON_BRIDGE, TILE_SIZE, TO_BRIDGES, and TO_CATENARY.

Referenced by DrawBridgeMiddle(), and DrawTile_TunnelBridge().

◆ DrawPillar()

void DrawPillar	(	const PalSpriteID &	psid,
		int	x,
		int	y,
		int	z,
		uint8_t	w,
		uint8_t	h,
		const SubSprite *	subsprite )

inlinestatic

Draw a single pillar sprite.

Parameters

psid	Pillarsprite
x	Pillar X
y	Pillar Y
z	Pillar Z
w	Bounding box size in X direction
h	Bounding box size in Y direction
subsprite	Optional subsprite for drawing halfpillars

< Start offset of pillar wrt. bridge (downwards)

Definition at line 1061 of file tunnelbridge_cmd.cpp.

References AddSortableSpriteToDraw(), BRIDGE_Z_START, PalSpriteID::pal, PalSpriteID::sprite, and TILE_HEIGHT.

Referenced by DrawBridgePillars(), and DrawPillarColumn().

◆ DrawPillarColumn()

int DrawPillarColumn	(	int	z_bottom,
		int	z_top,
		const PalSpriteID &	psid,
		int	x,
		int	y,
		int	w,
		int	h )

static

Draw two bridge pillars (north and south).

Parameters

z_bottom	Bottom Z
z_top	Top Z
psid	Pillarsprite
x	Pillar X
y	Pillar Y
w	Bounding box size in X direction
h	Bounding box size in Y direction

Returns: Reached Z at the bottom

Definition at line 1078 of file tunnelbridge_cmd.cpp.

References DrawPillar(), and TILE_HEIGHT.

Referenced by DrawBridgePillars().

◆ DrawTile_TunnelBridge()

void DrawTile_TunnelBridge ( TileInfo * ti )

static

Draws a tunnel of bridge tile.

For tunnels, this is rather simple, as you only need to draw the entrance. Bridges are a bit more complex. base_offset is where the sprite selection comes into play and it works a bit like a bitmask.

For bridge heads:

Parameters

ti	TileInfo of the structure to draw Bit 0: direction Bit 1: northern or southern heads Bit 2: Set if the bridge head is sloped Bit 3 and more: Railtype Specific subset Please note that in this code, "roads" are treated as railtype 1, whilst the real railtypes are 0, 2 and 3

Definition at line 1292 of file tunnelbridge_cmd.cpp.

References _settings_client, AddSortableSpriteToDraw(), AXIS_X, RailTypeInfo::base_sprites, BB_Z_SEPARATOR, RailTypeInfo::bridge_deck, BridgeHasCustomSpriteTable(), DIAGDIR_END, DiagDirToAxis(), DrawBridgeMiddle(), DrawBridgeRoadBits(), DrawFoundation(), DrawGroundSprite(), DrawRailCatenary(), DrawRailCatenaryOnTunnel(), DrawRoadOverlays(), EdgeNE, EndSpriteCombine(), GetBridgeFoundation(), GetBridgeRampDirectionBaseOffset(), GetBridgeSpriteTable(), GetBridgeSpriteTableBaseOffset(), GetBridgeType(), GetCustomRailSprite(), GetCustomRoadSprite(), GetRailType(), GetRailTypeInfo(), GetRoadTypeInfo(), GetTunnelBridgeDirection(), GetTunnelBridgeTransportType(), GetWaterClass(), HasBridgeFlatRamp(), HasRailCatenaryDrawn(), HasRoadCatenaryDrawn(), HasTileWaterClass(), HasTunnelBridgeReservation(), HasTunnelBridgeSnowOrDesert(), INVALID_ROADTYPE, IsTransparencySet(), IsTunnel(), PALETTE_CRASH, ROTSG_CATENARY_FRONT, ROTSG_TUNNEL, RTBO_SLOPE, RTBO_X, RTBO_Y, RTO_SLOPE_NE, RTO_X, RTSG_BRIDGE, RTSG_OVERLAY, RTSG_TUNNEL, RTSG_TUNNEL_PORTAL, Sea, RailTypeInfo::single_sloped, RailTypeInfo::single_x, RailTypeInfo::single_y, SLOPE_FLAT, SlopeToSpriteOffset(), SPR_RAILTYPE_TUNNEL_BASE, StartSpriteCombine(), TileInfo::tile, TILE_HEIGHT, TILE_SIZE, TileInfo::tileh, TileOffsByDiagDir(), TO_CATENARY, TRANSPORT_RAIL, TRANSPORT_ROAD, TRANSPORT_WATER, RailTypeInfo::tunnel, Coord3D< T >::x, Coord3D< T >::y, and Coord3D< T >::z.

◆ GetBridgeFoundation()

Foundation GetBridgeFoundation	(	Slope	tileh,
		Axis	axis )

Get the foundation for a bridge.

Parameters

tileh	The slope to build the bridge on.
axis	The axis of the bridge entrance.

Returns: The foundation required.

Definition at line 114 of file tunnelbridge_cmd.cpp.

References AXIS_X, AXIS_Y, FlatteningFoundation(), FOUNDATION_NONE, HasSlopeHighestCorner(), InclinedFoundation(), SLOPE_FLAT, SLOPE_NE, SLOPE_NW, SLOPE_SE, and SLOPE_SW.

Referenced by CheckBridgeSlope(), DrawRailCatenaryRailway(), DrawTile_TunnelBridge(), GetBridgeHeight(), and HasBridgeFlatRamp().

◆ GetBridgeMiddleAxisBaseOffset()

uint8_t GetBridgeMiddleAxisBaseOffset ( Axis axis )

static

Get bridge sprite table base offset for the middle part of bridge.

Parameters

axis	Axis of bridge.

Returns: Offset for axis.

Definition at line 198 of file tunnelbridge_cmd.cpp.

References AXIS_X.

Referenced by DrawBridgeMiddle().

◆ GetBridgeRampDirectionBaseOffset()

uint8_t GetBridgeRampDirectionBaseOffset ( DiagDirection diagdir )

static

Get bridge sprite table base offset for the ramp part of bridge.

Parameters

diagdir Direction of ramp.

Returns: Offset for direction.

Definition at line 186 of file tunnelbridge_cmd.cpp.

References DIAGDIR_END.

Referenced by DrawTile_TunnelBridge().

◆ GetBridgeRoadCatenary()

void GetBridgeRoadCatenary	(	const RoadTypeInfo *	rti,
		TileIndex	head_tile,
		int	offset,
		bool	head,
		SpriteID &	spr_back,
		SpriteID &	spr_front )

static

Retrieve the sprites required for catenary on a road/tram bridge.

Parameters

	rti	RoadTypeInfo for the road or tram type to get catenary for
	head_tile	Bridge head tile with roadtype information
	offset	Sprite offset identifying flat to sloped bridge tiles
	head	Are we drawing bridge head?
[out]	spr_back	Back catenary sprite to use
[out]	spr_front	Front catenary sprite to use

Definition at line 1154 of file tunnelbridge_cmd.cpp.

References GetCustomRoadSprite(), ROTSG_CATENARY_BACK, ROTSG_CATENARY_FRONT, SPR_TRAMWAY_BASE, TCX_NORMAL, and TCX_ON_BRIDGE.

Referenced by DrawBridgeRoadBits().

◆ GetBridgeSpriteTable()

std::span< const PalSpriteID > GetBridgeSpriteTable	(	BridgeType	bridge_type,
		BridgePieces	piece )

static

Get the sprite table for a rail/road bridge piece.

Parameters

bridge_type	Bridge type.
piece	Bridge piece.

Returns: Sprite table for the bridge piece.

Definition at line 156 of file tunnelbridge_cmd.cpp.

References GetBridgeSpec(), and BridgeSpec::sprite_table.

Referenced by DrawBridgeMiddle(), and DrawTile_TunnelBridge().

◆ GetBridgeSpriteTableBaseOffset()

uint8_t GetBridgeSpriteTableBaseOffset	(	TransportType	transport_type,
		TileIndex	ramp )

static

Get the sprite table transport type base offset for a rail/road bridge.

Parameters

transport_type	Transport type of bridge.
ramp	Tile of bridge ramp.

Returns: Offset for transport type.

Definition at line 172 of file tunnelbridge_cmd.cpp.

References RailTypeInfo::bridge_offset, GetRailType(), GetRailTypeInfo(), TRANSPORT_RAIL, and TRANSPORT_ROAD.

Referenced by DrawBridgeMiddle(), and DrawTile_TunnelBridge().

◆ GetBridgeTilePillarFlags()

BridgePillarFlags GetBridgeTilePillarFlags	(	TileIndex	tile,
		TileIndex	rampnorth,
		TileIndex	rampsouth,
		BridgeType	type,
		TransportType	transport_type )

static

Get pillar information for a bridge middle tile.

Parameters

tile	Tile of bridge middle.
rampnorth	Northern ramp tile of bridge.
rampsouth	Southern ramp tile of bridge.
type	Bridge type.
transport_type	Transport type of bridge.

Returns: Pillar flags for bridge middle.

Definition at line 1594 of file tunnelbridge_cmd.cpp.

References AXIS_X, AXIS_Y, CalcBridgePiece(), BridgeSpec::ctrl_flags, GetBridgeSpec(), GetTunnelBridgeLength(), BridgeSpec::InvalidPillarFlags, BridgeSpec::pillar_flags, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TileX(), and TRANSPORT_WATER.

Referenced by DrawBridgeMiddle().

◆ GetFoundation_TunnelBridge()

Foundation GetFoundation_TunnelBridge	(	TileIndex	tile,
		Slope	tileh )

static

Definition at line 1760 of file tunnelbridge_cmd.cpp.

◆ GetSlopePixelZ_TunnelBridge()

int GetSlopePixelZ_TunnelBridge	(	TileIndex	tile,
		uint	x,
		uint	y,
		bool	ground_vehicle )

static

Definition at line 1729 of file tunnelbridge_cmd.cpp.

◆ GetTileDesc_TunnelBridge()

void GetTileDesc_TunnelBridge	(	TileIndex	tile,
		TileDesc &	td )

static

Definition at line 1765 of file tunnelbridge_cmd.cpp.

◆ GetTileTrackStatus_TunnelBridge()

TrackStatus GetTileTrackStatus_TunnelBridge	(	TileIndex	tile,
		TransportType	mode,
		uint	sub_mode,
		DiagDirection	side )

static

Definition at line 1859 of file tunnelbridge_cmd.cpp.

◆ HasBridgeFlatRamp()

bool HasBridgeFlatRamp	(	Slope	tileh,
		Axis	axis )

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

Parameters

tileh	Slope of the tile under the bridge head
axis	Orientation of bridge

Returns: true iff the track is flat.

Definition at line 130 of file tunnelbridge_cmd.cpp.

References ApplyFoundationToSlope(), GetBridgeFoundation(), and SLOPE_FLAT.

Referenced by DrawTile_TunnelBridge(), and CYapfCostBase::stSlopeCost().

◆ MarkBridgeDirty() [1/2]

void MarkBridgeDirty	(	TileIndex	begin,
		TileIndex	end,
		DiagDirection	direction,
		uint	bridge_height )

Mark bridge tiles dirty.

Note: The bridge does not need to exist, everything is passed via parameters.

Parameters

begin	Start tile.
end	End tile.
direction	Direction from begin to end.
bridge_height	Bridge height level.

Definition at line 63 of file tunnelbridge_cmd.cpp.

References MarkTileDirtyByTile(), TileHeight(), and TileOffsByDiagDir().

Referenced by ClearPathReservation(), CmdBuildBridge(), CmdBuildRoad(), CmdConvertRail(), CmdConvertRoad(), MarkBridgeDirty(), RemoveRoad(), TryReserveRailTrack(), and UnreserveRailTrack().

◆ MarkBridgeDirty() [2/2]

void MarkBridgeDirty ( TileIndex tile )

Mark bridge tiles dirty.

Parameters

tile	Bridge head.

Definition at line 76 of file tunnelbridge_cmd.cpp.

References GetBridgeHeight(), GetOtherTunnelBridgeEnd(), GetTunnelBridgeDirection(), and MarkBridgeDirty().

◆ PrepareToEnterBridge()

template<typename T>

void PrepareToEnterBridge ( T * gv )

static

Helper to prepare the ground vehicle when entering a bridge.

This get called when entering the bridge, at the last frame of travel on the bridge head. Our calling function gets called before UpdateInclination/UpdateZPosition, which normally controls the Z-coordinate. However, in the wormhole of the bridge the vehicle is in a strange state so UpdateInclination does not get called for the wormhole of the bridge and as such the going up/down bits would remain set. As such, this function clears those. In doing so, the call to UpdateInclination will not update the Z-coordinate, so that has to be done here as well.

Parameters

gv	The ground vehicle entering the bridge.

Definition at line 1936 of file tunnelbridge_cmd.cpp.

References ClrBit(), GVF_GOINGDOWN_BIT, GVF_GOINGUP_BIT, and HasBit().

◆ ResetBridges()

void ResetBridges ( )

Reset the data been eventually changed by the grf loaded.

Definition at line 82 of file tunnelbridge_cmd.cpp.

References _bridge.

Referenced by ResetNewGRFData().

◆ TerraformTile_TunnelBridge()

CommandCost TerraformTile_TunnelBridge	(	TileIndex	tile,
		DoCommandFlags	flags,
		int	z_new,
		Slope	tileh_new )

static

Definition at line 2103 of file tunnelbridge_cmd.cpp.

◆ TileLoop_TunnelBridge()

void TileLoop_TunnelBridge ( TileIndex tile )

static

Definition at line 1831 of file tunnelbridge_cmd.cpp.

◆ TunnelBridgeClearCost()

Money TunnelBridgeClearCost	(	TileIndex	tile,
		Price	base_price )

static

Calculate the base cost of clearing a tunnel/bridge per tile.

Parameters

tile	Start tile of the tunnel/bridge.
base_price	The base cost for clearing the tile.

Returns: How much clearing this tunnel/bridge costs per tile.

Definition at line 264 of file tunnelbridge_cmd.cpp.

References ClearAqueduct, GetRailType(), GetTunnelBridgeTransportType(), INVALID_ROADTYPE, RailClearCost(), RoadClearCost(), TRANSPORT_RAIL, TRANSPORT_ROAD, and TRANSPORT_WATER.

Referenced by CmdBuildBridge(), DoClearBridge(), and DoClearTunnel().

◆ VehicleEnter_TunnelBridge()

VehicleEnterTileStates VehicleEnter_TunnelBridge	(	Vehicle *	v,
		TileIndex	tile,
		int	x,
		int	y )

static

Definition at line 1963 of file tunnelbridge_cmd.cpp.

Variable Documentation

◆ _bridge

BridgeSpec _bridge[MAX_BRIDGES]

The specification of all bridges.

Definition at line 48 of file tunnelbridge_cmd.cpp.

Referenced by BridgeChangeInfo(), GetBridgeSpec(), and ResetBridges().

◆ _build_tunnel_endtile

TileIndex _build_tunnel_endtile

The end of a tunnel; as hidden return from the tunnel build command for GUI purposes.

Definition at line 49 of file tunnelbridge_cmd.cpp.

Referenced by CcBuildRailTunnel(), CcBuildRoadTunnel(), CmdBuildTunnel(), DoClearTunnel(), BuildRailToolbarWindow::OnPlacePresize(), and BuildRoadToolbarWindow::OnPlacePresize().

◆ _tile_type_tunnelbridge_procs

const TileTypeProcs _tile_type_tunnelbridge_procs

extern

Initial value:

                                                         = {
  DrawTile_TunnelBridge,           
  GetSlopePixelZ_TunnelBridge,     
  ClearTile_TunnelBridge,          
  nullptr,                            
  GetTileDesc_TunnelBridge,        
  GetTileTrackStatus_TunnelBridge, 
  nullptr,                            
  nullptr,                            
  TileLoop_TunnelBridge,           
  ChangeTileOwner_TunnelBridge,    
  nullptr,                            
  VehicleEnter_TunnelBridge,       
  GetFoundation_TunnelBridge,      
  TerraformTile_TunnelBridge,      
  CheckBuildAbove_TunnelBridge, 
}

Definition at line 61 of file landscape.cpp.

◆ _tunnel_visibility_frame

const uint8_t _tunnel_visibility_frame[DIAGDIR_END] = {12, 8, 8, 12}

extern

Frame when a vehicle should be hidden in a tunnel with a certain direction.

This differs per direction, because of visibility / bounding box issues. Note that direction, in this case, is the direction leading into the tunnel. When entering a tunnel, hide the vehicle when it reaches the given frame. When leaving a tunnel, show the vehicle when it is one frame further to the 'outside', i.e. at (TILE_SIZE-1) - (frame) + 1

Referenced by AfterLoadGame().

◆ BRIDGE_Z_START

const int BRIDGE_Z_START = 3

static

Z position of the bridge sprites relative to bridge height (downwards).

Definition at line 52 of file tunnelbridge_cmd.cpp.

Referenced by DrawBridgeMiddle(), and DrawPillar().

◆ TUNNEL_SOUND_FRAME

const uint8_t TUNNEL_SOUND_FRAME = 1

static

Frame when the 'enter tunnel' sound should be played.

This is the second frame on a tile, so the sound is played shortly after entering the tunnel tile, while the vehicle is still visible.

Definition at line 1951 of file tunnelbridge_cmd.cpp.

Functions

Variables

Detailed Description

Function Documentation

◆ BridgeHasCustomSpriteTable()

◆ CalcBridgeLenCostFactor()

◆ CalcBridgePiece()

◆ ChangeTileOwner_TunnelBridge()

◆ CheckAllowRemoveTunnelBridge()

◆ CheckBridgeAvailability()

◆ CheckBridgeSlope()

◆ CheckBuildAbove()

◆ CheckBuildAbove_TunnelBridge()

◆ ClearTile_TunnelBridge()

◆ CmdBuildBridge()

◆ CmdBuildTunnel()

◆ DoClearBridge()

◆ DoClearTunnel()

◆ DrawBridgeMiddle()

◆ DrawBridgePillars()

◆ DrawBridgeRoadBits()

◆ DrawPillar()

◆ DrawPillarColumn()

◆ DrawTile_TunnelBridge()

◆ GetBridgeFoundation()

◆ GetBridgeMiddleAxisBaseOffset()

◆ GetBridgeRampDirectionBaseOffset()

◆ GetBridgeRoadCatenary()

◆ GetBridgeSpriteTable()

◆ GetBridgeSpriteTableBaseOffset()

◆ GetBridgeTilePillarFlags()

◆ GetFoundation_TunnelBridge()

◆ GetSlopePixelZ_TunnelBridge()

◆ GetTileDesc_TunnelBridge()

◆ GetTileTrackStatus_TunnelBridge()

◆ HasBridgeFlatRamp()

◆ MarkBridgeDirty() [1/2]

◆ MarkBridgeDirty() [2/2]

◆ PrepareToEnterBridge()

◆ ResetBridges()

◆ TerraformTile_TunnelBridge()

◆ TileLoop_TunnelBridge()

◆ TunnelBridgeClearCost()

◆ VehicleEnter_TunnelBridge()

Variable Documentation

◆ _bridge

◆ _build_tunnel_endtile

◆ _tile_type_tunnelbridge_procs

◆ _tunnel_visibility_frame

◆ BRIDGE_Z_START

◆ TUNNEL_SOUND_FRAME