OpenTTD
rail.cpp File Reference

Implementation of rail specific functions. More...

#include "stdafx.h"
#include "station_map.h"
#include "tunnelbridge_map.h"
#include "date_func.h"
#include "company_func.h"
#include "company_base.h"
#include "engine_base.h"
#include "safeguards.h"

Go to the source code of this file.

Functions

RailType GetTileRailType (TileIndex tile)
 Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
 
bool HasRailtypeAvail (const CompanyID company, const RailType railtype)
 Finds out if a company has a certain buildable railtype available. More...
 
bool HasAnyRailtypesAvail (const CompanyID company)
 Test if any buildable railtype is available for a company. More...
 
bool ValParamRailtype (const RailType rail)
 Validate functions for rail building. More...
 
RailTypes AddDateIntroducedRailTypes (RailTypes current, Date date)
 Add the rail types that are to be introduced at the given date. More...
 
RailTypes GetCompanyRailtypes (CompanyID company, bool introduces)
 Get the rail types the given company can build. More...
 
RailTypes GetRailTypes (bool introduces)
 Get list of rail types, regardless of company availability. More...
 
RailType GetRailTypeByLabel (RailTypeLabel label, bool allow_alternate_labels)
 Get the rail type for a given label. More...
 

Variables

const byte _signal_along_trackdir [TRACKDIR_END]
 
const byte _signal_against_trackdir [TRACKDIR_END]
 
const byte _signal_on_track []
 
const TrackdirBits _exitdir_reaches_trackdirs []
 
const Trackdir _next_trackdir [TRACKDIR_END]
 
const TrackdirBits _track_crosses_trackdirs [TRACK_END]
 
const TrackBits _track_crosses_tracks []
 
const DiagDirection _trackdir_to_exitdir [TRACKDIR_END]
 
const Trackdir _track_exitdir_to_trackdir [][DIAGDIR_END]
 
const Trackdir _track_enterdir_to_trackdir [][DIAGDIR_END]
 
const Trackdir _track_direction_to_trackdir [][DIR_END]
 
const Trackdir _dir_to_diag_trackdir []
 
const TrackBits _corner_to_trackbits []
 
const TrackdirBits _uphill_trackdirs []
 

Detailed Description

Implementation of rail specific functions.

Definition in file rail.cpp.

Function Documentation

◆ AddDateIntroducedRailTypes()

RailTypes AddDateIntroducedRailTypes ( RailTypes  current,
Date  date 
)

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

Parameters
currentThe currently available railtypes.
dateThe 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 218 of file rail.cpp.

References AddDateIntroducedRailTypes(), GetRailTypeInfo(), RailtypeInfo::introduces_railtypes, RailtypeInfo::introduction_date, RailtypeInfo::introduction_required_railtypes, IsInsideMM(), RailtypeInfo::label, MAX_DAY, RAILTYPE_BEGIN, and RAILTYPE_END.

Referenced by AddDateIntroducedRailTypes(), and EnginesDailyLoop().

◆ GetCompanyRailtypes()

RailTypes GetCompanyRailtypes ( CompanyID  company,
bool  introduces 
)

Get the rail types the given company can build.

Parameters
companythe company to get the rail types for.
introducesIf true, include rail types introduced by other rail types
Returns
the rail types.

Definition at line 251 of file rail.cpp.

References _date, _settings_game, EngineInfo::climates, DAYS_IN_YEAR, GameSettings::game_creation, HasBit(), Engine::IterateType(), GameCreationSettings::landscape, RAILTYPES_NONE, RAILVEH_WAGON, and VEH_TRAIN.

Referenced by GetRailTypeDropDownList(), SettingsDisableElrail(), and StartupEngines().

◆ GetRailTypeByLabel()

RailType GetRailTypeByLabel ( RailTypeLabel  label,
bool  allow_alternate_labels 
)

Get the rail type for a given label.

Parameters
labelthe railtype label.
allow_alternate_labelsSearch in the alternate label lists as well.
Returns
the railtype.

Definition at line 311 of file rail.cpp.

References RailtypeInfo::alternate_labels, GetRailTypeInfo(), INVALID_RAILTYPE, RailtypeInfo::label, RAILTYPE_BEGIN, and RAILTYPE_END.

◆ GetRailTypes()

