rail_cmd.cpp File Reference

Handling of rail tiles. More...

#include "stdafx.h"
#include "viewport_func.h"
#include "command_func.h"
#include "depot_base.h"
#include "pathfinder/yapf/yapf_cache.h"
#include "newgrf_debug.h"
#include "newgrf_railtype.h"
#include "train.h"
#include "autoslope.h"
#include "water.h"
#include "tunnelbridge_map.h"
#include "vehicle_func.h"
#include "sound_func.h"
#include "tunnelbridge.h"
#include "elrail_func.h"
#include "town.h"
#include "pbs.h"
#include "company_base.h"
#include "core/backup_type.hpp"
#include "core/container_func.hpp"
#include "timer/timer_game_calendar.h"
#include "strings_func.h"
#include "company_gui.h"
#include "object_map.h"
#include "rail_cmd.h"
#include "landscape_cmd.h"
#include "table/strings.h"
#include "table/railtypes.h"
#include "table/track_land.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	FenceOffset
	Offsets for drawing fences. More...

Typedefs
typedef std::vector< Train * >	TrainList
	Helper type for lists/vectors of trains.

Enumerations
enum	SignalOffsets {   SIGNAL_TO_SOUTHWEST , SIGNAL_TO_NORTHEAST , SIGNAL_TO_SOUTHEAST , SIGNAL_TO_NORTHWEST ,   SIGNAL_TO_EAST , SIGNAL_TO_WEST , SIGNAL_TO_SOUTH , SIGNAL_TO_NORTH }
	Enum holding the signal offset in the sprite sheet according to the side it is representing. More...

Functions
void	ResetRailTypes ()
	Reset all rail type information to its default values.
void	ResolveRailTypeGUISprites (RailTypeInfo *rti)
static bool	CompareRailTypes (const RailType &first, const RailType &second)
	Compare railtypes based on their sorting order.
void	InitRailTypes ()
	Resolve sprites of custom rail types.
RailType	AllocateRailType (RailTypeLabel label)
	Allocate a new rail type label.
static CommandCost	EnsureNoTrainOnTrack (TileIndex tile, Track track)
	Tests if a vehicle interacts with the specified track.
static CommandCost	CheckTrackCombination (TileIndex tile, TrackBits to_build)
	Check that the new track bits may be built.
Foundation	GetRailFoundation (Slope tileh, TrackBits bits)
	Checks if a track combination is valid on a specific slope and returns the needed foundation.
static CommandCost	CheckRailSlope (Slope tileh, TrackBits rail_bits, TrackBits existing, TileIndex tile)
	Tests if a track can be build on a tile.
static bool	ValParamTrackOrientation (Track track)
CommandCost	CmdBuildSingleRail (DoCommandFlags flags, TileIndex tile, RailType railtype, Track track, bool auto_remove_signals)
	Build a single piece of rail.
CommandCost	CmdRemoveSingleRail (DoCommandFlags flags, TileIndex tile, Track track)
	Remove a single piece of track.
bool	FloodHalftile (TileIndex t)
	Called from water_cmd if a non-flat rail-tile gets flooded and should be converted to shore.
static Trackdir	GetOtherTrackdir (Trackdir trackdir)
	Get the other Trackdir for a non-diagonal Trackdir.
static CommandCost	ValidateAutoDrag (Trackdir *trackdir, TileIndex start, TileIndex end)
static CommandCost	CmdRailTrackHelper (DoCommandFlags flags, TileIndex tile, TileIndex end_tile, RailType railtype, Track track, bool remove, bool auto_remove_signals, bool fail_on_obstacle)
	Build or remove a stretch of railroad tracks.
CommandCost	CmdBuildRailroadTrack (DoCommandFlags flags, TileIndex end_tile, TileIndex start_tile, RailType railtype, Track track, bool auto_remove_signals, bool fail_on_obstacle)
	Build rail on a stretch of track.
CommandCost	CmdRemoveRailroadTrack (DoCommandFlags flags, TileIndex end_tile, TileIndex start_tile, Track track)
	Build rail on a stretch of track.
CommandCost	CmdBuildTrainDepot (DoCommandFlags flags, TileIndex tile, RailType railtype, DiagDirection dir)
	Build a train depot.
CommandCost	CmdBuildSingleSignal (DoCommandFlags flags, TileIndex tile, Track track, SignalType sigtype, SignalVariant sigvar, bool convert_signal, bool skip_existing_signals, bool ctrl_pressed, SignalType cycle_start, SignalType cycle_stop, uint8_t num_dir_cycle, uint8_t signals_copy)
	Build signals, alternate between double/single, signal/semaphore, pre/exit/combo-signals, and what-else not.
static bool	AdvanceSignalAutoFill (TileIndex &tile, Trackdir &trackdir, bool remove)
static CommandCost	CmdSignalTrackHelper (DoCommandFlags flags, TileIndex tile, TileIndex end_tile, Track track, SignalType sigtype, SignalVariant sigvar, bool mode, bool remove, bool autofill, bool minimise_gaps, int signal_density)
	Build many signals by dragging; AutoSignals.
CommandCost	CmdBuildSignalTrack (DoCommandFlags flags, TileIndex tile, TileIndex end_tile, Track track, SignalType sigtype, SignalVariant sigvar, bool mode, bool autofill, bool minimise_gaps, uint8_t signal_density)
	Build signals on a stretch of track.
CommandCost	CmdRemoveSingleSignal (DoCommandFlags flags, TileIndex tile, Track track)
	Remove signals.
CommandCost	CmdRemoveSignalTrack (DoCommandFlags flags, TileIndex tile, TileIndex end_tile, Track track, bool autofill)
	Remove signals on a stretch of track.
CommandCost	CmdConvertRail (DoCommandFlags flags, TileIndex tile, TileIndex area_start, RailType totype, bool diagonal)
	Convert one rail type to the other.
static CommandCost	RemoveTrainDepot (TileIndex tile, DoCommandFlags flags)
static CommandCost	ClearTile_Rail (TileIndex tile, DoCommandFlags flags)
	Tile callback function signature for clearing a tile.
static uint	GetSafeSlopeZ (uint x, uint y, Track track)
	Get surface height in point (x,y) On tiles with halftile foundations move (x,y) to a safe point wrt.
static bool	IsTrainSignalSideRight ()
	Helper to determine whether the train signals are to be placed on the right side.
static void	DrawSingleSignal (TileIndex tile, const RailTypeInfo *rti, Track track, SignalState condition, SignalOffsets image, uint pos)
static void	DrawTrackFence (const TileInfo *ti, const PalSpriteID &psid, uint num_sprites, RailFenceOffset rfo)
	Draw a track fence.
static void	DrawTrackFence_NW (const TileInfo *ti, const PalSpriteID &psid, uint num_sprites)
	Draw fence at NW border matching the tile slope.
static void	DrawTrackFence_SE (const TileInfo *ti, const PalSpriteID &psid, uint num_sprites)
	Draw fence at SE border matching the tile slope.
static void	DrawTrackFence_NE (const TileInfo *ti, const PalSpriteID &psid, uint num_sprites)
	Draw fence at NE border matching the tile slope.
static void	DrawTrackFence_SW (const TileInfo *ti, const PalSpriteID &psid, uint num_sprites)
	Draw fence at SW border matching the tile slope.
static void	DrawTrackDetails (const TileInfo *ti, const RailTypeInfo *rti, PaletteID pal)
	Draw track fences.
static void	DrawTrackSprite (SpriteID sprite, PaletteID pal, const TileInfo *ti, Slope s)
static void	DrawTrackBitsOverlay (TileInfo *ti, TrackBits track, const RailTypeInfo *rti)
static int	GetJunctionGroundSpriteOffset (TrackBits track)
	Returns which of the 5 junction-'Rail underlays' to use for the given track bits.
static void	DrawTrackBits (TileInfo *ti, TrackBits track)
	Draw ground sprite and track bits.
static void	DrawSignals (TileIndex tile, TrackBits rails, const RailTypeInfo *rti)
static void	DrawTile_Rail (TileInfo *ti)
	Tile callback function signature for drawing a tile and its contents to the screen.
void	DrawTrainDepotSprite (int x, int y, DiagDirection dir, RailType railtype)
	Draw train depot sprite in the UI.
static int	GetSlopePixelZ_Rail (TileIndex tile, uint x, uint y, bool ground_vehicle)
	Tile callback function signature for obtaining the world Z coordinate of a given point of a tile.
