Allow AI and observers to see electrified doors (#33466)

Content.Client/Electrocution/ElectrocutionHUDVisualizerSystem.cs

@@ -0,0 +1,95 @@
+using Content.Shared.Electrocution;
+using Robust.Client.GameObjects;
+using Robust.Client.Player;
+using Robust.Shared.Player;
+
+namespace Content.Client.Electrocution;
+
+/// <summary>
+/// Shows the Electrocution HUD to entities with the ShowElectrocutionHUDComponent.
+/// </summary>
+public sealed class ElectrocutionHUDVisualizerSystem : VisualizerSystem<ElectrocutionHUDVisualsComponent>
+{
+    [Dependency] private readonly IPlayerManager _playerMan = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<ShowElectrocutionHUDComponent, ComponentInit>(OnInit);
+        SubscribeLocalEvent<ShowElectrocutionHUDComponent, ComponentShutdown>(OnShutdown);
+        SubscribeLocalEvent<ShowElectrocutionHUDComponent, LocalPlayerAttachedEvent>(OnPlayerAttached);
+        SubscribeLocalEvent<ShowElectrocutionHUDComponent, LocalPlayerDetachedEvent>(OnPlayerDetached);
+    }
+
+    private void OnPlayerAttached(Entity<ShowElectrocutionHUDComponent> ent, ref LocalPlayerAttachedEvent args)
+    {
+        ShowHUD();
+    }
+
+    private void OnPlayerDetached(Entity<ShowElectrocutionHUDComponent> ent, ref LocalPlayerDetachedEvent args)
+    {
+        RemoveHUD();
+    }
+
+    private void OnInit(Entity<ShowElectrocutionHUDComponent> ent, ref ComponentInit args)
+    {
+        if (_playerMan.LocalEntity == ent)
+        {
+            ShowHUD();
+        }
+    }
+
+    private void OnShutdown(Entity<ShowElectrocutionHUDComponent> ent, ref ComponentShutdown args)
+    {
+        if (_playerMan.LocalEntity == ent)
+        {
+            RemoveHUD();
+        }
+    }
+
+    // Show the HUD to the client.
+    // We have to look for all current entities that can be electrified and toggle the HUD layer on if they are.
+    private void ShowHUD()
+    {
+        var electrifiedQuery = AllEntityQuery<ElectrocutionHUDVisualsComponent, AppearanceComponent, SpriteComponent>();
+        while (electrifiedQuery.MoveNext(out var uid, out var _, out var appearanceComp, out var spriteComp))
+        {
+            if (!AppearanceSystem.TryGetData<bool>(uid, ElectrifiedVisuals.IsElectrified, out var electrified, appearanceComp))
+                continue;
+
+            if (electrified)
+                spriteComp.LayerSetVisible(ElectrifiedLayers.HUD, true);
+            else
+                spriteComp.LayerSetVisible(ElectrifiedLayers.HUD, false);
+        }
+    }
+
+    // Remove the HUD from the client.
+    // Find all current entities that can be electrified and hide the HUD layer.
+    private void RemoveHUD()
+    {
+        var electrifiedQuery = AllEntityQuery<ElectrocutionHUDVisualsComponent, AppearanceComponent, SpriteComponent>();
+        while (electrifiedQuery.MoveNext(out var uid, out var _, out var appearanceComp, out var spriteComp))
+        {
+
+            spriteComp.LayerSetVisible(ElectrifiedLayers.HUD, false);
+        }
+    }
+
+    // Toggle the HUD layer if an entity becomes (de-)electrified
+    protected override void OnAppearanceChange(EntityUid uid, ElectrocutionHUDVisualsComponent comp, ref AppearanceChangeEvent args)
+    {
+        if (args.Sprite == null)
+            return;
+
+        if (!AppearanceSystem.TryGetData<bool>(uid, ElectrifiedVisuals.IsElectrified, out var electrified, args.Component))
+            return;
+
+        var player = _playerMan.LocalEntity;
+        if (electrified && HasComp<ShowElectrocutionHUDComponent>(player))
+            args.Sprite.LayerSetVisible(ElectrifiedLayers.HUD, true);
+        else
+            args.Sprite.LayerSetVisible(ElectrifiedLayers.HUD, false);
+    }
+}

