From e17ffbd76fe03a217d72c26bd1fcbe820ba4cec9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?V=C3=ADctor=20Aguilera=20Puerto?=
 <6766154+Zumorica@users.noreply.github.com>
Date: Fri, 6 Mar 2020 20:11:24 +0100
Subject: [PATCH] Adds verb categories (#766)

* Adds verb categories

* Update Content.Shared/GameObjects/Verbs/Verb.cs

Co-Authored-By: Pieter-Jan Briers <pieterjan.briers@gmail.com>

* Make GetCategory virtual

Co-authored-by: Pieter-Jan Briers <pieterjan.briers@gmail.com>
---
 .../GameObjects/EntitySystems/VerbSystem.cs   | 60 ++++++++++++++++---
 .../GlobalVerbs/ViewVariablesVerb.cs          |  2 +
 .../Components/Chemistry/SolutionComponent.cs |  2 +-
 .../Components/RotatableComponent.cs          |  4 ++
 .../GameObjects/EntitySystems/VerbSystem.cs   |  4 +-
 Content.Server/GlobalVerbs/ControlMobVerb.cs  |  2 +
 Content.Server/GlobalVerbs/RejuvenateVerb.cs  |  2 +
 .../VerbSystemMessages.cs                     |  4 +-
 .../GameObjects/Verbs/GlobalVerb.cs           |  7 +++
 Content.Shared/GameObjects/Verbs/Verb.cs      | 22 +++++++
 10 files changed, 97 insertions(+), 12 deletions(-)

diff --git a/Content.Client/GameObjects/EntitySystems/VerbSystem.cs b/Content.Client/GameObjects/EntitySystems/VerbSystem.cs
index 832ea53501..c88bf50150 100644
--- a/Content.Client/GameObjects/EntitySystems/VerbSystem.cs
+++ b/Content.Client/GameObjects/EntitySystems/VerbSystem.cs
@@ -121,7 +121,7 @@ namespace Content.Client.GameObjects.EntitySystems
 
             DebugTools.AssertNotNull(_currentPopup);
 
-            var buttons = new List<Button>();
+            var buttons = new Dictionary<string, List<Button>>();
 
             var vBox = _currentPopup.List;
             vBox.DisposeAllChildren();
@@ -137,7 +137,10 @@ namespace Content.Client.GameObjects.EntitySystems
                     };
                 }
 
-                buttons.Add(button);
+                if(!buttons.ContainsKey(data.Category))
+                    buttons[data.Category] = new List<Button>();
+
+                buttons[data.Category].Add(button);
             }
 
             var user = GetUserEntity();
@@ -148,7 +151,13 @@ namespace Content.Client.GameObjects.EntitySystems
                     continue;
 
                 var disabled = verb.GetVisibility(user, component) != VerbVisibility.Visible;
