Merge pull request #445 from Sharpe49/scripts-preupdate

cjakeman · web-flow · commit 4ee365855f0c · 2021-08-24T20:28:02.000+01:00
Add a PreUpdate variable to scripts http://www.elvastower.com/forums/index.php?/topic/34792-c-signal-scripts/page__view__findpost__p__275090
diff --git a/Source/Orts.Simulation/Common/Scripting/Common.cs b/Source/Orts.Simulation/Common/Scripting/Common.cs
@@ -15,10 +15,10 @@
 // You should have received a copy of the GNU General Public License
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
-using System;
 using Orts.Common;
 using Orts.Simulation;
 using Orts.Simulation.RollingStocks;
+using System;
 
 namespace ORTS.Scripting.Api
 {
@@ -35,6 +35,10 @@ public abstract class AbstractScriptClass
         /// Clock value (in seconds) for the simulation. Starts with a value = 0.
         /// </summary>
         public Func<float> GameTime;
+        /// <summary>
+        /// Simulator is in pre-update mode (update during loading screen).
+        /// </summary>
+        public Func<bool> PreUpdate;
     }
     /// <summary>
     /// Base class for scripts related to train subsystems.
diff --git a/Source/Orts.Simulation/Simulation/AIs/AI.cs b/Source/Orts.Simulation/Simulation/AIs/AI.cs
@@ -54,7 +54,6 @@ public class AI
         public List<AITrain> AutoGenTrains = new List<AITrain>(); // auto-generated trains
         public double clockTime; // clock time : local time before activity start, common time from simulator after start
         private bool localTime;  // if true : clockTime is local time
-        public bool PreUpdate; // if true : running in pre-update phase
         public List<AITrain> TrainsToRemove = new List<AITrain>();
         public List<AITrain> TrainsToAdd = new List<AITrain>();
         public List<AITrain> TrainsToRemoveFromAI = new List<AITrain>();
@@ -341,14 +340,14 @@ private void PrerunAI(CancellationToken cancellation)
 
                 clockTime = firstAITime - 1.0f;
                 localTime = true;
