Convert ghost toggle button into an action (#12658)

* Convert ghost toggle button into an action

* figs

Content.Client/Ghost/GhostComponent.cs

@@ -20,7 +20,19 @@ namespace Content.Client.Ghost
             CheckCanInteract = false,
             Event = new DisableLightingActionEvent(),
         };
+
+        public InstantAction ToggleGhostsAction = new()
+        {
+            Icon = new SpriteSpecifier.Rsi(new ResourcePath("Mobs/Ghosts/ghost_human.rsi"), "icon"),
+            DisplayName = "ghost-gui-toggle-ghost-visibility-name",
+            Description = "ghost-gui-toggle-ghost-visibility-desc",
+            ClientExclusive = true,
+            CheckCanInteract = false,
+            Event = new ToggleGhostsActionEvent(),
+        };
     }
 
     public sealed class DisableLightingActionEvent : InstantActionEvent { };
+
+    public sealed class ToggleGhostsActionEvent : InstantActionEvent { };
 }

Content.Client/Ghost/GhostSystem.cs

@@ -67,6 +67,7 @@ namespace Content.Client.Ghost
             SubscribeNetworkEvent<GhostUpdateGhostRoleCountEvent>(OnUpdateGhostRoleCount);
 
             SubscribeLocalEvent<GhostComponent, DisableLightingActionEvent>(OnActionPerform);
+            SubscribeLocalEvent<GhostComponent, ToggleGhostsActionEvent>(OnToggleGhosts);
         }
 
         private void OnGhostInit(EntityUid uid, GhostComponent component, ComponentInit args)
@@ -77,6 +78,7 @@ namespace Content.Client.Ghost
             }
 
             _actions.AddAction(uid, component.DisableLightingAction, null);
+            _actions.AddAction(uid, component.ToggleGhostsAction, null);
         }
 
         private void OnActionPerform(EntityUid uid, GhostComponent component, DisableLightingActionEvent args)
@@ -88,9 +90,19 @@ namespace Content.Client.Ghost
             args.Handled = true;
         }
 
+        private void OnToggleGhosts(EntityUid uid, GhostComponent component, ToggleGhostsActionEvent args)
+        {
+            if (args.Handled)
+                return;
+
+            ToggleGhostVisibility();
+            args.Handled = true;
+        }
+
         private void OnGhostRemove(EntityUid uid, GhostComponent component, ComponentRemove args)
         {
             _actions.RemoveAction(uid, component.DisableLightingAction);
+            _actions.RemoveAction(uid, component.ToggleGhostsAction);
             _lightManager.Enabled = true;
 
             if (uid != _playerManager.LocalPlayer?.ControlledEntity)

Content.Client/UserInterface/Systems/Ghost/GhostUIController.cs

@@ -99,7 +99,6 @@ public sealed class GhostUIController : UIController, IOnSystemChanged<GhostSyst
         Gui.RequestWarpsPressed += RequestWarps;
         Gui.ReturnToBodyPressed += ReturnToBody;
         Gui.GhostRolesPressed += GhostRolesPressed;
-        Gui.ToggleGhostVisibility += ToggleGhostVisibility;
         Gui.TargetWindow.WarpClicked += OnWarpClicked;
 
         UpdateGui();
@@ -113,7 +112,6 @@ public sealed class GhostUIController : UIController, IOnSystemChanged<GhostSyst
         Gui.RequestWarpsPressed -= RequestWarps;
         Gui.ReturnToBodyPressed -= ReturnToBody;
         Gui.GhostRolesPressed -= GhostRolesPressed;
-        Gui.ToggleGhostVisibility -= ToggleGhostVisibility;
         Gui.TargetWindow.WarpClicked -= OnWarpClicked;
 
         Gui.Hide();
@@ -135,9 +133,4 @@ public sealed class GhostUIController : UIController, IOnSystemChanged<GhostSyst
     {
         _system?.OpenGhostRoles();
     }
-
-    private void ToggleGhostVisibility()
-    {
-        _system?.ToggleGhostVisibility();
-    }
 }

Content.Client/UserInterface/Systems/Ghost/Widgets/GhostGui.xaml

@@ -5,6 +5,5 @@
         <Button Name="ReturnToBodyButton" Text="{Loc ghost-gui-return-to-body-button}" />
         <Button Name="GhostWarpButton" Text="{Loc ghost-gui-ghost-warp-button}" />
         <Button Name="GhostRolesButton" />
-        <Button Name="ToggleGhostVisibilityButton" Text="{Loc ghost-gui-toggle-ghost-visibility-button}" />
     </BoxContainer>
 </widgets:GhostGui>

Content.Client/UserInterface/Systems/Ghost/Widgets/GhostGui.xaml.cs

@@ -14,7 +14,6 @@ public sealed partial class GhostGui : UIWidget
     public event Action? RequestWarpsPressed;
     public event Action? ReturnToBodyPressed;
     public event Action? GhostRolesPressed;
-    public event Action? ToggleGhostVisibility;
 
     public GhostGui()
     {
@@ -27,7 +26,6 @@ public sealed partial class GhostGui : UIWidget
         GhostWarpButton.OnPressed += _ => RequestWarpsPressed?.Invoke();
         ReturnToBodyButton.OnPressed += _ => ReturnToBodyPressed?.Invoke();
         GhostRolesButton.OnPressed += _ => GhostRolesPressed?.Invoke();
-        ToggleGhostVisibilityButton.OnPressed += _ => ToggleGhostVisibility?.Invoke();
     }
 
     public void Hide()

Resources/Locale/en-US/ghost/ghost-gui.ftl

@@ -1,7 +1,8 @@
 ghost-gui-return-to-body-button = Return to body
 ghost-gui-ghost-warp-button = Ghost Warp
 ghost-gui-ghost-roles-button = Ghost Roles ({$count})
-ghost-gui-toggle-ghost-visibility-button = Toggle Ghosts
+ghost-gui-toggle-ghost-visibility-name = Toggle Ghosts
+ghost-gui-toggle-ghost-visibility-desc = Toggle the visibility of other ghosts.
 ghost-gui-toggle-lighting-manager-name = Toggle Lighting
 ghost-gui-toggle-lighting-manager-desc = Toggle light rendering to better observe dark areas or to see what players see.
 

Resources/Textures/Mobs/Ghosts/ghost_human.rsi/meta.json

@@ -12,8 +12,7 @@
       "directions": 4
     },
     {
-      "name": "icon",
+      "name": "icon"
-      "directions": 4
     }
   ]
 }