Open Rails

MSTSElectricLocomotive Members

MSTSElectricLocomotive overview

Public Instance Constructors

MSTSElectricLocomotive Constructor

Public Instance Fields

_AccelerationMpSS (inherited from TrainCar)
_PrevSpeedMpS (inherited from TrainCar)
_SpeedMpS (inherited from TrainCar)
AcceptMUSignals (inherited from TrainCar)
accumedAcceTime (inherited from TrainCar)
Adhesion1 (inherited from MSTSWagon)
Adhesion2 (inherited from MSTSWagon)
Adhesion3 (inherited from MSTSWagon)
AdhesionFilter (inherited from MSTSLocomotive)
AdhesionK (inherited from MSTSWagon)
AlerterSnd (inherited from MSTSLocomotive)
AntiSlip (inherited from MSTSLocomotive)
AuxPowerOn (inherited from MSTSWagon)
AverageForceN (inherited from MSTSLocomotive)
AxleInertiaKgm2 (inherited from MSTSWagon)
BailOff (inherited from MSTSLocomotive)
Bell (inherited from MSTSLocomotive)
BrakeEmergencyTimeFactorS (inherited from MSTSLocomotive)
BrakeForceN (inherited from TrainCar)
BrakePipeChargingRatePSIpS (inherited from MSTSLocomotive)
BrakePipeTimeFactorS (inherited from MSTSLocomotive)
BrakeServiceTimeFactorS (inherited from MSTSLocomotive)
BrakeSystem (inherited from TrainCar)
BrakeSystemPressureUnits (inherited from MSTSLocomotive)
Cab3DShapeFileName (inherited from MSTSWagon)
Cab3DSoundFileName (inherited from MSTSWagon)
CabLightOn (inherited from MSTSLocomotive)
CabSoundFileName (inherited from MSTSLocomotive)
CabViewList (inherited from MSTSLocomotive)
CabViewpoints (inherited from TrainCar)
CarHeatLossWpT (inherited from TrainCar)
CarHeatPipeAreaM2 (inherited from TrainCar)
CarHeatVolumeM3 (inherited from TrainCar)
CarHeightM (inherited from TrainCar)
CarID (inherited from TrainCar)
CarLengthM (inherited from TrainCar)
CarTunnelData (inherited from TrainCar)
CarWidthM (inherited from TrainCar)
CombinedControlSplitPosition (inherited from MSTSLocomotive)
CombinedControlType (inherited from MSTSLocomotive)
CommandStartTime (inherited from MSTSLocomotive)
CompressorChargingRateM3pS (inherited from MSTSLocomotive)
CompressorIsOn (inherited from MSTSLocomotive)
CompressorRestartPressurePSI (inherited from MSTSLocomotive)
ContinuousForceTimeFactor (inherited from MSTSLocomotive)
controlUpdated (inherited from MSTSLocomotive)
CouplerForceA (inherited from TrainCar)
CouplerForceB (inherited from TrainCar)
CouplerForceC (inherited from TrainCar)
CouplerForceG (inherited from TrainCar)
CouplerForceR (inherited from TrainCar)
CouplerForceU (inherited from TrainCar)
CouplerOverloaded (inherited from TrainCar)
Couplers (inherited from MSTSWagon)
CouplerSlack2M (inherited from TrainCar)
CouplerSlackM (inherited from TrainCar)
CurrentCurveRadius (inherited from TrainCar)
CurrentElevationPercent (inherited from TrainCar)
CurrentFilter (inherited from MSTSLocomotive)
currentStiffness (inherited from TrainCar)
Curtius_KnifflerA (inherited from MSTSWagon)
Curtius_KnifflerB (inherited from MSTSWagon)
Curtius_KnifflerC (inherited from MSTSWagon)
CurveForceN (inherited from TrainCar)
CurveResistanceSpeedDependent (inherited from TrainCar)
CurveSpeedDependent (inherited from TrainCar)
CVFFileName (inherited from MSTSLocomotive)
DavisAN (inherited from MSTSWagon)
DavisBNSpM (inherited from MSTSWagon)
DavisCNSSpMM (inherited from MSTSWagon)
DistanceM (inherited from TrainCar)
DistributorPresent (inherited from MSTSWagon) True if triple valve is capable of releasing brake gradually
DoorLeftOpen (inherited from MSTSWagon)
DoorRightOpen (inherited from MSTSWagon)
DriverWheelRadiusM (inherited from MSTSWagon)
DynamicBrake (inherited from MSTSLocomotive)
DynamicBrakeAutoBailOff (inherited from MSTSLocomotive)
DynamicBrakeController (inherited from MSTSLocomotive)
DynamicBrakeDelayS (inherited from MSTSLocomotive)
DynamicBrakeForceCurves (inherited from MSTSLocomotive)
DynamicBrakeIntervention (inherited from MSTSLocomotive)
DynamicBrakeSpeed1MpS (inherited from MSTSLocomotive)
DynamicBrakeSpeed2MpS (inherited from MSTSLocomotive)
DynamicBrakeSpeed3MpS (inherited from MSTSLocomotive)
DynamicBrakeSpeed4MpS (inherited from MSTSLocomotive)
EffectData (inherited from MSTSLocomotive)
EmergencyButtonPressed (inherited from MSTSLocomotive)
EmergencyCausesPowerDown (inherited from MSTSLocomotive)
EmergencyCausesThrottleDown (inherited from MSTSLocomotive)
EmergencyEngagesHorn (inherited from MSTSLocomotive)
EmergencyReservoirPresent (inherited from MSTSWagon) True if vehicle is equipped with an additional emergency brake reservoir
EngineBrakeApplyRatePSIpS (inherited from MSTSLocomotive)
EngineBrakeController (inherited from MSTSLocomotive)
EngineBrakeIntervention (inherited from MSTSLocomotive)
EngineBrakeReleaseRatePSIpS (inherited from MSTSLocomotive)
EngineBrakeState (inherited from MSTSLocomotive)
EngineOperatingProcedures (inherited from MSTSLocomotive)
EngineType (inherited from MSTSLocomotive)
EventHandlers (inherited from MSTSWagon)
FilteredMotiveForceN (inherited from MSTSLocomotive)
Flipped (inherited from TrainCar)
FreightAnimFlag (inherited from MSTSWagon)
FreightAnimMaxLevelM (inherited from MSTSWagon)
FreightAnimMinLevelM (inherited from MSTSWagon)
FreightShapeFileName (inherited from MSTSWagon)
Friction0N (inherited from MSTSWagon)
FrictionForceN (inherited from TrainCar)
GearBoxController (inherited from MSTSLocomotive)
GravityForceN (inherited from TrainCar)
HandBrakePresent (inherited from MSTSWagon) True if equipped with handbrake. (Not common for older steam locomotives.)
HasFreightAnim (inherited from TrainCar)
HasInsideView (inherited from TrainCar)
HasPassengerCapacity (inherited from TrainCar)
HasSmoothStruc (inherited from MSTSLocomotive)
Headlight (inherited from TrainCar)
HeadOutViewpoints (inherited from TrainCar)
Horn (inherited from MSTSLocomotive)
InitialMassKG (inherited from TrainCar)
IntakePointList (inherited from MSTSWagon)
InteriorShapeFileName (inherited from MSTSWagon)
InteriorSoundFileName (inherited from MSTSWagon)
IsDavisFriction (inherited from MSTSWagon)
IsDiesel (inherited from MSTSLocomotive)
IsDriveable (inherited from TrainCar)
IsElectric (inherited from MSTSLocomotive)
IsEngine (inherited from MSTSWagon)
IsFreight (inherited from TrainCar)
IsFrictionBearing (inherited from MSTSWagon)
IsLowSpeed (inherited from MSTSWagon)
IsLowTorqueRollerBearing (inherited from MSTSWagon)
IsMetric (inherited from TrainCar)
IsPartOfActiveTrain (inherited from TrainCar)
IsPassenger (inherited from MSTSWagon)
IsRollerBearing (inherited from MSTSWagon)
IsStandStill (inherited from MSTSWagon)
IsSteam (inherited from MSTSLocomotive)
IsTender (inherited from TrainCar)
IsUK (inherited from TrainCar)
lastTime (inherited from TrainCar)
Lights (inherited from TrainCar)
LocalGearboxGearIndex (inherited from TrainCar)
LocalThrottlePercent (inherited from TrainCar)
LocomotiveAxle (inherited from MSTSLocomotive)
MainPressureUnit (inherited from MSTSLocomotive)
MainResChargingRatePSIpS (inherited from MSTSLocomotive)
MainResPressurePSI (inherited from MSTSLocomotive)
MainResVolumeM3 (inherited from MSTSLocomotive)
MainShapeFileName (inherited from MSTSWagon)
MainSoundFileName (inherited from MSTSWagon)
MassKG (inherited from TrainCar)
MaxContinuousForceN (inherited from MSTSLocomotive)
MaxCurrentA (inherited from MSTSLocomotive)
MaxDynamicBrakeForceN (inherited from MSTSLocomotive)
MaxForceN (inherited from MSTSLocomotive)
MaxMainResPressurePSI (inherited from MSTSLocomotive)
MaxPowerW (inherited from MSTSLocomotive)
MaxSpeedMpS (inherited from MSTSLocomotive)
MilepostUnitsMetric (inherited from MSTSLocomotive)
MirrorOpen (inherited from MSTSWagon)
MotiveForceN (inherited from TrainCar)
MotiveForceSmoothedN (inherited from TrainCar)
notificationReceived (inherited from MSTSLocomotive)
NumWheelsAdhesionFactor (inherited from MSTSLocomotive)
NumWheelsBrakingFactor (inherited from MSTSWagon)
ORTSFreightAnimData (inherited from TrainCar)
Pantographs (inherited from MSTSWagon)
Parts (inherited from TrainCar)
PassengerViewpoints (inherited from TrainCar)
PowerOn (inherited from MSTSLocomotive)
PowerOnDelayS (inherited from MSTSLocomotive)
PowerSupply
prevElev (inherited from TrainCar)
PrevMotiveForceN (inherited from TrainCar)
prevTilted (inherited from TrainCar)
prevY (inherited from TrainCar)
prevY2 (inherited from TrainCar)
RealWagFilePath (inherited from TrainCar)
RealXNAMatrix (inherited from TrainCar)
RetainerPositions (inherited from MSTSWagon) Number of available retainer positions. (Used on freight cars, mostly.) Might be 0, 3 or 4.
Sander (inherited from MSTSLocomotive)
SanderSpeedEffectUpToMpS (inherited from MSTSLocomotive)
SanderSpeedOfMpS (inherited from MSTSLocomotive)
ShowCab (inherited from MSTSLocomotive)
Simulator (inherited from TrainCar)
SlipWarningThresholdPercent (inherited from MSTSWagon)
SoundSourceIDs (inherited from TrainCar)
SuperElevationMatrix (inherited from TrainCar)
sx (inherited from TrainCar)
sy (inherited from TrainCar)
sz (inherited from TrainCar)
ThrottleController (inherited from MSTSLocomotive)
ThrottleIntervention (inherited from MSTSLocomotive)
TotalForceN (inherited from TrainCar)
totalRotationX (inherited from TrainCar)
totalRotationZ (inherited from TrainCar)
TrackSoundDistSquared (inherited from TrainCar)
TrackSoundLocation (inherited from TrainCar)
TrackSoundType (inherited from TrainCar)
TractiveForceCurves (inherited from MSTSLocomotive)
Train (inherited from TrainCar)
TrainBrakeController (inherited from MSTSLocomotive)
TrainBrakeIntervention (inherited from MSTSLocomotive)
TrainControlSystem (inherited from MSTSLocomotive)
TunnelForceN (inherited from TrainCar)
TunnelResistanceDependent (inherited from TrainCar)
UiD (inherited from TrainCar)
UnloadingPartsOpen (inherited from MSTSWagon)
UsingRearCab (inherited from MSTSLocomotive)
Variable1 (inherited from MSTSWagon)
Variable2 (inherited from MSTSWagon)
Variable3 (inherited from MSTSWagon)
Velocity (inherited from TrainCar)
VigilanceMonitor (inherited from MSTSLocomotive)
WagFilePath (inherited from TrainCar)
WaitForAnimationReady (inherited from MSTSWagon)
WeightLoadController (inherited from MSTSWagon)
WheelAxles (inherited from TrainCar)
WheelAxlesLoaded (inherited from TrainCar)
WheelRadiusM (inherited from MSTSWagon)
WheelSlip (inherited from TrainCar)
WheelslipCausesThrottleDown (inherited from MSTSLocomotive)
WheelSlipWarning (inherited from TrainCar)
WheelSpeedMpS (inherited from MSTSWagon)
Wiper (inherited from MSTSLocomotive)
WorldPosition (inherited from TrainCar)

