Add HoldState and HandleEvent to C# signal scripts (and refactoring)

Author: Sharpe49

Source/Orts.Simulation/MultiPlayer/Message.cs

@@ -3549,6 +3549,7 @@ public class MSGSignalChange : Message
         int index;
         int pick;
         string sender;
+
         //constructor to create a message from signal data
         public MSGSignalChange(SignalObject signal, int p)
         {
@@ -3569,40 +3570,28 @@ public MSGSignalChange(string m)
         //how to handle the message?
         public override void HandleMsg() //only client will get message, thus will set states
         {
-            if (MPManager.Server != null && !MPManager.Instance().aiderList.Contains(sender)) return; //client will ignore it, also if not an aider, will ignore it
+            if (MPManager.Server != null && !MPManager.Instance().aiderList.Contains(sender))
+                return; //client will ignore it, also if not an aider, will ignore it
 
             var signal = MPManager.Simulator.Signals.SignalObjects[index];
             switch (pick)
             {
                 case 0:
-                    signal.holdState = SignalObject.HoldState.None;
+                    signal.holdState = HoldState.None;
                     break;
+
                 case 1:
-                    signal.holdState = SignalObject.HoldState.ManualLock;
+                    signal.RequestMostRestrictiveAspect();
                     break;
+
                 case 2:
-                    signal.holdState = SignalObject.HoldState.ManualApproach;
-                    foreach (var sigHead in signal.SignalHeads)
-                    {
-                        var drawstate1 = sigHead.def_draw_state(MstsSignalAspect.APPROACH_1);
-                        var drawstate2 = sigHead.def_draw_state(MstsSignalAspect.APPROACH_2);
-                        var drawstate3 = sigHead.def_draw_state(MstsSignalAspect.APPROACH_3);
-                        if (drawstate1 > 0) { sigHead.state = MstsSignalAspect.APPROACH_1; }
-                        else if (drawstate2 > 0) { sigHead.state = MstsSignalAspect.APPROACH_2; }
-                        else { sigHead.state = MstsSignalAspect.APPROACH_3; }
-                        sigHead.draw_state = sigHead.def_draw_state(sigHead.state);
-                        // Clear the text aspect so as not to leave C# scripted signals in an inconsistent state.
-                        sigHead.TextSignalAspect = "";
-                    }
+                    signal.RequestApproachAspect();
                     break;
+
                 case 3:
-                    signal.holdState = SignalObject.HoldState.ManualPass;
-                    foreach (var sigHead in signal.SignalHeads)
-                    {
-                        sigHead.SetLeastRestrictiveAspect();
-                        sigHead.draw_state = sigHead.def_draw_state(sigHead.state);
-                    }
+                    signal.RequestLeastRestrictiveAspect();
                     break;
+
                 case 4:
                     signal.SetManualCallOn(true);
                     break;

Source/Orts.Simulation/Simulation/AIs/AITrain.cs

@@ -2082,7 +2082,7 @@ public virtual void UpdateStationState(float elapsedClockSeconds, int presentTim
 
             // first, check state of signal
 
-            if (thisStation.ExitSignal >= 0 && (thisStation.HoldSignal || signalRef.SignalObjects[thisStation.ExitSignal].holdState == SignalObject.HoldState.StationStop))
+            if (thisStation.ExitSignal >= 0 && (thisStation.HoldSignal || signalRef.SignalObjects[thisStation.ExitSignal].holdState == HoldState.StationStop))
             {
                 if (HoldingSignals.Contains(thisStation.ExitSignal)) HoldingSignals.Remove(thisStation.ExitSignal);
                 var nextSignal = signalRef.SignalObjects[thisStation.ExitSignal];
@@ -4949,7 +4949,6 @@ public void TestPermission(ref int delay)
 
         public void RequestSignalPermission(TCSubpathRoute selectedRoute, int routeIndex)
         {
-
             // check if signal at danger
 
             TCRouteElement thisElement = selectedRoute[PresentPosition[0].RouteListIndex];
@@ -4965,7 +4964,7 @@ public void RequestSignalPermission(TCSubpathRoute selectedRoute, int routeIndex
                 return;
 
             requestedSignal.enabledTrain = routeIndex == 0 ? routedForward : routedBackward;
-            requestedSignal.holdState = SignalObject.HoldState.None;
+            requestedSignal.holdState = HoldState.None;
             requestedSignal.hasPermission = SignalObject.Permission.Requested;
 
             requestedSignal.checkRouteState(false, requestedSignal.signalRoute, routedForward, false);
@@ -5451,7 +5450,7 @@ public void ProcessActionItem(AIActionItem thisItem)
             else if (thisItem.NextAction == AIActionItem.AI_ACTION_TYPE.SIGNAL_ASPECT_STOP)
             {
                 if (thisItem.ActiveItem.signal_state == MstsSignalAspect.STOP &&
-                    thisItem.ActiveItem.ObjectDetails.holdState == SignalObject.HoldState.StationStop)
+                    thisItem.ActiveItem.ObjectDetails.holdState == HoldState.StationStop)
                 {
                     actionValid = false;
 

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

@@ -1199,7 +1199,7 @@ public virtual void Save(BinaryWriter outf)
             {
                 outf.Write(1);
                 EOT.Save(outf);
-            }
+        }
             else
                 outf.Write(-1);*/
         }
@@ -1211,7 +1211,7 @@ private void SaveCars(BinaryWriter outf)
             {
                 outf.Write(wagon.WagFilePath);
                 wagon.Save(outf);
-            }
+        }
         }
 
         static void SaveTrafficSDefinition(BinaryWriter outf, Traffic_Service_Definition thisTSD)
@@ -2109,39 +2109,39 @@ public void UpdateWindComponents()
             //These will be representative of the train whilst it is on a straight track, but each wagon will vary when going around a curve.
             // Note both train and wind direction will be positive between 0 (north) and 180 (south) through east, and negative between 0 (north) and 180 (south) through west
             // Wind and train direction to be converted to an angle between 0 and 360 deg.
-            // Calculate Wind speed and direction, and train direction
-            // Update the value of the Wind Speed and Direction for the train
-            PhysicsWindDirectionDeg = MathHelper.ToDegrees(Simulator.Weather.WindDirection);
-            PhysicsWindSpeedMpS = Simulator.Weather.WindSpeed;
-            float TrainSpeedMpS = Math.Abs(SpeedMpS);
-
-            // If a westerly direction (ie -ve) convert to an angle between 0 and 360
-            if (PhysicsWindDirectionDeg < 0)
-                PhysicsWindDirectionDeg += 360;
-
-            if (PhysicsTrainLocoDirectionDeg < 0)
-                PhysicsTrainLocoDirectionDeg += 360;
-
-            // calculate angle between train and eind direction
-            if (PhysicsWindDirectionDeg > PhysicsTrainLocoDirectionDeg)
-                ResultantWindComponentDeg = PhysicsWindDirectionDeg - PhysicsTrainLocoDirectionDeg;
-            else if (PhysicsTrainLocoDirectionDeg > PhysicsWindDirectionDeg)
-                ResultantWindComponentDeg = PhysicsTrainLocoDirectionDeg - PhysicsWindDirectionDeg;
-            else
-                ResultantWindComponentDeg = 0.0f;
+                // Calculate Wind speed and direction, and train direction
+                // Update the value of the Wind Speed and Direction for the train
+                PhysicsWindDirectionDeg = MathHelper.ToDegrees(Simulator.Weather.WindDirection);
+                PhysicsWindSpeedMpS = Simulator.Weather.WindSpeed;
+                float TrainSpeedMpS = Math.Abs(SpeedMpS);
+
+                // If a westerly direction (ie -ve) convert to an angle between 0 and 360
+                if (PhysicsWindDirectionDeg < 0)
+                    PhysicsWindDirectionDeg += 360;
+
+                if (PhysicsTrainLocoDirectionDeg < 0)
+                    PhysicsTrainLocoDirectionDeg += 360;
+
+                // calculate angle between train and eind direction
+                if (PhysicsWindDirectionDeg > PhysicsTrainLocoDirectionDeg)
+                    ResultantWindComponentDeg = PhysicsWindDirectionDeg - PhysicsTrainLocoDirectionDeg;
+                else if (PhysicsTrainLocoDirectionDeg > PhysicsWindDirectionDeg)
+                    ResultantWindComponentDeg = PhysicsTrainLocoDirectionDeg - PhysicsWindDirectionDeg;
+                else
+                    ResultantWindComponentDeg = 0.0f;
 
-            // Correct wind direction if it is greater then 360 deg, then correct to a value less then 360
-            if (Math.Abs(ResultantWindComponentDeg) > 360)
-                ResultantWindComponentDeg = ResultantWindComponentDeg - 360.0f;
+                // Correct wind direction if it is greater then 360 deg, then correct to a value less then 360
+                if (Math.Abs(ResultantWindComponentDeg) > 360)
+                    ResultantWindComponentDeg = ResultantWindComponentDeg - 360.0f;
 
-            // Wind angle should be kept between 0 and 180 the formulas do not cope with angles > 180. If angle > 180, denotes wind of "other" side of train
-            if (ResultantWindComponentDeg > 180)
-                ResultantWindComponentDeg = 360 - ResultantWindComponentDeg;
+                // Wind angle should be kept between 0 and 180 the formulas do not cope with angles > 180. If angle > 180, denotes wind of "other" side of train
+                if (ResultantWindComponentDeg > 180)
+                    ResultantWindComponentDeg = 360 - ResultantWindComponentDeg;
 
-            float WindAngleRad = MathHelper.ToRadians(ResultantWindComponentDeg);
+                float WindAngleRad = MathHelper.ToRadians(ResultantWindComponentDeg);
 
-            WindResultantSpeedMpS = (float)Math.Sqrt(TrainSpeedMpS * TrainSpeedMpS + PhysicsWindSpeedMpS * PhysicsWindSpeedMpS + 2.0f * TrainSpeedMpS * PhysicsWindSpeedMpS * (float)Math.Cos(WindAngleRad));
-        }
+                WindResultantSpeedMpS = (float)Math.Sqrt(TrainSpeedMpS * TrainSpeedMpS + PhysicsWindSpeedMpS * PhysicsWindSpeedMpS + 2.0f * TrainSpeedMpS * PhysicsWindSpeedMpS * (float)Math.Cos(WindAngleRad));
+            }
 
 
         //================================================================================================//
@@ -2884,8 +2884,10 @@ public void UpdateManual(float elapsedClockSeconds)
 
                 //the following is added by CSantucci, applying also to manual mode what Jtang implemented for activity mode: after passing a manually forced signal,
                 // system will take back control of the signal
-                if (signalObject.holdState == SignalObject.HoldState.ManualPass ||
-                    signalObject.holdState == SignalObject.HoldState.ManualApproach) signalObject.holdState = SignalObject.HoldState.None;
+                if (signalObject.holdState == HoldState.ManualPass || signalObject.holdState == HoldState.ManualApproach)
+                {
+                    signalObject.holdState = HoldState.None;
+                }
             }
             UpdateSectionStateManual();                                                           // update track occupation          //
             UpdateManualMode(SignalObjIndex);                                                     // update route clearance           //
@@ -2911,8 +2913,10 @@ public void UpdateExplorer(float elapsedClockSeconds)
 
                 //the following is added by CSantucci, applying also to explorer mode what Jtang implemented for activity mode: after passing a manually forced signal,
                 // system will take back control of the signal
-                if (signalObject.holdState == SignalObject.HoldState.ManualPass ||
-                    signalObject.holdState == SignalObject.HoldState.ManualApproach) signalObject.holdState = SignalObject.HoldState.None;
+                if (signalObject.holdState == HoldState.ManualPass || signalObject.holdState == HoldState.ManualApproach)
+                {
+                    signalObject.holdState = HoldState.None;
+                }
             }
             UpdateSectionStateExplorer();                                                         // update track occupation          //
             UpdateExplorerMode(SignalObjIndex);                                                   // update route clearance           //