Content.Server/Electrocution/ElectrocutionSystem.cs

@@ -123,7 +123,7 @@ private void UpdateState(float frameTime)
             activated.TimeLeft -= frameTime;
             if (activated.TimeLeft <= 0 || !IsPowered(uid, electrified, transform))
             {
-                _appearance.SetData(uid, ElectrifiedVisuals.IsPowered, false);
+                _appearance.SetData(uid, ElectrifiedVisuals.ShowSparks, false);
                 RemComp<ActivatedElectrifiedComponent>(uid);
             }
         }
@@ -219,7 +219,7 @@ public bool TryDoElectrifiedAct(EntityUid uid, EntityUid targetUid,
             return false;
 
         EnsureComp<ActivatedElectrifiedComponent>(uid);
-        _appearance.SetData(uid, ElectrifiedVisuals.IsPowered, true);
+        _appearance.SetData(uid, ElectrifiedVisuals.ShowSparks, true);
 
         siemens *= electrified.SiemensCoefficient;
         if (!DoCommonElectrocutionAttempt(targetUid, uid, ref siemens) || siemens <= 0)

Content.Server/Power/PowerWireAction.cs

@@ -17,7 +17,7 @@ public sealed partial class PowerWireAction : BaseWireAction
     [DataField("pulseTimeout")]
     private int _pulseTimeout = 30;
 
-    private ElectrocutionSystem _electrocutionSystem = default!;
+    private ElectrocutionSystem _electrocution = default!;
 
     public override object StatusKey { get; } = PowerWireActionKey.Status;
 
@@ -108,7 +108,8 @@ private void SetElectrified(EntityUid used, bool setting, ElectrifiedComponent?
             && !EntityManager.TryGetComponent(used, out electrified))
             return;
 
-        electrified.Enabled = setting;
+        _electrocution.SetElectrifiedWireCut((used, electrified), setting);
+        _electrocution.SetElectrified((used, electrified), setting);
     }
 
     /// <returns>false if failed, true otherwise, or if the entity cannot be electrified</returns>
@@ -122,7 +123,7 @@ private bool TrySetElectrocution(EntityUid user, Wire wire, bool timed = false)
         // always set this to true
         SetElectrified(wire.Owner, true, electrified);
 
-        var electrifiedAttempt = _electrocutionSystem.TryDoElectrifiedAct(wire.Owner, user);
+        var electrifiedAttempt = _electrocution.TryDoElectrifiedAct(wire.Owner, user);
 
         // if we were electrified, then return false
         return !electrifiedAttempt;
@@ -163,7 +164,7 @@ public override void Initialize()
     {
         base.Initialize();
 
-        _electrocutionSystem = EntitySystem.Get<ElectrocutionSystem>();
+        _electrocution = EntityManager.System<ElectrocutionSystem>();
     }
 
     // This should add a wire into the entity's state, whether it be

Content.Shared/Electrocution/Components/ElectrocutionHUDVisualsComponent.cs

@@ -0,0 +1,7 @@
+namespace Content.Shared.Electrocution;
+
+/// <summary>
+/// Handles toggling sprite layers for the electrocution HUD to show if an entity with the ElectrifiedComponent is electrified.
+/// </summary>
+[RegisterComponent]
+public sealed partial class ElectrocutionHUDVisualsComponent : Component;

Content.Shared/Electrocution/Components/ShowElectrocutionHUDComponent.cs

@@ -0,0 +1,9 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Electrocution;
+
+/// <summary>
+/// Allow an entity to see the Electrocution HUD showing electrocuted doors.
+/// </summary>
+[RegisterComponent, NetworkedComponent]
+public sealed partial class ShowElectrocutionHUDComponent : Component;

Content.Shared/Electrocution/SharedElectrocution.cs

