Automatic merge of T1.5.1-1689-g72674c98d and 14 pull requests

- Pull request #900 at 4629736: DMI in 3D cab + two more dials
- Pull request #1030 at d3ae4a2: Refactor settings, in prep for settings exporter
- Pull request #1045 at cc4d53c: Bugfix: Empty Start Time for Explore, and other issues loading from Menu Selection and Content Routes
- Pull request #1052 at 17c8d18: Content Manager: Add axle count, and lowest derail force
- Pull request #1062 at 3b18c48: Train Forces popup Window.
- Pull request #1064 at 53dd604: Add Train Info tab to Help window (F1)
- Pull request #1066 at 62c89c1: Log derailment, using TraceInformation.
- Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH
- Pull request #1000 at d8d9709: Locomotive operation from control car
- Pull request #1029 at 92c74ef: Superelevation Follow Up Fixes
- Pull request #1065 at 409064d: Fix for PantographToggle sound event
- Pull request #1068 at d6e1f83: Build for online-only documentation files
- Pull request #896 at f1681df: First implementation of https://blueprints.launchpad.net/or/+spec/specific-sounds-for-ai-trains
- Pull request #1067 at 777efaf: Traction and dynamic brake retardation

Author: openrails-bot

Source/Contrib/ContentManager/Models/Car.cs

@@ -43,6 +43,7 @@ public class Car
         public readonly float MassKG;
         public readonly float LengthM;
         public readonly int NumDriveAxles;
+        public readonly int NumIdleAxles;
         public readonly int NumAllAxles;
         public readonly float MaxBrakeForceN;
         public readonly float MaxPowerW;
@@ -57,8 +58,6 @@ public Car(Content content)
 
             const float GravitationalAccelerationMpS2 = 9.80665f;
 
-            int ortsEngAxles = -1;  // not present
-
             // .eng files also have a wagon block
             var wagFile = new WagonFile(content.PathName);
             Type = CarType.Wagon;
@@ -81,20 +80,27 @@ public Car(Content content)
                 Description = engFile.Description;
 
                 // see MSTSLocomotive.Initialize()
-                ortsEngAxles = engFile.NumDriveAxles;
-                if (ortsEngAxles >= 0) { NumDriveAxles = ortsEngAxles; }
-                else if (engFile.NumEngWheels >= 7f) { NumDriveAxles = (int)(engFile.NumEngWheels / 2f); }
-                else if (engFile.NumEngWheels > 0f) { NumDriveAxles = (int)engFile.NumEngWheels; }
-                else { NumDriveAxles = 4; }
+                NumDriveAxles = engFile.NumDriveAxles;
+                if (NumDriveAxles == 0)
+                {
+                    if (engFile.NumEngWheels != 0 && engFile.NumEngWheels < 7) { NumDriveAxles = (int)engFile.NumEngWheels; }
+                    else { NumDriveAxles = 4; }
+                }
             }
 
             // see MSTSWagon.LoadFromWagFile()
-            if (ortsEngAxles >= 0 && wagFile.NumWagAxles >= 0) { NumAllAxles = ortsEngAxles + wagFile.NumWagAxles; }
-            else if (wagFile.NumWagAxles >= 0) { NumAllAxles = wagFile.NumWagAxles; }
-            else if (wagFile.NumWagWheels >= 7f) { NumAllAxles = (int)(wagFile.NumWagWheels / 2f); }
-            else if (wagFile.NumWagWheels > 0f) { NumAllAxles = (int)wagFile.NumWagWheels; }
-            else { NumAllAxles = 4; }
-            if (NumDriveAxles > NumAllAxles) { NumAllAxles = NumDriveAxles; }
+            NumIdleAxles = wagFile.NumWagAxles;
+            if ((NumIdleAxles == 0) && Type != CarType.Engine)
+            {
+                if (wagFile.NumWagWheels != 0 && wagFile.NumWagWheels < 6) { NumIdleAxles = (int)wagFile.NumWagWheels; }
+                else { NumIdleAxles = 4; }
+            }
+
+            // correction for steam engines; see TrainCar.Update()
+            // this is not always correct as TrainCar uses the WheelAxles array for the count; that is too complex to do here
+            if (SubType.Equals("Steam") && NumDriveAxles >= (NumDriveAxles + NumIdleAxles)) { NumDriveAxles /= 2; }
+
+            NumAllAxles = NumDriveAxles + NumIdleAxles;
 
             // see TrainCar.UpdateTrainDerailmentRisk()
             var numWheels = NumAllAxles * 2;

