suppress on screen messages, bug 2008012

Author: sweiland-openrails

Source/Documentation/Manual/options.rst

@@ -617,14 +617,19 @@ bottom of the screen.
 This is helpful for operations that don't have visible feedback and also
 allows you to control the train without being in the cab.
 
-The default setting is checked. 
-Uncheck this option if you prefer to monitor your cab instruments and
-don't want to see these messages.
+Informational, Warning and Error messages are displayed here also. 
+
+The default setting of this option is to show all messages. Dropdown list gives the following choices:
+
+- None: no messages suppressed (default)
+- Information: informational messages and control confirmations suppressed
+- Warning: warning messages and the ones mentioned above suppressed
+- Error: error messages and the ones mentioned above suppressed
 
 OR uses the same message scheme for system messages such as "Game saved"
 or "Replay ended" but you cannot suppress these system messages.
 
-Once the game has started, you can toggle the confirmations on and off 
+Once the game has started, you can cycle through the above settings  
 by pressing ``Ctrl+Alt+F10``. 
 
 

Source/Menu/Options.Designer.cs

@@ -303,7 +303,20 @@ orderby folder.Key
             checkWindowed.Checked = !Settings.FullScreen;
             comboWindowSize.Text = Settings.WindowSize;
             checkWindowGlass.Checked = Settings.WindowGlass;
-            checkControlConfirmations.Checked = !Settings.SuppressConfirmations;
+
+            // keep values in line with enum Orts.Simulation.ConfirmLevel
+            // see also function Message(CabControl control, ConfirmLevel level, string message)
+            // in Source\Orts.Simulation\Simulation\Confirmer.cs
+            comboControlConfirmations.DataSource = new[] {
+                new ComboBoxMember { Code = "None", Name = catalog.GetString("None") },
+                new ComboBoxMember { Code = "Information", Name = catalog.GetString("Information") },
+                new ComboBoxMember { Code = "Warning", Name = catalog.GetString("Warning") },
+                new ComboBoxMember { Code = "Error", Name = catalog.GetString("Error") },
+            }.ToList();
+            comboControlConfirmations.DisplayMember = "Name";
+            comboControlConfirmations.ValueMember = "Code";
+            comboControlConfirmations.SelectedIndex = Settings.SuppressConfirmations;
+
             numericWebServerPort.Value = Settings.WebServerPort;
             checkPerformanceTuner.Checked = Settings.PerformanceTuner;
             labelPerformanceTunerTarget.Enabled = checkPerformanceTuner.Checked;
@@ -493,7 +506,7 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.FullScreen = !checkWindowed.Checked;
             Settings.WindowSize = GetValidWindowSize(comboWindowSize.Text);
             Settings.WindowGlass = checkWindowGlass.Checked;
-            Settings.SuppressConfirmations = !checkControlConfirmations.Checked;
+            Settings.SuppressConfirmations = comboControlConfirmations.SelectedIndex;
             Settings.WebServerPort = (int)numericWebServerPort.Value;
             Settings.PerformanceTuner = checkPerformanceTuner.Checked;
             Settings.PerformanceTunerTarget = (int)numericPerformanceTunerTarget.Value;
@@ -876,7 +889,7 @@ private void InitializeHelpIcons()
                 (pbUpdateMode, new Control[] { labelUpdateMode }),
                 (pbWindowed, new Control[] { checkWindowed, labelWindowSize, comboWindowSize }),
                 (pbWindowGlass, new[] { checkWindowGlass }),
-                (pbControlConfirmations, new[] { checkControlConfirmations }),
+                (pbControlConfirmations, new Control[] { labelControlConfirmations, comboControlConfirmations }),
                 (pbWebServerPort, new Control[] { labelWebServerPort }),
                 (pbPerformanceTuner, new Control[] { checkPerformanceTuner, labelPerformanceTunerTarget }),
             };

Source/Menu/Options.cs

@@ -277,8 +277,8 @@ public enum DirectXFeature
         public string WindowSize { get; set; }
         [Default(false)]
         public bool WindowGlass { get; set; }
-        [Default(false)]
-        public bool SuppressConfirmations { get; set; }
+        [Default(0)]
+        public int SuppressConfirmations { get; set; }
         [Default(2150)]
         public int WebServerPort { get; set; }
         [Default(false)]

Source/ORTS.Settings/UserSettings.cs

