Rail specific functions. More...

#include "rail_type.h"
#include "track_type.h"
#include "gfx_type.h"
#include "core/bitmath_func.hpp"
#include "core/enum_type.hpp"
#include "core/flatset_type.hpp"
#include "economy_func.h"
#include "slope_type.h"
#include "strings_type.h"
#include "timer/timer_game_calendar.h"
#include "signal_type.h"
#include "settings_type.h"
#include "newgrf_badge_type.h"

Data Structures
class	RailTypeInfo
	This struct contains all the info that is needed to draw and construct tracks. More...

Typedefs
using	RailTypeFlags = EnumBitSet< RailTypeFlag, uint8_t >

Enumerations
enum class	RailTypeFlag : uint8_t { Catenary = 0 , NoLevelCrossing = 1 , Hidden = 2 , NoSpriteCombine = 3 , Allow90Deg = 4 , Disallow90Deg = 5 }
	Railtype flag bit numbers. More...

enum	RailTypeSpriteGroup : uint8_t { RTSG_CURSORS , RTSG_OVERLAY , RTSG_GROUND , RTSG_TUNNEL , RTSG_WIRES , RTSG_PYLONS , RTSG_BRIDGE , RTSG_CROSSING , RTSG_DEPOT , RTSG_FENCES , RTSG_TUNNEL_PORTAL , RTSG_SIGNALS , RTSG_GROUND_COMPLETE , RTSG_END }
	Sprite groups for a railtype. More...

enum	RailTrackOffset : uint8_t { RTO_X , RTO_Y , RTO_N , RTO_S , RTO_E , RTO_W , RTO_SLOPE_NE , RTO_SLOPE_SE , RTO_SLOPE_SW , RTO_SLOPE_NW , RTO_CROSSING_XY , RTO_JUNCTION_SW , RTO_JUNCTION_NE , RTO_JUNCTION_SE , RTO_JUNCTION_NW , RTO_JUNCTION_NSEW }
	Offsets for sprites within an overlay/underlay set. More...

enum	RailTrackBridgeOffset : uint8_t { RTBO_X , RTBO_Y , RTBO_SLOPE }
	Offsets for sprites within a bridge surface overlay set. More...

enum	RailFenceOffset : uint8_t { RFO_FLAT_X_NW , RFO_FLAT_Y_NE , RFO_FLAT_LEFT , RFO_FLAT_UPPER , RFO_SLOPE_SW_NW , RFO_SLOPE_SE_NE , RFO_SLOPE_NE_NW , RFO_SLOPE_NW_NE , RFO_FLAT_X_SE , RFO_FLAT_Y_SW , RFO_FLAT_RIGHT , RFO_FLAT_LOWER , RFO_SLOPE_SW_SE , RFO_SLOPE_SE_SW , RFO_SLOPE_NE_SE , RFO_SLOPE_NW_SW }
	Offsets from base sprite for fence sprites. More...

Functions
const RailTypeInfo *	GetRailTypeInfo (RailType railtype)
	Returns a pointer to the Railtype information for a given railtype.

RailTypes	GetAllCompatibleRailTypes (RailTypes railtypes)
	Returns all compatible railtypes for a set of railtypes.

RailTypes	GetAllPoweredRailTypes (RailTypes railtypes)
	Returns all powered railtypes for a set of railtypes.

RailTypes	GetAllIntroducesRailTypes (RailTypes railtypes)
	Returns all introduced railtypes for a set of railtypes.

bool	IsCompatibleRail (RailType enginetype, RailType tiletype)
	Checks if an engine of the given RailType can drive on a tile with a given RailType.

bool	IsCompatibleRail (RailTypes enginetype, RailType tiletype)
	Checks if an engine of the given RailTypes can drive on a tile with a given RailType.

bool	HasPowerOnRail (RailType enginetype, RailType tiletype)
	Checks if an engine of the given RailType got power on a tile with a given RailType.

bool	HasPowerOnRail (RailTypes enginetype, RailType tiletype)
	Checks if an engine of the given RailTypes got power on a tile with a given RailType.

bool	RailNoLevelCrossings (RailType rt)
	Test if a RailType disallows build of level crossings.