-                PreUpdate = true;
+                Simulator.PreUpdate = true;
 
                 for (double runTime = firstAITime; runTime < Simulator.ClockTime; runTime += 5.0) // update with 5 secs interval
                 {
                     int fullsec = Convert.ToInt32(runTime);
                     if (fullsec % 3600 == 0) Trace.Write(" " + (fullsec / 3600).ToString("00") + ":00 ");
 
-                    AIUpdate((float)(runTime - clockTime), PreUpdate);
+                    AIUpdate((float)(runTime - clockTime), Simulator.PreUpdate);
                     Simulator.Signals.Update(true);
                     clockTime = runTime;
                     if (cancellation.IsCancellationRequested) return; // ping watchdog process
@@ -371,14 +370,14 @@ private void PrerunAI(int playerTrainOriginalTrain, TTTrain.FormCommand playerTr
 
                 clockTime = firstAITime - 1.0f;
                 localTime = true;
-                PreUpdate = true;
+                Simulator.PreUpdate = true;
                 bool activeTrains = false;
                 for (double runTime = firstAITime; runTime < Simulator.ClockTime && !endPreRun; runTime += 5.0) // update with 5 secs interval
                 {
                     int fullsec = Convert.ToInt32(runTime);
                     if (fullsec % 3600 < 5) Trace.Write(" " + (fullsec / 3600).ToString("00") + ":00 ");
 
-                    endPreRun = AITTUpdate((float)(runTime - clockTime), PreUpdate, ref activeTrains);
+                    endPreRun = AITTUpdate((float)(runTime - clockTime), Simulator.PreUpdate, ref activeTrains);
 
                     if (activeTrains)
                     {
@@ -541,7 +540,7 @@ private void PrerunAI(int playerTrainOriginalTrain, TTTrain.FormCommand playerTr
 
                     while (!playerTrainStarted)
                     {
-                        endPreRun = AITTUpdate((float)(runTime - clockTime), PreUpdate, ref dummy);
+                        endPreRun = AITTUpdate((float)(runTime - clockTime), Simulator.PreUpdate, ref dummy);
                         Simulator.Signals.Update(true);
                         clockTime = runTime;
                         runTime += deltaTime;
@@ -625,8 +624,7 @@ private void PrerunAI(int playerTrainOriginalTrain, TTTrain.FormCommand playerTr
             }
 
             Trace.Write("\n");
-            PreUpdate = false;
-
+            Simulator.PreUpdate = false;
         }
 
         /// <summary>
diff --git a/Source/Orts.Simulation/Simulation/AIs/AITrain.cs b/Source/Orts.Simulation/Simulation/AIs/AITrain.cs
@@ -5903,7 +5903,7 @@ public void EndProcessAction(bool actionValid, AIActionItem thisItem, bool actio
                 if (nextActionInfo.RequiredSpeedMpS == 0)
                 {
                     NextStopDistanceM = thisItem.ActivateDistanceM - PresentPosition[0].DistanceTravelledM;
-                    if (AI.PreUpdate && !(nextActionInfo.NextAction == AIActionItem.AI_ACTION_TYPE.AUX_ACTION && NextStopDistanceM > minCheckDistanceM))
+                    if (Simulator.PreUpdate && !(nextActionInfo.NextAction == AIActionItem.AI_ACTION_TYPE.AUX_ACTION && NextStopDistanceM > minCheckDistanceM))
                     {
                         AITrainBrakePercent = 100; // because of short reaction time
                         AITrainThrottlePercent = 0;
diff --git a/Source/Orts.Simulation/Simulation/Physics/Train.cs b/Source/Orts.Simulation/Simulation/Physics/Train.cs
@@ -1461,7 +1461,7 @@ public void ReverseFormation(bool setMUParameters)
                 MUDirection = DirectionControl.Flip(MUDirection);
                 MUReverserPercent = -MUReverserPercent;
             }
-            if (!((this is AITrain && (this as AITrain).AI.PreUpdate) || this.TrainType == TRAINTYPE.STATIC)) FormationReversed = true;
+            if (!((this is AITrain && Simulator.PreUpdate) || this.TrainType == TRAINTYPE.STATIC)) FormationReversed = true;
         }
 
         //================================================================================================//
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Controllers/BrakeController.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Controllers/BrakeController.cs
@@ -343,6 +343,7 @@ public void Initialize()
                 // AbstractScriptClass
                 Script.ClockTime = () => (float)Simulator.ClockTime;
                 Script.GameTime = () => (float)Simulator.GameTime;
+                Script.PreUpdate = () => Simulator.PreUpdate;
                 Script.DistanceM = () => Locomotive.DistanceM;
                 Script.SpeedMpS = () => Math.Abs(Locomotive.SpeedMpS);
                 Script.Confirm = Locomotive.Simulator.Confirmer.Confirm;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/CircuitBreaker.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/CircuitBreaker.cs
@@ -131,6 +131,7 @@ public void Initialize()
                 // AbstractScriptClass
                 Script.ClockTime = () => (float)Simulator.ClockTime;
                 Script.GameTime = () => (float)Simulator.GameTime;
+                Script.PreUpdate = () => Simulator.PreUpdate;
                 Script.DistanceM = () => Locomotive.DistanceM;
                 Script.SpeedMpS = () => Math.Abs(Locomotive.SpeedMpS);
                 Script.Confirm = Locomotive.Simulator.Confirmer.Confirm;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/LocomotivePowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/LocomotivePowerSupply.cs
@@ -253,6 +253,7 @@ protected virtual void AssignScriptFunctions()
             // AbstractScriptClass
             AbstractScript.ClockTime = () => (float)Simulator.ClockTime;
             AbstractScript.GameTime = () => (float)Simulator.GameTime;
+            AbstractScript.PreUpdate = () => Simulator.PreUpdate;
             AbstractScript.DistanceM = () => Locomotive.DistanceM;
             AbstractScript.SpeedMpS = () => Math.Abs(Locomotive.SpeedMpS);
             AbstractScript.Confirm = Locomotive.Simulator.Confirmer.Confirm;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/PassengerCarPowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/PassengerCarPowerSupply.cs
@@ -302,6 +302,7 @@ protected virtual void AssignScriptFunctions()
             // AbstractScriptClass
             Script.ClockTime = () => (float)Simulator.ClockTime;
             Script.GameTime = () => (float)Simulator.GameTime;
+            Script.PreUpdate = () => Simulator.PreUpdate;
             Script.DistanceM = () => Wagon.DistanceM;
             Script.SpeedMpS = () => Math.Abs(Wagon.SpeedMpS);
             Script.Confirm = Simulator.Confirmer.Confirm;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/TractionCutOffRelay.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/TractionCutOffRelay.cs
@@ -114,6 +114,7 @@ public void Initialize()
                 // AbstractScriptClass
                 Script.ClockTime = () => (float)Simulator.ClockTime;
                 Script.GameTime = () => (float)Simulator.GameTime;
+                Script.PreUpdate = () => Simulator.PreUpdate;
                 Script.DistanceM = () => Locomotive.DistanceM;
                 Script.Confirm = Locomotive.Simulator.Confirmer.Confirm;
                 Script.Message = Locomotive.Simulator.Confirmer.Message;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/TrainControlSystem.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/TrainControlSystem.cs
@@ -260,6 +260,7 @@ public void Initialize()
                 // AbstractScriptClass
                 Script.ClockTime = () => (float)Simulator.ClockTime;
                 Script.GameTime = () => (float)Simulator.GameTime;
+                Script.PreUpdate = () => Simulator.PreUpdate;
                 Script.DistanceM = () => Locomotive.DistanceM;
                 Script.Confirm = Locomotive.Simulator.Confirmer.Confirm;
                 Script.Message = Locomotive.Simulator.Confirmer.Message;
diff --git a/Source/Orts.Simulation/Simulation/Signalling/CsSignalScript.cs b/Source/Orts.Simulation/Simulation/Signalling/CsSignalScript.cs
@@ -334,6 +334,7 @@ internal void AttachToHead(SignalHead signalHead)
             // Build AbstractScriptClass API functions
             ClockTime = () => (float)SignalObject.signalRef.Simulator.ClockTime;
             GameTime = () => (float)SignalObject.signalRef.Simulator.GameTime;
+            PreUpdate = () => SignalObject.signalRef.Simulator.PreUpdate;
         }
 
         // Functions to be implemented in script
diff --git a/Source/Orts.Simulation/Simulation/Simulator.cs b/Source/Orts.Simulation/Simulation/Simulator.cs
@@ -90,6 +90,7 @@ public class Simulator
         public string ActivityFileName;
         public string TimetableFileName;
         public bool TimetableMode;
+        public bool PreUpdate;
         public ActivityFile Activity;
         public Activity ActivityRun;
         public TrackDatabaseFile TDB;
@@ -578,7 +579,7 @@ AITrain InitializeAPTrains(CancellationToken cancellation)
             if (playerTrain != null)
             {
                 var validPosition = playerTrain.PostInit();  // place player train after pre-running of AI trains
-                if (validPosition && AI != null) AI.PreUpdate = false;
+                if (validPosition && AI != null) PreUpdate = false;
                 if (playerTrain.InitialSpeed > 0 && playerTrain.MovementState != AITrain.AI_MOVEMENT_STATE.STATION_STOP)
                 {
                     playerTrain.InitializeMoving();
diff --git a/Source/Orts.Simulation/Simulation/Timetables/TTTrain.cs b/Source/Orts.Simulation/Simulation/Timetables/TTTrain.cs
@@ -2231,7 +2231,7 @@ public override bool CheckStationPosition(PlatformDetails thisPlatform, int stat
             // check position
 
             float margin = 0.0f;
-            if (AI.PreUpdate)
+            if (Simulator.PreUpdate)
                 margin = 2.0f * clearingDistanceM;  // allow margin in pre-update due to low update rate
 
             int stationIndex = ValidRoute[0].GetRouteIndex(stationTCSectionIndex, PresentPosition[0].RouteListIndex);
@@ -5741,7 +5741,7 @@ public override void UpdateRunningState(float elapsedClockSeconds)
         public void DelayedStartMoving(AI_START_MOVEMENT reason)
         {
             // do not apply delayed restart while running in pre-update
-            if (AI.PreUpdate)
+            if (Simulator.PreUpdate)
             {
                 RestdelayS = 0.0f;
                 DelayedStart = false;
@@ -11820,7 +11820,7 @@ public void TTCouple(TTTrain attachTrain, bool thisTrainFront, bool attachTrainF
                 }
 
                 // if not in preupdate there must be an engine
-                if (AI.Simulator.PlayerLocomotive == null && !AI.PreUpdate)
+                if (AI.Simulator.PlayerLocomotive == null && !Simulator.PreUpdate)
                 {
                     throw new InvalidDataException("Can't find player locomotive in " + attachTrain.Name);
                 }
diff --git a/Source/Orts.Simulation/Simulation/Timetables/TTTurntable.cs b/Source/Orts.Simulation/Simulation/Timetables/TTTurntable.cs
@@ -2027,7 +2027,7 @@ public bool AutoRequestExit(int reqExit, Traveller.TravellerDirection entryPathD
 
                 // in prerun, also perform turntable update as simulation is not yet running
                 // also perform turntable update if this is not the active moving table
-                bool performUpdate = parentTrain.AI.PreUpdate;
+                bool performUpdate = parentTrain.Simulator.PreUpdate;
                 if (!performUpdate)
                 {
                     if (parentPool.Simulatorref.ActiveMovingTable == null)

Original file line number	Diff line number	Diff line change
`@@ -5903,7 +5903,7 @@ public void EndProcessAction(bool actionValid, AIActionItem thisItem, bool actio`
`5903`	`5903`	`if (nextActionInfo.RequiredSpeedMpS == 0)`
`5904`	`5904`	`{`
`5905`	`5905`	`NextStopDistanceM = thisItem.ActivateDistanceM - PresentPosition[0].DistanceTravelledM;`
`5906`		`- if (AI.PreUpdate && !(nextActionInfo.NextAction == AIActionItem.AI_ACTION_TYPE.AUX_ACTION && NextStopDistanceM > minCheckDistanceM))`
	`5906`	`+ if (Simulator.PreUpdate && !(nextActionInfo.NextAction == AIActionItem.AI_ACTION_TYPE.AUX_ACTION && NextStopDistanceM > minCheckDistanceM))`
`5907`	`5907`	`{`
`5908`	`5908`	`AITrainBrakePercent = 100; // because of short reaction time`
`5909`	`5909`	`AITrainThrottlePercent = 0;`
Original file line number	Diff line number	Diff line change
`@@ -1461,7 +1461,7 @@ public void ReverseFormation(bool setMUParameters)`
`1461`	`1461`	`MUDirection = DirectionControl.Flip(MUDirection);`
`1462`	`1462`	`MUReverserPercent = -MUReverserPercent;`
`1463`	`1463`	`}`
`1464`		`- if (!((this is AITrain && (this as AITrain).AI.PreUpdate) \|\| this.TrainType == TRAINTYPE.STATIC)) FormationReversed = true;`
	`1464`	`+ if (!((this is AITrain && Simulator.PreUpdate) \|\| this.TrainType == TRAINTYPE.STATIC)) FormationReversed = true;`
`1465`	`1465`	`}`
`1466`	`1466`
`1467`	`1467`	`//================================================================================================//`