Skip to content

Commit f67822a

Browse files
sweiland-openrailssweiland-openrails
committed
suppress on screen messages, bug 2008012
1 parent be04a6a commit f67822a

File tree

7 files changed

+126
-37
lines changed

7 files changed

+126
-37
lines changed

‎Source/Documentation/Manual/options.rst‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -617,14 +617,19 @@ bottom of the screen.
617617
This is helpful for operations that don't have visible feedback and also
618618
allows you to control the train without being in the cab.
619619

620-
The default setting is checked.
621-
Uncheck this option if you prefer to monitor your cab instruments and
622-
don't want to see these messages.
620+
Informational, Warning and Error messages are displayed here also.
621+
622+
The default setting of this option is to show all messages. Dropdown list gives the following choices:
623+
624+
- None: no messages suppressed (default)
625+
- Information: informational messages and control confirmations suppressed
626+
- Warning: warning messages and the ones mentioned above suppressed
627+
- Error: error messages and the ones mentioned above suppressed
623628

624629
OR uses the same message scheme for system messages such as "Game saved"
625630
or "Replay ended" but you cannot suppress these system messages.
626631

627-
Once the game has started, you can toggle the confirmations on and off
632+
Once the game has started, you can cycle through the above settings
628633
by pressing ``Ctrl+Alt+F10``.
629634

630635

‎Source/Menu/Options.Designer.cs‎

Lines changed: 30 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Source/Menu/Options.cs‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,20 @@ orderby folder.Key
303303
checkWindowed.Checked = !Settings.FullScreen;
304304
comboWindowSize.Text = Settings.WindowSize;
305305
checkWindowGlass.Checked = Settings.WindowGlass;
306-
checkControlConfirmations.Checked = !Settings.SuppressConfirmations;
306+
307+
// keep values in line with enum Orts.Simulation.ConfirmLevel
308+
// see also function Message(CabControl control, ConfirmLevel level, string message)
309+
// in Source\Orts.Simulation\Simulation\Confirmer.cs
310+
comboControlConfirmations.DataSource = new[] {
311+
new ComboBoxMember { Code = "None", Name = catalog.GetString("None") },
312+
new ComboBoxMember { Code = "Information", Name = catalog.GetString("Information") },
313+
new ComboBoxMember { Code = "Warning", Name = catalog.GetString("Warning") },
314+
new ComboBoxMember { Code = "Error", Name = catalog.GetString("Error") },
315+
}.ToList();
316+
comboControlConfirmations.DisplayMember = "Name";
317+
comboControlConfirmations.ValueMember = "Code";
318+
comboControlConfirmations.SelectedIndex = Settings.SuppressConfirmations;
319+
307320
numericWebServerPort.Value = Settings.WebServerPort;
308321
checkPerformanceTuner.Checked = Settings.PerformanceTuner;
309322
labelPerformanceTunerTarget.Enabled = checkPerformanceTuner.Checked;
@@ -493,7 +506,7 @@ void buttonOK_Click(object sender, EventArgs e)
493506
Settings.FullScreen = !checkWindowed.Checked;
494507
Settings.WindowSize = GetValidWindowSize(comboWindowSize.Text);
495508
Settings.WindowGlass = checkWindowGlass.Checked;
496-
Settings.SuppressConfirmations = !checkControlConfirmations.Checked;
509+
Settings.SuppressConfirmations = comboControlConfirmations.SelectedIndex;
497510
Settings.WebServerPort = (int)numericWebServerPort.Value;
498511
Settings.PerformanceTuner = checkPerformanceTuner.Checked;
499512
Settings.PerformanceTunerTarget = (int)numericPerformanceTunerTarget.Value;
@@ -876,7 +889,7 @@ private void InitializeHelpIcons()
876889
(pbUpdateMode, new Control[] { labelUpdateMode }),
877890
(pbWindowed, new Control[] { checkWindowed, labelWindowSize, comboWindowSize }),
878891
(pbWindowGlass, new[] { checkWindowGlass }),
879-
(pbControlConfirmations, new[] { checkControlConfirmations }),
892+
(pbControlConfirmations, new Control[] { labelControlConfirmations, comboControlConfirmations }),
880893
(pbWebServerPort, new Control[] { labelWebServerPort }),
881894
(pbPerformanceTuner, new Control[] { checkPerformanceTuner, labelPerformanceTunerTarget }),
882895
};

‎Source/ORTS.Settings/UserSettings.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,8 +277,8 @@ public enum DirectXFeature
277277
public string WindowSize { get; set; }
278278
[Default(false)]
279279
public bool WindowGlass { get; set; }
280-
[Default(false)]
281-
public bool SuppressConfirmations { get; set; }
280+
[Default(0)]
281+
public int SuppressConfirmations { get; set; }
282282
[Default(2150)]
283283
public int WebServerPort { get; set; }
284284
[Default(false)]

‎Source/Orts.Simulation/Simulation/Confirmer.cs‎

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -374,21 +374,55 @@ public void Message(ConfirmLevel level, string message)
374374