bool	Rail90DegTurnDisallowed (RailType rt1, RailType rt2, bool def=_settings_game.pf.forbid_90_deg)
	Test if 90 degree turns are disallowed between two railtypes.

Money	RailBuildCost (RailType railtype)
	Returns the cost of building the specified railtype.

Money	RailClearCost (RailType railtype)
	Returns the 'cost' of clearing the specified railtype.

Money	RailConvertCost (RailType from, RailType to)
	Calculates the cost of rail conversion.

Money	RailMaintenanceCost (RailType railtype, uint32_t num, uint32_t total_num)
	Calculates the maintenance cost of a number of track bits.

Money	SignalMaintenanceCost (uint32_t num)
	Calculates the maintenance cost of a number of signals.

void	DrawTrainDepotSprite (int x, int y, int image, RailType railtype)

int	TicksToLeaveDepot (const Train *v)
	Compute number of ticks when next wagon will leave a depot.

Foundation	GetRailFoundation (Slope tileh, TrackBits bits)
	Checks if a track combination is valid on a specific slope and returns the needed foundation.

bool	HasRailTypeAvail (const CompanyID company, const RailType railtype)
	Finds out if a company has a certain buildable railtype available.

bool	HasAnyRailTypesAvail (const CompanyID company)
	Test if any buildable railtype is available for a company.

bool	ValParamRailType (const RailType rail)
	Validate functions for rail building.

RailTypes	AddDateIntroducedRailTypes (RailTypes current, TimerGameCalendar::Date date)
	Add the rail types that are to be introduced at the given date.

RailTypes	GetCompanyRailTypes (CompanyID company, bool introduces=true)
	Get the rail types the given company can build.

RailTypes	GetRailTypes (bool introduces)
	Get list of rail types, regardless of company availability.

RailType	GetRailTypeByLabel (RailTypeLabel label, bool allow_alternate_labels=true)
	Get the rail type for a given label.

void	ResetRailTypes ()
	Reset all rail type information to its default values.

void	InitRailTypes ()
	Resolve sprites of custom rail types.

RailType	AllocateRailType (RailTypeLabel label)
	Allocate a new rail type label.

Variables
std::vector< RailType >	_sorted_railtypes
	Sorted list of rail types.

RailTypes	_railtypes_hidden_mask

Detailed Description

Rail specific functions.

Definition in file rail.h.

Typedef Documentation

◆ RailTypeFlags

using RailTypeFlags = EnumBitSet<RailTypeFlag, uint8_t>

Definition at line 36 of file rail.h.

Enumeration Type Documentation

◆ RailFenceOffset

enum RailFenceOffset : uint8_t

Offsets from base sprite for fence sprites.

These are in the order of the sprites in the original data files.

Enumerator
RFO_FLAT_X_NW	Slope FLAT, Track X, Fence NW.
RFO_FLAT_Y_NE	Slope FLAT, Track Y, Fence NE.
RFO_FLAT_LEFT	Slope FLAT, Track LEFT, Fence E.
RFO_FLAT_UPPER	Slope FLAT, Track UPPER, Fence S.
RFO_SLOPE_SW_NW	Slope SW, Track X, Fence NW.
RFO_SLOPE_SE_NE	Slope SE, Track Y, Fence NE.
RFO_SLOPE_NE_NW	Slope NE, Track X, Fence NW.
RFO_SLOPE_NW_NE	Slope NW, Track Y, Fence NE.
RFO_FLAT_X_SE	Slope FLAT, Track X, Fence SE.
RFO_FLAT_Y_SW	Slope FLAT, Track Y, Fence SW.
RFO_FLAT_RIGHT	Slope FLAT, Track RIGHT, Fence W.
RFO_FLAT_LOWER	Slope FLAT, Track LOWER, Fence N.
RFO_SLOPE_SW_SE	Slope SW, Track X, Fence SE.
RFO_SLOPE_SE_SW	Slope SE, Track Y, Fence SW.
RFO_SLOPE_NE_SE	Slope NE, Track X, Fence SE.
RFO_SLOPE_NW_SW	Slope NW, Track Y, Fence SW.

Definition at line 94 of file rail.h.

◆ RailTrackBridgeOffset

enum RailTrackBridgeOffset : uint8_t

Offsets for sprites within a bridge surface overlay set.

