Merge branch 'openrails:master' into alternate-tokens

Author: SteelFill

Source/Documentation/Manual/appendices.rst

@@ -123,7 +123,8 @@ The following folders are also written to by Open Rails.
    Save images          AppData\\Roaming\\Open Rails\\shunt_1 2021-07-18 19.46.35.png
    Replays              AppData\\Roaming\\Open Rails\\shunt_1 2021-07-18 19.46.35.replay
    Evaluations          AppData\\Roaming\\Open Rails\\shunt_1 2021-07-18 19.46.35.dbfeval
-   Loading progress bar AppData\\Roaming\\Open Rails\\Load Cache\\3cd9... ...0ce2.dat
+   Loading progress bar AppData\\Roaming\\Open Rails\\Cache\\Load\\3cd9... ...0ce2.cache-or
+   Timetable path files AppData\\Roaming\\Open Rails\\Cache\\Path\\4ae2... ...4132.cache-or
    ==================== ========================================================================================
 
 

Source/Documentation/Manual/timetable.rst

@@ -296,16 +296,15 @@ Special Rows
 
   Large timetables can require many paths, and loading those paths can take 
   considerable time (several minutes). To reduce this loading time, the paths 
-  can be stored in a processed, binary format. This format is the same as used 
-  in the 'save' command. Note that the binary path information cannot be 
-  directly accessed by the user, either for reading or for writing. When 
-  ``/binary`` is set, the program will check if a binary path exists. If so, it 
-  will read that path. If not, it will read the 'normal' path, and will then 
-  store this as binary for future use. Binary paths are stored in a subdirectory 
-  named ``OpenRails`` which must be created in the Paths directory of the route.
+  can be stored in files in a processed, binary format. When 
+  ``/binary`` is set, the program will check if a binary path file exists. 
+  If so, it will read that path. If not, it will read the 'normal' path, and will then 
+  store this as a binary path file for future use.
 
   Note: If a path or the route is edited, then the binary data will be out of date.
   If so, it is deleted and re-created automatically when the user starts the route.
+  These files are stored in the same 
+  folder as Saves - see :ref:`Folders used by Open Rails <appendices-folders_used>`.
 
 - ``#consist`` row 
 

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

@@ -952,9 +952,8 @@ private void RestoreCars(Simulator simulator, BinaryReader inf)
             {
                 for (int i = 0; i < count; ++i)
                 {
-                    TrainCar car = RollingStock.Load(simulator, this, inf.ReadString(), false);
+                    TrainCar car = RollingStock.Load(simulator, this, inf.ReadString());
                     car.Restore(inf);
-                    car.Initialize();
                 }
             }
             SetDPUnitIDs(true);

Source/Orts.Simulation/Simulation/RollingStocks/MSTSControlTrailerCar.cs

@@ -128,6 +128,7 @@ public override void Copy(MSTSWagon copy)
         /// </summary>
         public override void Save(BinaryWriter outf)
         {
+            base.Save(outf);
             ControllerFactory.Save(GearBoxController, outf);
             outf.Write(ControlGearIndication);
             outf.Write(ControlGearIndex);

Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs

@@ -91,11 +91,6 @@ public float DieselLevelL
 
         public float LocomotiveMaxRailOutputPowerW;
 
-        public int currentGearIndexRestore = -1;
-        public int currentnextGearRestore = -1;
-        public bool gearSaved;
-        public int dieselEngineRestoreState;
-
         public float EngineRPM;
         public SmoothedData ExhaustParticles = new SmoothedData(1);
         public SmoothedData ExhaustMagnitude = new SmoothedData(1);
@@ -476,17 +471,6 @@ public override void Initialize()
                 }
             }
 
