Base for the train class. More...

#include "core/enum_type.hpp"
#include "newgrf_engine.h"
#include "cargotype.h"
#include "rail.h"
#include "engine_base.h"
#include "rail_map.h"
#include "ground_vehicle.hpp"

Data Structures
struct	TrainCache
	Variables that are cached to improve performance and such. More...

struct	Train
	'Train' is either a loco or a wagon. More...

Enumerations
enum	VehicleRailFlags { VRF_REVERSING = 0 , VRF_POWEREDWAGON = 3 , VRF_REVERSE_DIRECTION = 4 , VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6 , VRF_TOGGLE_REVERSE = 7 , VRF_TRAIN_STUCK = 8 , VRF_LEAVING_STATION = 9 }
	Rail vehicle flags. More...

enum	TrainForceProceeding : uint8_t { TFP_NONE = 0 , TFP_STUCK = 1 , TFP_SIGNAL = 2 }
	Modes for ignoring signals. More...

enum	ConsistChangeFlags { CCF_LENGTH = 0x01 , CCF_CAPACITY = 0x02 , CCF_TRACK = 0 , CCF_LOADUNLOAD = 0 , CCF_AUTOREFIT = CCF_CAPACITY , CCF_REFIT = CCF_LENGTH \| CCF_CAPACITY , CCF_ARRANGE = CCF_LENGTH \| CCF_CAPACITY , CCF_SAVELOAD = CCF_LENGTH }
	Flags for Train::ConsistChanged. More...

Functions
uint8_t	FreightWagonMult (CargoID cargo)
	Return the cargo weight multiplier to use for a rail vehicle.

void	CheckTrainsLengths ()
	Checks if lengths of all rail vehicles are valid.

void	FreeTrainTrackReservation (const Train *v)
	Free the reserved path in front of a vehicle.

bool	TryPathReserve (Train *v, bool mark_as_stuck=false, bool first_tile_okay=false)
	Try to reserve a path to a safe position.

int	GetTrainStopLocation (StationID station_id, TileIndex tile, const Train v, int station_ahead, int *station_length)
	Get the stop location of (the center) of the front vehicle of a train at a platform of a station.

