Open Rails

TTTrain Members

TTTrain overview

Public Instance Constructors

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

Public Instance Fields

AccelerationMpSpS (inherited from Train)
ActivateTime
activityClearingDistanceM (inherited from Train)
actualWaitTimeS (inherited from Train)
AI (inherited from AITrain)
allowedAbsoluteMaxSpeedLimitMpS (inherited from Train)
allowedAbsoluteMaxSpeedSignalMpS (inherited from Train)
allowedMaxSpeedLimitMpS (inherited from Train)
AllowedMaxSpeedMpS (inherited from Train)
allowedMaxSpeedSignalMpS (inherited from Train)
Alpha10 (inherited from AITrain)
AtStation (inherited from Train)
AttachTo (inherited from Train)
AuxActionsContain (inherited from Train)
BrakeLine1PressurePSIorInHg (inherited from Train)
BrakeLine2PressurePSI (inherited from Train)
BrakeLine3PressurePSI (inherited from Train)
BrakeLine4 (inherited from Train)
Cars (inherited from Train)
CheckStations (inherited from Train)
CheckTrain (inherited from Train)
ClaimState (inherited from Train)
ClearanceAtRearM (inherited from Train)
ControlMode (inherited from Train)
CreateAhead
Created
DataLogFile (inherited from Train)
DatalogTrainSpeed (inherited from Train)
DatalogTSContents (inherited from Train)
DatalogTSInterval (inherited from Train)
DeadlockInfo (inherited from Train)
DefMaxAccelMpSSF
DefMaxAccelMpSSP
DefMaxDecelMpSSF
DefMaxDecelMpSSP
Delay (inherited from Train)
DetachDetails
DisplayColor (inherited from Train)
DisplayMessage (inherited from Train)
DistanceToEndNodeAuthorityM (inherited from Train)
distanceToSignal (inherited from Train)
DistanceTravelledM (inherited from Train)
Efficiency (inherited from AITrain)
EndAuthorityType (inherited from Train)
expectedDIr (inherited from Train)
expectedLength (inherited from Train)
expectedTDir (inherited from Train)
expectedTileX (inherited from Train)
expectedTileZ (inherited from Train)
expectedTracIndex (inherited from Train)
expectedTravelled (inherited from Train)
expectedX (inherited from Train)
expectedZ (inherited from Train)
FormedOf
FormedOfType
Forms
FormsAtStation
FormsStatic
FrontTDBTraveller (inherited from Train)
HoldingSignals (inherited from Train)
IncorporatedTrainNo (inherited from Train)
IncorporatingTrain (inherited from Train)
IndexNextSignal (inherited from Train)
IndexNextSpeedlimit (inherited from Train)
InitialSpeed (inherited from Train)
InitialThrottlepercent (inherited from Train)
IsFreight (inherited from Train)
IsPlayable (inherited from Train)
IsWheelSlip (inherited from Train)
IsWheelSlipWarninq (inherited from Train)
junctionOverlapM (inherited from Train)
LastPassedSignal (inherited from Train)
LastReportedSpeed (inherited from Train)
LastReservedSection (inherited from Train)
LastSpeedMpS (inherited from AITrain)
leadLocoAntiSlip
LeadLocomotiveIndex (inherited from Train)
Length (inherited from Train)
LoopSection (inherited from Train)
MassKg (inherited from Train)
MaxAccelMpSS (inherited from AITrain)
MaxAccelMpSSF (inherited from AITrain)
MaxAccelMpSSP (inherited from AITrain)
MaxDecelMpSS (inherited from AITrain)
MaxDecelMpSSF (inherited from AITrain)
MaxDecelMpSSP (inherited from AITrain)
MaximumCouplerForceN (inherited from Train)
maxTimeS (inherited from Train)
MaxVelocityA (inherited from AITrain)
MayDepart (inherited from Train)
minCheckDistanceM (inherited from Train)
minCheckDistanceManualM (inherited from Train)
MisalignedSwitch (inherited from Train)
movedBackward (inherited from Train)
MovementState (inherited from AITrain)
MUDirection (inherited from Train)
MUDynamicBrakePercent (inherited from Train)
MUGearboxGearIndex (inherited from Train)
MUReverserPercent (inherited from Train)
MUThrottlePercent (inherited from Train)
Name (inherited from Train)
nextActionInfo (inherited from AITrain)
nextGenAction (inherited from AITrain)
NextSignalObject (inherited from Train)
NextStopDistanceM (inherited from AITrain)
NPull (inherited from Train)
NPush (inherited from Train)
Number (inherited from Train)
NumOfCouplerBreaks (inherited from Train)
OccupiedTrack (inherited from Train)
OrgAINumber
OutOfControlReason (inherited from Train)
PassedSignalSpeeds (inherited from Train)
PassengerCarsNumber (inherited from Train)
Path (inherited from AITrain)
PowerState (inherited from AITrain)
PresentPosition (inherited from Train)
PreUpdate (inherited from AITrain)
PreviousPosition (inherited from Train)
PreviousStop (inherited from Train)
ProjectedSpeedMpS (inherited from Train)
RearSignalObject (inherited from Train)
RearTDBTraveller (inherited from Train)
requiredActions (inherited from Train)
ReservedTrackLengthM (inherited from Train)
RetainerPercent (inherited from Train)
RetainerSetting (inherited from Train)
routedBackward (inherited from Train)
routedForward (inherited from Train)
ServiceDefinition (inherited from AITrain)
SetStop
SignalObjectItems (inherited from Train)
SlipperySpotDistanceM (inherited from Train)
SlipperySpotLengthM (inherited from Train)
SpeedMpS (inherited from Train)
Stable_CallOn
standardOverlapM (inherited from Train)
StartTime (inherited from AITrain)
StationStops (inherited from Train)
TCRoute (inherited from Train)
tilted (inherited from Train)
TotalCouplerSlackM (inherited from Train)
TrafficService (inherited from Train)
TrainCurrentCarriageHeatTempC (inherited from Train)
TrainHeatPipeAreaM2 (inherited from Train)
TrainHeatVolumeM3 (inherited from Train)
TrainInsideTempC (inherited from Train)
TrainMaxSpeedMpS (inherited from Train)
TrainOutsideTempC (inherited from Train)
TrainRoute (inherited from Train)
TrainSteamHeatLossWpT (inherited from Train)
TrainType (inherited from Train)
travelled (inherited from Train)
UiD (inherited from AITrain)
UncondAttach (inherited from AITrain)
UncoupledFrom (inherited from Train)
updateMSGReceived (inherited from Train)
ValidRoute (inherited from Train)
WaitAnyList
waitingPointWaitTimeS (inherited from Train)
WaitList