375375
void Message(CabControl control, ConfirmLevel level, string message)
376376
{
377-
// User can suppress levels None and Information but not Warning, Error and MSGs.
378-
// Cab control confirmations have level None.
379-
if (level < ConfirmLevel.Information && Simulator.Settings.SuppressConfirmations)
380-
return;
377+
// Suppress control messages
378+
//
379+
// Cab control confirmations have level None. They are suppressed
380+
// both with Information messages when suppress level is Information
381+
// Control messages with level MSG are never suppressed
382+
switch (Simulator.Settings.SuppressConfirmations)
383+
{
384+
case (int)ConfirmLevel.None:
385+
break;
386+
case (int)ConfirmLevel.Information:
387+
if (level <= ConfirmLevel.Information)
388+
return;
389+
break;
390+
case (int)ConfirmLevel.Warning:
391+
if (level <= ConfirmLevel.Warning)
392+
return;
393+
break;
394+
case (int)ConfirmLevel.Error:
395+
if (level <= ConfirmLevel.Error)
396+
return;
397+
break;
398+
default:
399+
break;
400+
}
381401

382402
var format = "{2}";
403+
383404
// Skip control name if not a control
384405
if (control != CabControl.None)
385406
format = "{0}: " + format;
407+
386408
if (level >= ConfirmLevel.Information)
387409
format = "{1} - " + format;
410+
411+
// message displays longer if more severe
388412
var duration = DefaultDurationS;
389413
if (level >= ConfirmLevel.Warning) duration *= 2;
390414
if (level >= ConfirmLevel.MSG) duration *= 5;
391-
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));
415+
416+
if (DisplayMessage != null)
417+
DisplayMessage(
418+
this,
419+
new DisplayMessageEventArgs(
420+
key: String.Format("{0}/{1}", control, level),
421+
text: String.Format(
422+
format,
423+
ConfirmText[(int)control][0],
424+
Simulator.Catalog.GetString(GetStringAttribute.GetPrettyName(level)), message),
425+
duration));
392426
}
393427
}
394428
}

‎Source/RunActivity/Viewer3D/Popups/NoticeWindow.cs‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
using Microsoft.Xna.Framework;
2121
using Microsoft.Xna.Framework.Graphics;
22+
using Orts.Simulation;
2223
using Orts.Simulation.RollingStocks;
2324
using ORTS.Common;
2425

@@ -107,7 +108,10 @@ public override void PrepareFrame(ElapsedTime elapsedTime, bool updateFull)
107108
else if (FieldOfView != Owner.Viewer.Camera.FieldOfView)
108109
{
109110
FieldOfView = Owner.Viewer.Camera.FieldOfView;
110-
SetNotice(Viewer.Catalog.GetStringFmt("FOV: {0:F0}°", FieldOfView));
111+
if (playerLocomotive.Simulator.Settings.SuppressConfirmations == (int)ConfirmLevel.None)
112+
{
113+
SetNotice(Viewer.Catalog.GetStringFmt("FOV: {0:F0}°", FieldOfView));
114+
}
111115
}
112116
}
113117
}

‎Source/RunActivity/Viewer3D/Viewer.cs‎

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,12 +1054,31 @@ void HandleUserInput(ElapsedTime elapsedTime)
10541054

10551055
if (UserInput.IsPressed(UserCommand.DebugToggleConfirmations))
10561056
{
1057-
Simulator.Settings.SuppressConfirmations = !Simulator.Settings.SuppressConfirmations;
1058-
if (Simulator.Settings.SuppressConfirmations)
1059-
Simulator.Confirmer.Message(ConfirmLevel.Warning, Catalog.GetString("Confirmations suppressed"));
1060-
else
1061-
Simulator.Confirmer.Message(ConfirmLevel.Warning, Catalog.GetString("Confirmations visible"));
1062-
Settings.SuppressConfirmations = Simulator.Settings.SuppressConfirmations;
1057+
int suppressConfirmationsEntry = Simulator.Settings.SuppressConfirmations;
1058+
1059+
// cycle between ConfirmLevel.None and Error
1060+
suppressConfirmationsEntry++;
1061+
if (suppressConfirmationsEntry >= (int)ConfirmLevel.MSG)
1062+
{
1063+
suppressConfirmationsEntry = (int)ConfirmLevel.None;
1064+
}
1065+
1066+
Simulator.Settings.SuppressConfirmations = (int)ConfirmLevel.None;
1067+
if (suppressConfirmationsEntry > (int)ConfirmLevel.None)
1068+
{
1069+
Simulator.Confirmer.Message(
1070+
ConfirmLevel.Warning,
1071+
Catalog.GetString(((ConfirmLevel)suppressConfirmationsEntry).ToString()) +
1072+
" " +
1073+
Catalog.GetString("messages suppressed"));
1074+
}
1075+
else
1076+
{
1077+
Simulator.Confirmer.Message(ConfirmLevel.Warning, Catalog.GetString("All messages visible"));
1078+
}
1079+
1080+
Simulator.Settings.SuppressConfirmations = suppressConfirmationsEntry;
1081+
Settings.SuppressConfirmations = suppressConfirmationsEntry;
10631082
Settings.Save();
10641083
}
10651084

0 commit comments

Comments
 (0)