@@ -374,21 +374,55 @@ public void Message(ConfirmLevel level, string message)
 
         void Message(CabControl control, ConfirmLevel level, string message)
         {
-            // User can suppress levels None and Information but not Warning, Error and MSGs.
-            // Cab control confirmations have level None.
-            if (level < ConfirmLevel.Information && Simulator.Settings.SuppressConfirmations)
-                return;
+            // Suppress control messages
+            //
+            // Cab control confirmations have level None. They are suppressed 
+            //      both with Information messages when suppress level is Information
+            // Control messages with level MSG are never suppressed
+            switch (Simulator.Settings.SuppressConfirmations)
+            {
+                case (int)ConfirmLevel.None:
+                    break;
+                case (int)ConfirmLevel.Information:
+                    if (level <= ConfirmLevel.Information)
+                        return;
+                    break;
+                case (int)ConfirmLevel.Warning:
+                    if (level <= ConfirmLevel.Warning)
+                        return;
+                    break;
+                case (int)ConfirmLevel.Error:
+                    if (level <= ConfirmLevel.Error)
+                        return;
+                    break;
+                default:
+                    break;
+            }
 
             var format = "{2}";
+
             // Skip control name if not a control
             if (control != CabControl.None)
                 format = "{0}: " + format;
+
             if (level >= ConfirmLevel.Information)
                 format = "{1} - " + format;
+
+            // message displays longer if more severe
 			var duration = DefaultDurationS;
 			if (level >= ConfirmLevel.Warning) duration *= 2;
 			if (level >= ConfirmLevel.MSG) duration *= 5;
-            if (DisplayMessage != null) DisplayMessage(this, new DisplayMessageEventArgs(String.Format("{0}/{1}", control, level), String.Format(format, ConfirmText[(int)control][0], Simulator.Catalog.GetString(GetStringAttribute.GetPrettyName(level)), message), duration));
+
+            if (DisplayMessage != null)
+                DisplayMessage(
+                    this, 
+                    new DisplayMessageEventArgs(
+                        key: String.Format("{0}/{1}", control, level), 
+                        text: String.Format(
+                            format, 
+                            ConfirmText[(int)control][0], 
+                            Simulator.Catalog.GetString(GetStringAttribute.GetPrettyName(level)), message), 
+                        duration));
         }
     }
 }

Source/Orts.Simulation/Simulation/Confirmer.cs

@@ -19,6 +19,7 @@
 
 using Microsoft.Xna.Framework;
 using Microsoft.Xna.Framework.Graphics;
+using Orts.Simulation;
 using Orts.Simulation.RollingStocks;
 using ORTS.Common;
 
@@ -107,7 +108,10 @@ public override void PrepareFrame(ElapsedTime elapsedTime, bool updateFull)
                     else if (FieldOfView != Owner.Viewer.Camera.FieldOfView)
                     {
                         FieldOfView = Owner.Viewer.Camera.FieldOfView;
-                        SetNotice(Viewer.Catalog.GetStringFmt("FOV: {0:F0}°", FieldOfView));
+                        if (playerLocomotive.Simulator.Settings.SuppressConfirmations == (int)ConfirmLevel.None)
+                        {
+                            SetNotice(Viewer.Catalog.GetStringFmt("FOV: {0:F0}°", FieldOfView));
+                        }
                     }
                 }
             }

Source/RunActivity/Viewer3D/Popups/NoticeWindow.cs

@@ -1054,12 +1054,31 @@ void HandleUserInput(ElapsedTime elapsedTime)
 
             if (UserInput.IsPressed(UserCommand.DebugToggleConfirmations))
             {
-                Simulator.Settings.SuppressConfirmations = !Simulator.Settings.SuppressConfirmations;
-                if (Simulator.Settings.SuppressConfirmations)
-                    Simulator.Confirmer.Message(ConfirmLevel.Warning, Catalog.GetString("Confirmations suppressed"));
-                else
-                    Simulator.Confirmer.Message(ConfirmLevel.Warning, Catalog.GetString("Confirmations visible"));
-                Settings.SuppressConfirmations = Simulator.Settings.SuppressConfirmations;
+                int suppressConfirmationsEntry = Simulator.Settings.SuppressConfirmations;
+
+                // cycle between ConfirmLevel.None and Error
+                suppressConfirmationsEntry++;
+                if (suppressConfirmationsEntry >= (int)ConfirmLevel.MSG)
+                {
+                    suppressConfirmationsEntry = (int)ConfirmLevel.None;
+                }
+
+                Simulator.Settings.SuppressConfirmations = (int)ConfirmLevel.None;
+                if (suppressConfirmationsEntry > (int)ConfirmLevel.None)
+                {
+                    Simulator.Confirmer.Message(
+                        ConfirmLevel.Warning,
+                        Catalog.GetString(((ConfirmLevel)suppressConfirmationsEntry).ToString()) +
+                        " " +
+                        Catalog.GetString("messages suppressed"));
+                }
+                else 
+                {
+                    Simulator.Confirmer.Message(ConfirmLevel.Warning, Catalog.GetString("All messages visible"));
+                }
+
+                Simulator.Settings.SuppressConfirmations = suppressConfirmationsEntry;
+                Settings.SuppressConfirmations = suppressConfirmationsEntry;
                 Settings.Save();
             }