@@ -7559,10 +7563,9 @@ public void UpdateRouteClearanceAhead(int signalObjectIndex, int backward, float
                 var signalObject = signalRef.SignalObjects[signalObjectIndex];
 
                 //the following is added by JTang, passing a hold signal, will take back control by the system
-                if (signalObject.holdState == SignalObject.HoldState.ManualPass ||
-                    signalObject.holdState == SignalObject.HoldState.ManualApproach)
+                if (signalObject.holdState == HoldState.ManualPass || signalObject.holdState == HoldState.ManualApproach)
                 {
-                    signalObject.holdState = SignalObject.HoldState.None;
+                    signalObject.holdState = HoldState.None;
                 }
 
                 signalObject.resetSignalEnabled();
@@ -7769,7 +7772,7 @@ public bool CheckTrainWaitingForSignal(SignalObject thisSignal, int direction)
 
             if (signalRouteIndex < 0)
             {
-                return (false);
+                return false;
             }
 
             // check if any other trains in section ahead of this train
@@ -7786,7 +7789,7 @@ public bool CheckTrainWaitingForSignal(SignalObject thisSignal, int direction)
                 // check if train is closer as signal
                 if (!DistanceToSignal.HasValue || foundTrain.Value < DistanceToSignal)
                 {
-                    return (false);
+                    return false;
                 }
             }
 
