Device link visualizer (#11054)

* shuffles devicelist to shared, adds an overlay for devicelist * adds space property to overlay * moves networkconfigurator to shared, makes devicelistsystem clientside check activedevicelist * dirties components upon change, adds networkedcomponent to sharednetworkconfigurator * state handlers for networked components * whoops * lots of shuffling, renaming, and access changes * randomizes color for every new entity added to the overlay * adds a client-side action to clear all network overlays if they're active * clones action (oops) * localization, adds a command for clearing network link overlays (in case the action disappears) * moves the entity manager up into the bui fields * makes that a dependency * attempts to just directly get the color from the dict when drawing, now * fixes up a few comments * adds dirty on init to devicelistcomponent * hacky solution related to mapping with a networkconfigurator * more stricter bound on that hacky solution * just checks if the life stage is initialized instead of if the entity was initialized * moves getalldevices to shared * readds linq import * tries to ensure that the show button is toggled on if the device we're trying to configure is currently being tracked by the overlay * some reorganization
2022-09-05 17:55:44 -07:00
parent 6301ac5147
commit 9ace52a6c1
16 changed files with 454 additions and 55 deletions
--- a/Content.Client/NetworkConfigurator/Systems/NetworkConfiguratorSystem.cs
+++ b/Content.Client/NetworkConfigurator/Systems/NetworkConfiguratorSystem.cs
@@ -0,0 +1,116 @@
+using System.Linq;
+using Content.Client.Actions;
+using Content.Shared.Actions;
+using Content.Shared.Actions.ActionTypes;
+using Content.Shared.DeviceNetwork;
+using Robust.Client.Graphics;
+using Robust.Client.Player;
+using Robust.Shared.Console;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Utility;
+
+namespace Content.Client.NetworkConfigurator;
+
+public sealed class NetworkConfiguratorSystem : SharedNetworkConfiguratorSystem
+{
+    [Dependency] private readonly IPlayerManager _playerManager = default!;
+    [Dependency] private readonly IOverlayManager _overlay = default!;
+    [Dependency] private readonly IPrototypeManager _prototypeManager = default!;
+    [Dependency] private readonly ActionsSystem _actions = default!;
+
+    private const string Action = "ClearNetworkLinkOverlays";
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<ClearAllOverlaysEvent>(_ => ClearAllOverlays());
+    }
+
+    public bool ConfiguredListIsTracked(EntityUid uid, NetworkConfiguratorComponent? component = null)
+    {
+        return Resolve(uid, ref component)
+               && component.ActiveDeviceList != null
+               && HasComp<NetworkConfiguratorActiveLinkOverlayComponent>(component.ActiveDeviceList.Value);
+    }
+
+    /// <summary>
+    /// Toggles a device list's (tied to this network configurator) connection visualisation on and off.
+    /// </summary>
+    public void ToggleVisualization(EntityUid uid, bool toggle, NetworkConfiguratorComponent? component = null)
+    {
+        if (_playerManager.LocalPlayer == null
+            || _playerManager.LocalPlayer.ControlledEntity == null
+            || !Resolve(uid, ref component)
+            || component.ActiveDeviceList == null)
+            return;
+
+        if (!toggle)
+        {
+            if (_overlay.HasOverlay<NetworkConfiguratorLinkOverlay>())
+            {
+                _overlay.GetOverlay<NetworkConfiguratorLinkOverlay>().ClearEntity(component.ActiveDeviceList.Value);
+            }
+
+            RemComp<NetworkConfiguratorActiveLinkOverlayComponent>(component.ActiveDeviceList.Value);
+            if (!EntityQuery<NetworkConfiguratorActiveLinkOverlayComponent>().Any())
+            {
+                _overlay.RemoveOverlay<NetworkConfiguratorLinkOverlay>();
+                _actions.RemoveAction(_playerManager.LocalPlayer.ControlledEntity.Value, _prototypeManager.Index<InstantActionPrototype>(Action));
+            }
+
+
+            return;
+        }
+
+        if (!_overlay.HasOverlay<NetworkConfiguratorLinkOverlay>())
+        {
+            _overlay.AddOverlay(new NetworkConfiguratorLinkOverlay());
+            _actions.AddAction(_playerManager.LocalPlayer.ControlledEntity.Value, new InstantAction(_prototypeManager.Index<InstantActionPrototype>(Action)), null);
+        }
+
+        EnsureComp<NetworkConfiguratorActiveLinkOverlayComponent>(component.ActiveDeviceList.Value);
+    }
+
+    public void ClearAllOverlays()
+    {
+        if (!_overlay.HasOverlay<NetworkConfiguratorLinkOverlay>())
+        {
+            return;
+        }
+
+        foreach (var tracker in EntityQuery<NetworkConfiguratorActiveLinkOverlayComponent>())
+        {
+            RemCompDeferred<NetworkConfiguratorActiveLinkOverlayComponent>(tracker.Owner);
+        }
+
+        _overlay.RemoveOverlay<NetworkConfiguratorLinkOverlay>();
+
+        if (_playerManager.LocalPlayer?.ControlledEntity != null)
+        {
+            _actions.RemoveAction(_playerManager.LocalPlayer.ControlledEntity.Value, _prototypeManager.Index<InstantActionPrototype>(Action));
+        }
+    }
+
+    // hacky solution related to mapping
+    public void SetActiveDeviceList(EntityUid tool, EntityUid list, NetworkConfiguratorComponent? component = null)
+    {
+        if (!Resolve(tool, ref component))
+        {
+            return;
+        }
+
+        component.ActiveDeviceList = list;
+    }
+}
+
+public sealed class ClearAllNetworkLinkOverlays : IConsoleCommand
+{
+    public string Command => "clearnetworklinkoverlays";
+    public string Description => "Clear all network link overlays.";
+    public string Help => Command;
+    public void Execute(IConsoleShell shell, string argStr, string[] args)
+    {
+        IoCManager.Resolve<IEntityManager>().System<NetworkConfiguratorSystem>().ClearAllOverlays();
+    }
+}