-                buttons.Add(CreateVerbButton(verb.GetText(user, component), disabled, verb.ToString(),
+                var category = verb.GetCategory(user, component);
+
+
+                if(!buttons.ContainsKey(category))
+                    buttons[category] = new List<Button>();
+
+                buttons[category].Add(CreateVerbButton(verb.GetText(user, component), disabled, verb.ToString(),
                     entity.ToString(), () => verb.Activate(user, component)));
             }
             //Get global verbs. Visible for all entities regardless of their components.
@@ -158,17 +167,33 @@ namespace Content.Client.GameObjects.EntitySystems
                     continue;
 
                 var disabled = globalVerb.GetVisibility(user, entity) != VerbVisibility.Visible;
-                buttons.Add(CreateVerbButton(globalVerb.GetText(user, entity), disabled, globalVerb.ToString(),
+                var category = globalVerb.GetCategory(user, entity);
+
+                if(!buttons.ContainsKey(category))
+                    buttons[category] = new List<Button>();
+
+                buttons[category].Add(CreateVerbButton(globalVerb.GetText(user, entity), disabled, globalVerb.ToString(),
                     entity.ToString(), () => globalVerb.Activate(user, entity)));
             }
 
             if (buttons.Count > 0)
             {
-                buttons.Sort((a, b) => string.Compare(a.Text, b.Text, StringComparison.Ordinal));
-
-                foreach (var button in buttons)
+                foreach (var (category, verbs) in buttons)
                 {
-                    vBox.AddChild(button);
+                    if (string.IsNullOrEmpty(category))
+                        continue;
+
+                    vBox.AddChild(CreateCategoryButton(category, verbs));
+                }
+
+                if (buttons.ContainsKey(""))
+                {
+                    buttons[""].Sort((a, b) => string.Compare(a.Text, b.Text, StringComparison.Ordinal));
+
+                    foreach (var verb in buttons[""])
+                    {
+                        vBox.AddChild(verb);
+                    }
                 }
             }
             else
@@ -204,6 +229,25 @@ namespace Content.Client.GameObjects.EntitySystems
             return button;
         }
 
+        private Button CreateCategoryButton(string text, List<Button> verbButtons)
+        {
+            verbButtons.Sort((a, b) => string.Compare(a.Text, b.Text, StringComparison.Ordinal));
+
+            var button = new Button
+            {
+                Text = $"{text}...",
+            };
+            button.OnPressed += _ =>
+                {
+                    _currentPopup.List.DisposeAllChildren();
+                    foreach (var verb in verbButtons)
+                    {
+                        _currentPopup.List.AddChild(verb);
+                    }
+                };
+            return button;
+        }
+
         private void CloseContextMenu()
         {
             _currentPopup?.Dispose();
diff --git a/Content.Client/GlobalVerbs/ViewVariablesVerb.cs b/Content.Client/GlobalVerbs/ViewVariablesVerb.cs
index 482f615dc9..b1d25b96ab 100644
--- a/Content.Client/GlobalVerbs/ViewVariablesVerb.cs
+++ b/Content.Client/GlobalVerbs/ViewVariablesVerb.cs
@@ -13,6 +13,8 @@ namespace Content.Client.GlobalVerbs
     class ViewVariablesVerb : GlobalVerb
     {
         public override string GetText(IEntity user, IEntity target) => "View variables";
+        public override string GetCategory(IEntity user, IEntity target) => "Debug";
+
         public override bool RequireInteractionRange => false;
 
         public override VerbVisibility GetVisibility(IEntity user, IEntity target)
diff --git a/Content.Server/GameObjects/Components/Chemistry/SolutionComponent.cs b/Content.Server/GameObjects/Components/Chemistry/SolutionComponent.cs
index 3e123fca11..98b064bfc2 100644
--- a/Content.Server/GameObjects/Components/Chemistry/SolutionComponent.cs
+++ b/Content.Server/GameObjects/Components/Chemistry/SolutionComponent.cs
@@ -208,7 +208,7 @@ namespace Content.Server.GameObjects.Components.Chemistry
                     if (SolutionValidReaction(reaction, out int unitReactions))
                     {
                         PerformReaction(reaction, unitReactions);
-                        checkForNewReaction = true; 
+                        checkForNewReaction = true;
                         break;
                     }
                 }
diff --git a/Content.Server/GameObjects/Components/RotatableComponent.cs b/Content.Server/GameObjects/Components/RotatableComponent.cs
index 5150f9ad8a..5707056e0e 100644
--- a/Content.Server/GameObjects/Components/RotatableComponent.cs
+++ b/Content.Server/GameObjects/Components/RotatableComponent.cs
@@ -40,6 +40,8 @@ namespace Content.Server.GameObjects.Components
                 return "Rotate clockwise";
             }
 
+            protected override string GetCategory(IEntity user, RotatableComponent component) => "Rotate";
+
             protected override VerbVisibility GetVisibility(IEntity user, RotatableComponent component)
             {
                 return VerbVisibility.Visible;
@@ -59,6 +61,8 @@ namespace Content.Server.GameObjects.Components
                 return "Rotate counter-clockwise";
             }
 
+            protected override string GetCategory(IEntity user, RotatableComponent component) => "Rotate";
+
             protected override VerbVisibility GetVisibility(IEntity user, RotatableComponent component)
             {
                 return VerbVisibility.Visible;
diff --git a/Content.Server/GameObjects/EntitySystems/VerbSystem.cs b/Content.Server/GameObjects/EntitySystems/VerbSystem.cs
index d9c44a1cd6..95be3be1aa 100644
--- a/Content.Server/GameObjects/EntitySystems/VerbSystem.cs
+++ b/Content.Server/GameObjects/EntitySystems/VerbSystem.cs
@@ -108,7 +108,7 @@ namespace Content.Server.GameObjects.EntitySystems
 
                 // TODO: These keys being giant strings is inefficient as hell.
                 data.Add(new VerbsResponseMessage.VerbData(verb.GetText(userEntity, component),
-                    $"{component.GetType()}:{verb.GetType()}",
+                    $"{component.GetType()}:{verb.GetType()}", verb.GetCategory(userEntity, component),
                     vis == VerbVisibility.Visible));
             }
 
@@ -121,7 +121,7 @@ namespace Content.Server.GameObjects.EntitySystems
                     continue;
 
                 data.Add(new VerbsResponseMessage.VerbData(globalVerb.GetText(userEntity, entity),
-                    globalVerb.GetType().ToString(), vis == VerbVisibility.Visible));
+                    globalVerb.GetType().ToString(), globalVerb.GetCategory(userEntity, entity), vis == VerbVisibility.Visible));
             }
 
             var response = new VerbsResponseMessage(data, req.EntityUid);
