Add useful train information to all scripts

Author: cesarBLG

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

@@ -38,6 +38,7 @@ public abstract class BrakeController : AbstractTrainScriptClass
         internal void AttachToHost(ScriptedBrakeController host)
         {
             Host = host;
+            Car = Locomotive;
         }
 
         /// <summary>
@@ -188,7 +189,7 @@ public float IntermediateValue
         /// <summary>
         /// Fraction of train brake demanded by cruise control
         /// </summary>
-        public float CruiseControlBrakeDemand() => Locomotive.CruiseControl != null ? Locomotive.CruiseControl.TrainBrakePercent/100 : 0;
+        public float CruiseControlBrakeDemand() => Locomotive.CruiseControl != null ? Locomotive.CruiseControl.TrainBrakePercent / 100 : 0;
 
         /// <summary>
         /// Current notch of the brake controller

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

@@ -17,6 +17,7 @@
 
 using Orts.Common;
 using Orts.Simulation;
+using Orts.Simulation.Physics;
 using Orts.Simulation.RollingStocks;
 using Orts.Simulation.RollingStocks.SubSystems;
 using System;
@@ -47,6 +48,8 @@ public abstract class AbstractScriptClass
     /// </summary>
     public abstract class AbstractTrainScriptClass : AbstractScriptClass
     {
+        internal TrainCar Car;
+        internal Train Train => Car.Train;
         /// <summary>
         /// Running total of distance travelled - always positive, updated by train physics.
         /// </summary>
@@ -71,6 +74,25 @@ public abstract class AbstractTrainScriptClass : AbstractScriptClass
         /// Sends an event to the train.
         /// </summary>
         public Action<Event> SignalEventToTrain;
+        /// <summary>
+        /// Train's length
+        /// </summary>
+        public float TrainLengthM()
+        {
+            return Car.Train?.Length ?? 0.0f;
+        }
+        /// <summary>
+        /// Returns the number of locomotives in the train
+        /// </summary>
+        public int NumberOfLocomotives()
+        {
+            int count = 0;
+            for (int i = 0; i < Train.Cars.Count; i++)
+            {
+                if (Train.Cars[i] is MSTSLocomotive) count++;
+            }
+            return count;
+        }
     }
 
     /// <summary>

Source/Orts.Simulation/Common/Scripting/PowerSupply/LocomotivePowerSupply.cs

@@ -31,7 +31,6 @@ public abstract class LocomotivePowerSupply : PowerSupply
         // Internal members and methods (inaccessible from script)
         internal ScriptedLocomotivePowerSupply LpsHost => Host as ScriptedLocomotivePowerSupply;
         internal MSTSLocomotive Locomotive => LpsHost.Locomotive;
-        internal Train Train => Locomotive.Train;
         internal Simulator Simulator => Locomotive.Simulator;
 
         /// <summary>
@@ -188,19 +187,6 @@ protected float MaxThrottlePercent
         /// </summary>
         protected float ElectricTrainSupplyPowerW => LpsHost.ElectricTrainSupplyPowerW;
 
-        /// <summary>
-        /// Returns the number of locomotives in the train
-        /// </summary>
-        public int NumberOfLocomotives()
-        {
-            int count=0;
-            for (int i=0; i<Train.Cars.Count; i++)
-            {
-                if (Train.Cars[i] is MSTSLocomotive) count++;
-            }
-            return count;
-        }
-
         /// <summary>
         /// Returns the index of the current locomotive in the train (taking into account only locomotives)
         /// </summary>

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

@@ -31,6 +31,7 @@ public abstract class PowerSupply : AbstractTrainScriptClass
         internal void AttachToHost(IPowerSupply host)
         {
             Host = host;
+            Car = host.Car;
         }
 
         /// <summary>

Source/Orts.Simulation/Common/Scripting/PowerSupply/TractionCutOffSubsytem.cs

@@ -37,6 +37,7 @@ public abstract class TractionCutOffSubsystem : AbstractTrainScriptClass
         internal void AttachToHost(ITractionCutOffSubsystem host)
         {
             Host = host;
+            Car = Locomotive;
         }
 
         /// <summary>

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

@@ -168,10 +168,6 @@ internal void AttachToHost(ScriptedTrainControlSystem host)
         /// </summary>
         public Func<int, float> EOADistanceM;
         /// <summary>
-        /// Train's length
-        /// </summary>
-        public Func<float> TrainLengthM;
-        /// <summary>
         /// Locomotive direction.
         /// </summary>
         public Func<Direction> CurrentDirection;

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Controllers/BrakeController.cs

@@ -361,6 +361,7 @@ public void Initialize()
                 Script.AttachToHost(this);
 
                 // AbstractScriptClass
+                Script.Car = Locomotive;
                 Script.ClockTime = () => (float)Simulator.ClockTime;
                 Script.GameTime = () => (float)Simulator.GameTime;
                 Script.PreUpdate = () => Simulator.PreUpdate;

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

@@ -264,6 +264,7 @@ public void Initialize()
                 }
 
                 // AbstractScriptClass
+                Script.Car = Locomotive;
                 Script.ClockTime = () => (float)Simulator.ClockTime;
                 Script.GameTime = () => (float)Simulator.GameTime;
                 Script.PreUpdate = () => Simulator.PreUpdate;
@@ -330,7 +331,6 @@ public void Initialize()
                     return new MilepostInfo(list[value].DistanceToTrainM, float.Parse(list[value].ThisMile));
                 };
                 Script.EOADistanceM = (value) => Locomotive.Train.DistanceToEndNodeAuthorityM[value];
-                Script.TrainLengthM = () => Locomotive.Train != null ? Locomotive.Train.Length : 0f;
                 Script.SpeedMpS = () => Math.Abs(Locomotive.SpeedMpS);
                 Script.CurrentDirection = () => Locomotive.Direction; // Direction of locomotive, may be different from direction of train
                 Script.IsDirectionForward = () => Locomotive.Direction == Direction.Forward;