Small class to display warning and error prompts

TLM/TLM/State/Keybinds/KeybindUI.cs

@@ -8,6 +8,7 @@ namespace TrafficManager.State.Keybinds {
     using System;
     using TrafficManager.UI;
     using UnityEngine;
+    using TrafficManager.UI.Helpers;
 
     /// <summary>
     /// Helper for creating keyboard bindings Settings page.
@@ -219,9 +220,7 @@ private void OnBindingKeyDown(UIComponent comp, UIKeyEventParameter evParam) {
                         var message = Translation.Options.Get("Keybinds.Dialog.Text:Keybind conflict")
                                       + "\n\n" + maybeConflict;
                         Log.Info($"Keybind conflict: {message}");
-                        UIView.library
-                          .ShowModal<ExceptionPanel>("ExceptionPanel")
-                          .SetMessage("Key Conflict", message, false);
+                        Prompt.Warning("Key Conflict", message);
                     } else {
                         editedBinding.Value.TargetKey.value = inputKey;
                         editedBinding.Value.Target.NotifyKeyChanged();
@@ -257,9 +256,7 @@ private void OnBindingMouseDown(UIComponent comp, UIMouseEventParameter evParam)
                     var message = Translation.Options.Get("Keybinds.Dialog.Text:Keybind conflict")
                                   + "\n\n" + maybeConflict;
                     Log.Info($"Keybind conflict: {message}");
-                    UIView.library
-                          .ShowModal<ExceptionPanel>("ExceptionPanel")
-                          .SetMessage("Key Conflict", message, false);
+                    Prompt.Warning("Key Conflict", message);
                 } else {
                     editedBinding.Value.TargetKey.value = inputKey;
                     editedBinding.Value.Target.NotifyKeyChanged();

TLM/TLM/State/Options.cs

@@ -164,11 +164,10 @@ internal static bool IsGameLoaded(bool warn = true) {
             }
 
             if (warn) {
-                UIView.library.ShowModal<ExceptionPanel>("ExceptionPanel").SetMessage(
+                Prompt.Warning(
                     "Nope!",
                     Translation.Options.Get("Dialog.Text:Settings are stored in savegame")
-                    + " https://www.viathinksoft.de/tmpe/#options",
-                    false);
+                    + " https://github.com/CitiesSkylinesMods/TMPE/wiki/Settings");
             }
 
             return false;

TLM/TLM/TLM.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
   <PropertyGroup>
@@ -150,6 +150,7 @@
     <Compile Include="Manager\Impl\ExtSegmentEndManager.cs" />
     <Compile Include="Manager\Impl\ExtSegmentManager.cs" />
     <Compile Include="UI\Helpers\NodeLaneMarker.cs" />
+    <Compile Include="UI\Helpers\Prompt.cs" />
     <Compile Include="UI\Helpers\SegmentLaneMarker.cs" />
     <Compile Include="UI\Helpers\ExtUITabStrip.cs" />
     <Compile Include="Manager\Impl\SegmentEndManager.cs" />
@@ -525,7 +526,7 @@
   </ItemGroup>
   <ItemGroup>
     <Folder Include="Traffic\Data\" />
-    <Folder Include="U\MainMenu" />
+    <Folder Include="U\MainMenu\" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="Resources\TrafficLights\pedestrian_mode_1.png" />

TLM/TLM/ThreadingExtension.cs

@@ -13,6 +13,7 @@ namespace TrafficManager {
     using TrafficManager.State;
     using TrafficManager.UI;
     using UnityEngine;
+    using TrafficManager.UI.Helpers;
 
     [UsedImplicitly]
     public sealed class ThreadingExtension : ThreadingExtensionBase {
@@ -98,16 +99,7 @@ public override void OnBeforeSimulationFrame() {
                     Log.Info(log);
 
                     if (GlobalConfig.Instance.Main.ShowCompatibilityCheckErrorMessage) {
-                        Singleton<SimulationManager>.instance.m_ThreadingWrapper.QueueMainThread(
-                            () => {
-                                UIView
-                                    .library
-                                    .ShowModal<ExceptionPanel>(
-                                        "ExceptionPanel").SetMessage(
-                                        "Incompatibility Issue",
-                                        error,
-                                        true);
-                            });
+                        Prompt.Error("TM:PE Incompatibility Issue", error);
                     }
                 }
             }

TLM/TLM/UI/Helpers/Prompt.cs

@@ -0,0 +1,89 @@
+namespace TrafficManager.UI.Helpers {
+    using ColossalFramework;
+    using ColossalFramework.UI;
+    using CSUtil.Commons;
+    using System;
+    using UnityEngine.SceneManagement;
+
+    /// <summary>
+    /// Use this class to display small but annoying dialog prompts to the user.
+    ///
+    /// TODO: At some point add more panels, such as:
+    /// * ConfirmPanel
+    /// * ExitConfirmPanel
+    /// * MessageBoxPanel
+    /// * TutorialPanel
+    /// * TutorialAdvisorPanel
+    /// </summary>
+    public class Prompt {
+
+        /// <summary>
+        /// Display a warning prompt in the centre of the screen.
+        /// </summary>
+        /// 
+        /// <param name="title">Dialog title.</param>
+        /// <param name="message">Dialog body text.</param>
+        public static void Warning(string title, string message) {
+            ExceptionPanel(title, message, false);
+        }
+
+        /// <summary>
+        /// Display a formatted warning prompt in the center of the screen.
+        /// </summary>
+        /// 
+        /// <param name="title">Dialog title.</param>
+        /// <param name="messageFormat">Dialog body text format.</param>
+        /// <param name="args">Values to put in the <paramref name="messageFormat"/>.</param>
+        public static void WarningFormat(string title, string messageFormat, params object[] args) {
+            ExceptionPanel(title, string.Format(messageFormat, args), false);
+        }
+
+        /// <summary>
+        /// Display an error prompt in the centre of the screen.
+        /// </summary>
+        /// <param name="title">Dialog title.</param>
+        /// <param name="message">Dialog body text.</param>
+        public static void Error(string title, string message) {
+            ExceptionPanel(title, message, true);
+        }
+
+        /// <summary>
+        /// Display an formatted error prompt in the center of the screen.
+        /// </summary>
+        /// 
+        /// <param name="title">Dialog title.</param>
+        /// <param name="messageFormat">Dialog body text format.</param>
+        /// <param name="args">Values to put in the <paramref name="messageFormat"/>.</param>
+        public static void ErrorFormat(string title, string messageFormat, params object[] args) {
+            ExceptionPanel(title, string.Format(messageFormat, args), true);
+        }
+
+        /// <summary>
+        /// Display an exception message in the center of the screen, optionally
+        /// styled as an error.
+        /// </summary>
+        /// 
+        /// <param name="title">Dialog title.</param>
+        /// <param name="message">Dialog body text.</param>
+        /// <param name="isError">If <c>true</c>, the dialog is styled as an error.</param>
+        internal static void ExceptionPanel(string title, string message, bool isError) {
+            Action prompt = () => {
+                UIView.library
+                    .ShowModal<ExceptionPanel>("ExceptionPanel")
+                    .SetMessage(title, message, isError);
+            };
+
+            try {
+                if (SceneManager.GetActiveScene().name == "Game") {
+                    Singleton<SimulationManager>.instance.m_ThreadingWrapper.QueueMainThread(prompt);
+                } else {
+                    prompt();
+                }
+            } catch (Exception e) {
+                Log.ErrorFormat(
+                    "Error displaying a Prompt:\n{0}",
+                    e.ToString());
+            }
+        }
+    }
+}

TLM/TLM/UI/SubTools/ManualTrafficLightsTool.cs

@@ -1,7 +1,6 @@
-namespace TrafficManager.UI.SubTools {
+namespace TrafficManager.UI.SubTools {
     using ColossalFramework;
     using JetBrains.Annotations;
-    using TrafficLight;
     using TrafficManager.API.Manager;
     using TrafficManager.API.Traffic.Data;
     using TrafficManager.API.Traffic.Enums;
@@ -62,8 +61,7 @@ ref Singleton<NetManager>.instance.m_nodes.m_buffer[
                 //        }
                 //    }
             } else {
-                MainTool.ShowError(
-                    Translation.TrafficLights.Get("Dialog.Text:Node has timed TL script"));
+                MainTool.WarningPrompt(Translation.TrafficLights.Get("Dialog.Text:Node has timed TL script"));
             }
         }
 

TLM/TLM/UI/SubTools/PrioritySignsTool.cs

@@ -591,7 +591,7 @@ private bool MayNodeHavePrioritySigns(ushort nodeId) {
                 // Log._Debug($"PrioritySignsTool.MayNodeHavePrioritySigns: Node {nodeId} does not
                 //     allow priority signs: {reason}");
                 if (reason == SetPrioritySignError.HasTimedLight) {
-                    MainTool.ShowError(
+                    MainTool.WarningPrompt(
                         Translation.TrafficLights.Get("Dialog.Text:Node has timed TL script"));
                 }
 

TLM/TLM/UI/SubTools/TimedTrafficLightsTool.cs

@@ -106,7 +106,8 @@ public override void OnPrimaryClickOverlay() {
             bool ctrlDown = Input.GetKey(KeyCode.LeftControl) || Input.GetKey(KeyCode.RightControl);
             if(ctrlDown) {
                 AutoTimedTrafficLights.ErrorResult res = AutoTimedTrafficLights.Setup(HoveredNodeId);
-                    string message = null;
+                string message = null;
+
                 switch (res) {
                     case AutoTimedTrafficLights.ErrorResult.NotSupported:
                         MainTool.Guide.Activate("TimedTrafficLightsTool_Auto TL no need");
@@ -126,7 +127,7 @@ public override void OnPrimaryClickOverlay() {
                         Translation.TrafficLights.Get("Dialog.Text:Auto TL create failed because") +
                         "\n" +
                         Translation.TrafficLights.Get(message);
-                    MainTool.ShowError(message);
+                    MainTool.WarningPrompt(message);
                     return;
                 }
                 RefreshCurrentTimedNodeIds(HoveredNodeId);
@@ -160,7 +161,7 @@ public override void OnPrimaryClickOverlay() {
                                 MainTool.SetToolMode(ToolMode.TimedLightsShowLights);
                             }
                         } else {
-                            MainTool.ShowError(T("Dialog.Text:Node has timed TL script"));
+                            MainTool.WarningPrompt(T("Dialog.Text:Node has timed TL script"));
                         }
                     }
 
@@ -242,14 +243,14 @@ public override void OnPrimaryClickOverlay() {
                                             .CountSegments();
 
                     if (numSourceSegments != numTargetSegments) {
-                        MainTool.ShowError(
+                        MainTool.WarningPrompt(
                             T("Dialog.Text:Incompatible traffic light script"));
                         return;
                     }
 
                     // check for existing simulation
                     if (tlsMan.HasTimedSimulation(HoveredNodeId)) {
-                        MainTool.ShowError(
+                        MainTool.WarningPrompt(
                             T("Dialog.Text:Node has timed TL script"));
                         return;
                     }

TLM/TLM/UI/SubTools/ToggleTrafficLightsTool.cs

@@ -61,13 +61,13 @@ public void ToggleTrafficLight(ushort nodeId,
                 if (showMessageOnError) {
                     switch (reason) {
                         case ToggleTrafficLightError.HasTimedLight: {
-                            MainTool.ShowError(
+                            MainTool.WarningPrompt(
                                 Translation.TrafficLights.Get("Dialog.Text:Node has timed TL script"));
                             break;
                         }
 
                         case ToggleTrafficLightError.IsLevelCrossing: {
-                            MainTool.ShowError(
+                            MainTool.WarningPrompt(
                                 Translation.TrafficLights.Get("Dialog.Text:Node is level crossing"));
                             break;
                         }

TLM/TLM/UI/TrafficManagerTool.cs

@@ -14,15 +14,15 @@ namespace TrafficManager.UI {
     using JetBrains.Annotations;
     using TrafficManager.Manager.Impl;
     using TrafficManager.State;
+#if DEBUG
     using TrafficManager.State.ConfigData;
+#endif
     using TrafficManager.UI.MainMenu;
     using TrafficManager.UI.SubTools;
     using TrafficManager.UI.SubTools.SpeedLimits;
     using TrafficManager.Util;
     using UnityEngine;
     using TrafficManager.UI.Helpers;
-    using GenericGameBridge.Service;
-    using CitiesGameBridge.Service;
 
     [UsedImplicitly]
     public class TrafficManagerTool
@@ -1871,16 +1871,17 @@ internal bool CheckClicked() {
             return false;
         }
 
-        /// <summary>Displays modal popup with an error</summary>
-        /// <param name="text">The localized message</param>
-        public void ShowError(string text) {
-            if (text == null) {
+        /// <summary>
+        /// Displays a warning prompt in center of the screen.
+        /// </summary>
+        /// 
+        /// <param name="message">The localized body text of the prompt.</param>
+        public void WarningPrompt(string message) {
+            if (string.IsNullOrEmpty(message)) {
                 return;
             }
 
-            UIView.library
-                  .ShowModal<ExceptionPanel>("ExceptionPanel")
-                  .SetMessage("Info", text, false);
+            Prompt.Warning("Warning", message);
         }
     }
 }