static Foundation	GetFoundation_Rail (TileIndex tile, Slope tileh)
	Tile callback function signature for getting the foundation of a tile.
static void	TileLoop_Rail (TileIndex tile)
	Tile callback function signature for running periodic tile updates.
static TrackStatus	GetTileTrackStatus_Rail (TileIndex tile, TransportType mode, RoadTramType sub_mode, DiagDirection side)
	Tile callback function signature for getting the possible tracks that can be taken on a given tile by a given transport.
static bool	ClickTile_Rail (TileIndex tile)
	Tile callback function signature for clicking a tile.
static void	GetTileDesc_Rail (TileIndex tile, TileDesc &td)
	Tile callback function signature for obtaining a tile description.
static void	ChangeTileOwner_Rail (TileIndex tile, Owner old_owner, Owner new_owner)
	Tile callback function signature for changing the owner of a tile.
int	TicksToLeaveDepot (const Train *v)
	Compute number of ticks when next wagon will leave a depot.
static VehicleEnterTileStates	VehicleEnterTile_Rail (Vehicle *v, TileIndex tile, int x, int y)
	Tile callback function for a vehicle entering a tile.
static CommandCost	TestAutoslopeOnRailTile (TileIndex tile, DoCommandFlags flags, int z_old, Slope tileh_old, int z_new, Slope tileh_new, TrackBits rail_bits)
	Tests if autoslope is allowed.
static CommandCost	TerraformTile_Rail (TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new)
	Tile callback function signature of the terraforming callback.
static CommandCost	CheckBuildAbove_Rail (TileIndex tile, DoCommandFlags flags, Axis axis, int height)
	Tile callback function signature to test if a bridge can be built above a tile.

Variables
RailTypeInfo	_railtypes [RAILTYPE_END]
std::vector< RailType >	_sorted_railtypes
	Sorted list of rail types.
RailTypes	_railtypes_hidden_mask
static const uint8_t	_track_sloped_sprites [14]
static const TrackBits	_valid_tracks_without_foundation [15]
	Valid TrackBits on a specific (non-steep)-slope without foundation.
static const TrackBits	_valid_tracks_on_leveled_foundation [15]
	Valid TrackBits on a specific (non-steep)-slope with leveled foundation.
static const TrackdirIndexArray< TileIndexDiffC >	_trackdelta
	Tile deltas for each trackdir.
static const FenceOffset	_fence_offsets []
	Offsets for drawing fences.
static const int	INF = 1000
	Big number compared to tilesprite size.
static constexpr CornerIndexArray< SubSprite >	_halftile_sub_sprite
	SubSprite for drawing the track halftile of 'three-corners-raised'-sloped rail sprites.
static constexpr DiagDirectionIndexArray< Coord2D< uint8_t > >	_fractcoords_behind
	Coordinates to detect when a train is approaching a depot from behind for each depot direction.
static constexpr DiagDirectionIndexArray< Coord2D< uint8_t > >	_fractcoords_enter
	Coordinates where a train should enter a depot for each depot direction.
static constexpr DiagDirectionIndexArray< Coord2D< int8_t > >	_deltacoord_leaveoffset
	Offsets (to be multiplied by length) from the depot enter coordinates where a train should appear when exiting a depot for each depot direction.
const TileTypeProcs	_tile_type_rail_procs
	TileTypeProcs definitions for TileType::Rail tiles.

Detailed Description

Handling of rail tiles.

Definition in file rail_cmd.cpp.

Typedef Documentation

TrainList

typedef std::vector<Train *> TrainList

Helper type for lists/vectors of trains.

Definition at line 44 of file rail_cmd.cpp.

Enumeration Type Documentation

SignalOffsets

enum SignalOffsets

Enum holding the signal offset in the sprite sheet according to the side it is representing.

Definition at line 51 of file rail_cmd.cpp.

Function Documentation

AdvanceSignalAutoFill()

bool AdvanceSignalAutoFill ( TileIndex & tile, Trackdir & trackdir, bool remove )

static

Definition at line 1203 of file rail_cmd.cpp.

AllocateRailType()

RailType AllocateRailType

(

RailTypeLabel

label

)

Allocate a new rail type label.

Parameters

label

The label of the rail type.

Returns

The allocated type, or INVALID_RAILTYPE upon failures.

Definition at line 150 of file rail_cmd.cpp.

References _original_railtypes, RailTypeInfo::alternate_labels, RailTypeInfo::compatible_railtypes, RailTypeInfo::Index(), RailTypeInfo::introduces_railtypes, INVALID_RAILTYPE, RailTypeInfo::label, RailTypeInfo::powered_railtypes, RAILTYPE_RAIL, and RailTypeInfo::sorting_order.

ChangeTileOwner_Rail()

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

static

Tile callback function signature for changing the owner of a tile.

Parameters

tile	The tile to process.
old_owner	The owner to replace.
new_owner	The owner to replace with.

See also

ChangeTileOwner

Definition at line 2938 of file rail_cmd.cpp.

References Bankrupt, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Count(), CountBits(), Execute, GetPresentSignals(), GetRailType(), GetTrackBits(), HasSignals(), INVALID_OWNER, IsPlainRail(), IsTileOwner(), SetTileOwner(), and TracksOverlap().

CheckBuildAbove_Rail()

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

static

Tile callback function signature to test if a bridge can be built above a tile.

Parameters

tile	The involved tile.
flags	Command flags passed to the build command.
axis	Axis of bridge being built.
height	Absolute height of bridge platform.

Returns

Error code or extra cost for building bridge above the tile.

See also

CheckBuildAbove

Definition at line 3175 of file rail_cmd.cpp.

References IsPlainRail().

CheckRailSlope()

CommandCost CheckRailSlope ( Slope tileh, TrackBits rail_bits, TrackBits existing, TileIndex tile )

static

Tests if a track can be build on a tile.

Parameters

tileh	Tile slope.
rail_bits	Tracks to build.
existing	Tracks already built.
tile	Tile (used for water test)

Returns

Error message or cost for foundation building.

Definition at line 390 of file rail_cmd.cpp.

References _price, _settings_game, _valid_tracks_on_leveled_foundation, Any, BuildFoundation, Construction, GetFloodingBehaviour(), GetRailFoundation(), Invalid, IsSteepSlope(), and None.

Referenced by CmdBuildSingleRail(), and TestAutoslopeOnRailTile().

CheckTrackCombination()

CommandCost CheckTrackCombination ( TileIndex tile, TrackBits to_build )

static

Check that the new track bits may be built.

Parameters

tile	Tile to build on.
to_build	New track bits.

Returns

Succeeded or failed command.

Definition at line 239 of file rail_cmd.cpp.

References GetTrackBits(), and IsPlainRail().

Referenced by CmdBuildSingleRail().

ClearTile_Rail()

CommandCost ClearTile_Rail ( TileIndex tile, DoCommandFlags flags )

static

Tile callback function signature for clearing a tile.

Parameters

tile	The tile to clear.
flags	The command flags.

Returns

The cost or error.

See also

ClearTile

Definition at line 1799 of file rail_cmd.cpp.

References _current_company, _price, CommandCost::AddCost(), Auto, Bankrupt, ClearWater, CMD_ERROR, Construction, Depot, EnsureNoVehicleOnGround(), Execute, CommandCost::Failed(), CommandCost::GetCost(), GetRailGroundType(), GetRailTileType(), GetTileSlope(), GetTrackBits(), HalfTileWater, IsPlainRail(), IsSlopeWithOneCornerRaised(), IsTileOwner(), Normal, Signals, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

ClickTile_Rail()

bool ClickTile_Rail ( TileIndex tile )

static

Tile callback function signature for clicking a tile.

Parameters

tile	The tile that was clicked.

Returns

Whether any action was taken.

See also

ClickTile

Definition at line 2835 of file rail_cmd.cpp.

References IsRailDepot(), ShowDepotWindow(), and Train.

CmdBuildRailroadTrack()

CommandCost CmdBuildRailroadTrack	(	DoCommandFlags	flags,
		TileIndex	end_tile,
		TileIndex	start_tile,
		RailType	railtype,
		Track	track,
		bool	auto_remove_signals,
		bool	fail_on_obstacle )

Build rail on a stretch of track.

Stub for the unified rail builder/remover

Parameters

flags	operation to perform
end_tile	end tile of drag
start_tile	start tile of drag
railtype	railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev), only used for building
track	track-orientation
auto_remove_signals	false = build up to an obstacle, true = fail if an obstacle is found (used for AIs).
fail_on_obstacle	false = error on signal in the way, true = auto remove signals when in the way