-            // TO BE LOOKED AT - fix restoration process for gearbox and gear controller
-            // It appears that the gearbox is initialised in two different places to cater for Basic and Advanced ENG file configurations(?).
-            // Hence the restore values recovered in gearbox class are being overwritten , and resume was not working correctly
-            // Hence restore gear position values are read as part of the diesel and restored at this point.
-            if (gearSaved)
-            {
-                DieselEngines[0].GearBox.nextGearIndex = currentnextGearRestore;
-                DieselEngines[0].GearBox.currentGearIndex = currentGearIndexRestore;
-                GearBoxController.SetValue((float)DieselEngines[0].GearBox.currentGearIndex);
-            }
-
             if (Simulator.Settings.VerboseConfigurationMessages)
             {
                 if (DieselEngines.HasGearBox)

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Brakes/MSTS/AirSinglePipe.cs

@@ -322,6 +322,7 @@ public override void Save(BinaryWriter outf)
             outf.Write(ReleaseRatePSIpS);
             outf.Write(RetainerPressureThresholdPSI);
             outf.Write(AutoCylPressurePSI);
+            outf.Write(CylPressurePSI);
             outf.Write(AuxResPressurePSI);
             outf.Write(EmergResPressurePSI);
             outf.Write(ControlResPressurePSI);
@@ -345,6 +346,7 @@ public override void Restore(BinaryReader inf)
             ReleaseRatePSIpS = inf.ReadSingle();
             RetainerPressureThresholdPSI = inf.ReadSingle();
             AutoCylPressurePSI = inf.ReadSingle();
+            CylPressurePSI = inf.ReadSingle();
             AuxResPressurePSI = inf.ReadSingle();
             EmergResPressurePSI = inf.ReadSingle();
             ControlResPressurePSI = inf.ReadSingle();

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

@@ -188,7 +188,6 @@ public void HandleEvent(PowerSupplyEvent evt)
 
         public void Save(BinaryWriter outf)
         {
-            outf.Write(ScriptName);
             outf.Write(DelayS);
             outf.Write(State.ToString());
             outf.Write(DriverClosingOrder);
@@ -199,7 +198,6 @@ public void Save(BinaryWriter outf)
 
         public void Restore(BinaryReader inf)
         {
-            ScriptName = inf.ReadString();
             DelayS = inf.ReadSingle();
             State = (CircuitBreakerState)Enum.Parse(typeof(CircuitBreakerState), inf.ReadString());
             DriverClosingOrder = inf.ReadBoolean();

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

@@ -109,7 +109,6 @@ public void Parse(string lowercasetoken, STFReader stf)
                             DEList.Add(new DieselEngine(Locomotive));
 
                             DEList[i].Parse(stf);
-                            DEList[i].Initialize();
 
                             // sets flag to indicate that a diesel eng prime mover code block has been defined by user, otherwise OR will define one through the next code section using "MSTS" values
                             DEList[i].DieselEngineConfigured = true;
@@ -119,7 +118,6 @@ public void Parse(string lowercasetoken, STFReader stf)
                         {
                             STFException.TraceWarning(stf, "Diesel engine model has some errors - loading MSTS format");
                             DEList[i].InitFromMSTS();
-                            DEList[i].Initialize();
                         }
                     }
                     break;
@@ -993,15 +991,11 @@ public void Copy(DieselEngine other)
 
         public void Initialize()
         {
-            if (!Simulator.Settings.NoDieselEngineStart && !Locomotive.gearSaved)
+            if (!Simulator.Settings.NoDieselEngineStart)
             {
                 RealRPM = IdleRPM;
                 State = DieselEngineState.Running;
             }
-            else if (Locomotive.gearSaved)
-            {
-                State = (DieselEngineState)Locomotive.dieselEngineRestoreState;
-            }
 
             RPMRange = MaxRPM - IdleRPM;
             MagnitudeRange = MaxMagnitude - InitialMagnitude;
@@ -1018,16 +1012,14 @@ public void Initialize()
 
         public void InitializeMoving()
         {
-            if (!Simulator.Settings.NoDieselEngineStart && !Locomotive.gearSaved)
-            {
-                RealRPM = IdleRPM;
-                State = DieselEngineState.Running;
-            }
-            else if (Locomotive.gearSaved)
+            RealRPM = IdleRPM;
+            State = DieselEngineState.Running;
+            if (ThrottleRPMTab != null)
             {
-                State = (DieselEngineState)Locomotive.dieselEngineRestoreState;
+                DemandedRPM = ThrottleRPMTab[Locomotive.ThrottlePercent];
+                DemandedRPM = MathHelper.Clamp(DemandedRPM, IdleRPM, MaxRPM);  // Clamp throttle setting within bounds
+                RealRPM = DemandedRPM;
             }
-
             GearBox?.InitializeMoving();
         }
 
@@ -1594,20 +1586,12 @@ public void HandleEvent(PowerSupplyEvent evt)
 
         public void Restore(BinaryReader inf)
         {
-            Locomotive.dieselEngineRestoreState = inf.ReadInt32();
-            State = (DieselEngineState)Locomotive.dieselEngineRestoreState;
+            State = (DieselEngineState)inf.ReadInt32();
             RealRPM = inf.ReadSingle();
             OutputPowerW = inf.ReadSingle();
             DieselTemperatureDeg = inf.ReadSingle();
             GovernorEnabled = inf.ReadBoolean();
-
-            Locomotive.gearSaved = inf.ReadBoolean();  // read boolean which indicates gear data was saved
-
-            if (Locomotive.gearSaved)
-            {
-                GearBox = new GearBox(this);
-                GearBox.Restore(inf);
-            }
+            GearBox?.Restore(inf);
         }
 
         public void Save(BinaryWriter outf)
@@ -1617,16 +1601,7 @@ public void Save(BinaryWriter outf)
             outf.Write(OutputPowerW);
             outf.Write(DieselTemperatureDeg);
             outf.Write(GovernorEnabled);
-
-            if (GearBox != null)
-            {
-                outf.Write(true);
-                GearBox.Save(outf);
-            }
-            else
-            {
-                outf.Write(false);
-            }
+            GearBox?.Save(outf);
         }
 
         /// <summary>

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

@@ -110,16 +110,12 @@ public override void InitializeMoving()
 
         public override void Save(BinaryWriter outf)
         {
-            outf.Write(ScriptName);
-
             base.Save(outf);
             TractionCutOffRelay.Save(outf);
         }
 
         public override void Restore(BinaryReader inf)
         {
-            ScriptName = inf.ReadString();
-
             base.Restore(inf);
             TractionCutOffRelay.Restore(inf);
         }

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

@@ -112,17 +112,13 @@ public override void InitializeMoving()
 
         public override void Save(BinaryWriter outf)
         {
-            outf.Write(ScriptName);
-
             base.Save(outf);
             CircuitBreaker.Save(outf);
             TractionCutOffRelay.Save(outf);
         }
 
         public override void Restore(BinaryReader inf)
         {
-            ScriptName = inf.ReadString();
-
             base.Restore(inf);
             CircuitBreaker.Restore(inf);
             TractionCutOffRelay.Restore(inf);