Context menu UI backend refactor & better UX (#13318)

closes space-wizards/space-station-14#9209

Author: mirrorcult

Content.Client/Administration/UI/CustomControls/PlayerListControl.xaml.cs

@@ -2,10 +2,12 @@
 using Content.Client.Administration.Systems;
 using Content.Client.UserInterface.Controls;
 using Content.Client.Verbs;
+using Content.Client.Verbs.UI;
 using Content.Shared.Administration;
 using Content.Shared.Input;
 using Robust.Client.AutoGenerated;
 using Robust.Client.Graphics;
+using Robust.Client.UserInterface;
 using Robust.Client.UserInterface.Controls;
 using Robust.Client.UserInterface.XAML;
 using Robust.Shared.Input;
@@ -56,7 +58,7 @@ private void PlayerListItemPressed(BaseButton.ButtonEventArgs args, ListData dat
             }
             else if (args.Event.Function == EngineKeyFunctions.UseSecondary && selectedPlayer.EntityUid != null)
             {
-                _verbSystem.VerbMenu.OpenVerbMenu(selectedPlayer.EntityUid.Value);
+                IoCManager.Resolve<IUserInterfaceManager>().GetUIController<VerbMenuUIController>().OpenVerbMenu(selectedPlayer.EntityUid.Value);
             }
         }
 

Content.Client/CombatMode/CombatModeComponent.cs

@@ -1,7 +1,9 @@
+using Content.Client.ContextMenu.UI;
 using Content.Client.Verbs;
 using Content.Shared.CombatMode;
 using Content.Shared.Targeting;
 using Robust.Client.Player;
+using Robust.Client.UserInterface;
 
 namespace Content.Client.CombatMode
 {
@@ -38,8 +40,7 @@ private void UpdateHud()
                 return;
             }
 
-            var verbs = IoCManager.Resolve<IEntitySystemManager>().GetEntitySystem<VerbSystem>();
-            verbs.CloseAllMenus();
+            IoCManager.Resolve<IUserInterfaceManager>().GetUIController<ContextMenuUIController>().Close();
         }
     }
 }

Content.Client/Commands/GroupingEntityMenuCommand.cs

@@ -12,7 +12,7 @@ public sealed class GroupingEntityMenuCommand : IConsoleCommand
 
         public string Description => "Sets the entity menu grouping type.";
 
-        public string Help => $"Usage: entitymenug <0:{EntityMenuPresenter.GroupingTypesCount}>";
+        public string Help => $"Usage: entitymenug <0:{EntityMenuUIController.GroupingTypesCount}>";
         public void Execute(IConsoleShell shell, string argStr, string[] args)
         {
             if (args.Length != 1)
@@ -27,7 +27,7 @@ public void Execute(IConsoleShell shell, string argStr, string[] args)
                 return;
             }
 