Returns

The cost of this operation or an error.

See also

CmdRailTrackHelper

Definition at line 941 of file rail_cmd.cpp.

References CmdRailTrackHelper().

CmdBuildSignalTrack()

CommandCost CmdBuildSignalTrack	(	DoCommandFlags	flags,
		TileIndex	tile,
		TileIndex	end_tile,
		Track	track,
		SignalType	sigtype,
		SignalVariant	sigvar,
		bool	mode,
		bool	autofill,
		bool	minimise_gaps,
		uint8_t	signal_density )

Build signals on a stretch of track.

Stub for the unified signal builder/remover

Parameters

flags	operation to perform
tile	start tile of drag
end_tile	end tile of drag
track	track-orientation
sigtype	default signal type
sigvar	signal variant to build
mode	true = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
autofill	fill beyond selected stretch?
minimise_gaps	false = keep fixed distance, true = minimise gaps between signals
signal_density	user defined signals_density

Returns

the cost of this operation or an error

See also

CmdSignalTrackHelper

Definition at line 1453 of file rail_cmd.cpp.

References CmdSignalTrackHelper().

CmdBuildSingleRail()

CommandCost CmdBuildSingleRail	(	DoCommandFlags	flags,
		TileIndex	tile,
		RailType	railtype,
		Track	track,
		bool	auto_remove_signals )

Build a single piece of rail.

Parameters

flags	operation to perform
tile	tile to build on
railtype	railtype of being built piece (normal, mono, maglev)
track	track-orientation
auto_remove_signals	false = error on signal in the way, true = auto remove signals when in the way

Returns

the cost of this operation or an error

Definition at line 424 of file rail_cmd.cpp.

References _current_company, _price, _settings_game, CommandCost::AddCost(), AddTrackToSignalBuffer(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), Any, Barren, CheckForDockingTile(), CheckOwnership(), CheckRailSlope(), CheckTileOwnership(), CheckTrackCombination(), ClearRough, ClearWater, CMD_ERROR, Construction, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Count(), Count, DirtyCompanyInfrastructureWindows(), EnsureNoTrainOnTrack(), EnsureNoVehicleOnGround(), Execute, CommandCost::Failed(), CommandCost::GetCost(), GetCrossingRailTrack(), GetCrossingRoadAxis(), GetDisallowedRoadDirections(), GetRailType(), GetRoadBits(), GetRoadOwner(), GetRoadTypeRoad(), GetRoadTypeTram(), GetTileOwner(), GetTileSlope(), GetTileType(), GetTownIndex(), GetTrackBits(), HalfTileWater, HasBit(), HasPowerOnRail(), HasRoadWorks(), HasSignalOnTrack(), HasSignals(), INVALID_ROADTYPE, IsCompatibleRail(), IsLevelCrossing(), IsNormalRoad(), IsPlainRail(), IsPossibleDockingTile(), IsSlopeWithOneCornerRaised(), IsTileType(), LEVELCROSSING_TRACKBIT_FACTOR, MakeRailNormal(), MakeRoadCrossing(), MarkDirtyAdjacentLevelCrossingTiles(), MarkTileDirtyByTile(), OWNER_DEITY, RailBuildCost(), RailNoLevelCrossings(), Railway, Road, ROAD_X, ROAD_Y, RoadBuildCost(), RoadNoLevelCrossing(), SetRailGroundType(), SetTrackBits(), CommandCost::Succeeded(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TracksOverlap(), Tram, UpdateLevelCrossing(), VALID_LEVEL_CROSSING_SLOPES, ValParamRailType(), Water, X, Y, and YapfNotifyTrackLayoutChange().

CmdBuildSingleSignal()

CommandCost CmdBuildSingleSignal	(	DoCommandFlags	flags,
		TileIndex	tile,
		Track	track,
		SignalType	sigtype,
		SignalVariant	sigvar,
		bool	convert_signal,
		bool	skip_existing_signals,
		bool	ctrl_pressed,
		SignalType	cycle_start,
		SignalType	cycle_stop,
		uint8_t	num_dir_cycle,
		uint8_t	signals_copy )

Build signals, alternate between double/single, signal/semaphore, pre/exit/combo-signals, and what-else not.

If the rail piece does not have any signals, signal cycling is ignored

Parameters

flags	operation to perform
tile	tile where to build the signals
track	track-orientation
sigtype	type of the signal
sigvar	variant of signal type (normal/semaphore)
ctrl_pressed	true = override signal/semaphore, or pre/exit/combo signal or toggle variant (CTRL-toggle)
convert_signal	convert the present signal type and variant
cycle_start	start cycle from this signal type
cycle_stop	wrap around after this signal type
num_dir_cycle	cycle the signal direction this many times
skip_existing_signals	true = don't modify an existing signal but don't fail either, false = always set new signal type
signals_copy	used for CmdBuildManySignals() to copy direction of first signal

Returns

the cost of this operation or an error

Definition at line 1055 of file rail_cmd.cpp.

References _current_company, _price, _settings_game, AddTrackToSignalBuffer(), BuildSignals, CheckTileOwnership(), ClearSignals, CMD_ERROR, Construction, CountBits(), Vehicle::cur_speed, Vehicle::current_order, CycleSignalSide(), Depot, DirtyCompanyInfrastructureWindows(), Electric, End, EnsureNoVehicleOnGround(), Execute, CommandCost::Failed(), FreeTrainTrackReservation(), SpecializedVehicle< T, Type >::GetMovingFront(), GetPresentSignals(), GetRailReservationTrackBits(), GetSignalStates(), GetSignalType(), GetSignalVariant(), GetTileOwner(), GetTrackBits(), GetTrainForReservation(), Train::GetVehicleTrackdir(), HasReservedTracks(), HasSignalOnTrack(), HasSignals(), HasTrack(), IsPbsSignal(), IsPlainRailTile(), IsSafeWaitingPosition(), Order::IsType(), KillFirstBit(), MarkTileDirtyByTile(), Semaphore, SetHasSignals(), SetPresentSignals(), SetSignalStates(), SetSignalType(), SetSignalVariant(), SignalOnTrack(), Stopped, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), Vehicle::tile, to_underlying(), Train::track, TracksOverlap(), TryPathReserve(), Vehicle::vehstatus, and YapfNotifyTrackLayoutChange().

CmdBuildTrainDepot()

CommandCost CmdBuildTrainDepot	(	DoCommandFlags	flags,
		TileIndex	tile,
		RailType	railtype,
		DiagDirection	dir )

Build a train depot.

Parameters

flags	operation to perform
tile	position of the train depot
railtype	rail type
dir	entrance direction

Returns

the cost of this operation or an error

Definition at line 969 of file rail_cmd.cpp.

References _current_company, _price, _settings_game, CommandCost::AddCost(), AddSideToSignalBuffer(), BuildDepotTrain, BuildFoundation, CanBuildDepotByTileh(), CheckTileOwnership(), CMD_ERROR, Construction, DiagDirToDiagTrack(), DirtyCompanyInfrastructureWindows(), EnsureNoVehicleOnGround(), Execute, CommandCost::Failed(), GetRailDepotDirection(), GetRailType(), GetTileSlope(), Invalid, IsBridgeAbove(), IsRailDepotTile(), IsValidDiagDirection(), MakeDefaultName(), MakeRailDepot(), MarkTileDirtyByTile(), RailBuildCost(), SetRailDepotExitDirection(), SLOPE_FLAT, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), ValParamRailType(), and YapfNotifyTrackLayoutChange().

CmdConvertRail()

CommandCost CmdConvertRail	(	DoCommandFlags	flags,
		TileIndex	tile,
		TileIndex	area_start,
		RailType	totype,
		bool	diagonal )

Convert one rail type to the other.

You can convert normal rail to monorail/maglev easily or vice-versa.

Parameters

flags	operation to perform
tile	end tile of rail conversion drag
area_start	start tile of drag
totype	new railtype to convert to.
diagonal	build diagonally or not.

Returns

the cost of this operation or an error

Definition at line 1546 of file rail_cmd.cpp.