@@ -7801,7 +7804,7 @@ public bool CheckTrainWaitingForSignal(SignalObject thisSignal, int direction)
 
                     if (nextSection.CircuitState.HasTrainsOccupying())  // train is ahead - it's not our signal //
                     {
-                        return (false);
+                        return false;
                     }
                     else if (!nextSection.IsAvailable(this)) // is section really available to us? //
 
@@ -7817,30 +7820,24 @@ public bool CheckTrainWaitingForSignal(SignalObject thisSignal, int direction)
                         }
                         SwitchToNodeControl(thisSection.Index);
 
-                        return (false);
+                        return false;
                     }
                 }
             }
 
             // we are waiting, but is signal clearance requested ?
-
             if (thisSignal.enabledTrain == null)
             {
                 thisSignal.requestClearSignal(ValidRoute[0], thisRouted, 0, false, null);
             }
-
             // we are waiting, but is it really our signal ?
-
             else if (thisSignal.enabledTrain != thisRouted)
             {
-
                 // something is wrong - we are waiting, but it is not our signal - give warning, reset signal and clear route
-
                 Trace.TraceWarning("Train {0} ({1}) waiting for signal which is enabled to train {2}",
                         Name, Number, thisSignal.enabledTrain.Train.Number);
 
                 // stop other train - switch other train to node control
-
                 Train otherTrain = thisSignal.enabledTrain.Train;
                 otherTrain.LastReservedSection[0] = -1;
                 if (Math.Abs(otherTrain.SpeedMpS) > 0)
@@ -7850,29 +7847,27 @@ public bool CheckTrainWaitingForSignal(SignalObject thisSignal, int direction)
                 otherTrain.SwitchToNodeControl(-1);
 
                 // reset signal and clear route
-
                 thisSignal.ResetSignal(false);
                 thisSignal.requestClearSignal(ValidRoute[0], thisRouted, 0, false, null);
-                return (false);   // do not yet set to waiting, signal might clear //
+                return false;   // do not yet set to waiting, signal might clear //
             }
 
             // signal is in holding list - so not really waiting - but remove from list if held for station stop