Enumerator
RTBO_X	Piece of rail in X direction.
RTBO_Y	Piece of rail in Y direction.
RTBO_SLOPE	Sloped rail pieces, in order NE, SE, SW, NW.

Definition at line 84 of file rail.h.

◆ RailTrackOffset

enum RailTrackOffset : uint8_t

Offsets for sprites within an overlay/underlay set.

These are the same for overlay and underlay sprites.

Enumerator
RTO_X	Piece of rail in X direction.
RTO_Y	Piece of rail in Y direction.
RTO_N	Piece of rail in northern corner.
RTO_S	Piece of rail in southern corner.
RTO_E	Piece of rail in eastern corner.
RTO_W	Piece of rail in western corner.
RTO_SLOPE_NE	Piece of rail on slope with north-east raised.
RTO_SLOPE_SE	Piece of rail on slope with south-east raised.
RTO_SLOPE_SW	Piece of rail on slope with south-west raised.
RTO_SLOPE_NW	Piece of rail on slope with north-west raised.
RTO_CROSSING_XY	Crossing of X and Y rail, with ballast.
RTO_JUNCTION_SW	Ballast for junction 'pointing' SW.
RTO_JUNCTION_NE	Ballast for junction 'pointing' NE.
RTO_JUNCTION_SE	Ballast for junction 'pointing' SE.
RTO_JUNCTION_NW	Ballast for junction 'pointing' NW.
RTO_JUNCTION_NSEW	Ballast for full junction.

Definition at line 62 of file rail.h.

◆ RailTypeFlag

enum class RailTypeFlag : uint8_t

strong

Railtype flag bit numbers.

Enumerator
Catenary	Bit number for drawing a catenary.
NoLevelCrossing	Bit number for disallowing level crossings.
Hidden	Bit number for hiding from selection.
NoSpriteCombine	Bit number for using non-combined junctions.
Allow90Deg	Bit number for always allowed 90 degree turns, regardless of setting.
Disallow90Deg	Bit number for never allowed 90 degree turns, regardless of setting.

Definition at line 28 of file rail.h.

◆ RailTypeSpriteGroup

enum RailTypeSpriteGroup : uint8_t

Sprite groups for a railtype.

Enumerator
RTSG_CURSORS	Cursor and toolbar icon images.
RTSG_OVERLAY	Images for overlaying track.
RTSG_GROUND	Main group of ground images.
RTSG_TUNNEL	Main group of ground images for snow or desert.
RTSG_WIRES	Catenary wires.
RTSG_PYLONS	Catenary pylons.
RTSG_BRIDGE	Bridge surface images.
RTSG_CROSSING	Level crossing overlay images.
RTSG_DEPOT	Depot images.
RTSG_FENCES	Fence images.
RTSG_TUNNEL_PORTAL	Tunnel portal overlay.
RTSG_SIGNALS	Signal images.
RTSG_GROUND_COMPLETE	Complete ground images.

Definition at line 41 of file rail.h.

Function Documentation

◆ AddDateIntroducedRailTypes()

RailTypes AddDateIntroducedRailTypes	(	RailTypes	current,
		TimerGameCalendar::Date	date
	)

Add the rail types that are to be introduced at the given date.

Parameters

current	The currently available railtypes.
date	The date for the introduction comparisons.

Returns: The rail types that should be available when date introduced rail types are taken into account as well.

Definition at line 102 of file rail.cpp.