References _settings_game, CommandCost::AddCost(), CCF_TRACK, CheckTileOwnership(), CMD_ERROR, Construction, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Count(), Count, TileIterator::Create(), Depot, DiagDirToDiagTrack(), DirtyCompanyInfrastructureWindows(), EnsureNoTrainOnTrackBits(), EnsureNoVehicleOnGround(), Execute, CommandCost::Failed(), FreeTrainTrackReservation(), SpecializedVehicle< Train, Type >::From(), GetCrossingRailTrack(), GetOtherTunnelBridgeEnd(), GetRailDepotTrack(), GetRailStationTrack(), GetRailTileType(), GetRailType(), GetReservedTrackbits(), GetTileOwner(), GetTileType(), GetTrackBits(), GetTrainForReservation(), GetTunnelBridgeDirection(), GetTunnelBridgeLength(), GetTunnelBridgeTransportType(), HasPowerOnRail(), HasStationRail(), HasTunnelBridgeReservation(), include(), Company::infrastructure, INVALID_TILE, InvalidateWindowData(), IsBridge(), IsCompatibleRail(), IsLevelCrossing(), IsLevelCrossingTile(), IsPlainRailTile(), IsRailStationTile(), IsStationTileBlocked(), LEVELCROSSING_TRACKBIT_FACTOR, CommandCost::MakeError(), MarkBridgeDirty(), MarkTileDirtyByTile(), CompanyInfrastructure::rail, RailConvertCost(), RailNoLevelCrossings(), RAILTYPE_ELECTRIC, RAILTYPE_RAIL, Train::railtypes, Railway, Road, SetRailType(), Map::Size(), Station, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TracksOverlap(), Train, TRANSPORT_RAIL, TryPathReserve(), TunnelBridge, TUNNELBRIDGE_TRACKBIT_FACTOR, TunnelBridgeIsFree(), ValParamRailType(), and YapfNotifyTrackLayoutChange().

CmdRailTrackHelper()

CommandCost CmdRailTrackHelper ( DoCommandFlags flags, TileIndex tile, TileIndex end_tile, RailType railtype, Track track, bool remove, bool auto_remove_signals, bool fail_on_obstacle )

static

Build or remove a stretch of railroad tracks.

Parameters

flags	operation to perform
tile	start tile of drag
end_tile	end tile of drag
railtype	railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev), only used for building
track	track-orientation
remove	remove tracks?
auto_remove_signals	false = error on signal in the way, true = auto remove signals when in the way, only used for building
fail_on_obstacle	false = build starting from and up to an obstacle, true = fail if an obstacle is found (used for AIs)

Returns

the cost of this operation or an error

Definition at line 884 of file rail_cmd.cpp.

References _trackdelta, CommandCost::AddCost(), CMD_ERROR, Construction, CommandCost::Failed(), CommandCost::GetCost(), CommandCost::GetErrorMessage(), GetOtherTrackdir(), IsDiagonalTrackdir(), Map::Size(), ToTileIndexDiff(), TrackdirToTrack(), TrackToTrackdir(), and ValParamRailType().

Referenced by CmdBuildRailroadTrack(), and CmdRemoveRailroadTrack().

CmdRemoveRailroadTrack()

CommandCost CmdRemoveRailroadTrack	(	DoCommandFlags	flags,
		TileIndex	end_tile,
		TileIndex	start_tile,
		Track	track )

Build rail on a stretch of track.

Stub for the unified rail builder/remover

Parameters

flags	operation to perform
end_tile	end tile of drag
start_tile	start tile of drag
track	track-orientation

Returns

the cost of this operation or an error

See also

CmdRailTrackHelper

Definition at line 956 of file rail_cmd.cpp.

References CmdRailTrackHelper(), and INVALID_RAILTYPE.

CmdRemoveSignalTrack()

CommandCost CmdRemoveSignalTrack	(	DoCommandFlags	flags,
		TileIndex	tile,
		TileIndex	end_tile,
		Track	track,
		bool	autofill )

Remove signals on a stretch of track.

Stub for the unified signal builder/remover

Parameters

flags	operation to perform
tile	start tile of drag
end_tile	end tile of drag
track	track-orientation
autofill	fill beyond selected stretch?

Returns

the cost of this operation or an error

See also

CmdSignalTrackHelper

Definition at line 1531 of file rail_cmd.cpp.

References Block, CmdSignalTrackHelper(), and Electric.

CmdRemoveSingleRail()

CommandCost CmdRemoveSingleRail	(	DoCommandFlags	flags,
		TileIndex	tile,
		Track	track )

Remove a single piece of track.

Parameters

flags	operation to perform
tile	tile to remove track from
track	rail orientation

Returns

the cost of this operation or an error

Definition at line 613 of file rail_cmd.cpp.

