rail.cpp File Reference

Implementation of rail specific functions. More...

#include "stdafx.h"
#include "station_map.h"
#include "tunnelbridge_map.h"
#include "timer/timer_game_calendar.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 (Tile 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, TimerGameCalendar::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 uint8_t	_signal_along_trackdir [TRACKDIR_END]
const uint8_t	_signal_against_trackdir [TRACKDIR_END]
const uint8_t	_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,
		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 218 of file rail.cpp.

References GetRailTypeInfo(), RailTypeInfo::introduces_railtypes, RailTypeInfo::introduction_date, RailTypeInfo::introduction_required_railtypes, IsInsideMM(), RailTypeInfo::label, TimerGameConst< struct Calendar >::MAX_DATE, RAILTYPE_BEGIN, and RAILTYPE_END.

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

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 251 of file rail.cpp.

References _settings_game, AddDateIntroducedRailTypes(), EngineInfo::climates, TimerGameCalendar::date, TimerGameConst< struct Calendar >::DAYS_IN_YEAR, GameSettings::game_creation, GetRailTypeInfo(), HasBit(), RailTypeInfo::introduces_railtypes, Engine::IterateType(), GameCreationSettings::landscape, RailVehicleInfo::railtype, RAILTYPE_END, RAILTYPES_NONE, RAILVEH_WAGON, SetBit(), and VEH_TRAIN.

Referenced by DisableEngineForCompany(), EnableEngineForCompany(), and GetRailTypeDropDownList().

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 311 of file rail.cpp.

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

Referenced by GetRailTypeTranslation().

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 282 of file rail.cpp.

References _settings_game, AddDateIntroducedRailTypes(), EngineInfo::climates, GameSettings::game_creation, GetRailTypeInfo(), HasBit(), RailTypeInfo::introduces_railtypes, Engine::IterateType(), GameCreationSettings::landscape, TimerGameConst< struct Calendar >::MAX_DATE, RailVehicleInfo::railtype, RAILTYPE_END, RAILTYPES_NONE, RAILVEH_WAGON, SetBit(), 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 196 of file rail.cpp.

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

Referenced by CanBuildVehicleInfrastructure().

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 186 of file rail.cpp.

References HasBit().

Referenced by ValParamRailType().

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 206 of file rail.cpp.

References _current_company, HasRailTypeAvail(), and RAILTYPE_END.

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

Variable Documentation

_corner_to_trackbits

const TrackBits _corner_to_trackbits[]

extern

Initial value:

= {
  TRACK_BIT_LEFT, TRACK_BIT_LOWER, TRACK_BIT_RIGHT, TRACK_BIT_UPPER,
}

_dir_to_diag_trackdir

const Trackdir _dir_to_diag_trackdir[]

extern

Initial value:

= {
  TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW,
}

_exitdir_reaches_trackdirs

const TrackdirBits _exitdir_reaches_trackdirs[]

extern

Initial value:

= {
  TRACKDIR_BIT_X_NE | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_LEFT_N,  
  TRACKDIR_BIT_Y_SE | TRACKDIR_BIT_LEFT_S  | TRACKDIR_BIT_UPPER_E, 
  TRACKDIR_BIT_X_SW | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_RIGHT_S, 
  TRACKDIR_BIT_Y_NW | TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W  
}

_next_trackdir

const Trackdir _next_trackdir[TRACKDIR_END]

extern

Initial value:

= {
  TRACKDIR_X_NE,  TRACKDIR_Y_SE,  TRACKDIR_LOWER_E, TRACKDIR_UPPER_E, TRACKDIR_RIGHT_S, TRACKDIR_LEFT_S, INVALID_TRACKDIR, INVALID_TRACKDIR,
  TRACKDIR_X_SW,  TRACKDIR_Y_NW,  TRACKDIR_LOWER_W, TRACKDIR_UPPER_W, TRACKDIR_RIGHT_N, TRACKDIR_LEFT_N
}

_signal_against_trackdir

const uint8_t _signal_against_trackdir[TRACKDIR_END]

extern

Initial value:

= {
  0x4, 0x4, 0x4, 0x1, 0x8, 0x2, 0, 0,
  0x8, 0x8, 0x8, 0x2, 0x4, 0x1
}

_signal_along_trackdir

const uint8_t _signal_along_trackdir[TRACKDIR_END]

extern

Initial value:

= {
  0x8, 0x8, 0x8, 0x2, 0x4, 0x1, 0, 0,
  0x4, 0x4, 0x4, 0x1, 0x8, 0x2
}

_signal_on_track

