Merge pull request #701 from cesarBLG/explorer-ooc

Prevent train from going to manual mode from an explorer activity

Author: cesarBLG

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

@@ -487,6 +487,10 @@ public abstract class TrainControlSystem : AbstractTrainScriptClass
         /// </summary>
         public Action RequestToggleManualMode;
         /// <summary>
+        /// Requests reset of Out of Control Mode.
+        /// </summary>
+        public Action ResetOutOfControlMode;
+        /// <summary>
         /// Get bool parameter in the INI file.
         /// </summary>
         public Func<string, string, bool, bool> GetBoolParameter;

Source/Orts.Simulation/Simulation/Physics/Train.cs

@@ -348,7 +348,7 @@ public TRAIN_CONTROL ControlMode
         /// <summary>
         /// Set when the train is out of control
         /// </summary>
-        private TRAIN_CONTROL ControlModeBeforeOutOfControl = TRAIN_CONTROL.UNDEFINED;
+        public TRAIN_CONTROL ControlModeBeforeOutOfControl = TRAIN_CONTROL.UNDEFINED;
 
         public enum OUTOFCONTROL
         {
@@ -10193,16 +10193,14 @@ public void RequestToggleManualMode()
             }
             else if (ControlMode == TRAIN_CONTROL.EXPLORER)
             {
-                if (LeadLocomotive is MSTSLocomotive locomotive &&
-                    (locomotive.TrainBrakeController.TCSEmergencyBraking || locomotive.TrainBrakeController.TCSFullServiceBraking))
-                {
-                    locomotive.TrainControlSystem.HandleEvent(TCSEvent.EmergencyBrakingReleasedBySimulator);
-                    ResetExplorerMode();
-                    return;
-                }
-                else if (Simulator.Confirmer != null) // As Confirmer may not be created until after a restore.
+                if (Simulator.Confirmer != null) // As Confirmer may not be created until after a restore.
                     Simulator.Confirmer.Message(ConfirmLevel.Warning, Simulator.Catalog.GetString("Cannot change to Manual Mode while in Explorer Mode"));
             }
+            else if (ControlMode == TRAIN_CONTROL.OUT_OF_CONTROL && ControlModeBeforeOutOfControl == TRAIN_CONTROL.EXPLORER)
+            {
+                if (Simulator.Confirmer != null) // As Confirmer may not be created until after a restore.
+                    Simulator.Confirmer.Message(ConfirmLevel.Warning, Simulator.Catalog.GetString("Cannot change to Manual Mode. Use the Reset Out Of Control Mode command to release brakes"));
+            }
             else
             {
                 ToggleToManualMode();

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

@@ -539,7 +539,16 @@ public void Initialize()
                         CustomizedCabviewControlNames[id] = value;
                     }
                 };
-                Script.RequestToggleManualMode = () => Locomotive.Train.RequestToggleManualMode();
+                Script.RequestToggleManualMode = () => 
+                {
+                    if (Locomotive.Train.ControlMode == Train.TRAIN_CONTROL.OUT_OF_CONTROL && Locomotive.Train.ControlModeBeforeOutOfControl == Train.TRAIN_CONTROL.EXPLORER)
+                    {
+                        Trace.TraceWarning("RequestToggleManualMode() is deprecated for explorer mode. Please use ResetOutOfControlMode() instead");
+                        Locomotive.Train.ManualResetOutOfControlMode();
+                    }
+                    else Locomotive.Train.RequestToggleManualMode();
+                };
+                Script.ResetOutOfControlMode = () => Locomotive.Train.ManualResetOutOfControlMode();
 
                 // TrainControlSystem INI configuration file
                 Script.GetBoolParameter = (arg1, arg2, arg3) => LoadParameter<bool>(arg1, arg2, arg3);

Source/Orts.Simulation/Simulation/Signalling/SignalObject.cs

@@ -2522,6 +2522,9 @@ private void propagateRequest()
             // no. of next signals to clear : as passed on -1 if signal has normal clear ahead
             // if passed on < 0, use this signals num to clear
 
+            // Do not propagate the request in explorer mode, as it is handled elsewhere
+            if (enabledTrain != null && enabledTrain.Train.ControlMode == Train.TRAIN_CONTROL.EXPLORER) return;
+
             // sections not available
             bool validPropagationRequest = true;
             if (internalBlockState > InternalBlockstate.Reservable)