References _current_company, CommandCost::AddCost(), AddTrackToSignalBuffer(), Bankrupt, CheckTileOwnership(), CMD_ERROR, Construction, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Count(), DeleteNewGRFInspectWindow(), DirtyCompanyInfrastructureWindows(), EnsureNoTrainOnTrack(), EnsureNoVehicleOnGround(), Execute, CommandCost::Failed(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Flip(), FreeTrainTrackReservation(), GetCrossingRailTrack(), GetCrossingRoadAxis(), GetCrossingRoadBits(), GetRailGroundType(), GetRailReservationTrackBits(), GetRailType(), GetRoadOwner(), GetRoadTypeRoad(), GetRoadTypeTram(), GetTileOwner(), GetTileSlope(), GetTileType(), GetTownIndex(), GetTrackBits(), GetTrainForReservation(), HalfTileWater, HasReservedTracks(), HasSignalOnTrack(), INVALID_OWNER, IsDockingTile(), IsLevelCrossing(), IsPlainRail(), IsSlopeWithOneCornerRaised(), LEVELCROSSING_TRACKBIT_FACTOR, MakeRoadNormal(), MakeShore(), MarkTileDirtyByTile(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::None(), OWNER_WATER, RailClearCost(), RailTypes, Railway, Road, SetDockingTile(), SetTrackBits(), SetTrackReservation(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TRACK_BIT_CROSS, TracksOverlap(), Tram, TryPathReserve(), UpdateAdjacentLevelCrossingTilesOnLevelCrossingRemoval(), X, Y, and YapfNotifyTrackLayoutChange().

CmdRemoveSingleSignal()

CommandCost CmdRemoveSingleSignal	(	DoCommandFlags	flags,
		TileIndex	tile,
		Track	track )

Remove signals.

Parameters

flags	operation to perform
tile	coordinates where signal is being deleted from
track	track-orientation

Returns

the cost of this operation or an error

Definition at line 1465 of file rail_cmd.cpp.

References _current_company, _price, AddTrackToSignalBuffer(), CheckTileOwnership(), ClearSignals, Construction, CountBits(), DirtyCompanyInfrastructureWindows(), Electric, Execute, CommandCost::Failed(), GetPresentSignals(), GetReservedTrackbits(), GetSignalType(), GetTileOwner(), GetTrainForReservation(), HasReservedTracks(), HasSignalOnTrack(), HasSignalOnTrackdir(), HasTrack(), Invalid, IsPbsSignal(), IsPlainRailTile(), MarkTileDirtyByTile(), OWNER_WATER, ReverseTrackdir(), SetHasSignals(), SetPresentSignals(), SetSignalStates(), SetSignalVariant(), SignalOnTrack(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TileAddByDiagDir(), TrackBitsToTrack(), TrackdirBitsToTrackBits(), TrackdirReachesTrackdirs(), TrackdirToExitdir(), TrackToTrackdir(), TryPathReserve(), and YapfNotifyTrackLayoutChange().

CmdSignalTrackHelper()

CommandCost CmdSignalTrackHelper ( DoCommandFlags flags, TileIndex tile, TileIndex end_tile, Track track, SignalType sigtype, SignalVariant sigvar, bool mode, bool remove, bool autofill, bool minimise_gaps, int signal_density )

static

Build many signals by dragging; AutoSignals.

Parameters

flags	operation to perform
tile	start tile of drag
end_tile	end tile of drag
track	track-orientation
sigtype	default signal type
sigvar	signal variant to build
mode	true = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
remove	remove signals?
autofill	fill beyond selected stretch?
minimise_gaps	false = keep fixed distance, true = minimise gaps between signals
signal_density	user defined signals_density

Returns

the cost of this operation or an error

Definition at line 1262 of file rail_cmd.cpp.

References _trackdelta, CommandCost::AddCost(), Block, CMD_ERROR, Construction, End, Entry, Execute, Exit, CommandCost::Failed(), CommandCost::GetCost(), CommandCost::GetErrorMessage(), GetOtherTrackdir(), GetOtherTunnelBridgeEnd(), GetPresentSignals(), GetSignalType(), GetSignalVariant(), GetTileType(), GetTunnelBridgeLength(), HasBit(), HasSignalOnTrack(), HasTrack(), Invalid, INVALID_STRING_ID, INVALID_TILE, IsDiagonalTrackdir(), IsPbsSignal(), IsPlainRailTile(), Railway, Road, SetBit(), SignalAgainstTrackdir(), SignalAlongTrackdir(), SignalOnTrack(), Map::Size(), CommandCost::Succeeded(), TILE_AXIAL_DISTANCE, TILE_CORNER_DISTANCE, ToTileIndexDiff(), TrackdirToTrack(), TrackToTrackdir(), and TunnelBridge.

Referenced by CmdBuildSignalTrack(), and CmdRemoveSignalTrack().

CompareRailTypes()

bool CompareRailTypes ( const RailType & first, const RailType & second )

static

Compare railtypes based on their sorting order.

Parameters

first	The railtype to compare to.
second	The railtype to compare.

Returns

True iff the first should be sorted before the second.

Definition at line 122 of file rail_cmd.cpp.

References GetRailTypeInfo(), and RailTypeInfo::sorting_order.

Referenced by InitRailTypes().

DrawSignals()

void DrawSignals ( TileIndex tile, TrackBits rails, const RailTypeInfo * rti )

static

Definition at line 2427 of file rail_cmd.cpp.

DrawSingleSignal()

void DrawSingleSignal ( TileIndex tile, const RailTypeInfo * rti, Track track, SignalState condition, SignalOffsets image, uint pos )

static

Definition at line 1890 of file rail_cmd.cpp.

DrawTile_Rail()

void DrawTile_Rail ( TileInfo * ti )

static

Tile callback function signature for drawing a tile and its contents to the screen.

Parameters

ti	Information about the tile to draw

Definition at line 2462 of file rail_cmd.cpp.

References _depot_gfx_table, _depot_invisible_gfx_table, _display_opt, _settings_client, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), RailTypeInfo::base_sprites, Buildings, Depot, DrawBridgeMiddle(), DrawFoundation(), DrawGroundSprite(), DrawRailCatenary(), DrawRailTileSeq(), DrawTrackBits(), DrawTrackDetails(), EdgeNE, EdgeNW, EdgeSE, EdgeSW, FullDetail, GetCompanyPalette(), GetCustomRailSprite(), GetRailDepotDirection(), GetRailType(), GetRailTypeInfo(), RailTypeInfo::GetRailtypeSpriteOffset(), GetTileOwner(), GetTrackBits(), Ground, DrawTileSprites::ground, GroundSpritePaletteTransform(), HasDepotReservation(), HasRailCatenaryDrawn(), HasSignals(), IsBridgeAbove(), IsInvisibilitySet(), IsPlainRail(), IsSnowOrDesertRailGround(), Leveled, Menu, NE, NW, Overlay, PALETTE_CRASH, RTO_X, RTO_Y, SE, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), RailTypeInfo::single_x, RailTypeInfo::single_y, SLOPE_FLAT, RailTypeInfo::snow_offset, PalSpriteID::sprite, SW, TileInfo::tile, TileInfo::tileh, TRACK_BIT_3WAY_NE, TRACK_BIT_3WAY_NW, TRACK_BIT_3WAY_SE, and TRACK_BIT_3WAY_SW.

DrawTrackBits()

void DrawTrackBits ( TileInfo * ti, TrackBits track )

static

Draw ground sprite and track bits.

Parameters

ti	TileInfo
track	TrackBits to draw

Definition at line 2280 of file rail_cmd.cpp.

References _halftile_sub_sprite, _settings_client, Barren, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), RailTypeInfo::base_sprites, ComplementSlope(), CornerToTrackBits(), DrawFoundation(), DrawGroundSprite(), GetHalftileFoundationCorner(), GetHighestSlopeCorner(), GetJunctionGroundSpriteOffset(), GetRailFoundation(), GetRailGroundType(), GetRailReservationTrackBits(), GetRailType(), GetRailTypeInfo(), RailTypeInfo::ground, HalftileFoundation(), HalfTileSnow, HalfTileWater, HasReservedTracks(), IsNonContinuousFoundation(), IsSteepSlope(), IsValidCorner(), Left, Lower, Menu, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::None(), None, OppositeCorner(), PALETTE_CRASH, PALETTE_TO_BARE_LAND, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset(), Right, RailTypeInfo::single_e, RailTypeInfo::single_n, RailTypeInfo::single_s, RailTypeInfo::single_sloped, RailTypeInfo::single_w, RailTypeInfo::single_x, RailTypeInfo::single_y, SLOPE_E, SLOPE_ELEVATED, SLOPE_FLAT, SLOPE_N, SLOPE_S, SLOPE_W, SlopeToSpriteOffset(), SlopeWithThreeCornersRaised(), RailTypeInfo::snow_offset, SnowOrDesert, SteepBoth, SteepLower, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TileInfo::tile, TILE_HEIGHT, TileInfo::tileh, TRACK_BIT_CROSS, TRACK_BIT_HORZ, TRACK_BIT_VERT, RailTypeInfo::track_ns, RailTypeInfo::track_y, Upper, X, and Y.

Referenced by DrawTile_Rail().

DrawTrackBitsOverlay()

void DrawTrackBitsOverlay ( TileInfo * ti, TrackBits track, const RailTypeInfo * rti )

static

Definition at line 2092 of file rail_cmd.cpp.

DrawTrackDetails()

void DrawTrackDetails ( const TileInfo * ti, const RailTypeInfo * rti, PaletteID pal )

static

Draw track fences.

Parameters

ti	Tile drawing information.
rti	Rail type information.
pal	The palette to apply while drawing.

Definition at line 2027 of file rail_cmd.cpp.

References ComplementSlope(), DrawTrackFence(), DrawTrackFence_NE(), DrawTrackFence_NW(), DrawTrackFence_SE(), DrawTrackFence_SW(), FenceHoriz1, FenceHoriz2, FenceNE, FenceNESW, FenceNW, Fences, FenceSE, FenceSENW, FenceSW, FenceVert1, FenceVert2, GetCustomRailSprite(), GetHalftileSlopeCorner(), GetHighestSlopeCorner(), GetRailGroundType(), HalfTileWater, IsHalftileSlope(), OppositeCorner(), RFO_FLAT_LEFT, RFO_FLAT_LOWER, RFO_FLAT_RIGHT, RFO_FLAT_UPPER, PalSpriteID::sprite, TCX_NORMAL, TCX_UPPER_HALFTILE, TileInfo::tile, and TileInfo::tileh.

Referenced by DrawTile_Rail().

DrawTrackFence()

void DrawTrackFence ( const TileInfo * ti, const PalSpriteID & psid, uint num_sprites, RailFenceOffset rfo )

static

Draw a track fence.

Parameters

ti	Tile drawing information.
psid	First fence sprite and palette.
num_sprites	Number of fence sprites.
rfo	Fence to draw.

Definition at line 1960 of file rail_cmd.cpp.

References _fence_offsets, AddSortableSpriteToDraw(), GetSlopePixelZInCorner(), IsValidCorner(), PalSpriteID::pal, RemoveHalftileSlope(), PalSpriteID::sprite, TileInfo::tileh, Coord3D< T >::x, Coord3D< T >::y, and Coord3D< T >::z.

Referenced by DrawTrackDetails(), DrawTrackFence_NE(), DrawTrackFence_NW(), DrawTrackFence_SE(), and DrawTrackFence_SW().

DrawTrackFence_NE()

void DrawTrackFence_NE ( const TileInfo * ti, const PalSpriteID & psid, uint num_sprites )

static

Draw fence at NE border matching the tile slope.

Parameters

ti	Tile drawing information.
psid	First fence sprite and palette.
num_sprites	Number of fence sprites.

Definition at line 2001 of file rail_cmd.cpp.

References DrawTrackFence(), RFO_FLAT_Y_NE, RFO_SLOPE_NW_NE, RFO_SLOPE_SE_NE, SLOPE_E, SLOPE_NE, and TileInfo::tileh.

Referenced by DrawTrackDetails().

DrawTrackFence_NW()

void DrawTrackFence_NW ( const TileInfo * ti, const PalSpriteID & psid, uint num_sprites )

static

Draw fence at NW border matching the tile slope.

Parameters

ti	Tile drawing information.
psid	First fence sprite and palette.
num_sprites	Number of fence sprites.

Definition at line 1975 of file rail_cmd.cpp.

References DrawTrackFence(), RFO_FLAT_X_NW, RFO_SLOPE_NE_NW, RFO_SLOPE_SW_NW, SLOPE_NW, SLOPE_W, and TileInfo::tileh.

Referenced by DrawTrackDetails().

DrawTrackFence_SE()

void DrawTrackFence_SE ( const TileInfo * ti, const PalSpriteID & psid, uint num_sprites )

static

Draw fence at SE border matching the tile slope.

Parameters

ti	Tile drawing information.
psid	First fence sprite and palette.
num_sprites	Number of fence sprites.

Definition at line 1988 of file rail_cmd.cpp.

References DrawTrackFence(), RFO_FLAT_X_SE, RFO_SLOPE_NE_SE, RFO_SLOPE_SW_SE, SLOPE_S, SLOPE_SE, and TileInfo::tileh.

Referenced by DrawTrackDetails().

DrawTrackFence_SW()

void DrawTrackFence_SW ( const TileInfo * ti, const PalSpriteID & psid, uint num_sprites )

static

Draw fence at SW border matching the tile slope.

Parameters

ti	Tile drawing information.
psid	First fence sprite and palette.
num_sprites	Number of fence sprites.

Definition at line 2014 of file rail_cmd.cpp.

References DrawTrackFence(), RFO_FLAT_Y_SW, RFO_SLOPE_NW_SW, RFO_SLOPE_SE_SW, SLOPE_S, SLOPE_SW, and TileInfo::tileh.

Referenced by DrawTrackDetails().

DrawTrackSprite()

void DrawTrackSprite ( SpriteID sprite, PaletteID pal, const TileInfo * ti, Slope s )

inlinestatic

Definition at line 2087 of file rail_cmd.cpp.

DrawTrainDepotSprite()

void DrawTrainDepotSprite	(	int	x,
		int	y,
		DiagDirection	dir,
		RailType	railtype )

Draw train depot sprite in the UI.

Parameters

x	X position.
y	Y position.
dir	Direction of depot.
railtype	Railtype of depot.

Definition at line 2597 of file rail_cmd.cpp.

References _depot_gfx_table, _local_company, Depot, DrawRailTileSeqInGUI(), DrawSprite(), GetCompanyPalette(), GetCustomRailSprite(), GetRailTypeInfo(), RailTypeInfo::GetRailtypeSpriteOffset(), Ground, DrawTileSprites::ground, INVALID_TILE, RTO_X, RTO_Y, SE, PalSpriteID::sprite, and SW.

Referenced by BuildRailDepotWindow::DrawWidget().

EnsureNoTrainOnTrack()

CommandCost EnsureNoTrainOnTrack ( TileIndex tile, Track track )

static

Tests if a vehicle interacts with the specified track.

All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

Parameters

tile	The tile.
track	The track.

Returns

Succeeded command (no train found), or a failed command (a train was found).

Definition at line 228 of file rail_cmd.cpp.

References EnsureNoTrainOnTrackBits().

Referenced by CmdBuildSingleRail(), and CmdRemoveSingleRail().

FloodHalftile()

bool FloodHalftile

(

TileIndex

t

)

Called from water_cmd if a non-flat rail-tile gets flooded and should be converted to shore.

The function floods the lower halftile, if the tile has a halftile foundation.

Parameters

t	The tile to flood.

Returns

true if something was flooded.

Definition at line 759 of file rail_cmd.cpp.

References _current_company, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), ApplyFoundationToSlope(), CornerToTrackBits(), Execute, FindFirstTrack(), GetHighestSlopeCorner(), GetRailFoundation(), GetRailGroundType(), GetTileSlope(), GetTrackBits(), HalfTileWater, IsNonContinuousFoundation(), IsPlainRailTile(), IsSlopeWithOneCornerRaised(), IsSlopeWithThreeCornersRaised(), IsSteepSlope(), MakeShore(), MarkTileDirtyByTile(), OppositeCorner(), OWNER_WATER, and SetRailGroundType().

