Dynamic brake availability is now managed by power supply scripts

(related to https://bugs.launchpad.net/or/+bug/1620802)

Author: Sharpe49

Source/Orts.Simulation/Common/Scripting/PowerSupply/LocomotivePowerSupply.cs

@@ -36,6 +36,10 @@ public abstract class LocomotivePowerSupply : PowerSupply
         /// </summary>
         public Func<PowerSupplyState> CurrentCabPowerSupplyState;
         /// <summary>
+        /// Current availability of the dynamic brake
+        /// </summary>
+        public Func<bool> CurrentDynamicBrakeAvailability;
+        /// <summary>
         /// Main supply power on delay
         /// </summary>
         public Func<float> PowerOnDelayS;
@@ -76,6 +80,10 @@ public abstract class LocomotivePowerSupply : PowerSupply
         /// </summary>
         public Action<PowerSupplyState> SetCurrentElectricTrainSupplyState;
         /// <summary>
+        /// Sets the current availability of the dynamic brake
+        /// </summary>
+        public Action<bool> SetCurrentDynamicBrakeAvailability;
+        /// <summary>
         /// Sends an event to the master switch
         /// </summary>
         public Action<PowerSupplyEvent> SignalEventToMasterKey;

Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs

@@ -1628,7 +1628,7 @@ public override void Update(float elapsedClockSeconds)
             if (DynamicBrakePercent > 0 && DynamicBrakeForceCurves != null && AbsSpeedMpS > 0)
             {
                 float f = DynamicBrakeForceCurves.Get(.01f * DynamicBrakePercent, AbsTractionSpeedMpS);
-                if (f > 0 && LocomotivePowerSupply.MainPowerSupplyOn)
+                if (f > 0 && LocomotivePowerSupply.DynamicBrakeAvailable)
                 {
                     DynamicBrakeForceN = f * (1 - PowerReduction);
                     MotiveForceN -= (SpeedMpS > 0 ? 1 : SpeedMpS < 0 ? -1 : Direction == Direction.Reverse ? -1 : 1) * DynamicBrakeForceN;                 

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/DieselPowerSupply.cs

@@ -247,6 +247,9 @@ public override void Update(float elapsedClockSeconds)
                     break;
             }
 
+            // By default, on diesel locomotives, dynamic brake is available only if main power is available.
+            SetCurrentDynamicBrakeAvailability(CurrentMainPowerSupplyState() == PowerSupplyState.PowerOn);
+
             if (ElectricTrainSupplyUnfitted())
             {
                 SetCurrentElectricTrainSupplyState(PowerSupplyState.Unavailable);

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ElectricPowerSupply.cs

@@ -244,6 +244,9 @@ public override void Update(float elapsedClockSeconds)
                     break;
             }
 
+            // By default, on electric locomotives, dynamic brake is always available (rheostatic brake is always available).
+            SetCurrentDynamicBrakeAvailability(true);
+
             if (ElectricTrainSupplyUnfitted())
             {
                 SetCurrentElectricTrainSupplyState(PowerSupplyState.Unavailable);

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ILocomotivePowerSupply.cs

@@ -28,6 +28,7 @@ public interface ILocomotivePowerSupply : IPowerSupply
 
         PowerSupplyState MainPowerSupplyState { get; }
         bool MainPowerSupplyOn { get; }
+        bool DynamicBrakeAvailable { get; }
 
         PowerSupplyState AuxiliaryPowerSupplyState { get; }
         bool AuxiliaryPowerSupplyOn { get; }

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/LocomotivePowerSupply.cs

@@ -42,6 +42,7 @@ public abstract class ScriptedLocomotivePowerSupply : ILocomotivePowerSupply, IS
 
         public PowerSupplyState MainPowerSupplyState { get; protected set; } = PowerSupplyState.PowerOff;
         public bool MainPowerSupplyOn => MainPowerSupplyState == PowerSupplyState.PowerOn;
+        public bool DynamicBrakeAvailable { get; protected set; } = false;
 
         public PowerSupplyState AuxiliaryPowerSupplyState { get; protected set; } = PowerSupplyState.PowerOff;
         public bool AuxiliaryPowerSupplyOn => AuxiliaryPowerSupplyState == PowerSupplyState.PowerOn;
@@ -277,6 +278,7 @@ protected virtual void AssignScriptFunctions()
             AbstractScript.CurrentLowVoltagePowerSupplyState = () => LowVoltagePowerSupplyState;
             AbstractScript.CurrentBatteryState = () => BatteryState;
             AbstractScript.CurrentCabPowerSupplyState = () => CabPowerSupplyState;
+            AbstractScript.CurrentDynamicBrakeAvailability = () => DynamicBrakeAvailable;
             AbstractScript.PowerOnDelayS = () => PowerOnDelayS;
             AbstractScript.AuxPowerOnDelayS = () => AuxPowerOnDelayS;
             AbstractScript.BatterySwitchOn = () => BatterySwitch.On;
@@ -291,6 +293,7 @@ protected virtual void AssignScriptFunctions()
             AbstractScript.SetCurrentLowVoltagePowerSupplyState = (value) => LowVoltagePowerSupplyState = value;
             AbstractScript.SetCurrentBatteryState = (value) => BatteryState = value;
             AbstractScript.SetCurrentCabPowerSupplyState = (value) => CabPowerSupplyState = value;
+            AbstractScript.SetCurrentDynamicBrakeAvailability = (value) => DynamicBrakeAvailable = value;
             AbstractScript.SignalEventToBatterySwitch = (evt) => BatterySwitch.HandleEvent(evt);
             AbstractScript.SignalEventToMasterKey = (evt) => MasterKey.HandleEvent(evt);
             AbstractScript.SignalEventToElectricTrainSupplySwitch = (evt) => ElectricTrainSupplySwitch.HandleEvent(evt);

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamPowerSupply.cs

@@ -20,6 +20,7 @@ public class SteamPowerSupply : ILocomotivePowerSupply, ISubSystem<SteamPowerSup
 
         public PowerSupplyState MainPowerSupplyState => PowerSupplyState.PowerOn;
         public bool MainPowerSupplyOn => true;
+        public bool DynamicBrakeAvailable => false;
 
         public PowerSupplyState AuxiliaryPowerSupplyState => PowerSupplyState.PowerOn;
         public bool AuxiliaryPowerSupplyOn => true;