-            if (id < 0 ||id > EntityMenuPresenter.GroupingTypesCount - 1)
+            if (id < 0 ||id > EntityMenuUIController.GroupingTypesCount - 1)
             {
                 shell.WriteLine($"{args[0]} is not a valid integer.");
                 return;

Content.Client/ContextMenu/UI/ContextMenuPopup.xaml.cs

@@ -31,14 +31,14 @@ public sealed partial class ContextMenuPopup : Popup
         /// </summary>
         public GridContainer MenuBody = new();
 
-        private ContextMenuPresenter _presenter;
+        private ContextMenuUIController _uiController;
 
-        public ContextMenuPopup (ContextMenuPresenter presenter, ContextMenuElement? parentElement) : base()
+        public ContextMenuPopup (ContextMenuUIController uiController, ContextMenuElement? parentElement) : base()
         {
             RobustXamlLoader.Load(this);
             MenuPanel.SetOnlyStyleClass(StyleClassContextMenuPopup);
 
-            _presenter = presenter;
+            _uiController = uiController;
             ParentElement = parentElement;
 
             // TODO xaml controls now have the access options -> re-xamlify all this.
@@ -52,7 +52,7 @@ public ContextMenuPopup (ContextMenuPresenter presenter, ContextMenuElement? par
             MenuPanel.MaxHeight = MaxItemsBeforeScroll * (ContextMenuElement.ElementHeight + 2 * ContextMenuElement.ElementMargin) + styleSize.Y;
 
             UserInterfaceManager.ModalRoot.AddChild(this);
-            MenuBody.OnChildRemoved += ctrl => _presenter.OnRemoveElement(this, ctrl);
+            MenuBody.OnChildRemoved += ctrl => _uiController.OnRemoveElement(this, ctrl);
             MenuBody.VSeparationOverride = 0;
             MenuBody.HSeparationOverride = 0;
 
@@ -67,13 +67,13 @@ public ContextMenuPopup (ContextMenuPresenter presenter, ContextMenuElement? par
             OnPopupHide += () =>
             {
                 if (ParentElement != null)
-                    _presenter.CloseSubMenus(ParentElement.ParentMenu);
+                    _uiController.CloseSubMenus(ParentElement.ParentMenu);
             };
         }
 
         protected override void Dispose(bool disposing)
         {
-            MenuBody.OnChildRemoved -= ctrl => _presenter.OnRemoveElement(this, ctrl);
+            MenuBody.OnChildRemoved -= ctrl => _uiController.OnRemoveElement(this, ctrl);
             ParentElement = null;
             base.Dispose(disposing);
         }

Content.Client/ContextMenu/UI/ContextMenuPresenter.cs Content.Client/ContextMenu/UI/ContextMenuUIController.cs

@@ -1,24 +1,26 @@
-using System;
-using System.Collections.Generic;
 using System.Threading;
+using Content.Client.Gameplay;
 using Robust.Client.UserInterface;
-using Robust.Shared.Log;
-using Robust.Shared.Maths;
+using Robust.Client.UserInterface.Controllers;
 using Timer = Robust.Shared.Timing.Timer;
 namespace Content.Client.ContextMenu.UI
 {
     /// <summary>
-    ///     This class handles all the logic associated with showing a context menu.
+    ///     This class handles all the logic associated with showing a context menu, as well as all the state for the
+    ///     entire context menu stack, including verb and entity menus. It does not currently support multiple
+    ///     open context menus.
     /// </summary>
     /// <remarks>
     ///     This largely involves setting up timers to open and close sub-menus when hovering over other menu elements.
     /// </remarks>
-    [Virtual]
-    public class ContextMenuPresenter : IDisposable
+    public sealed class ContextMenuUIController : UIController, IOnStateEntered<GameplayState>, IOnStateExited<GameplayState>
     {
         public static readonly TimeSpan HoverDelay = TimeSpan.FromSeconds(0.2);
 
-        public ContextMenuPopup RootMenu;
+        /// <summary>
+        ///     Root menu of the entire context menu.
+        /// </summary>
+        public ContextMenuPopup RootMenu = default!;
         public Stack<ContextMenuPopup> Menus { get; } = new();
 
         /// <summary>
@@ -31,30 +33,35 @@ public class ContextMenuPresenter : IDisposable
         /// </summary>
         public CancellationTokenSource? CancelClose;
 
-        public ContextMenuPresenter()
+        public Action? OnContextClosed;
+        public Action<ContextMenuElement>? OnContextMouseEntered;
+        public Action<ContextMenuElement>? OnContextMouseExited;
+        public Action<ContextMenuElement>? OnSubMenuOpened;
+        public Action<ContextMenuElement, GUIBoundKeyEventArgs>? OnContextKeyEvent;
+
+        public void OnStateEntered(GameplayState state)
         {
             RootMenu = new(this, null);
-            RootMenu.OnPopupHide += RootMenu.MenuBody.DisposeAllChildren;
+            RootMenu.OnPopupHide += Close;
             Menus.Push(RootMenu);
         }
 
-        /// <summary>
-        ///     Dispose of all UI elements.
-        /// </summary>
-        public virtual void Dispose()
+        public void OnStateExited(GameplayState state)
         {
-            RootMenu.OnPopupHide -= RootMenu.MenuBody.DisposeAllChildren;
+            Close();
+            RootMenu.OnPopupHide -= Close;
             RootMenu.Dispose();
         }
 
         /// <summary>
         ///     Close and clear the root menu. This will also dispose any sub-menus.
         /// </summary>
-        public virtual void Close()
+        public void Close()
         {
-            RootMenu.Close();
+            RootMenu.MenuBody.DisposeAllChildren();
             CancelOpen?.Cancel();
             CancelClose?.Cancel();
+            OnContextClosed?.Invoke();
         }
 
         /// <summary>
@@ -82,7 +89,7 @@ public void CloseSubMenus(ContextMenuPopup? menu)
         /// <summary>
         ///     Start a timer to open this element's sub-menu.
         /// </summary>
-        public virtual void OnMouseEntered(ContextMenuElement element)
+        private void OnMouseEntered(ContextMenuElement element)
         {
             if (!Menus.TryPeek(out var topMenu))
             {
@@ -100,6 +107,7 @@ public virtual void OnMouseEntered(ContextMenuElement element)
             CancelOpen?.Cancel();
             CancelOpen = new();
             Timer.Spawn(HoverDelay, () => OpenSubMenu(element), CancelOpen.Token);
+            OnContextMouseEntered?.Invoke(element);
         }
 
         /// <summary>
@@ -108,7 +116,7 @@ public virtual void OnMouseEntered(ContextMenuElement element)
         /// <remarks>
         ///     Note that this timer will be aborted when entering the actual sub-menu itself.
         /// </remarks>
-        public virtual void OnMouseExited(ContextMenuElement element)
+        private void OnMouseExited(ContextMenuElement element)
         {
             CancelOpen?.Cancel();
 
@@ -118,17 +126,21 @@ public virtual void OnMouseExited(ContextMenuElement element)
             CancelClose?.Cancel();
             CancelClose = new();
             Timer.Spawn(HoverDelay, () => CloseSubMenus(element.ParentMenu), CancelClose.Token);
+            OnContextMouseExited?.Invoke(element);
         }
 
-        public virtual void OnKeyBindDown(ContextMenuElement element, GUIBoundKeyEventArgs args) { }
+        private void OnKeyBindDown(ContextMenuElement element, GUIBoundKeyEventArgs args)
+        {
+            OnContextKeyEvent?.Invoke(element, args);
+        }
 
         /// <summary>
         ///     Opens a new sub menu, and close the old one.
         /// </summary>
         /// <remarks>
         ///     If the given element has no sub-menu, just close the current one.
         /// </remarks>
-        public virtual void OpenSubMenu(ContextMenuElement element)
+        public void OpenSubMenu(ContextMenuElement element)
         {
             if (!Menus.TryPeek(out var topMenu))
             {
@@ -164,6 +176,7 @@ public virtual void OpenSubMenu(ContextMenuElement element)
             element.SubMenu.SetPositionLast();
 
             Menus.Push(element.SubMenu);
+            OnSubMenuOpened?.Invoke(element);
         }
 
         /// <summary>

Content.Client/ContextMenu/UI/EntityMenuElement.cs

@@ -45,12 +45,12 @@ public EntityMenuElement(EntityUid? entity = null)
             LayoutContainer.SetGrowVertical(CountLabel, LayoutContainer.GrowDirection.Begin);
 
             Entity = entity;
-            if (Entity != null)
-            {
-                Count = 1;
-                CountLabel.Visible = false;
-                UpdateEntity();
-            }
+            if (Entity == null)
+                return;
+
+            Count = 1;
+            CountLabel.Visible = false;
+            UpdateEntity();
         }
 
         protected override void Dispose(bool disposing)

Content.Client/ContextMenu/UI/EntityMenuPresenterGrouping.cs

@@ -1,16 +1,17 @@
 using Content.Shared.IdentityManagement;
 using Robust.Client.GameObjects;
 using System.Linq;
+using Robust.Client.UserInterface.Controllers;
 
 namespace Content.Client.ContextMenu.UI
 {
-    public sealed partial class EntityMenuPresenter : ContextMenuPresenter
+    public sealed partial class EntityMenuUIController
     {
         public const int GroupingTypesCount = 2;
         private int GroupingContextMenuType { get; set; }
         public void OnGroupingChanged(int obj)
         {
-            Close();
+            _context.Close();
             GroupingContextMenuType = obj;
         }