Referenced by DoFloodTile().

GetFoundation_Rail()

Foundation GetFoundation_Rail ( TileIndex tile, Slope tileh )

static

Tile callback function signature for getting the foundation of a tile.

Parameters

tile	The tile to check.
tileh	The current slope.

Returns

The foundation that will be used.

Definition at line 2639 of file rail_cmd.cpp.

References FlatteningFoundation(), GetRailFoundation(), GetTrackBits(), and IsPlainRail().

GetJunctionGroundSpriteOffset()

int GetJunctionGroundSpriteOffset ( TrackBits track )

static

Returns which of the 5 junction-'Rail underlays' to use for the given track bits.

See https://newgrf-specs.tt-wiki.net/wiki/Action3/Railtypes for the cases.

Precondition

The track bits describe a junction, so at least two bits are set.

Parameters

track

The track bits to consider.

Returns

The offset in the five junction ground sprites.

Definition at line 2263 of file rail_cmd.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), TRACK_BIT_3WAY_NE, TRACK_BIT_3WAY_NW, TRACK_BIT_3WAY_SE, and TRACK_BIT_3WAY_SW.

Referenced by DrawTrackBits().

GetOtherTrackdir()

Trackdir GetOtherTrackdir ( Trackdir trackdir )

static

Get the other Trackdir for a non-diagonal Trackdir.

i.e. upper -> lower, left -> right, etc.

Parameters

trackdir

the trackdir.

Returns

The other trackdir.

Definition at line 820 of file rail_cmd.cpp.

References to_underlying().

Referenced by CmdRailTrackHelper(), and CmdSignalTrackHelper().

GetRailFoundation()

Foundation GetRailFoundation	(	Slope	tileh,
		TrackBits	bits )

Checks if a track combination is valid on a specific slope and returns the needed foundation.

Parameters

tileh	Tile slope.
bits	Trackbits.

Returns

Needed foundation or Foundation::Invalid if track/slope combination is not allowed.

Definition at line 310 of file rail_cmd.cpp.

References _valid_tracks_on_leveled_foundation, _valid_tracks_without_foundation, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), CornerToTrackBits(), GetHighestSlopeCorner(), HalftileFoundation(), InclinedX, InclinedY, Invalid, IsSlopeWithOneCornerRaised(), IsSlopeWithThreeCornersRaised(), IsSteepSlope(), Left, Leveled, Lower, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::None(), None, OppositeCorner(), Right, SLOPE_E, SLOPE_N, SLOPE_S, SLOPE_W, SlopeWithOneCornerRaised(), SlopeWithThreeCornersRaised(), SpecialRailFoundation(), SteepBoth, SteepLower, TRACK_BIT_HORZ, TRACK_BIT_VERT, TracksOverlap(), Upper, X, and Y.

Referenced by CheckRailSlope(), DrawRailCatenaryRailway(), DrawTrackBits(), FloodHalftile(), GetFoundation_Rail(), GetSlopePixelZ_Rail(), TerraformTile_Rail(), TestAutoslopeOnRailTile(), and TileLoop_Rail().

GetSafeSlopeZ()

uint GetSafeSlopeZ ( uint x, uint y, Track track )

static

Get surface height in point (x,y) On tiles with halftile foundations move (x,y) to a safe point wrt.

track

Parameters

x	The world X-coordinate.
y	The world Y-coordinate.
track	The track to get the height for.

Returns

The world Z-coordinate.

Definition at line 1860 of file rail_cmd.cpp.

References GetSlopePixelZ(), Left, Lower, Right, and Upper.

GetSlopePixelZ_Rail()

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

static

Tile callback function signature for obtaining the world Z coordinate of a given point of a tile.

Parameters

tile	The queries tile for the Z coordinate.
x	World X coordinate in tile "units".
y	World Y coordinate in tile "units".
ground_vehicle	Whether to get the Z coordinate of the ground vehicle, or the ground.

Returns

World Z coordinate at tile ground (vehicle) level, including slopes and foundations.

See also

GetSlopePixelZ

Definition at line 2625 of file rail_cmd.cpp.

References ApplyPixelFoundationToSlope(), GetPartialPixelZ(), GetRailFoundation(), GetTileMaxPixelZ(), GetTilePixelSlope(), GetTrackBits(), IsPlainRail(), and SLOPE_FLAT.

GetTileDesc_Rail()

void GetTileDesc_Rail ( TileIndex tile, TileDesc & td )

static

Tile callback function signature for obtaining a tile description.

Parameters

tile	Tile being queried
td	Storage pointer for returned tile description

See also

GetTileDesc

Definition at line 2844 of file rail_cmd.cpp.

