Open Rails

Train Members

Train overview

Public Static Fields

shortClearingDistanceM
standardClearingDistanceM
standardTrainMinCarNo
TotalNumber

Public Instance Constructors

Train Overloaded. Initializes a new instance of the Train class.

Public Instance Fields

AccelerationMpSpS
activityClearingDistanceM
actualWaitTimeS
allowedAbsoluteMaxSpeedLimitMpS
allowedAbsoluteMaxSpeedSignalMpS
allowedMaxSpeedLimitMpS
AllowedMaxSpeedMpS
allowedMaxSpeedSignalMpS
AtStation
AttachTo
AuxActionsContain
BrakeLine1PressurePSIorInHg
BrakeLine2PressurePSI
BrakeLine3PressurePSI
BrakeLine4
Cars
CheckStations
CheckTrain
ClaimState
ClearanceAtRearM
ControlMode
DataLogFile
DatalogTrainSpeed
DatalogTSContents
DatalogTSInterval
DeadlockInfo
Delay
DisplayColor
DisplayMessage
DistanceToEndNodeAuthorityM
distanceToSignal
DistanceTravelledM
EndAuthorityType
expectedDIr
expectedLength
expectedTDir
expectedTileX
expectedTileZ
expectedTracIndex
expectedTravelled
expectedX
expectedZ
FrontTDBTraveller
HoldingSignals
IncorporatedTrainNo
IncorporatingTrain
IndexNextSignal
IndexNextSpeedlimit
InitialSpeed
InitialThrottlepercent
IsFreight
IsPlayable
IsWheelSlip
IsWheelSlipWarninq
junctionOverlapM
LastPassedSignal
LastReportedSpeed
LastReservedSection
LeadLocomotiveIndex
Length
LoopSection
MassKg
MaximumCouplerForceN
maxTimeS
MayDepart
minCheckDistanceM
minCheckDistanceManualM
MisalignedSwitch
movedBackward
MUDirection
MUDynamicBrakePercent
MUGearboxGearIndex
MUReverserPercent
MUThrottlePercent
Name
NextSignalObject
NPull
NPush
Number
NumOfCouplerBreaks
OccupiedTrack
OutOfControlReason
PassedSignalSpeeds
PassengerCarsNumber
PresentPosition
PreviousPosition
PreviousStop
ProjectedSpeedMpS
RearSignalObject
RearTDBTraveller
requiredActions
ReservedTrackLengthM
RetainerPercent
RetainerSetting
routedBackward
routedForward
SignalObjectItems
SlipperySpotDistanceM
SlipperySpotLengthM
SpeedMpS
standardOverlapM
StationStops
TCRoute
tilted
TotalCouplerSlackM
TrafficService
TrainCurrentCarriageHeatTempC
TrainHeatPipeAreaM2
TrainHeatVolumeM3
TrainInsideTempC
TrainMaxSpeedMpS
TrainOutsideTempC
TrainRoute
TrainSteamHeatLossWpT
TrainType
travelled
UncoupledFrom
updateMSGReceived
ValidRoute
waitingPointWaitTimeS

Public Instance Properties

AITrainBrakePercent
AITrainDirectionForward
AITrainGearboxGearIndex
AITrainThrottlePercent
FirstCar
IsActualPlayerTrain
IsPlayerDriven
LastCar
LeadLocomotive
signalRef
Simulator

Public Instance Methods