RailTypes GetRailTypes ( bool  introduces)

Get list of rail types, regardless of company availability.

Parameters
introducesIf true, include rail types introduced by other rail types
Returns
the rail types.

Definition at line 282 of file rail.cpp.

References _settings_game, EngineInfo::climates, GameSettings::game_creation, HasBit(), Engine::IterateType(), GameCreationSettings::landscape, RAILTYPES_NONE, RAILVEH_WAGON, and VEH_TRAIN.

Referenced by GetRailTypeDropDownList().

◆ HasAnyRailtypesAvail()

bool HasAnyRailtypesAvail ( const CompanyID  company)

Test if any buildable railtype is available for a company.

Parameters
companythe company in question
Returns
true if company has any RailTypes available

Definition at line 196 of file rail.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get().

◆ HasRailtypeAvail()

bool HasRailtypeAvail ( const CompanyID  company,
const RailType  railtype 
)

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

Parameters
companythe company in question
railtyperequested RailType
Returns
true if company has requested RailType available

Definition at line 186 of file rail.cpp.

References HasBit().

Referenced by ValParamRailtype().

◆ ValParamRailtype()

bool ValParamRailtype ( const RailType  rail)

Validate functions for rail building.

Parameters
railthe railtype to check.
Returns
true if the current company may build the rail.

Definition at line 206 of file rail.cpp.

References _current_company, HasRailtypeAvail(), and RAILTYPE_END.

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

Variable Documentation

◆ _corner_to_trackbits

const TrackBits _corner_to_trackbits[]
Initial value:

◆ _dir_to_diag_trackdir

const Trackdir _dir_to_diag_trackdir[]
Initial value:
= {
}
X-axis and direction to north-east.
Definition: track_type.h:72
Y-axis and direction to north-west.
Definition: track_type.h:81
Y-axis and direction to south-east.
Definition: track_type.h:73
X-axis and direction to south-west.
Definition: track_type.h:80

◆ _exitdir_reaches_trackdirs

const TrackdirBits _exitdir_reaches_trackdirs[]
Initial value:
= {
}
Track upper, direction west.
Definition: track_type.h:112
Track right, direction north.
Definition: track_type.h:115
Track left, direction south.
Definition: track_type.h:107
Track y-axis, direction south-east.
Definition: track_type.h:104
Track left, direction north.
Definition: track_type.h:114
Track lower, direction east.
Definition: track_type.h:106
Track x-axis, direction south-west.
Definition: track_type.h:110
Track y-axis, direction north-west.
Definition: track_type.h:111
Track lower, direction west.
Definition: track_type.h:113
Track upper, direction east.
Definition: track_type.h:105
Track x-axis, direction north-east.
Definition: track_type.h:103
Track right, direction south.
Definition: track_type.h:108

◆ _next_trackdir

const Trackdir _next_trackdir[TRACKDIR_END]
Initial value:
= {
}
Lower track and direction to west.
Definition: track_type.h:83
X-axis and direction to north-east.
Definition: track_type.h:72
Upper track and direction to west.
Definition: track_type.h:82
Y-axis and direction to north-west.
Definition: track_type.h:81
Y-axis and direction to south-east.
Definition: track_type.h:73
Right track and direction to south.
Definition: track_type.h:77
Flag for an invalid trackdir.
Definition: track_type.h:89
Left track and direction to south.
Definition: track_type.h:76
Upper track and direction to east.
Definition: track_type.h:74
X-axis and direction to south-west.
Definition: track_type.h:80
Left track and direction to north.
Definition: track_type.h:84
Right track and direction to north.
Definition: track_type.h:85
Lower track and direction to east.
Definition: track_type.h:75

◆ _signal_against_trackdir

const byte _signal_against_trackdir[TRACKDIR_END]
Initial value:
= {
0x4, 0x4, 0x4, 0x1, 0x8, 0x2, 0, 0,
0x8, 0x8, 0x8, 0x2, 0x4, 0x1
}

◆ _signal_along_trackdir

const byte _signal_along_trackdir[TRACKDIR_END]
Initial value:
= {
0x8, 0x8, 0x8, 0x2, 0x4, 0x1, 0, 0,
0x4, 0x4, 0x4, 0x1, 0x8, 0x2
}