References _settings_game, TileDesc::build_date, Depot, End, GetRailTileType(), GetRailType(), GetRailTypeInfo(), GetSignalType(), GetTileOwner(), HasSignalOnTrack(), Lower, RailTypeInfo::max_speed, RailTypeInfo::name, Normal, TileDesc::owner, TileDesc::rail_speed, TileDesc::railtype, Signals, TileDesc::str, RailTypeInfo::strings, and Upper.

GetTileTrackStatus_Rail()

TrackStatus GetTileTrackStatus_Rail ( TileIndex tile, TransportType mode, RoadTramType sub_mode, DiagDirection side )

static

Tile callback function signature for getting the possible tracks that can be taken on a given tile by a given transport.

The return value contains the existing trackdirs and signal states.

see track_func.h for usage of TrackStatus.

Parameters

tile	the tile to get the track status from
mode	the mode of transportation
sub_mode	used to differentiate between different kinds within the mode
side	The side where the tile is entered.

Returns

the track status information

See also

GetTileTrackStatus

Definition at line 2772 of file rail_cmd.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), Depot, DiagDirToDiagTrack(), GetPresentSignals(), GetRailDepotDirection(), GetRailGroundType(), GetRailTileType(), GetSignalStates(), GetTileSlope(), GetTrackBits(), HalfTileWater, Invalid, IsOnewaySignal(), IsPlainRail(), IsSlopeWithOneCornerRaised(), Left, Left_N, Left_S, Lower, Lower_E, Lower_W, Normal, Right, Right_N, Right_S, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), SignalOnTrack(), Signals, TrackBitsToTrackdirBits(), TRANSPORT_RAIL, TRANSPORT_WATER, Upper, Upper_E, Upper_W, X_NE, X_SW, Y_NW, and Y_SE.

InitRailTypes()

void InitRailTypes

(

)

Resolve sprites of custom rail types.

Definition at line 130 of file rail_cmd.cpp.

References _sorted_railtypes, CompareRailTypes(), RailTypeInfo::flags, Hidden, RailTypeInfo::Index(), RailTypeInfo::label, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by AfterLoadGRFs().

IsTrainSignalSideRight()

bool IsTrainSignalSideRight ( )

static

Helper to determine whether the train signals are to be placed on the right side.

Returns

true iff signals are to be drawn on the right side.

Definition at line 1876 of file rail_cmd.cpp.

References _settings_game, Left, Right, and RoadVehicleDrivingSide.

RemoveTrainDepot()

CommandCost RemoveTrainDepot ( TileIndex tile, DoCommandFlags flags )

static

Definition at line 1764 of file rail_cmd.cpp.

ResetRailTypes()

void ResetRailTypes

(

)

Reset all rail type information to its default values.

Definition at line 65 of file rail_cmd.cpp.

References _original_railtypes.

Referenced by ResetNewGRFData().

ResolveRailTypeGUISprites()

void ResolveRailTypeGUISprites

(

RailTypeInfo *

rti

)

Definition at line 75 of file rail_cmd.cpp.

TerraformTile_Rail()

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

static

Tile callback function signature of the terraforming callback.

The function is called when a tile is affected by a terraforming operation. It has to check if terraforming of the tile is allowed and return extra terraform-cost that depend on the tiletype. With DoCommandFlag::Execute in flags it has to perform tiletype-specific actions (like clearing land etc., but not the terraforming itself).

Note

The terraforming has not yet taken place. So GetTileZ() and GetTileSlope() refer to the landscape before the terraforming operation.

Parameters

tile	The involved tile.
flags	Command flags passed to the terraform command (DoCommandFlag::Execute, DoCommandFlag::QueryCost, etc.).
z_new	TileZ after terraforming.
tileh_new	Slope after terraforming.

Returns

Error code or extra cost for terraforming (like clearing land, building foundations, etc., but not the terraforming itself.)

See also

TerraformTile

Definition at line 3125 of file rail_cmd.cpp.

References _price, _settings_game, AutoslopeCheckForEntranceEdge(), AutoslopeEnabled(), Barren, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), BuildFoundation, ClearWater, Construction, Execute, GetRailDepotDirection(), GetRailFoundation(), GetRailGroundType(), GetSlopeZInCorner(), GetTileSlopeZ(), GetTrackBits(), HalfTileWater, HasVehicleOnTile(), IsPlainRail(), IsSlopeWithOneCornerRaised(), IsSpecialRailFoundation(), Left, Lower, Right, SetRailGroundType(), Ship, SLOPE_EW, SLOPE_NS, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TestAutoslopeOnRailTile(), BaseVehicle::type, and Upper.

TestAutoslopeOnRailTile()

CommandCost TestAutoslopeOnRailTile ( TileIndex tile, DoCommandFlags flags, int z_old, Slope tileh_old, int z_new, Slope tileh_new, TrackBits rail_bits )

static

Tests if autoslope is allowed.

Parameters

tile	The tile.
flags	Terraform command flags.
z_old	Old TileZ.
tileh_old	Old TileSlope.
z_new	New TileZ.
tileh_new	New TileSlope.
rail_bits	Trackbits.

Returns

The cost of this operation or an error.

Definition at line 3085 of file rail_cmd.cpp.

References _price, _settings_game, CommandCost::AddCost(), ApplyFoundationToSlope(), AutoslopeEnabled(), Barren, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), BuildFoundation, CheckRailSlope(), ClearWater, Construction, Execute, CommandCost::Failed(), GetRailFoundation(), GetRailGroundType(), GetSlopeZInCorner(), HalfTileWater, IsSlopeWithOneCornerRaised(), Left, Lower, RemoveHalftileSlope(), Right, SetRailGroundType(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and Upper.

Referenced by TerraformTile_Rail().

TicksToLeaveDepot()

int TicksToLeaveDepot

(

const Train *

v

)

Compute number of ticks when next wagon will leave a depot.

Negative means next wagon should have left depot n ticks before.

Parameters

v	vehicle outside (leaving) the depot

Returns

number of ticks when the next wagon will leave

Definition at line 2999 of file rail_cmd.cpp.

References _fractcoords_enter, Train::CalcNextVehicleOffset(), GetRailDepotDirection(), NE, NW, SE, SW, Vehicle::tile, TILE_UNIT_MASK, Vehicle::x_pos, and Vehicle::y_pos.

Referenced by AdvanceWagonsAfterSwap(), CheckTrainsLengths(), and FixupTrainLengths().

TileLoop_Rail()

void TileLoop_Rail ( TileIndex tile )

static

Tile callback function signature for running periodic tile updates.

Parameters

tile	The tile to update.

See also

RunTileLoop

Definition at line 2645 of file rail_cmd.cpp.

References _settings_game, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), Arctic, Barren, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), Desert, End, FenceHoriz1, FenceHoriz2, FenceNE, FenceNESW, FenceNW, FenceSE, FenceSENW, FenceSW, FenceVert1, FenceVert2, GetRailFoundation(), GetRailGroundType(), GetSnowLine(), GetTileOwner(), GetTileSlopeZ(), GetTrackBits(), GetTropicZone(), Grass, HalfTileSnow, HalfTileWater, House, InclinedX, InclinedY, Industry, IsNonContinuousFoundation(), IsObjectType(), IsPlainRail(), IsSlopeWithThreeCornersRaised(), IsSteepSlope(), IsTileOwner(), IsTileType(), IsValidTile(), MarkTileDirtyByTile(), NE, None, NW, Object, OBJECT_OWNED_LAND, Road, SE, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), SetRailGroundType(), SLOPE_FLAT, SnowOrDesert, SteepLower, SW, TileLoop_Water(), TileOffsByDiagDir(), TRACK_BIT_3WAY_NE, TRACK_BIT_3WAY_NW, TRACK_BIT_3WAY_SE, TRACK_BIT_3WAY_SW, Tropic, and TunnelBridge.

ValidateAutoDrag()

CommandCost ValidateAutoDrag ( Trackdir * trackdir, TileIndex start, TileIndex end )

static

Definition at line 825 of file rail_cmd.cpp.

ValParamTrackOrientation()

bool ValParamTrackOrientation ( Track track )

inlinestatic

Definition at line 410 of file rail_cmd.cpp.

VehicleEnterTile_Rail()

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

static

Tile callback function for a vehicle entering a tile.

Parameters

v	Vehicle entering the tile.
tile	Tile entered.
x	X position in world coordinates.
y	Y position in world coordinates.

Returns

Some meta-data over the to be entered tile.

See also

VehicleEnterTile

Definition at line 3014 of file rail_cmd.cpp.