const uint8_t _signal_on_track[]

extern

Initial value:

= {
  0xC, 0xC, 0xC, 0x3, 0xC, 0x3
}

_track_crosses_trackdirs

const TrackdirBits _track_crosses_trackdirs[TRACK_END]

extern

Initial value:

= {
  TRACKDIR_BIT_Y_SE     | TRACKDIR_BIT_Y_NW,                                                   
  TRACKDIR_BIT_X_NE     | TRACKDIR_BIT_X_SW,                                                   
  TRACKDIR_BIT_RIGHT_N  | TRACKDIR_BIT_RIGHT_S  | TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_LEFT_S,  
  TRACKDIR_BIT_RIGHT_N  | TRACKDIR_BIT_RIGHT_S  | TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_LEFT_S,  
  TRACKDIR_BIT_UPPER_W  | TRACKDIR_BIT_UPPER_E  | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_LOWER_E, 
  TRACKDIR_BIT_UPPER_W  | TRACKDIR_BIT_UPPER_E  | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_LOWER_E  
}

_track_crosses_tracks

const TrackBits _track_crosses_tracks[]

extern

Initial value:

= {
  TRACK_BIT_Y,    
  TRACK_BIT_X,    
  TRACK_BIT_VERT, 
  TRACK_BIT_VERT, 
  TRACK_BIT_HORZ, 
  TRACK_BIT_HORZ  
}

_track_direction_to_trackdir

const Trackdir _track_direction_to_trackdir[][DIR_END]

extern

Initial value:

= {
  {INVALID_TRACKDIR, TRACKDIR_X_NE,     INVALID_TRACKDIR, INVALID_TRACKDIR,  INVALID_TRACKDIR, TRACKDIR_X_SW,     INVALID_TRACKDIR, INVALID_TRACKDIR},
  {INVALID_TRACKDIR, INVALID_TRACKDIR,  INVALID_TRACKDIR, TRACKDIR_Y_SE,     INVALID_TRACKDIR, INVALID_TRACKDIR,  INVALID_TRACKDIR, TRACKDIR_Y_NW},
  {INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_UPPER_E, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_UPPER_W, INVALID_TRACKDIR},
  {INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_LOWER_E, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_LOWER_W, INVALID_TRACKDIR},
  {TRACKDIR_LEFT_N,  INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_LEFT_S,  INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR},
  {TRACKDIR_RIGHT_N, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_RIGHT_S, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR}
}

_track_enterdir_to_trackdir

const Trackdir _track_enterdir_to_trackdir[][DIAGDIR_END]

extern

Initial value:

= {
  {TRACKDIR_X_NE,     INVALID_TRACKDIR,  TRACKDIR_X_SW,     INVALID_TRACKDIR},
  {INVALID_TRACKDIR,  TRACKDIR_Y_SE,     INVALID_TRACKDIR,  TRACKDIR_Y_NW},
  {INVALID_TRACKDIR,  TRACKDIR_UPPER_E,  TRACKDIR_UPPER_W,  INVALID_TRACKDIR},
  {TRACKDIR_LOWER_E,  INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_LOWER_W},
  {TRACKDIR_LEFT_N,   TRACKDIR_LEFT_S,   INVALID_TRACKDIR,  INVALID_TRACKDIR},
  {INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_RIGHT_S,  TRACKDIR_RIGHT_N}
}

_track_exitdir_to_trackdir

const Trackdir _track_exitdir_to_trackdir[][DIAGDIR_END]

extern

Initial value:

= {
  {TRACKDIR_X_NE,     INVALID_TRACKDIR,  TRACKDIR_X_SW,     INVALID_TRACKDIR},
  {INVALID_TRACKDIR,  TRACKDIR_Y_SE,     INVALID_TRACKDIR,  TRACKDIR_Y_NW},
  {TRACKDIR_UPPER_E,  INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_UPPER_W},
  {INVALID_TRACKDIR,  TRACKDIR_LOWER_E,  TRACKDIR_LOWER_W,  INVALID_TRACKDIR},
  {INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_LEFT_S,   TRACKDIR_LEFT_N},
  {TRACKDIR_RIGHT_N,  TRACKDIR_RIGHT_S,  INVALID_TRACKDIR,  INVALID_TRACKDIR}
}

_trackdir_to_exitdir

const DiagDirection _trackdir_to_exitdir[TRACKDIR_END]

extern

Initial value:

= {
  DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_SW, DIAGDIR_SE, DIAGDIR_NE, DIAGDIR_NE,
  DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NE,
}