-
-            if (thisSignal.holdState == SignalObject.HoldState.ManualLock)
+            if (thisSignal.holdState == HoldState.ManualLock)
             {
-                return (false);
+                return false;
             }
-            else if (thisSignal.holdState == SignalObject.HoldState.StationStop && HoldingSignals.Contains(thisSignal.thisRef))
+            else if (thisSignal.holdState == HoldState.StationStop && HoldingSignals.Contains(thisSignal.thisRef))
             {
                 if (StationStops != null && StationStops.Count > 0 && StationStops[0].ExitSignal != thisSignal.thisRef) // not present station stop
                 {
                     HoldingSignals.Remove(thisSignal.thisRef);
-                    thisSignal.holdState = SignalObject.HoldState.None;
-                    return (false);
+                    thisSignal.holdState = HoldState.None;
+                    return false;
                 }
             }
 
-            return (true);  // it is our signal and we are waiting //
+            return true;  // it is our signal and we are waiting //
         }
 
         //================================================================================================//
@@ -8057,8 +8052,10 @@ public void UpdateManualMode(int signalObjectIndex)
                 var thisSignal = signalRef.SignalObjects[signalObjectIndex];
                 thisSignal.hasPermission = SignalObject.Permission.Denied;
                 //the following is added by JTang, passing a hold signal, will take back control by the system
-                if (thisSignal.holdState == SignalObject.HoldState.ManualPass ||
-                    thisSignal.holdState == SignalObject.HoldState.ManualApproach) thisSignal.holdState = SignalObject.HoldState.None;
+                if (thisSignal.holdState == HoldState.ManualPass || thisSignal.holdState == HoldState.ManualApproach)
+                {
+                    thisSignal.holdState = HoldState.None;
+                }
 
                 thisSignal.resetSignalEnabled();
             }
@@ -8574,7 +8571,7 @@ public void RequestManualSignalPermission(ref TCSubpathRoute selectedRoute, int
 
             requestedSignal.enabledTrain = routeIndex == 0 ? routedForward : routedBackward;
             requestedSignal.signalRoute.Clear();
-            requestedSignal.holdState = SignalObject.HoldState.None;
+            requestedSignal.holdState = HoldState.None;
             requestedSignal.hasPermission = SignalObject.Permission.Requested;
 
             // get route from next signal - extend to next signal or maximum length
@@ -9238,7 +9235,7 @@ public void UpdateExplorerMode(int signalObjectIndex)
                 {
                     distanceToSignalForward += thisSection.Length - lengthOffset;
                     lengthOffset = 0;
-                }
+            }
             }
 
             // backward
@@ -9255,7 +9252,7 @@ public void UpdateExplorerMode(int signalObjectIndex)
                 {
                     lengthOffset = -PresentPosition[1].TCOffset + signalRef.TrackCircuitList[PresentPosition[1].TCSectionIndex].Length;
                     presentIndex = iindex;
-                }
+            }
                 if (presentIndex != -1 && presentIndex <= iindex)
                 {
                     distanceToSignalBackward += thisSection.Length - lengthOffset;