◆ _signal_on_track

const byte _signal_on_track[]
Initial value:
= {
0xC, 0xC, 0xC, 0x3, 0xC, 0x3
}

◆ _track_crosses_trackdirs

const TrackdirBits _track_crosses_trackdirs[TRACK_END]
Initial value:
= {
}
Track upper, direction west.
Definition: track_type.h:112
Track right, direction north.
Definition: track_type.h:115
Track left, direction south.
Definition: track_type.h:107
Track y-axis, direction south-east.
Definition: track_type.h:104
Track left, direction north.
Definition: track_type.h:114
Track lower, direction east.
Definition: track_type.h:106
Track x-axis, direction south-west.
Definition: track_type.h:110
Track y-axis, direction north-west.
Definition: track_type.h:111
Track lower, direction west.
Definition: track_type.h:113
Track upper, direction east.
Definition: track_type.h:105
Track x-axis, direction north-east.
Definition: track_type.h:103
Track right, direction south.
Definition: track_type.h:108

◆ _track_crosses_tracks

const TrackBits _track_crosses_tracks[]
Initial value:
= {
TRACK_BIT_HORZ
}
X-axis track.
Definition: track_type.h:40
Left and right track.
Definition: track_type.h:48
Y-axis track.
Definition: track_type.h:41
Upper and lower track.
Definition: track_type.h:47

◆ _track_direction_to_trackdir

const Trackdir _track_direction_to_trackdir[][DIR_END]
Initial value:
= {
}
Lower track and direction to west.
Definition: track_type.h:83
X-axis and direction to north-east.
Definition: track_type.h:72
Upper track and direction to west.
Definition: track_type.h:82
Y-axis and direction to north-west.
Definition: track_type.h:81
Y-axis and direction to south-east.
Definition: track_type.h:73
Right track and direction to south.
Definition: track_type.h:77
Flag for an invalid trackdir.
Definition: track_type.h:89
Left track and direction to south.
Definition: track_type.h:76
Upper track and direction to east.
Definition: track_type.h:74
X-axis and direction to south-west.
Definition: track_type.h:80
Left track and direction to north.
Definition: track_type.h:84
Right track and direction to north.
Definition: track_type.h:85
Lower track and direction to east.
Definition: track_type.h:75

◆ _track_enterdir_to_trackdir

const Trackdir _track_enterdir_to_trackdir[][DIAGDIR_END]
Initial value:
= {
}
Lower track and direction to west.
Definition: track_type.h:83
X-axis and direction to north-east.
Definition: track_type.h:72
Upper track and direction to west.
Definition: track_type.h:82
Y-axis and direction to north-west.
Definition: track_type.h:81
Y-axis and direction to south-east.
Definition: track_type.h:73
Right track and direction to south.
Definition: track_type.h:77
Flag for an invalid trackdir.
Definition: track_type.h:89
Left track and direction to south.
Definition: track_type.h:76
Upper track and direction to east.
Definition: track_type.h:74
X-axis and direction to south-west.
Definition: track_type.h:80
Left track and direction to north.
Definition: track_type.h:84
Right track and direction to north.
Definition: track_type.h:85
Lower track and direction to east.
Definition: track_type.h:75

◆ _track_exitdir_to_trackdir

const Trackdir _track_exitdir_to_trackdir[][DIAGDIR_END]
Initial value:
= {
}
Lower track and direction to west.
Definition: track_type.h:83
X-axis and direction to north-east.
Definition: track_type.h:72
Upper track and direction to west.
Definition: track_type.h:82
Y-axis and direction to north-west.
Definition: track_type.h:81
Y-axis and direction to south-east.
Definition: track_type.h:73
Right track and direction to south.
Definition: track_type.h:77
Flag for an invalid trackdir.
Definition: track_type.h:89
Left track and direction to south.
Definition: track_type.h:76
Upper track and direction to east.
Definition: track_type.h:74
X-axis and direction to south-west.
Definition: track_type.h:80
Left track and direction to north.
Definition: track_type.h:84
Right track and direction to north.
Definition: track_type.h:85
Lower track and direction to east.
Definition: track_type.h:75

◆ _trackdir_to_exitdir

const DiagDirection _trackdir_to_exitdir[TRACKDIR_END]
Initial value: