- add: Enhanced vision refactor. (#471)

Content.Client/_White/Overlays/NightVisionSystem.cs

@@ -7,7 +7,8 @@ using Robust.Shared.Player;
 
 namespace Content.Client._White.Overlays;
 
-public sealed class NightVisionSystem : SharedNightVisionSystem
+public sealed class NightVisionSystem : SharedEnhancedVisionSystem<NightVisionComponent, TemporaryNightVisionComponent,
+    ToggleNightVisionEvent>
 {
     [Dependency] private readonly IPlayerManager _player = default!;
     [Dependency] private readonly IOverlayManager _overlayMan = default!;
@@ -46,12 +47,12 @@ public sealed class NightVisionSystem : SharedNightVisionSystem
         if (TryComp(ent, out NightVisionComponent? nightVision) && nightVision.IsActive)
             return;
 
-        UpdateNightVision(ent, false);
+        UpdateEnhancedVision(ent, false);
     }
 
     private void OnTempInit(Entity<TemporaryNightVisionComponent> ent, ref ComponentInit args)
     {
-        UpdateNightVision(ent, true);
+        UpdateEnhancedVision(ent, true);
     }
 
     private void OnPlayerAttached(EntityUid uid, NightVisionComponent component, PlayerAttachedEvent args)
@@ -76,7 +77,7 @@ public sealed class NightVisionSystem : SharedNightVisionSystem
         UpdateNightVision(active);
     }
 
-    protected override void UpdateNightVision(EntityUid uid, bool active)
+    protected override void UpdateEnhancedVision(EntityUid uid, bool active)
     {
         if (_player.LocalSession?.AttachedEntity != uid)
             return;

Content.Client/_White/Overlays/ThermalVisionOverlay.cs

@@ -22,6 +22,7 @@ public sealed class ThermalVisionOverlay : Overlay
     public override OverlaySpace Space => OverlaySpace.WorldSpace;
 
     private readonly List<NightVisionRenderEntry> _entries = new();
+    private EntityUid _pointLightEntity;
 
     public ThermalVisionOverlay()
     {
@@ -46,23 +47,50 @@ public sealed class ThermalVisionOverlay : Overlay
             return;
         }
 
+        var transform = _entity.GetComponent<TransformComponent>(ent);
+        if (_pointLightEntity == default)
+        {
+            _pointLightEntity = _entity.SpawnAttachedTo(null, transform.Coordinates);
+            _entity.EnsureComponent<PointLightComponent>(_pointLightEntity);
+            _transform.SetParent(_pointLightEntity, ent);
+        }
+        else
+        {
+            var pointLightXForm = _entity.GetComponent<TransformComponent>(_pointLightEntity);
+            if (pointLightXForm.ParentUid != ent)
+                _transform.SetParent(_pointLightEntity, pointLightXForm, ent, transform);
+        }
+
         if (HasOccluders(ent))
             return;
 
         var handle = args.WorldHandle;
         var eye = args.Viewport.Eye;
+        var mapId = eye?.Position.MapId;
         var eyeRot = eye?.Rotation ?? default;
 
         _entries.Clear();
         var entities = _entity.EntityQueryEnumerator<BodyComponent, SpriteComponent, TransformComponent>();
         while (entities.MoveNext(out var uid, out _, out var sprite, out var xform))
         {
-            if (HasOccluders(uid))
+            var entity = uid;
+
+            if (_container.TryGetOuterContainer(uid, xform, out var container))
+            {
+                var owner = container.Owner;
+                if (_entity.TryGetComponent<SpriteComponent>(owner, out var ownerSprite) &&
+                    _entity.TryGetComponent<TransformComponent>(owner, out var ownerXform))
+                {
+                    entity = owner;
+                    sprite = ownerSprite;
+                    xform = ownerXform;
+                }
+            }
+
+            if (_entries.Any(e => e.Ent.Item1 == entity))
                 continue;
 
-            _entries.Add(new NightVisionRenderEntry((uid, sprite, xform),
+            _entries.Add(new NightVisionRenderEntry((entity, sprite, xform), mapId, eyeRot));
-                eye?.Position.MapId,
-                eyeRot));
         }
 
         foreach (var entry in _entries)
@@ -79,7 +107,7 @@ public sealed class ThermalVisionOverlay : Overlay
         Angle eyeRot)
     {
         var (uid, sprite, xform) = ent;
-        if (xform.MapID != map || _container.IsEntityOrParentInContainer(uid))
+        if (xform.MapID != map || HasOccluders(uid))
             return;
 
         var position = _transform.GetWorldPosition(xform);
@@ -95,6 +123,15 @@ public sealed class ThermalVisionOverlay : Overlay
             Box2.CenteredAround(mapCoordinates.Position, new Vector2(0.4f, 0.4f)));
         return occluders.Any(o => o.Component.Enabled);
     }
+
+    public void Reset()
+    {
+        if (_pointLightEntity == default)
+            return;
+
+        _entity.DeleteEntity(_pointLightEntity);
+        _pointLightEntity = default;
+    }
 }
 
 public record struct NightVisionRenderEntry(

Content.Client/_White/Overlays/ThermalVisionSystem.cs

@@ -1,13 +1,15 @@
 using Content.Shared._Miracle.Systems;
 using Content.Shared.GameTicking;
 using Content.Shared._White.Overlays;
+using Robust.Client.GameObjects;
 using Robust.Client.Graphics;
 using Robust.Client.Player;
 using Robust.Shared.Player;
 
 namespace Content.Client._White.Overlays;
 
-public sealed class ThermalVisionSystem : SharedThermalVisionSystem
+public sealed class ThermalVisionSystem : SharedEnhancedVisionSystem<ThermalVisionComponent,
+    TemporaryThermalVisionComponent, ToggleThermalVisionEvent>
 {
     [Dependency] private readonly IPlayerManager _player = default!;
     [Dependency] private readonly IOverlayManager _overlayMan = default!;
@@ -46,12 +48,12 @@ public sealed class ThermalVisionSystem : SharedThermalVisionSystem
         if (TryComp(ent, out ThermalVisionComponent? thermalVision) && thermalVision.IsActive)
             return;
 
-        UpdateThermalVision(ent, false);
+        UpdateEnhancedVision(ent, false);
     }
 
     private void OnTempInit(Entity<TemporaryThermalVisionComponent> ent, ref ComponentInit args)
     {
-        UpdateThermalVision(ent, true);
+        UpdateEnhancedVision(ent, true);
     }
 
     private void OnPlayerAttached(EntityUid uid, ThermalVisionComponent component, PlayerAttachedEvent args)
@@ -76,7 +78,7 @@ public sealed class ThermalVisionSystem : SharedThermalVisionSystem
         UpdateThermalVision(active);
     }
 
-    protected override void UpdateThermalVision(EntityUid uid, bool active)
+    protected override void UpdateEnhancedVision(EntityUid uid, bool active)
     {
         if (_player.LocalSession?.AttachedEntity != uid)
             return;
@@ -89,6 +91,7 @@ public sealed class ThermalVisionSystem : SharedThermalVisionSystem
     {
         if (_player.LocalEntity == null)
         {
+            _overlay.Reset();
             _overlayMan.RemoveOverlay(_overlay);
             return;
         }
@@ -99,11 +102,15 @@ public sealed class ThermalVisionSystem : SharedThermalVisionSystem
         if (active)
             _overlayMan.AddOverlay(_overlay);
         else
+        {
+            _overlay.Reset();
             _overlayMan.RemoveOverlay(_overlay);
+        }
     }
 
     private void OnRestart(RoundRestartCleanupEvent ev)
     {
+        _overlay.Reset();
         _overlayMan.RemoveOverlay(_overlay);
     }
 }

Content.Server/_Miracle/Systems/NightVisionSystem.cs

@@ -1,7 +1,9 @@
 using Content.Shared._Miracle.Systems;
+using Content.Shared._White.Overlays;
 
 namespace Content.Server._Miracle.Systems;
 
-public sealed class NightVisionSystem : SharedNightVisionSystem
+public sealed class NightVisionSystem : SharedEnhancedVisionSystem<NightVisionComponent, TemporaryNightVisionComponent,
+    ToggleNightVisionEvent>
 {
 }

Content.Server/_Miracle/Systems/ThermalVisionSystem.cs

@@ -1,7 +1,9 @@
 using Content.Shared._Miracle.Systems;
+using Content.Shared._White.Overlays;
 
 namespace Content.Server._Miracle.Systems;
 
-public sealed class ThermalVisionSystem : SharedThermalVisionSystem
+public sealed class ThermalVisionSystem : SharedEnhancedVisionSystem<ThermalVisionComponent,
+    TemporaryThermalVisionComponent, ToggleThermalVisionEvent>
 {
 }

Content.Shared/_Miracle/Systems/SharedEnhancedVisionSystem.cs

@@ -0,0 +1,64 @@
+using Content.Shared._White.Overlays;
+using Content.Shared.Actions;
+using Robust.Shared.Audio.Systems;
+using Robust.Shared.Timing;
+
+namespace Content.Shared._Miracle.Systems;
+
+public abstract class SharedEnhancedVisionSystem<TComp, TTempComp, TEvent> : EntitySystem
+    where TComp : BaseEnhancedVisionComponent
+    where TEvent : InstantActionEvent
+    where TTempComp : Component
+{
+    [Dependency] private readonly SharedAudioSystem _audio = default!;
+    [Dependency] private readonly SharedActionsSystem _actions = default!;
+    [Dependency] private readonly IGameTiming _timing = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<TComp, TEvent>(OnToggle);
+        SubscribeLocalEvent<TComp, ComponentInit>(OnInit);
+        SubscribeLocalEvent<TComp, ComponentRemove>(OnRemove);
+    }
+
+    private void OnRemove(EntityUid uid, TComp component, ComponentRemove args)
+    {
+        _actions.RemoveAction(uid, component.ToggleActionEntity);
+
+        if (HasComp<TTempComp>(uid))
+            return;
+
+        UpdateEnhancedVision(uid, false);
+    }
+
+    private void OnInit(EntityUid uid, TComp component, ComponentInit args)
+    {
+        _actions.AddAction(uid, ref component.ToggleActionEntity, component.ToggleAction);
+
+        if (!component.IsActive && HasComp<TTempComp>(uid))
+            return;
+
+        UpdateEnhancedVision(uid, component.IsActive);
+    }
+
+    protected virtual void UpdateEnhancedVision(EntityUid uid, bool active) { }
+
+    private void OnToggle(EntityUid uid, TComp component, TEvent args)
+    {
+        if (!_timing.IsFirstTimePredicted)
+            return;
+
+        component.IsActive = !component.IsActive;
+
+        _audio.PlayPredicted(component.IsActive ? component.ActivateSound : component.DeactivateSound, uid, uid);
+
+        args.Handled = true;
+
+        if (!component.IsActive && HasComp<TTempComp>(uid))
+            return;
+
+        UpdateEnhancedVision(uid, component.IsActive);
+    }
+}

Content.Shared/_Miracle/Systems/SharedNightVisionSystem.cs

@@ -1,64 +0,0 @@
-using Content.Shared._White.Overlays;
-using Content.Shared.Actions;
-using Robust.Shared.Audio.Systems;
-using Robust.Shared.Timing;
-
-namespace Content.Shared._Miracle.Systems;
-
-public abstract class SharedNightVisionSystem : EntitySystem
-{
-    [Dependency] private readonly SharedAudioSystem _audio = default!;
-    [Dependency] private readonly SharedActionsSystem _actions = default!;
-    [Dependency] private readonly IGameTiming _timing = default!;
-
-    public override void Initialize()
-    {
-        base.Initialize();
-
-        SubscribeLocalEvent<NightVisionComponent, ToggleNightVisionEvent>(OnToggle);
-        SubscribeLocalEvent<NightVisionComponent, ComponentInit>(OnInit);
-        SubscribeLocalEvent<NightVisionComponent, ComponentRemove>(OnRemove);
-    }
-
-    private void OnRemove(EntityUid uid, NightVisionComponent component, ComponentRemove args)
-    {
-        _actions.RemoveAction(uid, component.ToggleActionEntity);
-
-        if (HasComp<TemporaryNightVisionComponent>(uid))
-            return;
-
-        UpdateNightVision(uid, false);
-    }
-
-    private void OnInit(EntityUid uid, NightVisionComponent component, ComponentInit args)
-    {
-        _actions.AddAction(uid, ref component.ToggleActionEntity, component.ToggleAction);
-
-        if (!component.IsActive && HasComp<TemporaryNightVisionComponent>(uid))
-            return;
-
-        UpdateNightVision(uid, component.IsActive);
-    }
-
-    protected virtual void UpdateNightVision(EntityUid uid, bool active) { }
-
-    private void OnToggle(EntityUid uid, NightVisionComponent component, ToggleNightVisionEvent args)
-    {
-        if (!_timing.IsFirstTimePredicted)
-            return;
-
-        component.IsActive = !component.IsActive;
-
-        if (component.IsActive && component.ActivateSound != null)
-            _audio.PlayPredicted(component.ActivateSound, uid, uid);
-        else if (component.DeactivateSound != null)
-            _audio.PlayPredicted(component.DeactivateSound, uid, uid);
-
-        args.Handled = true;
-
-        if (!component.IsActive && HasComp<TemporaryNightVisionComponent>(uid))
-            return;
-
-        UpdateNightVision(uid, component.IsActive);
-    }
-}

Content.Shared/_Miracle/Systems/SharedThermalVisionSystem.cs

@@ -1,64 +0,0 @@
-using Content.Shared._White.Overlays;
-using Content.Shared.Actions;
-using Robust.Shared.Audio.Systems;
-using Robust.Shared.Timing;
-
-namespace Content.Shared._Miracle.Systems;
-
-public abstract class SharedThermalVisionSystem : EntitySystem
-{
-    [Dependency] private readonly SharedAudioSystem _audio = default!;
-    [Dependency] private readonly SharedActionsSystem _actions = default!;
-    [Dependency] private readonly IGameTiming _timing = default!;
-
-    public override void Initialize()
-    {
-        base.Initialize();
-
-        SubscribeLocalEvent<ThermalVisionComponent, ToggleThermalVisionEvent>(OnToggle);
-        SubscribeLocalEvent<ThermalVisionComponent, ComponentInit>(OnInit);
-        SubscribeLocalEvent<ThermalVisionComponent, ComponentRemove>(OnRemove);
-    }
-
-    private void OnRemove(EntityUid uid, ThermalVisionComponent component, ComponentRemove args)
-    {
-        _actions.RemoveAction(uid, component.ToggleActionEntity);
-
-        if (HasComp<TemporaryThermalVisionComponent>(uid))
-            return;
-
-        UpdateThermalVision(uid, false);
-    }
-
-    private void OnInit(EntityUid uid, ThermalVisionComponent component, ComponentInit args)
-    {
-        _actions.AddAction(uid, ref component.ToggleActionEntity, component.ToggleAction);
-
-        if (!component.IsActive && HasComp<TemporaryThermalVisionComponent>(uid))
-            return;
-
-        UpdateThermalVision(uid, component.IsActive);
-    }
-
-    protected virtual void UpdateThermalVision(EntityUid uid, bool active) { }
-
-    private void OnToggle(EntityUid uid, ThermalVisionComponent component, ToggleThermalVisionEvent args)
-    {
-        if (!_timing.IsFirstTimePredicted)
-            return;
-
-        component.IsActive = !component.IsActive;
-
-        if (component.IsActive && component.ActivateSound != null)
-            _audio.PlayPredicted(component.ActivateSound, uid, uid);
-        else if (component.DeactivateSound != null)
-            _audio.PlayPredicted(component.DeactivateSound, uid, uid);
-
-        args.Handled = true;
-
-        if (!component.IsActive && HasComp<TemporaryThermalVisionComponent>(uid))
-            return;
-
-        UpdateThermalVision(uid, component.IsActive);
-    }
-}

Content.Shared/_White/Overlays/BaseEnhancedVisionComponent.cs

@@ -0,0 +1,24 @@
+using Robust.Shared.Audio;
+using Robust.Shared.GameStates;
+using Robust.Shared.Prototypes;
+
+namespace Content.Shared._White.Overlays;
+
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public abstract partial class BaseEnhancedVisionComponent : BaseNvOverlayComponent
+{
+    [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField]
+    public bool IsActive = true;
+
+    [DataField]
+    public virtual SoundSpecifier? ActivateSound { get; set; }= new SoundPathSpecifier("/Audio/White/Items/Goggles/activate.ogg");
+
+    [DataField]
+    public virtual SoundSpecifier? DeactivateSound { get; set; } = new SoundPathSpecifier("/Audio/White/Items/Goggles/deactivate.ogg");
+
+    [DataField]
+    public virtual EntProtoId? ToggleAction { get; set; }
+
+    [ViewVariables]
+    public EntityUid? ToggleActionEntity;
+}

Content.Shared/_White/Overlays/NightVisionComponent.cs

@@ -6,25 +6,13 @@ using Robust.Shared.Prototypes;
 namespace Content.Shared._White.Overlays;
 
 [RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
-public sealed partial class NightVisionComponent : BaseNvOverlayComponent
+public sealed partial class NightVisionComponent : BaseEnhancedVisionComponent
 {
     [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField]
     public override Color Color { get; set; } = Color.FromHex("#98FB98");
 
-    [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField]
-    public bool IsActive = true;
-
     [DataField]
-    public SoundSpecifier? ActivateSound = new SoundPathSpecifier("/Audio/White/Items/Goggles/activate.ogg");
+    public override EntProtoId? ToggleAction { get; set; } = "ToggleNightVision";
-
-    [DataField]
-    public SoundSpecifier? DeactivateSound = new SoundPathSpecifier("/Audio/White/Items/Goggles/deactivate.ogg");
-
-    [DataField]
-    public EntProtoId? ToggleAction = "ToggleNightVision";
-
-    [ViewVariables]
-    public EntityUid? ToggleActionEntity;
 }
 
 public sealed partial class ToggleNightVisionEvent : InstantActionEvent

Content.Shared/_White/Overlays/ThermalVisionComponent.cs

@@ -6,25 +6,13 @@ using Robust.Shared.Prototypes;
 namespace Content.Shared._White.Overlays;
 
 [RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
-public sealed partial class ThermalVisionComponent : BaseNvOverlayComponent
+public sealed partial class ThermalVisionComponent : BaseEnhancedVisionComponent
 {
     [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField]
     public override Color Color { get; set; } = Color.FromHex("#F84742");
 
-    [DataField, ViewVariables(VVAccess.ReadWrite), AutoNetworkedField]
-    public bool IsActive = true;
-
     [DataField]
-    public SoundSpecifier? ActivateSound = new SoundPathSpecifier("/Audio/White/Items/Goggles/activate.ogg");
+    public override EntProtoId? ToggleAction { get; set; } = "ToggleThermalVision";
-
-    [DataField]
-    public SoundSpecifier? DeactivateSound = new SoundPathSpecifier("/Audio/White/Items/Goggles/deactivate.ogg");
-
-    [DataField]
-    public EntProtoId? ToggleAction = "ToggleThermalVision";
-
-    [ViewVariables]
-    public EntityUid? ToggleActionEntity;
 }
 
 public sealed partial class ToggleThermalVisionEvent : InstantActionEvent