@@ -5,11 +5,13 @@ namespace Content.Shared.Electrocution;
 [Serializable, NetSerializable]
 public enum ElectrifiedLayers : byte
 {
-    Powered
+    Sparks,
+    HUD,
 }
 
 [Serializable, NetSerializable]
 public enum ElectrifiedVisuals : byte
 {
-    IsPowered
+    ShowSparks, // only shown when zapping someone, deactivated after a short time
+    IsElectrified, // if the entity is electrified or not, used for the AI HUD
 }

Content.Shared/Electrocution/SharedElectrocutionSystem.cs

@@ -5,6 +5,8 @@ namespace Content.Shared.Electrocution
 {
     public abstract class SharedElectrocutionSystem : EntitySystem
     {
+        [Dependency] private readonly SharedAppearanceSystem _appearance = default!;
+
         public override void Initialize()
         {
             base.Initialize();
@@ -23,6 +25,33 @@ public void SetInsulatedSiemensCoefficient(EntityUid uid, float siemensCoefficie
             Dirty(uid, insulated);
         }
 
+        /// <summary>
+        /// Sets electrified value of component and marks dirty if required.
+        /// </summary>
+        public void SetElectrified(Entity<ElectrifiedComponent> ent, bool value)
+        {
+            if (ent.Comp.Enabled == value)
+            {
+                return;
+            }
+
+            ent.Comp.Enabled = value;
+            Dirty(ent, ent.Comp);
+
+            _appearance.SetData(ent.Owner, ElectrifiedVisuals.IsElectrified, value);
+        }
+
+        public void SetElectrifiedWireCut(Entity<ElectrifiedComponent> ent, bool value)
+        {
+            if (ent.Comp.IsWireCut == value)
+            {
+                return;
+            }
+
+            ent.Comp.IsWireCut = value;
+            Dirty(ent);
+        }
+
         /// <param name="uid">Entity being electrocuted.</param>
         /// <param name="sourceUid">Source entity of the electrocution.</param>
         /// <param name="shockDamage">How much shock damage the entity takes.</param>

Resources/Prototypes/Entities/Mobs/Player/observer.yml

@@ -58,6 +58,7 @@
     skipChecks: true
   - type: Ghost
   - type: GhostHearing
+  - type: ShowElectrocutionHUD
   - type: IntrinsicRadioReceiver
   - type: ActiveRadio
     receiveAllChannels: true

Resources/Prototypes/Entities/Mobs/Player/silicon.yml

@@ -22,6 +22,7 @@
   - type: IgnoreUIRange
   - type: StationAiHeld
   - type: StationAiOverlay
+  - type: ShowElectrocutionHUD
   - type: ActionGrant
     actions:
     - ActionJumpToCore

Resources/Prototypes/Entities/Structures/Doors/Airlocks/base_structureairlocks.yml

@@ -30,6 +30,11 @@
       shader: unshaded
     - state: panel_open
       map: ["enum.WiresVisualLayers.MaintenancePanel"]
+    - state: electrified
+      sprite: Interface/Misc/ai_hud.rsi
+      shader: unshaded
+      visible: false
+      map: ["enum.ElectrifiedLayers.HUD"]
   - type: AnimationPlayer
   - type: Physics
   - type: Fixtures
@@ -72,6 +77,7 @@
   - type: DoorBolt
   - type: Appearance
   - type: WiresVisuals
+  - type: ElectrocutionHUDVisuals
   - type: ApcPowerReceiver
     powerLoad: 20
   - type: ExtensionCableReceiver

Resources/Prototypes/Entities/Structures/Doors/Airlocks/shuttle.yml

@@ -30,23 +30,6 @@
         hard: false
   - type: Sprite
     sprite: Structures/Doors/Airlocks/Standard/shuttle.rsi
-    snapCardinals: false
-    layers:
-    - state: closed
-      map: ["enum.DoorVisualLayers.Base"]
-    - state: closed_unlit
-      shader: unshaded
-      map: ["enum.DoorVisualLayers.BaseUnlit"]
-    - state: welded
-      map: ["enum.WeldableLayers.BaseWelded"]
-    - state: bolted_unlit
-      shader: unshaded
-      map: ["enum.DoorVisualLayers.BaseBolted"]
-    - state: emergency_unlit
-      shader: unshaded
-      map: ["enum.DoorVisualLayers.BaseEmergencyAccess"]
-    - state: panel_open
-      map: ["enum.WiresVisualLayers.MaintenancePanel"]
   - type: Wires
     layoutId: Docking
   - type: Door

Resources/Prototypes/Entities/Structures/Walls/fence_metal.yml

@@ -70,8 +70,8 @@
   - type: Appearance
   - type: GenericVisualizer
     visuals:
-      enum.ElectrifiedVisuals.IsPowered:
-        enum.ElectrifiedLayers.Powered:
+      enum.ElectrifiedVisuals.ShowSparks:
+        enum.ElectrifiedLayers.Sparks:
           True: { visible: True }
           False: { visible: False }
   - type: AnimationPlayer
@@ -94,7 +94,7 @@
     - state: straight_broken
     - state: electrified
       sprite: Effects/electricity.rsi
-      map: ["enum.ElectrifiedLayers.Powered"]
+      map: ["enum.ElectrifiedLayers.Sparks"]
       shader: unshaded
       visible: false
   - type: Physics
@@ -149,7 +149,7 @@
     - state: straight
     - state: electrified
       sprite: Effects/electricity.rsi
-      map: ["enum.ElectrifiedLayers.Powered"]
+      map: ["enum.ElectrifiedLayers.Sparks"]
       shader: unshaded
       visible: false
   - type: Fixtures
@@ -202,7 +202,7 @@
     - state: corner
     - state: electrified
       sprite: Effects/electricity.rsi
-      map: ["enum.ElectrifiedLayers.Powered"]
+      map: ["enum.ElectrifiedLayers.Sparks"]
       shader: unshaded
       visible: false
   - type: Fixtures
@@ -244,7 +244,7 @@
     - state: end
     - state: electrified
       sprite: Effects/electricity.rsi
-      map: ["enum.ElectrifiedLayers.Powered"]
+      map: ["enum.ElectrifiedLayers.Sparks"]
       shader: unshaded
       visible: false
   - type: Fixtures
@@ -275,7 +275,7 @@
       map: ["enum.DoorVisualLayers.Base"]
     - state: electrified
       sprite: Effects/electricity.rsi
-      map: [ "enum.ElectrifiedLayers.Powered" ]
+      map: [ "enum.ElectrifiedLayers.Sparks" ]
       shader: unshaded
       visible: false
   - type: Fixtures

Resources/Prototypes/Entities/Structures/Walls/grille.yml

@@ -21,7 +21,7 @@
         - state: grille
         - state: electrified
           sprite: Effects/electricity.rsi
-          map: ["enum.ElectrifiedLayers.Powered"]
+          map: ["enum.ElectrifiedLayers.Sparks"]
           shader: unshaded
           visible: false
     - type: Icon
@@ -82,8 +82,8 @@
     - type: Appearance
     - type: GenericVisualizer
       visuals:
-        enum.ElectrifiedVisuals.IsPowered:
-          enum.ElectrifiedLayers.Powered:
+        enum.ElectrifiedVisuals.ShowSparks:
+          enum.ElectrifiedLayers.Sparks:
             True: { visible: True }
             False: { visible: False }
     - type: AnimationPlayer
@@ -176,7 +176,7 @@
         - state: grille_diagonal
         - state: electrified_diagonal
           sprite: Effects/electricity.rsi
-          map: ["enum.ElectrifiedLayers.Powered"]
+          map: ["enum.ElectrifiedLayers.Sparks"]
           shader: unshaded
           visible: false
     - type: Icon
@@ -211,7 +211,7 @@
         - state: ratvargrille_diagonal
         - state: electrified_diagonal
           sprite: Effects/electricity.rsi
-          map: ["enum.ElectrifiedLayers.Powered"]
+          map: ["enum.ElectrifiedLayers.Sparks"]
           shader: unshaded
           visible: false
     - type: Icon