void	GetTrainSpriteSize (EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
	Get the size of the sprite of a train sprite heading west, or both heads (used for lists).

bool	TrainOnCrossing (TileIndex tile)
	Check if a level crossing tile has a train on it.

void	NormalizeTrainVehInDepot (const Train *u)
	Move all free vehicles in the depot to the train.

Detailed Description

Base for the train class.

Definition in file train.h.

Enumeration Type Documentation

◆ ConsistChangeFlags

enum ConsistChangeFlags

Flags for Train::ConsistChanged.

Enumerator
CCF_LENGTH	Allow vehicles to change length.
CCF_CAPACITY	Allow vehicles to change capacity.
CCF_TRACK	Valid changes while vehicle is driving, and possibly changing tracks.
CCF_LOADUNLOAD	Valid changes while vehicle is loading/unloading.
CCF_AUTOREFIT	Valid changes for autorefitting in stations.
CCF_REFIT	Valid changes for refitting in a depot.
CCF_ARRANGE	Valid changes for arranging the consist in a depot.
CCF_SAVELOAD	Valid changes when loading a savegame. (Everything that is not stored in the save.)

Definition at line 44 of file train.h.

◆ TrainForceProceeding

enum TrainForceProceeding : uint8_t

Modes for ignoring signals.

Enumerator
TFP_NONE	Normal operation.
TFP_STUCK	Proceed till next signal, but ignore being stuck till then. This includes force leaving depots.
TFP_SIGNAL	Ignore next signal, after the signal ignore being stuck.

Definition at line 37 of file train.h.

◆ VehicleRailFlags

enum VehicleRailFlags

Rail vehicle flags.

Enumerator
VRF_POWEREDWAGON	Wagon is powered.
VRF_REVERSE_DIRECTION	Reverse the visible direction of the vehicle.
VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL	Electric train engine is allowed to run on normal rail. *‍/.
VRF_TOGGLE_REVERSE	Used for vehicle var 0xFE bit 8 (toggled each time the train is reversed, accurate for first vehicle only).
VRF_TRAIN_STUCK	Train can't get a path reservation.
VRF_LEAVING_STATION	Train is just leaving a station.

Definition at line 25 of file train.h.

Function Documentation

◆ CheckTrainsLengths()

void CheckTrainsLengths ( )

Checks if lengths of all rail vehicles are valid.

If not, shows an error message.

Definition at line 76 of file train_cmd.cpp.

References _networking, abs(), INVALID_STRING_ID, SpecializedVehicle< T, Type >::Iterate(), SpecializedVehicle< T, Type >::Next(), PM_PAUSED_ERROR, SetDParam(), ShowErrorMessage(), TicksToLeaveDepot(), TRACK_BIT_DEPOT, VS_CRASHED, and WL_CRITICAL.

Referenced by InitializeWindowsAndCaches(), and ReloadNewGRFData().

◆ FreeTrainTrackReservation()

void FreeTrainTrackReservation ( const Train * v )

Free the reserved path in front of a vehicle.

Parameters

v	Train owning the reserved path.

Definition at line 2386 of file train_cmd.cpp.

References AddSideToSignalBuffer(), ClearPathReservation(), RailTypeInfo::compatible_railtypes, CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::Follow(), GetRailDepotDirection(), GetRailTypeInfo(), GetReservedTrackbits(), GetSignalStateByTrackdir(), GetStationIndex(), Train::GetVehicleTrackdir(), HasPbsSignalOnTrackdir(), HasSignalOnTrackdir(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::is_bridge, CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::is_station, CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::is_tunnel, Vehicle::IsFrontEngine(), IsOnewaySignal(), IsRailDepotTile(), IsRailStationTile(), IsTileType(), IsValidTrackdir(), MarkTileDirtyByTile(), MP_RAILWAY, MP_TUNNELBRIDGE, CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::new_td_bits, CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::new_tile, SpecializedVehicle< T, Type >::Next(), Vehicle::owner, RemoveFirstTrackdir(), ReverseTrackdir(), SetSignalStateByTrackdir(), SIGNAL_STATE_RED, Vehicle::tile, TRACK_BIT_DEPOT, TrackBitsToTrackdirBits(), TRACKDIR_BIT_NONE, TrackdirToExitdir(), TrackdirToTrack(), TracksOverlap(), TrackToTrackBits(), UnreserveRailTrack(), and UpdateSignalsInBuffer().

Referenced by CmdBuildSingleSignal(), CmdConvertRail(), CmdRemoveSingleRail(), Train::Crash(), DoClearBridge(), DoClearTunnel(), FreeTrainReservation(), and ReverseTrainDirection().

◆ FreightWagonMult()

uint8_t FreightWagonMult ( CargoID cargo )

Return the cargo weight multiplier to use for a rail vehicle.

Parameters

cargo Cargo type to get multiplier for

Returns: Cargo weight multiplier

Definition at line 69 of file train_cmd.cpp.

References _settings_game, VehicleSettings::freight_trains, CargoSpec::Get(), and GameSettings::vehicle.

Referenced by DrawTrainDetails(), TrainDetailsCapacityTab(), and TrainDetailsCargoTab().

◆ GetTrainSpriteSize()

void GetTrainSpriteSize	(	EngineID	engine,
		uint &	width,
		uint &	height,
		int &	xoffs,
		int &	yoffs,
		EngineImageType	image_type
	)

Get the size of the sprite of a train sprite heading west, or both heads (used for lists).

Parameters

	engine	The engine to get the sprite from.
[out]	width	The width of the sprite.
[out]	height	The height of the sprite.
[out]	xoffs	Number of pixels to shift the sprite to the right.
[out]	yoffs	Number of pixels to shift the sprite downwards.
	image_type	Context the sprite is used in.

Definition at line 581 of file train_cmd.cpp.

References VehicleSpriteSeq::GetBounds(), Rect::Height(), RAILVEH_MULTIHEAD, ScaleSpriteTrad(), UnScaleGUI(), and Rect::Width().

Referenced by EnginePreviewWindow::UpdateWidgetSize().

◆ GetTrainStopLocation()

int GetTrainStopLocation	(	StationID	station_id,
		TileIndex	tile,
		const Train *	v,
		int *	station_ahead,
		int *	station_length
	)

Get the stop location of (the center) of the front vehicle of a train at a platform of a station.

Parameters

station_id	the ID of the station where we're stopping
tile	the tile where the vehicle currently is
v	the vehicle to get the stop location of
station_ahead	'return' the amount of 1/16th tiles in front of the train
station_length	'return' the station length in 1/16th tiles

Returns: the location, calculated from the begin of the station to stop at.

Definition at line 263 of file train_cmd.cpp.

References GroundVehicleCache::cached_total_length, GroundVehicleCache::cached_veh_length, Vehicle::current_order, Vehicle::direction, DirToDiagDir(), GroundVehicle< T, Type >::gcache, SpecializedStation< Station, false >::Get(), Order::GetDestination(), Station::GetPlatformLength(), Order::GetStopLocation(), Order::IsType(), OSL_PLATFORM_FAR_END, OSL_PLATFORM_MIDDLE, OSL_PLATFORM_NEAR_END, and TILE_SIZE.

Referenced by Train::GetCurrentMaxSpeed().

◆ NormalizeTrainVehInDepot()

void NormalizeTrainVehInDepot ( const Train * u )

Move all free vehicles in the depot to the train.

Definition at line 693 of file train_cmd.cpp.

References DC_EXEC, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, GroundVehicle< T, Type >::IsEngine(), SpecializedVehicle< T, Type >::Iterate(), Vehicle::tile, and TRACK_BIT_DEPOT.

Referenced by CmdBuildVehicle().

◆ TrainOnCrossing()

bool TrainOnCrossing ( TileIndex tile )

Check if a level crossing tile has a train on it.

Parameters

tile	tile to test

Returns: true if a train is on the crossing

Precondition: tile is a level crossing

Definition at line 1683 of file train_cmd.cpp.

References HasVehicleOnPos(), IsLevelCrossingTile(), and TrainOnTileEnum().

Referenced by CheckLevelCrossing().

◆ TryPathReserve()

bool TryPathReserve	(	Train *	v,
		bool	mark_as_stuck,
		bool	first_tile_okay
	)

Try to reserve a path to a safe position.

Parameters

v	The vehicle
mark_as_stuck	Should the train be marked as stuck on a failed reservation?
first_tile_okay	True if no path should be reserved if the current tile is a safe position.

Returns: True if a path could be reserved.

Definition at line 2866 of file train_cmd.cpp.

References _settings_client, ClrBit(), DiagdirReachesTrackdirs(), DiagdirReachesTracks(), FollowTrainReservation(), GetRailDepotDirection(), GetTileRailType(), GetTileTrackStatus(), ClientSettings::gui, HasBit(), HasDepotReservation(), HasReservedTracks(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::IsFrontEngine(), MarkTileDirtyByTile(), MarkTrainAsStuck(), PBSTileInfo::okay, Rail90DegTurnDisallowed(), SetDepotReservation(), SetWindowWidgetDirty(), GUISettings::show_track_reservation, PBSTileInfo::tile, Vehicle::tile, TileAddByDiagDir(), TRACK_BIT_DEPOT, PBSTileInfo::trackdir, TrackdirBitsToTrackBits(), TrackdirToExitdir(), TrackdirToTrack(), TrackStatusToTrackdirBits(), TRANSPORT_RAIL, VRF_TRAIN_STUCK, Train::wait_counter, WC_VEHICLE_VIEW, and WID_VV_START_STOP.

Referenced by CheckTrainStayInDepot(), CmdBuildSingleSignal(), CmdConvertRail(), CmdRemoveSingleRail(), CmdRemoveSingleSignal(), DoClearBridge(), DoClearTunnel(), RestoreTrainReservation(), ReverseTrainDirection(), and TrainController().

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ConsistChangeFlags

◆ TrainForceProceeding

◆ VehicleRailFlags

Function Documentation

◆ CheckTrainsLengths()

◆ FreeTrainTrackReservation()

◆ FreightWagonMult()

◆ GetTrainSpriteSize()

◆ GetTrainStopLocation()

◆ NormalizeTrainVehInDepot()

◆ TrainOnCrossing()

◆ TryPathReserve()