Public Instance Properties

AITrainBrakePercent (inherited from Train)
AITrainDirectionForward (inherited from Train)
AITrainGearboxGearIndex (inherited from Train)
AITrainThrottlePercent (inherited from Train)
FirstCar (inherited from Train)
IsActualPlayerTrain (inherited from Train)
IsPlayerDriven (inherited from Train)
LastCar (inherited from Train)
LeadLocomotive (inherited from Train)
signalRef (inherited from Train)
Simulator (inherited from Train)

Public Instance Methods

AddCouplerImpuseForces (inherited from Train)
AddMovementState
AddRestartTime (inherited from Train)
AddTrainReversalInfo Add reversal info to TrackMonitorInfo
AddWaitingPointInfo (inherited from Train) Add waiting point info to TrackMonitorInfo
AdjustControlsAccelLess (inherited from AITrain)
AdjustControlsAccelMore (inherited from AITrain)
AdjustControlsBrakeFull (inherited from AITrain)
AdjustControlsBrakeLess (inherited from AITrain)
AdjustControlsBrakeMore (inherited from AITrain)
AdjustControlsBrakeOff (inherited from AITrain)
AdjustControlsFixedSpeed (inherited from AITrain)
AdjustControlsThrottleOff (inherited from AITrain)
AICopyTrain (inherited from AITrain)
AIPreUpdate
AIUpdate (inherited from AITrain) Update Update function for a single AI train.
BreakdownClaim (inherited from Train) Breakdown claimed route when signal set to hold
BuildSectionString (inherited from Train)
BuildStationList (inherited from Train)
BuildWaitingPointList (inherited from AITrain)
CalculateDistancesToNextStation (inherited from AITrain)
CalculateInitialTrainPosition (inherited from Train) Calculate initial position
CalculateInitialTTTrainPosition Calculate initial position
CalculatePositionOfCars (inherited from Train) Distance is the signed distance the cars are moving.
CalculateStationStopOverloaded.
CalculateStationStop (inherited from Train)Overloaded.
CheckAnyWaitCondition
CheckBackwardClearance (inherited from Train) Check if train moves backward and if so, check clearance behindtrain If no save clearance left, set train to Out_Of_Control
CheckCouplePosition (inherited from AITrain)
CheckDeadlockWait (inherited from Train)
CheckExplorerPath (inherited from Train)
CheckForRouteWait
CheckForSingleTrainWait
CheckFreight (inherited from Train) Check if train is passenger or freight train
CheckInitialStation
CheckManualPath (inherited from Train)
CheckRequiredAction
CheckReversal (inherited from Train)
CheckRouteActions
CheckSignalObjects (inherited from AITrain)
CheckSignalPassed (inherited from Train) Check if train went passed signal if so, and signal was at danger, set train Out_Of_Control
CheckSpeedLimitManual (inherited from Train) Update speed limit in manual mode
CheckStationTask Check on station tasks, required when in timetable mode when there is no activity
CheckStoppedTrains (inherited from Train)
CheckTrainWaitingForSignal (inherited from Train) Check if train is waiting for signal
CheckTTTrainNotStartedByNumber Check if other train is yet to be started Use Simulator.Trains to get other train
CheckWaitCondition Check for active wait condition for this section
ClearActiveSectionItems (inherited from Train)
ClearDeadlocks (inherited from Train)
ClearOccupiedSection (inherited from Train) Clear section
ClearStation
ComputeCouplerForces (inherited from Train)
ComputeDistanceToNextStation (inherited from Train)
ComputeDistanceToReversalPoint (inherited from Train)
ConnectBrakeHoses (inherited from Train)
ConvertPlayerTraffic (inherited from Train)
CoupleAI (inherited from AITrain)
CoupleAIToStatic (inherited from AITrain)
CoupleTT
CreateLogFile (inherited from Train)
CreateRoute (inherited from AITrain)Overloaded.
CreateStationStopOverloaded.
CreateStationStop (inherited from Train)Overloaded.
CreateTrainAction (inherited from AITrain)
DisconnectBrakes (inherited from Train)
EndProcessAction (inherited from AITrain)
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ExtractAlternativeRoute_locationBased (inherited from Train)
ExtractAlternativeRoute_pathBased (inherited from Train)
FinalizeTimetableCommands Finalize the command information - process referenced train details
FindCommonSectionEnd (inherited from Train) Find end of common section searching through both routes in forward direction
FindCommonSectionEndReverse (inherited from Train) Find end of common section searching through own train forward but through other train backward
FindCommonSectionStart (inherited from Train) 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 (inherited from Train)
FindLeadLocomotives (inherited from Train)
ForcedStop (inherited from Train)
GetAIMovementState (inherited from AITrain) Get AI Movement State
GetDistanceToTrain (inherited from Train) 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 (inherited from Train) 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 (inherited from Train) get aspect of next signal ahead
GetObjectDistanceToTrain (inherited from Train) Get distance from train to object position using route list
GetOtherTrainByName (inherited from Train) Get other train from number Use Simulator.Trains to get other train
GetOtherTrainByNumber (inherited from Train) Get other train from number Use Simulator.Trains to get other train
GetOtherTTTrainByName Get other train from number Use Simulator.Trains to get other train
GetOtherTTTrainByNumber Get other train from number Use Simulator.Trains to get other train
GetPositionAheadOfTrain
GetStatus (inherited from Train)
GetTrainInfo (inherited from Train) Create TrackInfoObject for information in TrackMonitor window
GetTrainInfoAuto (inherited from Train) Create TrackInfoObject for information in TrackMonitor window for Auto mode
GetTrainInfoManual (inherited from Train) Create TrackInfoObject for information in TrackMonitor window when in Manual mode
GetTrainInfoOOC (inherited from Train) Create TrackInfoObject for information in TrackMonitor window when OutOfControl
GetType (inherited from Object)Gets the type of the current instance.
HasActiveWait Check for any active waits in indicated path
IncrementSubpath (inherited from Train)
InitalizePlayerTrain
InitializeBrakes (inherited from AITrain)
InitializeMoving (inherited from AITrain)
InitializeSignals (inherited from Train) initialize signal array
InitialTrainPlacement
IsChangeCabAvailable (inherited from Train) Is there another cab in the player's train to change to?
isInWaitState
LeadNextLocomotive (inherited from Train)
LeaveCarsToLivingTrain (inherited from AITrain)
LogTrainSpeed (inherited from Train)
MergeWPAndInsert (inherited from Train)
ObtainRequiredActions (inherited from Train) get list of required actions (only if not moving backward)
PerformActions (inherited from AITrain)
physicsPreUpdate
physicsUpdate (inherited from Train)
PostInitOverloaded. Post Init (override from Train) (with activate train option) perform all actions required to start
PresetExplorerPath (inherited from Train)
ProcessActionItem (inherited from AITrain)
ProcessConnections Process connection at station stop
ProcessConnectRequest Process Connect Request : process details of connect command
ProcessEndOfPath
ProcessEndOfPathReached
ProcessExplorerSwitch (inherited from Train) Process switching of explorer switch
ProcessManualSwitch (inherited from Train) Process switching of manual switch
ProcessRequestExplorerSetSwitch (inherited from Train)Overloaded. Process request to set switch in explorer mode Request may contain direction or actual node
ProcessRequestManualSetSwitch (inherited from Train)Overloaded. Process request to set switch in manual mode Request may contain direction or actual node
ProcessRouteEndTimetablePlayer
ProcessTimetableStopCommands Set unprocessed info for train timetable commands Info will be fully processed after all trains have been created - this is necessary as only then is all required info available StationStop info may be null if command is not linked to a station
ProcessTunnels (inherited from Train)
ProcessWaitRequest Process wait request for Timetable waits
PropagateBrakePressure (inherited from Train)
RecalculateAllowedMaxSpeed (inherited from AITrain)
RemoveFromTrack (inherited from Train)
RemoveTrain
RepositionRearTraveller (inherited from Train) Cars have been added to the rear of the train, recalc the rearTDBtraveller
RequestExplorerSignalPermission (inherited from Train)
RequestManualSignalPermission (inherited from Train)
RequestResetSignal (inherited from Train)
RequestSignalPermission (inherited from AITrain)Overloaded.
RequestSignalPermission (inherited from Train)Overloaded.
RequestToggleManualMode (inherited from Train)
ResetActions (inherited from AITrain)
ResetInitialTrainRoute (inherited from Train)
RestoreExplorerMode (inherited from Train) Restore Explorer Mode
RestoreManualMode (inherited from Train) Restore Manual Mode
RestoreServiceDefinition (inherited from AITrain)
RestoreTrainPlacement (inherited from Train)
ReverseFormation (inherited from Train) 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
SaveBase (inherited from AITrain)
SetAIPendingSpeedLimit (inherited from AITrain)
SetAlternativeRoute_locationBased (inherited from AITrain)
SetAlternativeRoute_pathBased (inherited from AITrain)
SetAlternativeStationStop
SetCoupleSpeed (inherited from Train)
SetEndOfRouteAction
SetFormedOccupied (inherited from Train) Set Formed Occupied Set track occupied for train formed out of other train
SetHandbrakePercent (inherited from Train)
SetInitialTrainRoute (inherited from Train)
SetNextStationAction (inherited from AITrain)
SetPendingSpeedLimit (inherited from Train) Set pending speed limits
SetPercentsFromTrainToTrainset (inherited from AITrain)
SetRetainers (inherited from Train)
SetReversalAction
SetRoutePath (inherited from Train)Overloaded. Create Track Circuit Route Path
SetTrainOutOfControl (inherited from Train) Switch train to Out-of-Control Set mode and apply emergency brake
SetupStationStopHandling setup station stop handling when run in timetable mode
SignalEvent (inherited from Train)Overloaded. Someone is sending an event notification to all cars on this train. ie doors open, pantograph up, lights on etc.
StartFromAITrain Start train out of AI train due to 'formed' action
StartMoving
StealCarsToLivingTrain (inherited from AITrain)
SuspendTrain (inherited from AITrain)
SwitchToAutopilotControl (inherited from AITrain)
SwitchToNodeControl (inherited from AITrain)
SwitchToPlayerControl (inherited from AITrain)
SwitchToSignalControl (inherited from AITrain)
TemporarilyRemoveFromTrack (inherited from Train)
TerminateCoupling (inherited from AITrain)
TestAbsDelay (inherited from Train)
TestPermission (inherited from AITrain)
TestUncondAttach (inherited from AITrain)
TestUncouple (inherited from AITrain)
ToDoUpdate (inherited from Train)
ToggleFromManualMode (inherited from Train)
ToggleToManualMode (inherited from Train)
ToString (inherited from Object)Returns a string that represents the current object.
TraincarsInitializeMoving (inherited from Train)
TrainHasPower (inherited from AITrain)
TTAnalysisStartMoving
TTAnalysisUpdateBrakingState1
TTAnalysisUpdateBrakingState2
TTAnalysisUpdateStationState1 TTAnalys methods : dump methods for Timetable Analysis Use Simulator.Trains to get other train
TTAnalysisUpdateStationState2
UnconditionalInitializeBrakes (inherited from Train)
Update (inherited from Train)
UpdateAccelState
UpdateAIStaticState Update AI Static state
UpdateBrakingState
UpdateCarSpeeds (inherited from Train)
UpdateCarSteamHeat (inherited from Train)
UpdateCouplerSlack (inherited from Train)
UpdateExplorer (inherited from Train)
UpdateExplorerMode (inherited from Train) Update Explorer Mode
UpdateFollowingState
UpdateManual (inherited from Train)
UpdateManualMode (inherited from Train) Update Manual Mode
UpdateMinimalDelay Calculate running delay if present time is later than next station arrival
UpdateNodeMode (inherited from Train) Perform auto node mode update
UpdateOutOfControl (inherited from Train) Update out-of-control mode
UpdateRemoteTrainPos (inherited from Train)
UpdateRouteActions (inherited from Train) 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 (inherited from Train) Update route clearance ahead of train Called every update, actions depend on present control state
UpdateRunningState
UpdateSectionState (inherited from Train) Update section occupy states Input is backward movement counter
UpdateSectionState_Additional Update Section State - additional clear waitany actions for this section
UpdateSectionStateExplorer (inherited from Train) Update section occupy states fore explorer mode Note : explorer mode has no distance actions so sections must be cleared immediately
UpdateSectionStateManual (inherited from Train) Update section occupy states for manual mode Note : manual mode has no distance actions so sections must be cleared immediately
UpdateSignalMode (inherited from Train) Perform auto signal mode update
UpdateSignalState (inherited from Train) Update the distance to and aspect of next signal
updateSpeedInfo (inherited from Train) set actual speed limit for all objects depending on state and type of train
UpdateStationState
UpdateStoppedState
UpdateTrackActionsCoupling (inherited from Train)
UpdateTrackActionsUncoupling (inherited from Train)
UpdateTrainOnEnteringSection (inherited from AITrain)
UpdateTrainPosition (inherited from Train) Update train position
UpdateTrainPositionInformation (inherited from Train)

Protected Instance Fields

Catalog (inherited from Train)

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

TTTrain Class | ORTS Namespace