References AddDateIntroducedRailTypes(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::All(), GetRailTypeInfo(), RailTypeInfo::introduces_railtypes, RailTypeInfo::introduction_date, RailTypeInfo::introduction_required_railtypes, IsInsideMM(), RailTypeInfo::label, TimerGameConst< struct Calendar >::MAX_DATE, RAILTYPE_BEGIN, RAILTYPE_END, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set().

Referenced by AddDateIntroducedRailTypes(), GetCompanyRailTypes(), GetRailTypes(), and NewVehicleAvailable().

◆ AllocateRailType()

RailType AllocateRailType ( RailTypeLabel label )

Allocate a new rail type label.

Definition at line 148 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.

◆ DrawTrainDepotSprite()

void DrawTrainDepotSprite	(	int	x,
		int	y,
		int	image,
		RailType	railtype
	)

Definition at line 2535 of file rail_cmd.cpp.

◆ GetAllCompatibleRailTypes()

RailTypes GetAllCompatibleRailTypes ( RailTypes railtypes )

inline

Returns all compatible railtypes for a set of railtypes.

Parameters

railtypes Set of railtypes to get the compatible railtypes from.

Returns: Union of all compatible railtypes.

Definition at line 313 of file rail.h.

References RailTypeInfo::compatible_railtypes, GetRailTypeInfo(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set().

Referenced by CheckAutoreplaceValidity(), FollowTrainReservation(), FreeTrainTrackReservation(), IsCompatibleRail(), IsEngineBuildable(), and IsSafeWaitingPosition().

◆ GetAllIntroducesRailTypes()

RailTypes GetAllIntroducesRailTypes ( RailTypes railtypes )

inline

Returns all introduced railtypes for a set of railtypes.

Parameters

railtypes Set of railtypes to get the introduced railtypes from.

Returns: Union of all introduced railtypes.

Definition at line 337 of file rail.h.

References GetRailTypeInfo(), RailTypeInfo::introduces_railtypes, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set().

Referenced by GetCompanyRailTypes(), GetRailTypes(), and NewVehicleAvailable().

◆ GetAllPoweredRailTypes()

RailTypes GetAllPoweredRailTypes ( RailTypes railtypes )

inline

Returns all powered railtypes for a set of railtypes.

Parameters

railtypes Set of railtypes to get the powered railtypes from.

Returns: Union of all powered railtypes.

Definition at line 325 of file rail.h.

References GetRailTypeInfo(), RailTypeInfo::powered_railtypes, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set().

Referenced by Train::ConsistChanged(), and HasPowerOnRail().

◆ GetCompanyRailTypes()

RailTypes GetCompanyRailTypes	(	CompanyID	company,
		bool	introduces
	)

Get the rail types the given company can build.

Parameters

company	the company to get the rail types for.
introduces	If true, include rail types introduced by other rail types

Returns: the rail types.

Definition at line 135 of file rail.cpp.

References _settings_game, AddDateIntroducedRailTypes(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), EngineInfo::climates, TimerGameCalendar::date, TimerGameConst< struct Calendar >::DAYS_IN_YEAR, GameSettings::game_creation, GetAllIntroducesRailTypes(), Engine::IterateType(), GameCreationSettings::landscape, RailVehicleInfo::railtypes, RAILVEH_WAGON, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and VEH_TRAIN.

Referenced by AfterLoadGame(), DisableEngineForCompany(), DoStartupNewCompany(), EnableEngineForCompany(), GetRailTypeDropDownList(), and StartupEngines().

◆ 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 309 of file rail_cmd.cpp.

References _valid_tracks_without_foundation, CornerToTrackBits(), FOUNDATION_INCLINED_X, FOUNDATION_INCLINED_Y, FOUNDATION_INVALID, FOUNDATION_LEVELED, FOUNDATION_NONE, FOUNDATION_STEEP_BOTH, FOUNDATION_STEEP_LOWER, GetHighestSlopeCorner(), HalftileFoundation(), IsSlopeWithOneCornerRaised(), IsSlopeWithThreeCornersRaised(), IsSteepSlope(), OppositeCorner(), SLOPE_E, SLOPE_N, SLOPE_S, SLOPE_W, SlopeWithOneCornerRaised(), SlopeWithThreeCornersRaised(), SpecialRailFoundation(), TRACK_BIT_HORZ, TRACK_BIT_LEFT, TRACK_BIT_LOWER, TRACK_BIT_NONE, TRACK_BIT_RIGHT, TRACK_BIT_UPPER, TRACK_BIT_VERT, TRACK_BIT_X, TRACK_BIT_Y, and TracksOverlap().

Referenced by CheckRailSlope(), DrawRailCatenaryRailway(), DrawTrackBits(), FloodHalftile(), and TestAutoslopeOnRailTile().

◆ GetRailTypeByLabel()

RailType GetRailTypeByLabel	(	RailTypeLabel	label,
		bool	allow_alternate_labels
	)

Get the rail type for a given label.

Parameters

label	the railtype label.
allow_alternate_labels	Search in the alternate label lists as well.

Returns: the railtype.

Definition at line 195 of file rail.cpp.

References RailTypeInfo::alternate_labels, FlatSet< Tkey, Tcompare >::contains(), INVALID_RAILTYPE, RailTypeInfo::label, and RAILTYPE_END.

Referenced by AfterLoadGRFs(), ConvertRailTypes(), GetRailTypeTranslation(), and RailTypeChangeInfo().

◆ GetRailTypeInfo()

const RailTypeInfo * GetRailTypeInfo ( RailType railtype )

inline

Returns a pointer to the Railtype information for a given railtype.

Parameters

railtype the rail type which the information is requested for

Returns: The pointer to the RailTypeInfo

Definition at line 301 of file rail.h.

References RAILTYPE_END.

Referenced by AddDateIntroducedRailTypes(), CompareRailTypes(), DrawBridgeMiddle(), DrawStationTile(), DrawTile_Road(), DrawTile_TunnelBridge(), DrawTrackBits(), BuildSignalWindow::DrawWidget(), FinaliseEngineArray(), Train::GetAccelerationType(), GetAllCompatibleRailTypes(), GetAllIntroducesRailTypes(), GetAllPoweredRailTypes(), NIHRailType::GetBadges(), GetBridgeSpriteTableBaseOffset(), Train::GetCurveSpeedLimit(), GetEngineCategoryName(), GetGlobalVariable(), Train::GetMaxTrackSpeed(), GetNewEngine(), GetPylonBase(), GetRailTypeDropDownList(), GetRailTypeTranslation(), GetReverseRailTypeTranslation(), GetSmallMapRoutesPixels(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::GetSpeedLimit(), GetTrainForReservation(), ReplaceVehicleWindow::GetWidgetString(), BuildVehicleWindow::GetWidgetString(), BuildRailToolbarWindow::GetWidgetString(), GetWireBase(), HasPowerOnRail(), HasRailCatenary(), IsCompatibleRail(), BuildRailToolbarWindow::OnClick(), BuildRailToolbarWindow::OnInit(), BuildSignalWindow::OnInit(), Rail90DegTurnDisallowed(), RailBuildCost(), RailMaintenanceCost(), RailNoLevelCrossings(), ResetNewGRFData(), RAILChunkHandler::Save(), SetCurrentRailTypeLabelList(), ReplaceVehicleWindow::UpdateWidgetSize(), and CompanyInfrastructureWindow::UpdateWidgetSize().

◆ GetRailTypes()

RailTypes GetRailTypes ( bool introduces )

Get list of rail types, regardless of company availability.

Parameters

introduces If true, include rail types introduced by other rail types

Returns: the rail types.

Definition at line 166 of file rail.cpp.

References _settings_game, AddDateIntroducedRailTypes(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), EngineInfo::climates, GameSettings::game_creation, GetAllIntroducesRailTypes(), Engine::IterateType(), GameCreationSettings::landscape, TimerGameConst< struct Calendar >::MAX_DATE, RailVehicleInfo::railtypes, RAILVEH_WAGON, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and VEH_TRAIN.

Referenced by GetRailTypeDropDownList().

◆ HasAnyRailTypesAvail()

bool HasAnyRailTypesAvail ( const CompanyID company )

Test if any buildable railtype is available for a company.

Parameters

company the company in question

Returns: true if company has any RailTypes available

Definition at line 78 of file rail.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::Get(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset().

Referenced by CanBuildVehicleInfrastructure().

◆ HasPowerOnRail() [1/2]

bool HasPowerOnRail	(	RailType	enginetype,
		RailType	tiletype
	)

inline

Checks if an engine of the given RailType got power on a tile with a given RailType.

This would normally just be an equality check, but for electric rails (which also support non-electric engines).

Parameters

enginetype	The RailType of the engine we are considering.
tiletype	The RailType of the tile we are considering.

Returns: Whether the engine got power on this tile.

Definition at line 377 of file rail.h.

References GetRailTypeInfo(), RailTypeInfo::powered_railtypes, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by CheckFlatLandRailStation(), CmdBuildRailVehicle(), CmdBuildSingleRail(), CmdConvertRail(), Train::GetPower(), Train::GetPoweredPartPower(), RailConvertCost(), and Vehicle::ShowVisualEffect().

◆ HasPowerOnRail() [2/2]

bool HasPowerOnRail	(	RailTypes	enginetype,
		RailType	tiletype
	)

inline

Checks if an engine of the given RailTypes got power on a tile with a given RailType.

Parameters

enginetype	The RailTypes of the engine we are considering.
tiletype	The RailType of the tile we are considering.

Returns: Whether the engine got power on this tile.

Definition at line 389 of file rail.h.

References GetAllPoweredRailTypes(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

◆ HasRailTypeAvail()

bool HasRailTypeAvail	(	const CompanyID	company,
		const RailType	railtype
	)

Finds out if a company has a certain buildable railtype available.

Parameters

company	the company in question
railtype	requested RailType

Returns: true if company has requested RailType available

Definition at line 68 of file rail.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::Get(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by ValParamRailType().

◆ 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, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by AfterLoadGRFs().

◆ IsCompatibleRail() [1/2]

bool IsCompatibleRail	(	RailType	enginetype,
		RailType	tiletype
	)

inline

Checks if an engine of the given RailType can drive on a tile with a given RailType.

This would normally just be an equality check, but for electric rails (which also support non-electric engines).

Parameters

enginetype	The RailType of the engine we are considering.
tiletype	The RailType of the tile we are considering.

Returns: Whether the engine can drive on this tile.

Definition at line 352 of file rail.h.

References RailTypeInfo::compatible_railtypes, GetRailTypeInfo(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by CmdBuildRailWagon(), CmdBuildSingleRail(), CmdConvertRail(), and IsCompatibleTrainStationTile().

◆ IsCompatibleRail() [2/2]

bool IsCompatibleRail	(	RailTypes	enginetype,
		RailType	tiletype
	)

inline

Checks if an engine of the given RailTypes can drive on a tile with a given RailType.

Parameters

enginetype	The RailTypes of the engine we are considering.
tiletype	The RailType of the tile we are considering.

Returns: Whether the engine can drive on this tile.

Definition at line 364 of file rail.h.

References GetAllCompatibleRailTypes(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

◆ Rail90DegTurnDisallowed()

bool Rail90DegTurnDisallowed	(	RailType	rt1,
		RailType	rt2,
		bool	def = `_settings_game.pf.forbid_90_deg`
	)

inline

Test if 90 degree turns are disallowed between two railtypes.

Parameters

rt1	First railtype to test for.
rt2	Second railtype to test for.
def	Default value to use if the rail type doesn't specify anything.

Returns: True if 90 degree turns are disallowed between the two rail types.

Definition at line 411 of file rail.h.

References Allow90Deg, Disallow90Deg, RailTypeInfo::flags, GetRailTypeInfo(), INVALID_RAILTYPE, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by CheckNextTrainTile(), ExtendTrainReservation(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::Follow(), IsSafeWaitingPosition(), IsWaitingPositionFree(), TrainCheckIfLineEnds(), TrainController(), and TryPathReserve().

◆ RailBuildCost()

Money RailBuildCost ( RailType railtype )

inline

Returns the cost of building the specified railtype.

Parameters

railtype The railtype being built.

Returns: The cost multiplier.

Definition at line 429 of file rail.h.

References GetRailTypeInfo(), and RAILTYPE_END.

Referenced by CalculateRailStationCost(), CmdBuildBridge(), CmdBuildSingleRail(), CmdBuildTrainDepot(), CmdBuildTunnel(), GetRailTypeDropDownList(), RailClearCost(), RailConvertCost(), and ShowBuildBridgeWindow().

◆ RailClearCost()

Money RailClearCost ( RailType railtype )

inline

Returns the 'cost' of clearing the specified railtype.

Parameters

railtype The railtype being removed.

Returns: The cost.

Definition at line 440 of file rail.h.

References RailBuildCost(), and RAILTYPE_END.

Referenced by CmdRemoveSingleRail(), RailConvertCost(), and TunnelBridgeClearCost().

◆ RailConvertCost()

Money RailConvertCost	(	RailType	from,
		RailType	to
	)

inline

Calculates the cost of rail conversion.

Parameters

from	The railtype we are converting from
to	The railtype we are converting to

Returns: Cost per TrackBit

Definition at line 457 of file rail.h.

References HasPowerOnRail(), RailBuildCost(), and RailClearCost().

Referenced by CmdConvertRail().

◆ RailMaintenanceCost()

Money RailMaintenanceCost	(	RailType	railtype,
		uint32_t	num,
		uint32_t	total_num
	)

inline

Calculates the maintenance cost of a number of track bits.

Parameters

railtype	The railtype to get the cost of.
num	Number of track bits of this railtype.
total_num	Total number of track bits of all railtypes.

Returns: Total cost.

Definition at line 484 of file rail.h.

References GetRailTypeInfo(), IntSqrt(), and RAILTYPE_END.

Referenced by CompaniesGenStatistics().

◆ RailNoLevelCrossings()

bool RailNoLevelCrossings ( RailType rt )

inline

Test if a RailType disallows build of level crossings.

Parameters

rt	The RailType to check.

Returns: Whether level crossings are not allowed.

Definition at line 399 of file rail.h.

References RailTypeInfo::flags, GetRailTypeInfo(), NoLevelCrossing, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by CmdBuildRoad(), CmdBuildSingleRail(), and CmdConvertRail().

◆ 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().

◆ SignalMaintenanceCost()

Money SignalMaintenanceCost ( uint32_t num )

inline

Calculates the maintenance cost of a number of signals.

Parameters

num	Number of signals.

Returns: Total cost.

Definition at line 495 of file rail.h.

References IntSqrt().

Referenced by CompaniesGenStatistics().

◆ 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 2911 of file rail_cmd.cpp.

References Train::CalcNextVehicleOffset(), DIAGDIR_NE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_SW, GetRailDepotDirection(), Vehicle::tile, Vehicle::x_pos, and Vehicle::y_pos.

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

◆ ValParamRailType()

bool ValParamRailType ( const RailType rail )

Validate functions for rail building.

Parameters

rail	the railtype to check.

Returns: true if the current company may build the rail.

Definition at line 90 of file rail.cpp.

References _current_company, HasRailTypeAvail(), and RAILTYPE_END.

Referenced by CmdBuildBridge(), CmdBuildRailStation(), CmdBuildSingleRail(), CmdBuildTrainDepot(), CmdBuildTunnel(), CmdConvertRail(), CmdRailTrackHelper(), BuildRailToolbarWindow::OnInvalidateData(), and ShowBuildRailToolbar().

Variable Documentation

◆ _railtypes_hidden_mask

RailTypes _railtypes_hidden_mask

extern

Definition at line 48 of file rail_cmd.cpp.

◆ _sorted_railtypes

std::vector<RailType> _sorted_railtypes

extern

Sorted list of rail types.

Definition at line 47 of file rail_cmd.cpp.

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

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ RailTypeFlags

Enumeration Type Documentation

◆ RailFenceOffset

◆ RailTrackBridgeOffset

◆ RailTrackOffset

◆ RailTypeFlag

◆ RailTypeSpriteGroup

Function Documentation

◆ AddDateIntroducedRailTypes()

◆ AllocateRailType()

◆ DrawTrainDepotSprite()

◆ GetAllCompatibleRailTypes()

◆ GetAllIntroducesRailTypes()

◆ GetAllPoweredRailTypes()

◆ GetCompanyRailTypes()

◆ GetRailFoundation()

◆ GetRailTypeByLabel()

◆ GetRailTypeInfo()

◆ GetRailTypes()

◆ HasAnyRailTypesAvail()

◆ HasPowerOnRail() [1/2]

◆ HasPowerOnRail() [2/2]

◆ HasRailTypeAvail()

◆ InitRailTypes()

◆ IsCompatibleRail() [1/2]

◆ IsCompatibleRail() [2/2]

◆ Rail90DegTurnDisallowed()

◆ RailBuildCost()

◆ RailClearCost()

◆ RailConvertCost()

◆ RailMaintenanceCost()

◆ RailNoLevelCrossings()

◆ ResetRailTypes()

◆ SignalMaintenanceCost()

◆ TicksToLeaveDepot()

◆ ValParamRailType()

Variable Documentation

◆ _railtypes_hidden_mask

◆ _sorted_railtypes