Merge pull request #830 from cesarBLG/electric-hot-start

Electric locomotive hot start

Author: cesarBLG

Source/Documentation/Manual/options.rst

@@ -407,6 +407,16 @@ Uncheck this option for a more detailed behaviour in which the player has to sta
 The default setting is checked.
 
 
+At game start, Electric - power connected
+-----------------------------------
+
+When this option is checked, stationary electric locos start the simulation with power available.
+Uncheck this option for a more detailed behaviour in which the player has to switch on electrical equipment.
+
+The default setting is checked.
+
+In timetable mode, power status is not affected by these options.
+
 .. _options-forced-red:
 
 Forced red at station stops

Source/Menu/Options.Designer.cs

@@ -187,6 +187,7 @@ public OptionsForm(UserSettings settings, UpdateManager updateManager, bool init
             checkForcedRedAtStationStops.Checked = !Settings.NoForcedRedAtStationStops;
             checkDoorsAITrains.Checked = Settings.OpenDoorsInAITrains;
             checkDieselEnginesStarted.Checked = !Settings.NoDieselEngineStart; // Inverted as "EngineStart" is better UI than "NoEngineStart"
+            checkElectricPowerConnected.Checked = Settings.ElectricHotStart;
 
             // Keyboard tab
             InitializeKeyboardSettings();
@@ -472,6 +473,7 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.NoForcedRedAtStationStops = !checkForcedRedAtStationStops.Checked;
             Settings.OpenDoorsInAITrains = checkDoorsAITrains.Checked;
             Settings.NoDieselEngineStart = !checkDieselEnginesStarted.Checked; // Inverted as "EngineStart" is better UI than "NoEngineStart"
+            Settings.ElectricHotStart = checkElectricPowerConnected.Checked;
 
             // Keyboard tab
             // These are edited live.

Source/Menu/Options.cs

@@ -226,6 +226,8 @@ public enum DirectXFeature
         public bool HotStart { get; set; }
         [Default(false)]
         public bool NoDieselEngineStart { get; set; }
+        [Default(true)]
+        public bool ElectricHotStart { get; set; }
 
         // Data logger settings:
         [Default("comma")]

Source/ORTS.Settings/UserSettings.cs

@@ -131,6 +131,8 @@ public override void Initialize()
                     CurrentLocomotiveSteamHeatBoilerWaterCapacityL = L.FromGUK(800.0f);
                 }
             }
+
+            if (Simulator.Settings.ElectricHotStart) SetPower(true);
         }
 
         //================================================================================================//

Source/Orts.Simulation/Simulation/RollingStocks/MSTSElectricLocomotive.cs

@@ -43,6 +43,8 @@ public enum ModeType
         public bool CommandButtonOn { get; protected set; } = false;
         public bool CommandButtonOff { get; protected set; } = false;
         public bool On { get; protected set; } = false;
+        protected bool QuickPowerOn;
+        protected bool QuickPowerOff;
 
         public BatterySwitch(MSTSWagon wagon)
         {
@@ -201,6 +203,15 @@ public virtual void Update(float elapsedClockSeconds)
                 case ModeType.PushButtons:
                     if (On)
                     {
+                        if (QuickPowerOn)
+                        {
+                            QuickPowerOn = false;
+                            if (CommandButtonOn)
+                            {
+                                CommandButtonOn = false;
+                                Wagon.SignalEvent(Event.BatterySwitchCommandOff);
+                            }
+                        }
                         if (CommandButtonOff)
                         {
                             if (!Timer.Started)
@@ -225,6 +236,15 @@ public virtual void Update(float elapsedClockSeconds)
                     }
                     else
                     {
+                        if (QuickPowerOff)
+                        {
+                            QuickPowerOff = false;
+                            if (CommandButtonOff)
+                            {
+                                CommandButtonOff = false;
+                                Wagon.SignalEvent(Event.BatterySwitchCommandOff);
+                            }
+                        }
                         if (CommandButtonOn)
                         {
                             if (!Timer.Started)
@@ -302,6 +322,37 @@ public virtual void HandleEvent(PowerSupplyEvent evt)
                         Wagon.SignalEvent(Event.BatterySwitchCommandOff);
                     }
                     break;
+                case PowerSupplyEvent.QuickPowerOn:
+                    switch (Mode)
+                    {
+                        case ModeType.Switch:
+                            CommandSwitch = true;
+                            Wagon.SignalEvent(Event.BatterySwitchCommandOn);
+                            break;
+                        case ModeType.PushButtons:
+                            CommandButtonOn = true;
+                            Wagon.SignalEvent(Event.BatterySwitchCommandOn);
+                            QuickPowerOn = true;
+                            QuickPowerOff = false;
+                            break;
+
+                    }
+                    break;
+                case PowerSupplyEvent.QuickPowerOff:
+                    switch (Mode)
+                    {
+                        case ModeType.Switch:
+                            CommandSwitch = false;
+                            Wagon.SignalEvent(Event.BatterySwitchCommandOff);
+                            break;
+                        case ModeType.PushButtons:
+                            CommandButtonOff = true;
+                            Wagon.SignalEvent(Event.BatterySwitchCommandOn);
+                            QuickPowerOn = false;
+                            QuickPowerOff = true;
+                            break;
+                    }
+                    break;
             }
         }
     }

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

@@ -320,7 +320,7 @@ public override void HandleEvent(PowerSupplyEvent evt)
             {
                 case PowerSupplyEvent.QuickPowerOn:
                     QuickPowerOn = true;
-                    SignalEventToBatterySwitch(PowerSupplyEvent.CloseBatterySwitch);
+                    SignalEventToBatterySwitch(PowerSupplyEvent.QuickPowerOn);
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOnMasterKey);
                     SignalEventToDieselEngines(PowerSupplyEvent.StartEngine);
                     SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.SwitchOnElectricTrainSupply);
@@ -332,7 +332,7 @@ public override void HandleEvent(PowerSupplyEvent evt)
                     SignalEventToTractionCutOffRelay(PowerSupplyEvent.OpenTractionCutOffRelay);
                     SignalEventToDieselEngines(PowerSupplyEvent.StopEngine);
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOffMasterKey);
-                    SignalEventToBatterySwitch(PowerSupplyEvent.OpenBatterySwitch);
+                    SignalEventToBatterySwitch(PowerSupplyEvent.QuickPowerOff);
                     break;
 
                 case PowerSupplyEvent.TogglePlayerEngine:

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

@@ -271,7 +271,7 @@ public override void HandleEvent(PowerSupplyEvent evt)
             {
                 case PowerSupplyEvent.QuickPowerOn:
                     QuickPowerOn = true;
-                    SignalEventToBatterySwitch(PowerSupplyEvent.CloseBatterySwitch);
+                    SignalEventToBatterySwitch(PowerSupplyEvent.QuickPowerOn);
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOnMasterKey);
                     SignalEventToPantograph(PowerSupplyEvent.RaisePantograph, 1);
                     SignalEventToOtherTrainVehiclesWithId(PowerSupplyEvent.RaisePantograph, 1);
@@ -285,7 +285,7 @@ public override void HandleEvent(PowerSupplyEvent evt)
                     SignalEventToPantographs(PowerSupplyEvent.LowerPantograph);
                     SignalEventToOtherTrainVehicles(PowerSupplyEvent.LowerPantograph);
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOffMasterKey);
-                    SignalEventToBatterySwitch(PowerSupplyEvent.OpenBatterySwitch);
+                    SignalEventToBatterySwitch(PowerSupplyEvent.QuickPowerOff);
                     break;
 
                 default: