Merge pull request #891 from Roeterdink/AutoSave

feature: Auto save

Author: cjakeman

Source/Documentation/Manual/images/options-general.png

@@ -110,6 +110,17 @@ This option uses the train control system scripts for locomotives where
 these have been implemented.
 
 
+.. _auto-save:
+
+Auto Save
+--------
+
+This option will make saves automatically at regular intervals just as though you had pressed ``<F2>`` 
+for a  :ref:`manual save<driving-saveresume>`. This option is off by default, 
+
+When Auto Save is on, you can still make manual saves and doing so resets the automatic timer.
+
+
 Overspeed Monitor
 -----------------
 

Source/Documentation/Manual/options.rst

@@ -139,6 +139,10 @@ public OptionsForm(UserSettings settings, UpdateManager updateManager, string ba
             comboPressureUnit.Text = Settings.PressureUnit;
             comboOtherUnits.Text = settings.Units;
             checkEnableTCSScripts.Checked = !Settings.DisableTCSScripts;    // Inverted as "Enable scripts" is better UI than "Disable scripts"
+            checkAutoSaveActive.Checked = Settings.AutoSaveActive;
+            ButtonAutoSave15.Checked = checkAutoSaveActive.Checked & Settings.AutoSaveInterval == 15;
+            ButtonAutoSave30.Checked = checkAutoSaveActive.Checked & Settings.AutoSaveInterval == 30;
+            ButtonAutoSave60.Checked = checkAutoSaveActive.Checked & Settings.AutoSaveInterval == 60;
 
             // Audio tab
             numericSoundVolumePercent.Value = Settings.SoundVolumePercent;
@@ -415,6 +419,8 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.PressureUnit = comboPressureUnit.SelectedValue.ToString();
             Settings.Units = comboOtherUnits.SelectedValue.ToString();
             Settings.DisableTCSScripts = !checkEnableTCSScripts.Checked; // Inverted as "Enable scripts" is better UI than "Disable scripts"
+            Settings.AutoSaveActive = checkAutoSaveActive.Checked;
+            Settings.AutoSaveInterval = ButtonAutoSave15.Checked ? 15 : ButtonAutoSave30.Checked ? 30 : 60;
 
             // Audio tab
             Settings.SoundVolumePercent = (int)numericSoundVolumePercent.Value;
@@ -664,6 +670,50 @@ private void checkPerformanceTuner_Click(object sender, EventArgs e)
             labelPerformanceTunerTarget.Enabled = checkPerformanceTuner.Checked;
         }
 
+        private void checkAutoSave_checkchanged(object sender, EventArgs e)
+        {
+            if (checkAutoSaveActive.Checked)
+            {
+                ButtonAutoSave15.Enabled = true;
+                ButtonAutoSave15.Checked = Settings.AutoSaveInterval == 15;
+                ButtonAutoSave30.Enabled = true;
+                ButtonAutoSave30.Checked = Settings.AutoSaveInterval == 30;
+                ButtonAutoSave60.Enabled = true;
+                ButtonAutoSave60.Checked = Settings.AutoSaveInterval == 60;
+            }
+            else
+            {
+                ButtonAutoSave15.Checked = false;
+                ButtonAutoSave15.Enabled = false;
+                ButtonAutoSave30.Checked = false;
+                ButtonAutoSave30.Enabled = false;
+                ButtonAutoSave60.Checked = false;
+                ButtonAutoSave60.Enabled = false;
+            }
+        }
+
+        private void buttonAutoSaveInterval_checkchanged(object sender, EventArgs e)
+        {
+            if (ButtonAutoSave15.Checked)
+            {
+                Settings.AutoSaveInterval = 15;
+                ButtonAutoSave30.Checked = false;
+                ButtonAutoSave60.Checked = false;
+            }
+            else if (ButtonAutoSave30.Checked)
+            {
+                Settings.AutoSaveInterval = 30;
+                ButtonAutoSave15.Checked = false;
+                ButtonAutoSave60.Checked = false;
+            }
+            else if (ButtonAutoSave60.Checked)
+            {
+                Settings.AutoSaveInterval = 60;
+                ButtonAutoSave15.Checked = false;
+                ButtonAutoSave30.Checked = false;
+            }
+        }
+
         #region Help for Options
         // The icons all share the same code which assumes they are named according to a simple scheme as follows:
         //   1. To add a new Help Icon, copy an existing one and paste it onto the tab.
@@ -728,6 +778,7 @@ private void InitializeHelpIcons()
                 (pbPressureUnit, new Control[] { labelPressureUnit, comboPressureUnit }),
                 (pbOtherUnits, new Control[] { labelOtherUnits, comboOtherUnits }),
                 (pbEnableTcsScripts, new[] { checkEnableTCSScripts }),
+                (pbAutoSave, new[] { checkAutoSaveActive }),
                 (pbOverspeedMonitor, new[] { checkOverspeedMonitor }),
 
                 // Audio tab
@@ -782,6 +833,7 @@ private void HelpIcon_Click(object sender, EventArgs _)
         {
             var urls = new Dictionary<object, string>
             {
+                // General tab
                 {
                     pbAlerter,
                     BaseDocumentationUrl + "/options.html#alerter-in-cab"
@@ -810,6 +862,10 @@ private void HelpIcon_Click(object sender, EventArgs _)
                     pbEnableTcsScripts,
                     BaseDocumentationUrl + "/options.html#disable-tcs-scripts"
                 },
+                {
+                    pbAutoSave,
+                    BaseDocumentationUrl + "/options.html#auto-save"
+                },
                 {
                     pbOverspeedMonitor,
                     BaseDocumentationUrl + "/options.html#overspeed-monitor"

Source/Menu/Options.Designer.cs

@@ -168,6 +168,10 @@ public enum DirectXFeature
         public String Units { get; set; }
         [Default(false)]
         public bool DisableTCSScripts { get; set; }
+        [Default(false)]
+        public bool AutoSaveActive { get; set; }
+        [Default (15)]
+        public int AutoSaveInterval { get; set; }
 
         // Audio settings:
         [Default(100)]

Source/Menu/Options.cs

@@ -70,6 +70,7 @@ void buttonQuit_Click(Control arg1, Point arg2)
         void buttonSave_Click(Control arg1, Point arg2)
         {
             GameStateRunActivity.Save();
+            Owner.Viewer.AutoSaveDueAt = Owner.Viewer.RealTime + 60 * Owner.Viewer.Simulator.Settings.AutoSaveInterval;
         }
 
         void buttonContinue_Click(Control arg1, Point arg2)

Source/ORTS.Settings/UserSettings.cs

@@ -79,6 +79,7 @@ public class Viewer
         /// Monotonically increasing time value (in seconds) for the game/viewer. Starts at 0 and only ever increases, at real-time.
         /// </summary>
         public double RealTime { get; private set; }
+        public double AutoSaveDueAt { get; set; } = -1; // RealTime when next AutoSave is due
         InfoDisplay InfoDisplay;
         public WindowManager WindowManager { get; private set; }
         public MessagesWindow MessagesWindow { get; private set; } // Game message window (special, always visible)
@@ -307,6 +308,8 @@ public Viewer(Simulator simulator, Orts.Viewer3D.Processes.Game game)
             Settings = simulator.Settings;
             Use3DCabProperty = Settings.GetSavingProperty<bool>("Use3DCab");
 
+            AutoSaveDueAt = Simulator.Settings.AutoSaveInterval * 60;
+
             RenderProcess = game.RenderProcess;
             UpdaterProcess = game.UpdaterProcess;
             LoaderProcess = game.LoaderProcess;
@@ -773,6 +776,14 @@ public void Update(RenderFrame frame, float elapsedRealTime)
             RealTime += elapsedRealTime;
             var elapsedTime = new ElapsedTime(Simulator.GetElapsedClockSeconds(elapsedRealTime), elapsedRealTime);
 
+            // auto save
+            if (Simulator.Settings.AutoSaveActive && RealTime > AutoSaveDueAt && !Simulator.Paused)
+            {
+                GameStateRunActivity.Save();
+                AutoSaveDueAt = RealTime + Simulator.Settings.AutoSaveInterval * 60;
+            }
+
+            // show message
             if (ComposeMessageWindow.Visible == true)
             {
                 UserInput.Handled();
@@ -988,7 +999,11 @@ void HandleUserInput(ElapsedTime elapsedTime)
                 Simulator.GameSpeed = 1;
                 Simulator.Confirmer.ConfirmWithPerCent(CabControl.SimulationSpeed, CabSetting.Off, Simulator.GameSpeed * 100);
             }
-            if (UserInput.IsPressed(UserCommand.GameSave)) { GameStateRunActivity.Save(); }
+            if (UserInput.IsPressed(UserCommand.GameSave))
+            {
+                GameStateRunActivity.Save();
+                AutoSaveDueAt = RealTime + 60 * Simulator.Settings.AutoSaveInterval;
+            }
             if (UserInput.IsPressed(UserCommand.DisplayHelpWindow)) if (UserInput.IsDown(UserCommand.DisplayNextWindowTab)) HelpWindow.TabAction(); else HelpWindow.Visible = !HelpWindow.Visible;
             if (UserInput.IsPressed(UserCommand.DisplayTrackMonitorWindow)) if (UserInput.IsDown(UserCommand.DisplayNextWindowTab)) TrackMonitorWindow.TabAction(); else TrackMonitorWindow.Visible = !TrackMonitorWindow.Visible;
             if (UserInput.IsPressed(UserCommand.DisplayTrainDrivingWindow)) if (UserInput.IsDown(UserCommand.DisplayNextWindowTab)) TrainDrivingWindow.TabAction(); else TrainDrivingWindow.Visible = !TrainDrivingWindow.Visible;