References _deltacoord_leaveoffset, _fractcoords_behind, _fractcoords_enter, AxisToTrack(), Train::CalcNextVehicleOffset(), CannotEnter, Depot, DiagDirToAxis(), DiagDirToDir(), DrivingBackwards, EnteredWormhole, SpecializedVehicle< T, Type >::First(), SpecializedVehicle< Train, Type >::From(), Vehicle::GetMovingDirection(), Vehicle::GetMovingNext(), GetRailDepotDirection(), Hidden, InvalidateWindowData(), IsRailDepotTile(), SpecializedVehicle< T, Type >::Next(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset(), ReverseDiagDir(), ReverseDir(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), Vehicle::tile, TILE_UNIT_MASK, Train::track, Train, BaseVehicle::type, BaseConsist::vehicle_flags, VehicleEnterDepot(), and Vehicle::vehstatus.

Variable Documentation

_deltacoord_leaveoffset

DiagDirectionIndexArray<Coord2D<int8_t> > _deltacoord_leaveoffset

staticconstexpr

Initial value:

{{{
  {-1, 0}, 
  {0, 1}, 
  {1, 0}, 
  {0, -1}, 
}}}

Offsets (to be multiplied by length) from the depot enter coordinates where a train should appear when exiting a depot for each depot direction.

Definition at line 2986 of file rail_cmd.cpp.

Referenced by VehicleEnterTile_Rail().

_fence_offsets

const FenceOffset _fence_offsets[]

static

Initial value:

                                        = {
  { CORNER_INVALID,  0,  1, 16,  1 }, 
  { CORNER_INVALID,  1,  0,  1, 16 }, 
  { CORNER_W,        8,  8,  1,  1 }, 
  { CORNER_N,        8,  8,  1,  1 }, 
  { CORNER_INVALID,  0,  1, 16,  1 }, 
  { CORNER_INVALID,  1,  0,  1, 16 }, 
  { CORNER_INVALID,  0,  1, 16,  1 }, 
  { CORNER_INVALID,  1,  0,  1, 16 }, 
  { CORNER_INVALID,  0, 15, 16,  1 }, 
  { CORNER_INVALID, 15,  0,  1, 16 }, 
  { CORNER_E,        8,  8,  1,  1 }, 
  { CORNER_S,        8,  8,  1,  1 }, 
  { CORNER_INVALID,  0, 15, 16,  1 }, 
  { CORNER_INVALID, 15,  0,  1, 16 }, 
  { CORNER_INVALID,  0, 15, 16,  1 }, 
  { CORNER_INVALID, 15,  0,  1, 16 }, 
}

Offsets for drawing fences.

Definition at line 1934 of file rail_cmd.cpp.

Referenced by DrawTrackFence().

_fractcoords_behind

DiagDirectionIndexArray<Coord2D<uint8_t> > _fractcoords_behind

staticconstexpr

Initial value:

{{{
  {15, 8}, 
  {8, 0}, 
  {0, 8}, 
  {8, 15}, 
}}}

Coordinates to detect when a train is approaching a depot from behind for each depot direction.

Definition at line 2967 of file rail_cmd.cpp.

Referenced by VehicleEnterTile_Rail().

_fractcoords_enter

DiagDirectionIndexArray<Coord2D<uint8_t> > _fractcoords_enter

staticconstexpr

Initial value:

{{{
  {10, 8}, 
  {8, 4}, 
  {4, 8}, 
  {8, 10}, 
}}}

Coordinates where a train should enter a depot for each depot direction.

Definition at line 2975 of file rail_cmd.cpp.

Referenced by TicksToLeaveDepot(), and VehicleEnterTile_Rail().

_halftile_sub_sprite

CornerIndexArray<SubSprite> _halftile_sub_sprite

staticconstexpr

Initial value:

                                                       = {{{
  { -INF    , -INF  , 32 - 33, INF     }, 
  { -INF    ,  0 + 7, INF    , INF     }, 
  { -31 + 33, -INF  , INF    , INF     }, 
  { -INF    , -INF  , INF    , 30 - 23 }  
}}}

SubSprite for drawing the track halftile of 'three-corners-raised'-sloped rail sprites.

Definition at line 2080 of file rail_cmd.cpp.

Referenced by DrawTrackBits().

_railtypes

RailTypeInfo _railtypes[RAILTYPE_END]

Definition at line 46 of file rail_cmd.cpp.

_railtypes_hidden_mask

RailTypes _railtypes_hidden_mask

Definition at line 48 of file rail_cmd.cpp.

_sorted_railtypes

std::vector<RailType> _sorted_railtypes

Sorted list of rail types.

Definition at line 47 of file rail_cmd.cpp.

Referenced by BuildRailToolbarWindow::ChangeRailTypeOnHotkey(), GetRailTypeDropDownList(), InitRailTypes(), SetDefaultRailGui(), CompanyInfrastructureWindow::UpdateWidgetSize(), and ReplaceVehicleWindow::UpdateWidgetSize().

_tile_type_rail_procs

const TileTypeProcs _tile_type_rail_procs

extern

Initial value:

                                                 = {
  .draw_tile_proc = DrawTile_Rail,
  .get_slope_pixel_z_proc = GetSlopePixelZ_Rail,
  .clear_tile_proc = ClearTile_Rail,
  .get_tile_desc_proc = GetTileDesc_Rail,
  .get_tile_track_status_proc = GetTileTrackStatus_Rail,
  .click_tile_proc = ClickTile_Rail,
  .tile_loop_proc = TileLoop_Rail,
  .change_tile_owner_proc = ChangeTileOwner_Rail,
  .vehicle_enter_tile_proc = VehicleEnterTile_Rail,
  .get_foundation_proc = GetFoundation_Rail,
  .terraform_tile_proc = TerraformTile_Rail,
  .check_build_above_proc = CheckBuildAbove_Rail,
}

TileTypeProcs definitions for TileType::Rail tiles.

Definition at line 53 of file landscape.cpp.

_track_sloped_sprites

const uint8_t _track_sloped_sprites[14]

static

Initial value:

                                           = {
  14, 15, 22, 13,
   0, 21, 17, 12,
  23,  0, 18, 20,
  19, 16
}

Definition at line 181 of file rail_cmd.cpp.

_trackdelta

const TrackdirIndexArray<TileIndexDiffC> _trackdelta

static

Initial value:

{{{
  { -1,  0 }, {  0,  1 }, { -1,  0 }, {  0,  1 }, {  1,  0 }, {  0,  1 },
  {  0,  0 },
  {  0,  0 },
  {  1,  0 }, {  0, -1 }, {  0, -1 }, {  1,  0 }, {  0, -1 }, { -1,  0 },
  {  0,  0 },
  {  0,  0 }
}}}

Tile deltas for each trackdir.

Definition at line 805 of file rail_cmd.cpp.

Referenced by CmdRailTrackHelper(), and CmdSignalTrackHelper().

_valid_tracks_on_leveled_foundation

const TrackBits _valid_tracks_on_leveled_foundation[15]

static

Initial value:

                                                           = {
  {},
  Track::Left,
  Track::Lower,
  {Track::Y, Track::Lower, Track::Left},
 
  Track::Right,
  TRACK_BIT_ALL,
  {Track::X, Track::Lower, Track::Right},
  TRACK_BIT_ALL,
 
  Track::Upper,
  {Track::X, Track::Upper, Track::Left},
  TRACK_BIT_ALL,
  TRACK_BIT_ALL,
 
  {Track::Y, Track::Upper, Track::Right},
  TRACK_BIT_ALL,
  TRACK_BIT_ALL,
}

Valid TrackBits on a specific (non-steep)-slope with leveled foundation.

Definition at line 282 of file rail_cmd.cpp.

Referenced by CheckRailSlope(), and GetRailFoundation().

_valid_tracks_without_foundation

const TrackBits _valid_tracks_without_foundation[15]

static

Initial value:

                                                        = {
  TRACK_BIT_ALL,
  Track::Right,
  Track::Upper,
  Track::X,
 
  Track::Left,
  {},
  Track::Y,
  Track::Lower,
 
  Track::Lower,
  Track::Y,
  {},
  Track::Left,
 
  Track::X,
  Track::Upper,
  Track::Right,
}

Valid TrackBits on a specific (non-steep)-slope without foundation.

Definition at line 260 of file rail_cmd.cpp.

Referenced by GetRailFoundation().

INF

const int INF = 1000

static

Big number compared to tilesprite size.

Definition at line 2078 of file rail_cmd.cpp.

Referenced by DrawBridgePillars(), and DrawRoadTypeCatenary().