Small class to display warning and error prompts

TLM/TLM/UI/Helpers/Prompt.cs

@@ -0,0 +1,86 @@
+namespace TrafficManager.UI.Helpers {
+    using ColossalFramework;
+    using ColossalFramework.UI;
+    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) {
+            // if in-game, queue in main thread, otherwise display immediately
+            // note: I have no idea if this is good way to do it!
+            Action show = 
+            if (SceneManager.GetActiveScene().name == "Game") {
+                Singleton<SimulationManager>.instance.m_ThreadingWrapper.QueueMainThread(
+                    () => {
+                        UIView.library
+                            .ShowModal<ExceptionPanel>("ExceptionPanel")
+                            .SetMessage(title, message, isError);
+                    });
+            } else {
+                UIView.library
+                    .ShowModal<ExceptionPanel>("ExceptionPanel")
+                    .SetMessage(title, message, isError);
+            }
+        }
+    }
+}