Source/Contrib/ContentManager/Models/Consist.cs

@@ -60,7 +60,7 @@ public Consist(Content content)
                 var CarList = new List<Car>();
                 foreach (Wagon wag in file.Train.TrainCfg.WagonList)
                 {
-                    float wagonMassKG = 0; int ortsEngAxles = -1; int numDriveAxles = 0; int numAllAxles = 0;
+                    float wagonMassKG = 0; int numDriveAxles = 0; int numIdleAxles = 0; int numAllAxles = 0;
                     try
                     {
                         var fileType = wag.IsEngine ? ".eng" : ".wag";
@@ -73,16 +73,20 @@ public Consist(Content content)
                         wagonMassKG = wagonFile.MassKG;
                         MaxBrakeForce += wagonFile.MaxBrakeForceN;
                         MinCouplerStrengthN = Math.Min(MinCouplerStrengthN, wagonFile.MinCouplerStrengthN);
+                        var subType = wagonFile.WagonType;
                         if (wagonFile.MaxBrakeForceN > 0) { NumOperativeBrakes++; }
 
-                        if (wag.IsEngine)
+                        if (engFile != null)
                         {
+                            subType = engFile.EngineType;
+
                             // see MSTSLocomotive.Initialize()
-                            ortsEngAxles = engFile.NumDriveAxles;
-                            if (ortsEngAxles >= 0) { numDriveAxles = ortsEngAxles; }
-                            else if (engFile.NumEngWheels > 7f) { numDriveAxles = (int)(engFile.NumEngWheels / 2f); }
-                            else if (engFile.NumEngWheels > 0) { numDriveAxles = (int)engFile.NumEngWheels; }
-                            else { numDriveAxles = 4; }
+                            numDriveAxles = engFile.NumDriveAxles;
+                            if (numDriveAxles == 0)
+                            {
+                                if (engFile.NumEngWheels != 0 && engFile.NumEngWheels < 7) { numDriveAxles = (int)engFile.NumEngWheels; }
+                                else { numDriveAxles = 4; }
+                            }
 
                             if (engFile.MaxForceN > 25000)  // exclude legacy driving trailers / cab-cars
                             {
@@ -99,12 +103,18 @@ public Consist(Content content)
                         }
 
                         // see MSTSWagon.LoadFromWagFile()
-                        if (ortsEngAxles >= 0 && wagonFile.NumWagAxles >= 0) { numAllAxles = ortsEngAxles + wagonFile.NumWagAxles; }
-                        else if (wagonFile.NumWagAxles >= 0) { numAllAxles =  wagonFile.NumWagAxles; }
-                        else if (wagonFile.NumWagWheels >= 7f) { numAllAxles = (int)(wagonFile.NumWagWheels / 2f); }
-                        else if (wagonFile.NumWagWheels >= 0f) { numAllAxles = (int)wagonFile.NumWagWheels; }
-                        else { numAllAxles = 4; }
-                        if (numDriveAxles > numAllAxles) { numAllAxles = numDriveAxles; }
+                        numIdleAxles = wagonFile.NumWagAxles;
+                        if (numIdleAxles == 0 && !wag.IsEngine)
+                        {
+                            if (wagonFile.NumWagWheels != 0 && wagonFile.NumWagWheels < 6) { numIdleAxles = (int)wagonFile.NumWagWheels; }
+                            else { numIdleAxles = 4; }
+                        }
+
+                        // correction for steam engines; see TrainCar.Update()
+                        // this is not always correct as TrainCar uses the WheelAxles array for the count; that is too complex to do here
+                        if (subType.Equals("Steam") && numDriveAxles >= (numDriveAxles + numIdleAxles)) { numDriveAxles /= 2; }
+
+                        numAllAxles = numDriveAxles + numIdleAxles;
 
                         // exclude legacy EOT from total axle count
                         if (!wag.IsEOT && wagonFile.WagonSize.LengthM > 1.1)

Source/Contrib/SettingsExporter/Properties/launchSettings.json

@@ -0,0 +1,8 @@
+{
+  "profiles": {
+    "SettingsExporter": {
+      "commandName": "Project",
+      "commandLineArgs": "REG INI"
+    }
+  }
+}

Source/Documentation/Manual/physics.rst

@@ -1141,6 +1141,58 @@ with the ``ORTSTractionMotorType ( AC ) `` parameter, to be inserted in the Engi
 section of the ENG file. The use of this motor will have an impact on wheel slip,
 because the wheel speed never exceeds the frequency of the rotating magnetic field.
 
+Traction force retardation
+''''''''''''''''''''''''''
+
+.. index::
+    single: ORTSTractiveForceRampUpRate
+    single: ORTSTractiveForceRampDownRate
+    single: ORTSTractiveForceRampDownToZeroRate
+    single: ORTSDynamicBrakeForceRampUpRate
+    single: ORTSDynamicBrakeForceRampDownRate
+    single: ORTSDynamicBrakeForceRampDownToZeroRate
+    single: ORTSDelayTimeBeforeUpdating
+
+When the driver sets full throttle, the control electronics may not apply the full
+tractive force instantly, but it will instead linearly apply force until reaching
+the target demand. This can be tuned both for traction and dynamic braking by inserting
+``ORTSTractiveForceRampUpRate``, ``ORTSTractiveForceRampDownRate``,
+``ORTSTractiveForceRampDownToZeroRate``, ``ORTSDynamicBrakeForceRampUpRate``,
+``ORTSDynamicBrakeForceRampDownRate`` and ``ORTSDynamicBrakeForceRampDownToZeroRate``
+in the .eng file. The value of each parameter determines the force increase/decrease
+rate in one second.
+
+Example::
+
+  Engine (
+    ORTSTractiveForceRampUpRate ( 50kN )
+    ORTSTractiveForceRampDownRate ( 50kN )
+    ORTSTractiveForceRampDownToZeroRate ( 100kN )
+    ORTSDynamicBrakeForceRampUpRate ( 70kN )
+    ORTSDynamicBrakeForceRampDownRate ( 50kN )
+    ORTSDynamicBrakeForceRampDownToZeroRate ( 50kN )
+  )
+
+Another possibility to avoid sudden variations in tractive force while the driver
+is moving the throttle, is to only update the throttle/brake demand when the lever
+has not been moved for a defined amount of time. This can be implemented using the
+``ORTSDelayTimeBeforeUpdating``, which has to be inserted for the desired
+controller in the ``EngineControllers`` block.
+
+Example::
+
+  Engine (
+    EngineControllers (
+      Throttle ( 0 1 0.1 0
+        NumNotches ( 0 )
+        ORTSDelayTimeBeforeUpdating ( 0.5s )
+      )
+      Brake_Dynamic ( 0 1 0.1 0
+        NumNotches ( 0 )
+        ORTSDelayTimeBeforeUpdating ( 1s )
+      )
+    )
+  )
 
 Steam Locomotives
 -----------------

Source/Orts.Common/Conversions.cs

@@ -189,7 +189,7 @@ public static class Kg
         /// <summary>Convert from kilograms to UK Tons</summary>
         public static float ToTUK(float kg)       { return kg     * (1.0f / 1016.047f); }
         /// <summary>Convert from kilogram to metric tonnes</summary>
-        public static float ToTonne(float kg)      { return kg    / 1000.0f; }
+        public static float ToTonne(float kg)      { return kg    * (1.0f / 1000.0f); }
         /// <summary>Convert from metrix tonnes to kilogram</summary>
         public static float FromTonne(float tonne) { return tonne * 1000.0f; }
     }

Source/Orts.Formats.Msts/EngineFile.cs

@@ -33,7 +33,7 @@ public class EngineFile
         public float MaxForceN;
         public float MaxDynamicBrakeForceN;
         public float MaxSpeedMps;
-        public int NumDriveAxles = -1;  // ORTS; -1 indicates absent
+        public int NumDriveAxles;  // ORTS
         public float NumEngWheels;  // MSTS
         public string Description;
         public string CabViewFile;

Source/Orts.Formats.Msts/WagonFile.cs

@@ -32,7 +32,7 @@ public class WagonFile
         public string WagonType;
         public float MassKG;
         public CarSize WagonSize;
-        public int NumWagAxles = -1;  // ORTS; -1 indicates absent
+        public int NumWagAxles;  // ORTS
         public float NumWagWheels;  // MSTS
         public float MaxBrakeForceN;
         public float MinCouplerStrengthN = ImpossiblyHighForceN;

Source/Orts.Parsers.Msts/STFReader.cs

@@ -609,10 +609,11 @@ public float ReadFloat(UNITS validUnits, float? defaultValue)
             // However, some values (mostly "time" ones) may be followed by text. Therefore that approach cannot be used consistently 
             // and has been abandoned. </CJComment> 
 
+            float val;
+            double scale = ParseUnitSuffix(ref item, validUnits);
             if (item.Length == 0) return 0.0f;
             if (item[item.Length - 1] == ',') item = item.TrimEnd(',');
-            double scale = ParseUnitSuffix(ref item, validUnits); // must be after TrimEnd(','), otherwise the unit parsed becomes invalid
-            if (float.TryParse(item, parseNum, parseNFI, out float val)) return (scale == 1) ? val : (float)(scale * val);
+            if (float.TryParse(item, parseNum, parseNFI, out val)) return (scale == 1) ? val : (float)(scale * val);
             STFException.TraceWarning(this, "Cannot parse the constant number " + item);
             if (item == ")") StepBackOneItem();
             return defaultValue.GetValueOrDefault(0);

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

@@ -4061,14 +4061,33 @@ public void UnconditionalInitializeBrakes()
                 MSTSLocomotive lead = (MSTSLocomotive)Cars[LeadLocomotiveIndex];
                 if (lead.TrainBrakeController != null)
                 {
-                    foreach (var car in Cars)
+                    foreach (MSTSWagon car in Cars)
                     {
-                        if (lead.BrakeSystem.GetType() != car.BrakeSystem.GetType())
+                        if (lead.CarBrakeSystemType != car.CarBrakeSystemType) // Test to see if car brake system is the same as the locomotive
                         {
-                            car.BrakeSystem = BrakeSystem.CreateNewLike(lead.BrakeSystem, car);
-                            car.BrakeSystem.InitializeFromCopy(lead.BrakeSystem, false);
-                            if (car.BrakeSystem is AirSinglePipe carAir && lead.BrakeSystem is AirSinglePipe leadAir)
-                                carAir.EmergencyReservoirPresent = leadAir.EmergencyReservoirPresent;
+                            // If not, change so that they are compatible
+                            car.CarBrakeSystemType = lead.CarBrakeSystemType;
+                            if (lead.BrakeSystem is VacuumSinglePipe)
+                                car.MSTSBrakeSystem = new VacuumSinglePipe(car);
+                            else if (lead.BrakeSystem is AirTwinPipe)
+                                car.MSTSBrakeSystem = new AirTwinPipe(car);
+                            else if (lead.BrakeSystem is AirSinglePipe leadAir)
+                            {
+                                car.MSTSBrakeSystem = new AirSinglePipe(car);
+                                // if emergency reservoir has been set on lead locomotive then also set on trailing cars
+                                if (leadAir.EmergencyReservoirPresent)
+                                {
+                                    (car.BrakeSystem as AirSinglePipe).EmergencyReservoirPresent = leadAir.EmergencyReservoirPresent;
+                                }
+                            }
+                            else if (lead.BrakeSystem is EPBrakeSystem ep)
+                                car.MSTSBrakeSystem = new EPBrakeSystem(car, ep.TwoPipes);
+                            else if (lead.BrakeSystem is SingleTransferPipe)
+                                car.MSTSBrakeSystem = new SingleTransferPipe(car);
+                            else
+                                throw new Exception("Unknown brake type");
+
+                            car.MSTSBrakeSystem.InitializeFromCopy(lead.BrakeSystem);
                             Trace.TraceInformation("Car and Locomotive Brake System Types Incompatible on Car {0} - Car brakesystem type changed to {1}", car.CarID, car.CarBrakeSystemType);
                         }
                     }

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

@@ -263,7 +263,7 @@ public override string GetStatus()
         /// <summary>
         /// This function updates periodically the locomotive's motive force.
         /// </summary>
-        protected override void UpdateTractiveForce(float elapsedClockSeconds, float t, float AbsSpeedMpS, float AbsWheelSpeedMpS)
+        protected override void UpdateTractiveForce(float elapsedClockSeconds)
         {
         }