diff --git a/Content.Server/GlobalVerbs/ControlMobVerb.cs b/Content.Server/GlobalVerbs/ControlMobVerb.cs
index d67391c202..52150d57be 100644
--- a/Content.Server/GlobalVerbs/ControlMobVerb.cs
+++ b/Content.Server/GlobalVerbs/ControlMobVerb.cs
@@ -16,6 +16,8 @@ namespace Content.Server.GlobalVerbs
     public class ControlMobVerb : GlobalVerb
     {
         public override string GetText(IEntity user, IEntity target) => "Control Mob";
+        public override string GetCategory(IEntity user, IEntity target) => "Debug";
+
         public override bool RequireInteractionRange => false;
 
         public override VerbVisibility GetVisibility(IEntity user, IEntity target)
diff --git a/Content.Server/GlobalVerbs/RejuvenateVerb.cs b/Content.Server/GlobalVerbs/RejuvenateVerb.cs
index d5511bf0a7..e2082077c0 100644
--- a/Content.Server/GlobalVerbs/RejuvenateVerb.cs
+++ b/Content.Server/GlobalVerbs/RejuvenateVerb.cs
@@ -15,6 +15,8 @@ namespace Content.Server.GlobalVerbs
     class RejuvenateVerb : GlobalVerb
     {
         public override string GetText(IEntity user, IEntity target) => "Rejuvenate";
+        public override string GetCategory(IEntity user, IEntity target) => "Debug";
+
         public override bool RequireInteractionRange => false;
 
         public override VerbVisibility GetVisibility(IEntity user, IEntity target)
diff --git a/Content.Shared/GameObjects/EntitySystemMessages/VerbSystemMessages.cs b/Content.Shared/GameObjects/EntitySystemMessages/VerbSystemMessages.cs
index 3ba08ebe2b..6a976aa977 100644
--- a/Content.Shared/GameObjects/EntitySystemMessages/VerbSystemMessages.cs
+++ b/Content.Shared/GameObjects/EntitySystemMessages/VerbSystemMessages.cs
@@ -35,12 +35,14 @@ namespace Content.Shared.GameObjects.EntitySystemMessages
             {
                 public readonly string Text;
                 public readonly string Key;
+                public readonly string Category;
                 public readonly bool Available;
 
-                public VerbData(string text, string key, bool available)
+                public VerbData(string text, string key, string category, bool available)
                 {
                     Text = text;
                     Key = key;
+                    Category = category;
                     Available = available;
                 }
             }
diff --git a/Content.Shared/GameObjects/Verbs/GlobalVerb.cs b/Content.Shared/GameObjects/Verbs/GlobalVerb.cs
index dcf8d182b8..c4c5e3a3ab 100644
--- a/Content.Shared/GameObjects/Verbs/GlobalVerb.cs
+++ b/Content.Shared/GameObjects/Verbs/GlobalVerb.cs
@@ -27,6 +27,13 @@ namespace Content.Shared.GameObjects
         /// <returns>The text string that is shown in the right click menu for this verb.</returns>
         public abstract string GetText(IEntity user, IEntity target);
 
+        /// <summary>
+        ///     Gets the category of this verb.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <returns>The category of this verb.</returns>
+        public virtual string GetCategory(IEntity user, IEntity target) => "";
+
         /// <summary>
         ///     Gets the visibility level of this verb in the right click menu.
         /// </summary>
diff --git a/Content.Shared/GameObjects/Verbs/Verb.cs b/Content.Shared/GameObjects/Verbs/Verb.cs
index b5e213541c..819bc0fb41 100644
--- a/Content.Shared/GameObjects/Verbs/Verb.cs
+++ b/Content.Shared/GameObjects/Verbs/Verb.cs
@@ -31,6 +31,14 @@ namespace Content.Shared.GameObjects
         /// <returns>The text string that is shown in the right click menu for this verb.</returns>
         public abstract string GetText(IEntity user, IComponent component);
 
+        /// <summary>
+        ///     Gets the category of this verb.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        /// <returns>The category of this verb.</returns>
+        public virtual string GetCategory(IEntity user, IComponent component)  => "";
+
         /// <summary>
         ///     Gets the visibility level of this verb in the right click menu.
         /// </summary>
@@ -63,6 +71,14 @@ namespace Content.Shared.GameObjects
         /// <returns>The text string that is shown in the right click menu for this verb.</returns>
         protected abstract string GetText(IEntity user, T component);
 
+        /// <summary>
+        ///     Gets the category of this verb.
+        /// </summary>
+        /// <param name="user">The entity of the user opening this menu.</param>
+        /// <param name="component">The component instance for which this verb is being loaded.</param>
+        /// <returns>The category of this verb.</returns>
+        protected virtual string GetCategory(IEntity user, T component) => "";
+
         /// <summary>
         ///     Gets the visibility level of this verb in the right click menu.
         /// </summary>
@@ -84,6 +100,12 @@ namespace Content.Shared.GameObjects
             return GetText(user, (T) component);
         }
 
+        /// <inheritdoc />
+        public sealed override string GetCategory(IEntity user, IComponent component)
+        {
+            return GetCategory(user, (T) component);
+        }
+
         /// <inheritdoc />
         public sealed override VerbVisibility GetVisibility(IEntity user, IComponent component)
         {