Public Instance Properties

AccelerationMpSS (inherited from TrainCar)
CabRotationZ (inherited from MSTSLocomotive)
Coupler (inherited from MSTSWagon)
Direction (inherited from TrainCar)
DynamicBrakePercent (inherited from TrainCar)
GearboxGearIndex (inherited from TrainCar)
HasFrontCab (inherited from TrainCar)
HasRearCab (inherited from TrainCar)
IsPlayerTrain (inherited from TrainCar)
MSTSBrakeSystem (inherited from MSTSWagon)
OdometerM (inherited from MSTSLocomotive)
OdometerVisible (inherited from MSTSLocomotive)
SpeedMpS (inherited from TrainCar)
TendersSteamLocomotive (inherited from MSTSWagon) Attached steam locomotive in case this wagon is a tender
ThrottlePercent (inherited from TrainCar)

Public Instance Methods

AddBogie (inherited from TrainCar)
AddWheelSet (inherited from TrainCar)
AdjustNotchedThrottle (inherited from MSTSLocomotive) Used by commands to make a single adjustment.
AlerterPressed (inherited from MSTSLocomotive)
AlerterReset (inherited from MSTSLocomotive)Overloaded.
BrakeHoseConnect (inherited from MSTSLocomotive)
ChangeGearDown (inherited from MSTSLocomotive)
ChangeGearUp (inherited from MSTSLocomotive)
ComputeMaxXZ (inherited from TrainCar)
ComputePosition (inherited from TrainCar)
ConfirmWheelslip (inherited from MSTSLocomotive)
Copy This initializer is called when we are making a new copy of a car already loaded in memory. We use this one to speed up loading by eliminating the need to parse the wag file multiple times. NOTE: you must initialize all the same variables as you parsed above
CopyControllerSettings (inherited from MSTSLocomotive) Sets controler settings from other engine for cab switch
CopyCoupler (inherited from MSTSWagon)
DynamicBrakeChangeActiveState (inherited from MSTSLocomotive)
DynamicBrakeChangeTo (inherited from MSTSLocomotive)
EngineBrakeChangeTo (inherited from MSTSLocomotive)
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
FindTendersSteamLocomotive (inherited from MSTSWagon)
GetCabFlipped (inherited from MSTSLocomotive)
GetCentreofGravityM (inherited from MSTSWagon)
GetCombinedHandleValue (inherited from MSTSLocomotive) Determines which sub-control of combined handle is active (based on its type), and returns the overall position considering the split position.
GetCouplerStiffnessNpM (inherited from MSTSWagon)
GetCouplerZeroLengthM (inherited from MSTSWagon)
GetDataOf
GetDebugStatus
GetDriverWheelRadiusM (inherited from MSTSWagon)
GetDynamicBrakeStatus (inherited from MSTSLocomotive)
GetEngineBrakeStatus (inherited from MSTSLocomotive)
GetEngineType (inherited from MSTSLocomotive)
GetFilledFraction (inherited from MSTSLocomotive) To be overridden by MSTSSteamLocomotive and MSTSDieselLocomotive.
GetHashCode (inherited from Object)Serves as a hash function for a particular type.
GetLocoNumWheels (inherited from MSTSLocomotive)
GetMaximumCouplerForceN (inherited from TrainCar)
GetMaximumCouplerSlack1M (inherited from MSTSWagon)
GetMaximumCouplerSlack2M (inherited from MSTSWagon)
GetMeasurementUnits (inherited from MSTSWagon)
GetRefillController (inherited from MSTSLocomotive) To be overridden by MSTSSteamLocomotive and MSTSDieselLocomotive.
GetRigidWheelBaseM (inherited from MSTSWagon)
GetSanderOn (inherited from MSTSLocomotive)
GetStatus
GetTrackGaugeM (inherited from MSTSWagon)
GetTrainBrakeStatus (inherited from MSTSLocomotive)
GetTrainHandbrakeStatus (inherited from MSTSWagon)
GetType (inherited from Object)Gets the type of the current instance.
GetUnbalancedSuperElevationM (inherited from MSTSWagon)
GetWagonNumWheels (inherited from MSTSWagon)
GetWagonType (inherited from MSTSWagon)
GetXNAMatrix (inherited from TrainCar)
Initialize
InitializeMoving
IsLeadLocomotive (inherited from MSTSLocomotive)
IsOverTrough (inherited from TrainCar) Checks if traincar is over trough. Used to check if refill possible
LimitMotiveForce (inherited from MSTSLocomotive)Overloaded. Adjusts the MotiveForce to account for adhesion limits If UseAdvancedAdhesion is true, dynamic adhesion model is computed If UseAdvancedAdhesion is false, the basic force limits are calculated the same way MSTS calculates them, but the weather handleing is different and Curtius-Kniffler curves are considered as a static limit
Load (inherited from MSTSWagon)
LoadFromWagFile (inherited from MSTSLocomotive) This initializer is called when we haven't loaded this type of car before and must read it new from the wag file.
MoveParamsToAxle (inherited from MSTSLocomotive) We are moving parameters from locomotive to axle.
OdometerReset (inherited from MSTSLocomotive) Set odometer reference distance to actual travelled distance, and set measuring direction to the actual direction
OdometerToggle (inherited from MSTSLocomotive)
OdometerToggleDirection (inherited from MSTSLocomotive)
Parse Parse the wag file parameters required for the simulator and viewer classes
RefillImmediately (inherited from MSTSLocomotive) To be overridden by MSTSSteamLocomotive and MSTSDieselLocomotive.
Refuel (inherited from MSTSLocomotive)
Restore We are restoring a saved game. The TrainCar class has already been initialized. Restore the game state.
Save We are saving the game. Save anything that we'll need to restore the status later.
SetBailOff (inherited from MSTSLocomotive)
SetCombinedHandleValue (inherited from MSTSLocomotive) Determines which sub-control of combined handle is to be set when receiving a combined value. Combined value is in 0-1 range, where arrangement is [[1--throttle--0]split[0--dynamic|airbrake--1]].
SetDirection (inherited from MSTSLocomotive)
SetDynamicBrakePercent (inherited from MSTSLocomotive)
SetDynamicBrakeValue (inherited from MSTSLocomotive)
SetEmergency (inherited from MSTSLocomotive)
SetEngineBrakePercent (inherited from MSTSLocomotive)
SetEngineBrakeValue (inherited from MSTSLocomotive)
SetGearBoxValue (inherited from MSTSLocomotive)
SetPower
SetThrottlePercent (inherited from MSTSLocomotive)
SetThrottleValue (inherited from MSTSLocomotive)
SetTrainBrakePercent (inherited from MSTSLocomotive)
SetTrainBrakeValue (inherited from MSTSLocomotive)
SetTrainHandbrake (inherited from MSTSLocomotive)
SetTrainRetainers (inherited from MSTSLocomotive)
SetUpWheels (inherited from TrainCar)
SetWagonHandbrake (inherited from MSTSWagon)
SignalEventOverloaded. Used when someone want to notify us of an event
StartDynamicBrakeDecrease (inherited from MSTSLocomotive)
StartDynamicBrakeIncrease (inherited from MSTSLocomotive)
StartEngineBrakeDecrease (inherited from MSTSLocomotive)
StartEngineBrakeIncrease (inherited from MSTSLocomotive)
StartGearBoxDecrease (inherited from MSTSLocomotive)
StartGearBoxIncrease (inherited from MSTSLocomotive)
StartRefillingOrUnloading (inherited from MSTSWagon) Starts a continuous increase in controlled value.
StartReverseDecrease (inherited from MSTSLocomotive)
StartReverseIncrease (inherited from MSTSLocomotive)
StartThrottleDecrease (inherited from MSTSLocomotive)Overloaded.
StartThrottleIncrease (inherited from MSTSLocomotive)Overloaded.
StartThrottleToZero (inherited from MSTSLocomotive)
StartTrainBrakeDecrease (inherited from MSTSLocomotive)
StartTrainBrakeIncrease (inherited from MSTSLocomotive)
StopDynamicBrakeDecrease (inherited from MSTSLocomotive)
StopDynamicBrakeIncrease (inherited from MSTSLocomotive)
StopEngineBrakeDecrease (inherited from MSTSLocomotive) Ends change of brake value.
StopEngineBrakeIncrease (inherited from MSTSLocomotive) Ends change of brake value.
StopGearBoxDecrease (inherited from MSTSLocomotive)
StopGearBoxIncrease (inherited from MSTSLocomotive)
StopThrottleDecrease (inherited from MSTSLocomotive)
StopThrottleIncrease (inherited from MSTSLocomotive)
StopTrainBrakeDecrease (inherited from MSTSLocomotive)
StopTrainBrakeIncrease (inherited from MSTSLocomotive)
SuperElevation (inherited from TrainCar)
SwitchToAutopilotControl (inherited from MSTSLocomotive)
SwitchToPlayerControl (inherited from MSTSLocomotive)
ThrottleChangeTo (inherited from MSTSLocomotive) Used by commands to start a continuous adjustment.
ThrottleToZero (inherited from MSTSLocomotive)
ToggleCabLight (inherited from MSTSLocomotive)
ToggleDoorsLeft (inherited from MSTSWagon)
ToggleDoorsRight (inherited from MSTSWagon)
ToggleMirrors (inherited from MSTSWagon)
ToggleWipers (inherited from MSTSLocomotive)
ToString (inherited from Object)Returns a string that represents the current object.
TrainBrakeChangeTo (inherited from MSTSLocomotive) Used by commands to start a continuous adjustment.
Update This is a periodic update to calculate physics parameters and update the base class's MotiveForceN and FrictionForceN values based on throttle settings etc for the locomotive.
UpdateCarriageHeatLoss (inherited from TrainCar) This section calculates the heat loss in a carriage, and is used in conjunction with steam heating. Overall heat loss is made up of the following components - heat loss due to transmission through walls, windows, doors, floors and more (W) + heat loss caused by ventilation (W) + heat loss caused by infiltration (W)
UpdateCurveForce (inherited from TrainCar) Reads current curve radius and computes the CurveForceN friction. Can be overriden by calling base.UpdateCurveForce(); CurveForceN *= someCarSpecificCoef;
UpdateCurveSpeedLimit (inherited from TrainCar) Reads current curve radius and computes the maximum recommended speed around the curve based upon the superelevation of the track
UpdateSoundPosition (inherited from TrainCar)
UpdateTunnelForce (inherited from TrainCar) Tunnel force (resistance calculations based upon formula presented in papaer titled "Reasonable compensation coefficient of maximum gradient in long railway tunnels"

Protected Instance Fields

PreviousDynamicBrakeIntervention (inherited from MSTSLocomotive)

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.
ParseEffects (inherited from MSTSLocomotive)
UpdateMotiveForce (inherited from MSTSLocomotive)
UpdateParent (inherited from MSTSLocomotive) Calls the Update method in the parent class MSTSWagon.

See Also

MSTSElectricLocomotive Class | ORTS Namespace