AddCouplerImpuseForces
AddRestartTime
AddTrainReversalInfo Add reversal info to TrackMonitorInfo
AddWaitingPointInfo Add waiting point info to TrackMonitorInfo
BreakdownClaim Breakdown claimed route when signal set to hold
BuildSectionString
BuildStationList
BuildWaitingPointList
CalculateInitialTrainPosition Calculate initial position
CalculatePositionOfCars Distance is the signed distance the cars are moving.
CalculateStationStop
CheckAnyWaitCondition
CheckBackwardClearance Check if train moves backward and if so, check clearance behindtrain If no save clearance left, set train to Out_Of_Control
CheckDeadlockWait
CheckExplorerPath
CheckFreight Check if train is passenger or freight train
CheckManualPath
CheckReversal
CheckRouteActions
CheckSignalPassed Check if train went passed signal if so, and signal was at danger, set train Out_Of_Control
CheckSpeedLimitManual Update speed limit in manual mode
CheckStationTask Check on station tasks, required when in timetable mode when there is no activity - dummy method to allow virtualization by child classes
CheckStoppedTrains
CheckTrainWaitingForSignal Check if train is waiting for signal
CheckWaitCondition
ClearActiveSectionItems
ClearDeadlocks
ClearOccupiedSection Clear section
ClearStation
ComputeCouplerForces
ComputeDistanceToNextStation
ComputeDistanceToReversalPoint
ConnectBrakeHoses
ConvertPlayerTraffic
CreateLogFile
CreateStationStop
DisconnectBrakes
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExtractAlternativeRoute_locationBased
ExtractAlternativeRoute_pathBased
FindCommonSectionEnd Find end of common section searching through both routes in forward direction
FindCommonSectionEndReverse Find end of common section searching through own train forward but through other train backward
FindCommonSectionStart Find start of common section of two trains May check through all subpaths for other train but only through start subpath for this train Return value indices : [0, 0] = own train subpath index [0, 1] = own train route index [1, 0] = other train subpath index [1, 1] = other train route index
FindLeadLocomotive
FindLeadLocomotives
ForcedStop
GetAIMovementState Get AI Movement State - dummy method to allow virtualization by child classes
GetDistanceToTrain Get distance from train to location using route list TODO : rewrite to use active links, and if fails use traveller location must have same direction as train
GetHashCode (inherited from Object)Serves as a hash function for a particular type.
GetNextCab Changes the Lead locomotive (i.e. the loco which the player controls) to the next in the consist. Steps back through the train, ignoring any cabs that face rearwards until there are no forward-facing cabs left. Then continues from the rearmost, rearward-facing cab, reverses the train and resumes stepping back. E.g. if consist is made of 3 cars, each with front and rear-facing cabs (A-b]:(C-d]:[e-F) then pressing Ctrl+E cycles the cabs in the sequence A -> b -> C -> d -> e -> F
GetNextSignalAspect get aspect of next signal ahead
GetObjectDistanceToTrain Get distance from train to object position using route list
GetOtherTrainByName Get other train from number Use Simulator.Trains to get other train
GetOtherTrainByNumber Get other train from number Use Simulator.Trains to get other train
GetStatus
GetTrainInfo Create TrackInfoObject for information in TrackMonitor window
GetTrainInfoAuto Create TrackInfoObject for information in TrackMonitor window for Auto mode
GetTrainInfoManual Create TrackInfoObject for information in TrackMonitor window when in Manual mode
GetTrainInfoOOC Create TrackInfoObject for information in TrackMonitor window when OutOfControl
GetType (inherited from Object)Gets the type of the current instance.
HasActiveWait
IncrementSubpath
InitializeBrakes
InitializeMoving
InitializeSignals initialize signal array
InitialTrainPlacement
IsChangeCabAvailable Is there another cab in the player's train to change to?
isInWaitState
LeadNextLocomotive
LogTrainSpeed
MergeWPAndInsert
ObtainRequiredActions get list of required actions (only if not moving backward)
PerformActions Perform actions linked to distance travelled
physicsUpdate
PostInit Post Init : perform all actions required to start
PresetExplorerPath
ProcessExplorerSwitch Process switching of explorer switch
ProcessManualSwitch Process switching of manual switch
ProcessRequestExplorerSetSwitchOverloaded. Process request to set switch in explorer mode Request may contain direction or actual node
ProcessRequestManualSetSwitchOverloaded. Process request to set switch in manual mode Request may contain direction or actual node
ProcessTunnels
PropagateBrakePressure
RemoveFromTrack
RepositionRearTraveller Cars have been added to the rear of the train, recalc the rearTDBtraveller
RequestExplorerSignalPermission
RequestManualSignalPermission
RequestResetSignal
RequestSignalPermission
RequestToggleManualMode
ResetInitialTrainRoute
RestoreExplorerMode Restore Explorer Mode
RestoreManualMode Restore Manual Mode
RestoreTrainPlacement
ReverseFormation Reverse train formation Only performed when train activates a reversal point NOTE : this routine handles the physical train orientation only, all related route settings etc. must be handled separately
Save
SetAlternativeRoute_locationBased
SetAlternativeRoute_pathBased
SetAlternativeStationStop
SetCoupleSpeed
SetFormedOccupied Set Formed Occupied Set track occupied for train formed out of other train
SetHandbrakePercent
SetInitialTrainRoute
SetPendingSpeedLimit Set pending speed limits
SetRetainers
SetRoutePathOverloaded. Create Track Circuit Route Path
SetTrainOutOfControl Switch train to Out-of-Control Set mode and apply emergency brake
SignalEventOverloaded. Someone is sending an event notification to all cars on this train. ie doors open, pantograph up, lights on etc.
SwitchToNodeControl Switch to Auto Node mode
SwitchToSignalControl Switch to Auto Signal mode
TemporarilyRemoveFromTrack
TestAbsDelay
ToDoUpdate
ToggleFromManualMode
ToggleToManualMode
ToString (inherited from Object)Returns a string that represents the current object.
TraincarsInitializeMoving
UnconditionalInitializeBrakes
Update
UpdateAIStaticState Update AI Static state - dummy method to allow virtualization by child classes
UpdateCarSpeeds
UpdateCarSteamHeat
UpdateCouplerSlack
UpdateExplorer
UpdateExplorerMode Update Explorer Mode
UpdateManual
UpdateManualMode Update Manual Mode
UpdateMinimalDelay
UpdateNodeMode Perform auto node mode update
UpdateOutOfControl Update out-of-control mode
UpdateRemoteTrainPos
UpdateRouteActions Check for end of route actions Called every update, actions depend on route state returns : bool[0] "false" end of route not reached bool[1] "false" if no further route available
UpdateRouteClearanceAhead Update route clearance ahead of train Called every update, actions depend on present control state
UpdateSectionState Update section occupy states Input is backward movement counter
UpdateSectionState_Additional Update Section State - additional dummy method to allow virtualisation for Timetable trains
UpdateSectionStateExplorer Update section occupy states fore explorer mode Note : explorer mode has no distance actions so sections must be cleared immediately
UpdateSectionStateManual Update section occupy states for manual mode Note : manual mode has no distance actions so sections must be cleared immediately
UpdateSignalMode Perform auto signal mode update
UpdateSignalState Update the distance to and aspect of next signal
updateSpeedInfo set actual speed limit for all objects depending on state and type of train
UpdateTrackActionsCoupling
UpdateTrackActionsUncoupling
UpdateTrainPosition Update train position
UpdateTrainPositionInformation

Protected Instance Fields

Catalog

Protected Instance Methods

Finalize (inherited from Object)Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

Train Class | ORTS Namespace