Merge pull request #525 from Sharpe49/tcs-extensions

TCS extensions

Author: Sharpe49

Source/Orts.Simulation/Common/Scripting/TrainControlSystem.cs

@@ -225,6 +225,10 @@ public abstract class TrainControlSystem : AbstractTrainScriptClass
         /// </summary>
         public Func<float> ThrottlePercent;
         /// <summary>
+        /// Returns maximum throttle percent
+        /// </summary>
+        public Func<float> MaxThrottlePercent;
+        /// <summary>
         /// Returns dynamic brake percent
         /// </summary>
         public Func<float> DynamicBrakePercent;
@@ -367,6 +371,11 @@ public abstract class TrainControlSystem : AbstractTrainScriptClass
         /// </summary>
         public Action<bool> SetTractionAuthorization;
         /// <summary>
+        /// Set the maximum throttle percent
+        /// Range: 0 to 100
+        /// </summary>
+        public Action<float> SetMaxThrottlePercent;
+        /// <summary>
         /// Switch vigilance alarm sound on (true) or off (false).
         /// </summary>
         public Action<bool> SetVigilanceAlarm;
@@ -688,16 +697,20 @@ public enum MonitoringStatus
     public struct SignalFeatures
     {
         public readonly string MainHeadSignalTypeName;
+        public readonly string SignalTypeName;
         public readonly Aspect Aspect;
+        public readonly string DrawStateName;
         public readonly float DistanceM;
         public readonly float SpeedLimitMpS;
         public readonly float AltitudeM;
         public readonly string TextAspect;
 
-        public SignalFeatures(string mainHeadSignalTypeName, Aspect aspect, float distanceM, float speedLimitMpS, float altitudeM, string textAspect = "")
+        public SignalFeatures(string mainHeadSignalTypeName, string signalTypeName, Aspect aspect, string drawStateName, float distanceM, float speedLimitMpS, float altitudeM, string textAspect = "")
         {
             MainHeadSignalTypeName = mainHeadSignalTypeName;
+            SignalTypeName = signalTypeName;
             Aspect = aspect;
+            DrawStateName = drawStateName;
             DistanceM = distanceM;
             SpeedLimitMpS = speedLimitMpS;
             AltitudeM = altitudeM;

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/TrainControlSystem.cs

@@ -152,6 +152,7 @@ protected set
         public bool CircuitBreakerClosingOrder { get; private set; }
         public bool CircuitBreakerOpeningOrder { get; private set; }
         public bool TractionAuthorization { get; private set; }
+        public float MaxThrottlePercent { get; private set; } = 100f;
         public bool FullDynamicBrakingOrder { get; private set; }
 
         public float[] CabDisplayControls = new float[TCSCabviewControlCount];
@@ -348,7 +349,7 @@ public void Initialize()
                 Script.PantographCount = () => Locomotive.Pantographs.Count;
                 Script.GetPantographState = (pantoID) =>
                 {
-                   if (pantoID >= Pantographs.MinPantoID && pantoID <= Pantographs.MaxPantoID)
+                    if (pantoID >= Pantographs.MinPantoID && pantoID <= Pantographs.MaxPantoID)
                     {
                         return Locomotive.Pantographs[pantoID].State;
                     }
@@ -360,6 +361,7 @@ public void Initialize()
                 };
                 Script.ArePantographsDown = () => Locomotive.Pantographs.State == PantographState.Down;
                 Script.ThrottlePercent = () => Locomotive.ThrottleController.CurrentValue * 100;
+                Script.MaxThrottlePercent = () => MaxThrottlePercent;
                 Script.DynamicBrakePercent = () => Locomotive.DynamicBrakeController == null ? 0 : Locomotive.DynamicBrakeController.CurrentValue * 100;
                 Script.TractionAuthorization = () => TractionAuthorization;
                 Script.BrakePipePressureBar = () => Locomotive.BrakeSystem != null ? Bar.FromPSI(Locomotive.BrakeSystem.BrakeLine1PressurePSI) : float.MaxValue;
@@ -456,6 +458,13 @@ public void Initialize()
                 Script.SetCircuitBreakerClosingOrder = (value) => CircuitBreakerClosingOrder = value;
                 Script.SetCircuitBreakerOpeningOrder = (value) => CircuitBreakerOpeningOrder = value;
                 Script.SetTractionAuthorization = (value) => TractionAuthorization = value;
+                Script.SetMaxThrottlePercent = (value) =>
+                {
+                    if (value >= 0 && value <= 100f)
+                    {
+                        MaxThrottlePercent = value;
+                    }
+                };
                 Script.SetVigilanceAlarm = (value) => Locomotive.SignalEvent(value ? Event.VigilanceAlarmOn : Event.VigilanceAlarmOff);
                 Script.SetHorn = (value) => Locomotive.TCSHorn = value;
                 Script.TriggerSoundAlert1 = () => this.SignalEvent(Event.TrainControlSystemAlert1, Script);
@@ -599,10 +608,12 @@ T NextGenericSignalItem<T>(int itemSequenceIndex, ref T retval, float maxDistanc
             return retval;
         }
 
-        SignalFeatures NextGenericSignalFeatures(string signalTypeName, int itemSequenceIndex, float maxDistanceM, Train.TrainObjectItem.TRAINOBJECTTYPE type)
+        SignalFeatures NextGenericSignalFeatures(string signalFunctionTypeName, int itemSequenceIndex, float maxDistanceM, Train.TrainObjectItem.TRAINOBJECTTYPE type)
         {
             var mainHeadSignalTypeName = "";
+            var signalTypeName = "";
             var aspect = Aspect.None;
+            var drawStateName = "";
             var distanceM = float.MaxValue;
             var speedLimitMpS = -1f;
             var altitudeM = float.MinValue;
@@ -615,7 +626,7 @@ SignalFeatures NextGenericSignalFeatures(string signalTypeName, int itemSequence
 
             int index = dir == 0 ? Locomotive.Train.PresentPosition[dir].RouteListIndex :
                 Locomotive.Train.ValidRoute[dir].GetRouteIndex(Locomotive.Train.PresentPosition[dir].TCSectionIndex, 0);
-            int fn_type = Locomotive.Train.signalRef.ORTSSignalTypes.IndexOf(signalTypeName);
+            int fn_type = Locomotive.Train.signalRef.ORTSSignalTypes.IndexOf(signalFunctionTypeName);
             if (index < 0)
                 goto Exit;
             if (type == Train.TrainObjectItem.TRAINOBJECTTYPE.SIGNAL)
@@ -635,7 +646,7 @@ SignalFeatures NextGenericSignalFeatures(string signalTypeName, int itemSequence
                 // All OK, we can retrieve the data for the required signal;
                 distanceM = trainSignal.DistanceToTrainM;
                 mainHeadSignalTypeName = trainSignal.SignalObject.SignalHeads[0].SignalTypeName;
-                if (signalTypeName == "NORMAL")
+                if (signalFunctionTypeName == "NORMAL")
                 {
                     aspect = (Aspect)trainSignal.SignalState;
                     speedLimitMpS = trainSignal.AllowedSpeedMpS;
@@ -645,7 +656,13 @@ SignalFeatures NextGenericSignalFeatures(string signalTypeName, int itemSequence
                 {
                     aspect = (Aspect)Locomotive.Train.signalRef.TranslateToTCSAspect(trainSignal.SignalObject.this_sig_lr(fn_type));
                 }
+
                 var functionHead = trainSignal.SignalObject.SignalHeads.Find(head => head.ORTSsigFunctionIndex == fn_type);
+                signalTypeName = functionHead.SignalTypeName;
+                if (functionHead.draw_state >= 0)
+                {
+                    drawStateName = functionHead.signalType.DrawStates.First(d => d.Value.Index == functionHead.draw_state).Value.Name;
+                }
                 textAspect = functionHead?.TextSignalAspect ?? "";
             }
             else if (type == Train.TrainObjectItem.TRAINOBJECTTYPE.SPEEDPOST)
@@ -663,7 +680,7 @@ SignalFeatures NextGenericSignalFeatures(string signalTypeName, int itemSequence
             }
 
         Exit:
-            return new SignalFeatures(mainHeadSignalTypeName: mainHeadSignalTypeName, aspect: aspect, distanceM: distanceM, speedLimitMpS: speedLimitMpS,
+            return new SignalFeatures(mainHeadSignalTypeName: mainHeadSignalTypeName, signalTypeName: signalTypeName, aspect: aspect, drawStateName: drawStateName, distanceM: distanceM, speedLimitMpS: speedLimitMpS,
                 altitudeM: altitudeM, textAspect: textAspect);
         }
 

Source/Orts.Simulation/Simulation/RollingStocks/TrainCar.cs

@@ -467,19 +467,29 @@ public float ThrottlePercent
             {
                 if (RemoteControlGroup == 0 && Train != null)
                 {
-                    if (Train.LeadLocomotive != null && !((MSTSLocomotive)Train.LeadLocomotive).TrainControlSystem.TractionAuthorization && Train.MUThrottlePercent > 0)
+                    if (Train.LeadLocomotive is MSTSLocomotive locomotive)
                     {
-                        return 0;
-                    }
-                    else
-                    {
-                        return Train.MUThrottlePercent;
+                        if (!locomotive.TrainControlSystem.TractionAuthorization
+                            || Train.MUThrottlePercent <= 0)
+                        {
+                            return 0;
+                        }
+                        else if (Train.MUThrottlePercent > locomotive.TrainControlSystem.MaxThrottlePercent)
+                        {
+                            return Math.Max(locomotive.TrainControlSystem.MaxThrottlePercent, 0);
+                        }
                     }
+
+                    return Train.MUThrottlePercent;
                 }
                 else if (RemoteControlGroup == 1 && Train != null)
+                {
                     return Train.DPThrottlePercent;
+                }
                 else
+                {
                     return LocalThrottlePercent;
+                }
             }
             set
             {
@@ -514,21 +524,26 @@ public float DynamicBrakePercent
         {
             get
             {
-                if (RemoteControlGroup >= 0 && Train != null)
+                if (RemoteControlGroup == 0 && Train != null)
                 {
-                    if (Train.LeadLocomotive != null && ((MSTSLocomotive) Train.LeadLocomotive).TrainControlSystem.FullDynamicBrakingOrder)
+                    if (Train.LeadLocomotive is MSTSLocomotive locomotive)
                     {
-                        return 100;
-                    }
-                    else if (RemoteControlGroup == 1 && Train != null)
-                        return Train.DPDynamicBrakePercent;
-                    else
-                    {
-                        return Train.MUDynamicBrakePercent;
+                        if (locomotive.TrainControlSystem.FullDynamicBrakingOrder)
+                        {
+                            return 100;
+                        }
                     }
-}
+
+                    return Train.MUDynamicBrakePercent;
+                }
+                else if (RemoteControlGroup == 1 && Train != null)
+                {
+                    return Train.DPDynamicBrakePercent;
+                }
                 else
+                {
                     return LocalDynamicBrakePercent;
+                }
             }
             set
             {