Client distinguish between eye and mob for drawing, context menu, and verbs

OpenDreamClient/ClientVerbSystem.cs

@@ -18,6 +18,7 @@ public sealed class ClientVerbSystem : VerbSystem {
     [Dependency] private readonly ITaskManager _taskManager = default!;
     [Dependency] private readonly ITimerManager _timerManager = default!;
     [Dependency] private readonly IOverlayManager _overlayManager = default!;
+    [Dependency] private readonly DreamClientSystem _dreamClientSystem = default!;
     [Dependency] private readonly TransformSystem _transformSystem = default!;
 
     private EntityQuery<DMISpriteComponent> _spriteQuery;
@@ -83,8 +84,10 @@ public IEnumerable<VerbInfo> GetAllVerbs() {
     /// <returns>The ID, src, and information of every executable verb</returns>
     public IEnumerable<(int Id, ClientObjectReference Src, VerbInfo VerbInfo)> GetExecutableVerbs(bool ignoreHiddenAttr = false) {
         sbyte? seeInvisibility = null;
-        if (_playerManager.LocalEntity != null) {
-            _sightQuery.TryGetComponent(_playerManager.LocalEntity.Value, out var mobSight);
+
+        EntityUid mob = _dreamClientSystem.MobUid;
+        if (mob.IsValid()) {
+            _sightQuery.TryGetComponent(mob, out var mobSight);
 
             seeInvisibility = mobSight?.SeeInvisibility;
         }
@@ -120,12 +123,12 @@ public IEnumerable<VerbInfo> GetAllVerbs() {
                 // Check the verb's "set src" allows us to execute this
                 switch (verb.Accessibility) {
                     case VerbAccessibility.Usr:
-                        if (entity != _playerManager.LocalEntity)
+                        if (entity != mob)
                             continue;
 
                         break;
                     case VerbAccessibility.InUsr:
-                        if (_transformSystem.GetParentUid(entity) != _playerManager.LocalEntity)
+                        if (_transformSystem.GetParentUid(entity) != mob)
                             continue;
 
                         break;

OpenDreamClient/DreamClientSystem.cs

@@ -1,11 +1,46 @@
 using OpenDreamClient.Interface;
+using OpenDreamShared.Dream;
+using OpenDreamShared.Network.Messages;
 using Robust.Shared.Player;
 
 namespace OpenDreamClient;
 
 internal sealed class DreamClientSystem : EntitySystem {
+    [Dependency] private readonly IEntityManager _entityManager = default!;
     [Dependency] private readonly IDreamInterfaceManager _interfaceManager = default!;
 
+    // Current NetEntityof player's mob, or Invalid if could not be determined.
+    private NetEntity _mobNet = NetEntity.Invalid;
+
+    // Current Entity of player's mob, or Invalid if could not be determined.
+    private EntityUid _mobUid = EntityUid.Invalid;
+
+    // Sometimes we get mob info before we know all the net entities, so store the net entity and refer to it 
+    public EntityUid MobUid {
+        get {
+            // if entity of mob is invalid but net entity isn't, try referring to known net entities
+            if (! _mobUid.IsValid() && _mobNet.IsValid() && _entityManager.TryGetEntity(_mobNet, out var ent)) {
+                _mobUid = ent.GetValueOrDefault(EntityUid.Invalid);
+            }
+
+            return _mobUid;
+        }
+    }
+
+    // Current Entity of player's eye, or Invalid if could not be determined.
+    private ClientObjectReference _eyeRef = new(NetEntity.Invalid);
+
+    public ClientObjectReference EyeRef {
+        get {
+            if (_eyeRef.Type == ClientObjectReference.RefType.Entity && !_eyeRef.Entity.IsValid()) {
+                return new(_entityManager.GetNetEntity(MobUid));
+            } else {
+                return _eyeRef;
+            }
+        }
+        private set => _eyeRef = value;
+    }
+
     public override void Initialize() {
         SubscribeLocalEvent<LocalPlayerAttachedEvent>(OnPlayerAttached);
     }
@@ -15,4 +50,32 @@
         // So we have to set it again
         _interfaceManager.DefaultWindow?.Macro.SetActive();
     }
+
+    public void RxNotifyMobEyeUpdate(MsgNotifyMobEyeUpdate msg) {
+        var prevMobNet = _mobNet;
+        _mobNet = msg.MobNetEntity;
+
+        if (prevMobNet != _mobNet) {
+            // mark mob cache as dirty/invalid
+            _mobUid = EntityUid.Invalid;
+        }
+
+        var incomingEyeRef = msg.EyeRef;
+
+        switch (incomingEyeRef.Type) {
+            default:
+                EyeRef = new(msg.MobNetEntity);
+                break;
+            case ClientObjectReference.RefType.Entity:
+                if (incomingEyeRef.Entity.IsValid()) {
+                    EyeRef = incomingEyeRef;
+                } else {
+                    EyeRef = new(msg.MobNetEntity);
+                }
+                break;
+            case ClientObjectReference.RefType.Turf:
+                EyeRef = incomingEyeRef;
+                break;
+        }
+    }
 }

OpenDreamClient/Input/ContextMenu/ContextMenuPopup.xaml.cs

@@ -19,6 +19,7 @@ internal sealed partial class ContextMenuPopup : Popup {
     [Dependency] private readonly IEntitySystemManager _entitySystemManager = default!;
     [Dependency] private readonly IUserInterfaceManager _uiManager = default!;
     private readonly ClientAppearanceSystem _appearanceSystem;
+    private readonly DreamClientSystem _dreamClientSystem;
     private readonly ClientVerbSystem _verbSystem;
     private readonly DMISpriteSystem _spriteSystem;
     private readonly EntityLookupSystem _lookupSystem;
@@ -37,6 +38,7 @@ public ContextMenuPopup() {
 
         _verbSystem = _entitySystemManager.GetEntitySystem<ClientVerbSystem>();
         _appearanceSystem = _entitySystemManager.GetEntitySystem<ClientAppearanceSystem>();
+        _dreamClientSystem = _entitySystemManager.GetEntitySystem<DreamClientSystem>();
         _spriteSystem = _entitySystemManager.GetEntitySystem<DMISpriteSystem>();
         _lookupSystem = _entitySystemManager.GetEntitySystem<EntityLookupSystem>();
         _mouseInputSystem = _entitySystemManager.GetEntitySystem<MouseInputSystem>();
@@ -115,7 +117,7 @@ public void SetActiveItem(ContextMenuItem item) {
     private sbyte GetSeeInvisible() {
         if (_playerManager.LocalSession == null)
             return 127;
-        if (!_mobSightQuery.TryGetComponent(_playerManager.LocalSession.AttachedEntity, out DreamMobSightComponent? sight))
+        if (!_mobSightQuery.TryGetComponent(_dreamClientSystem.MobUid, out DreamMobSightComponent? sight))
             return 127;
 
         return sight.SeeInvisibility;

OpenDreamClient/Interface/DreamInterfaceManager.cs

@@ -1,28 +1,28 @@
-using System.IO;
-using System.Text;
-using System.Globalization;
-using OpenDreamShared.Network.Messages;
-using OpenDreamClient.Interface.Controls;
-using OpenDreamShared.Interface.Descriptors;
-using OpenDreamShared.Interface.DMF;
+using OpenDreamClient.Interface.Controls;
 using OpenDreamClient.Interface.Prompts;
 using OpenDreamClient.Resources;
 using OpenDreamClient.Resources.ResourceTypes;
 using OpenDreamShared.Dream;
+using OpenDreamShared.Interface.Descriptors;
+using OpenDreamShared.Interface.DMF;
+using OpenDreamShared.Network.Messages;
 using Robust.Client;
 using Robust.Client.Graphics;
 using Robust.Client.Input;
 using Robust.Client.UserInterface;
 using Robust.Client.UserInterface.Controls;
 using Robust.Shared.ContentPack;
+using Robust.Shared.Map;
 using Robust.Shared.Network;
 using Robust.Shared.Random;
 using Robust.Shared.Serialization.Manager;
 using Robust.Shared.Timing;
 using Robust.Shared.Utility;
 using SixLabors.ImageSharp;
+using System.Globalization;
+using System.IO;
 using System.Linq;
-using Robust.Shared.Map;
+using System.Text;
 
 namespace OpenDreamClient.Interface;
 
@@ -131,9 +131,14 @@ public void Initialize() {
         _netManager.RegisterNetMessage<MsgLoadInterface>(RxLoadInterface);
         _netManager.RegisterNetMessage<MsgAckLoadInterface>();
         _netManager.RegisterNetMessage<MsgUpdateClientInfo>(RxUpdateClientInfo);
+        _netManager.RegisterNetMessage<MsgNotifyMobEyeUpdate>(RxNotifyMobEyeUpdate);
         _clyde.OnWindowFocused += OnWindowFocused;
     }
 
+    private void RxNotifyMobEyeUpdate(MsgNotifyMobEyeUpdate message) {
+        _entitySystemManager.GetEntitySystem<DreamClientSystem>().RxNotifyMobEyeUpdate(message);
+    }
+
     private void RxUpdateStatPanels(MsgUpdateStatPanels message) {
         DefaultInfo?.UpdateStatPanels(message);
     }

OpenDreamClient/Rendering/DreamViewOverlay.cs

@@ -1,20 +1,20 @@
-using System.Linq;
-using OpenDreamClient.Interface;
-using Robust.Client.Graphics;
-using Robust.Client.Player;
-using Robust.Shared.Map;
+using OpenDreamClient.Interface;
+using OpenDreamClient.Rendering.Particles;
 using OpenDreamShared.Dream;
-using Robust.Shared.Console;
-using Robust.Shared.Prototypes;
 using OpenDreamShared.Rendering;
-using OpenDreamClient.Rendering.Particles;
 using Robust.Client.GameObjects;
-using Robust.Shared.Map.Components;
-using Robust.Shared.Profiling;
-using Matrix3x2 = System.Numerics.Matrix3x2;
+using Robust.Client.Graphics;
+using Robust.Client.Player;
 using Robust.Client.ResourceManagement;
 using Robust.Client.UserInterface.RichText;
+using Robust.Shared.Console;
 using Robust.Shared.Enums;
+using Robust.Shared.Map;
+using Robust.Shared.Map.Components;
+using Robust.Shared.Profiling;
+using Robust.Shared.Prototypes;
+using System.Linq;
+using Matrix3x2 = System.Numerics.Matrix3x2;
 
 namespace OpenDreamClient.Rendering;
 
@@ -60,6 +60,7 @@ internal sealed partial class DreamViewOverlay : Overlay {
     private readonly ClientScreenOverlaySystem _screenOverlaySystem;
     private readonly ClientImagesSystem _imagesSystem;
     private readonly DMISpriteSystem _spriteSystem;
+    private readonly DreamClientSystem _dreamClientSystem;
 
     private readonly EntityQuery<DMISpriteComponent> _spriteQuery;
     private readonly EntityQuery<TransformComponent> _xformQuery;
@@ -90,6 +91,7 @@ public DreamViewOverlay(RenderTargetPool renderTargetPool) {
         _screenOverlaySystem = _entitySystemManager.GetEntitySystem<ClientScreenOverlaySystem>();
         _imagesSystem = _entitySystemManager.GetEntitySystem<ClientImagesSystem>();
         _spriteSystem = _entitySystemManager.GetEntitySystem<DMISpriteSystem>();
+        _dreamClientSystem = _entitySystemManager.GetEntitySystem<DreamClientSystem>();
 
         _spriteQuery = _entityManager.GetEntityQuery<DMISpriteComponent>();
         _xformQuery = _entityManager.GetEntityQuery<TransformComponent>();
@@ -120,15 +122,21 @@ public DreamViewOverlay(RenderTargetPool renderTargetPool) {
     protected override void Draw(in OverlayDrawArgs args) {
         using var _ = _prof.Group("Dream View Overlay");
 
-        EntityUid? eye = _playerManager.LocalSession?.AttachedEntity;
-        if (eye == null)
+        var eyeRef = _dreamClientSystem.EyeRef;
+        if (eyeRef.Type == ClientObjectReference.RefType.Entity && !eyeRef.Entity.IsValid()) {
             return;
+        }
+
+        EntityUid mob = _dreamClientSystem.MobUid;
+        if (!mob.IsValid()) {
+            return;
+        }
 
         //Main drawing of sprites happens here
         try {
             var viewportSize = (Vector2i)(args.Viewport.Size / args.Viewport.RenderScale);
 
-            DrawAll(args, eye.Value, viewportSize);
+            DrawAll(args, mob, eyeRef, viewportSize);
         } catch (Exception e) {
             _sawmill.Error($"Error occurred while rendering frame. Error details:\n{e.Message}\n{e.StackTrace}");
         }
@@ -145,20 +153,39 @@ protected override void Draw(in OverlayDrawArgs args) {
             _rendererMetaDataRental.Push(_rendererMetaDataToReturn.Pop());
     }
 
-    private void DrawAll(OverlayDrawArgs args, EntityUid eye, Vector2i viewportSize) {
-        if (!_xformQuery.TryGetComponent(eye, out var eyeTransform))
-            return;
+    private void DrawAll(OverlayDrawArgs args, EntityUid mob, ClientObjectReference eyeRef, Vector2i viewportSize) {
+        MapCoordinates eyeCoords;
+        DreamMobSightComponent? eyeSight;
+        Box2 worldAABB;
+
+        switch (eyeRef.Type) {
+            default:
+                return;
+            case ClientObjectReference.RefType.Turf:
+                eyeCoords = new MapCoordinates(new(eyeRef.TurfX, eyeRef.TurfY), new(eyeRef.TurfZ));
+                _mobSightQuery.TryGetComponent(mob, out eyeSight);
+                worldAABB = args.WorldAABB;
+                worldAABB = worldAABB.Translated(eyeCoords.Position - worldAABB.Center);
+                break;
+            case ClientObjectReference.RefType.Entity:
+                var eyeUid = _entityManager.GetEntity(new(eyeRef.Entity.Id));
+                if (!_xformQuery.TryGetComponent(eyeUid, out var eyeTransform))
+                    return;
+                eyeCoords = _transformSystem.GetMapCoordinates(eyeUid, eyeTransform);
+
+                _mobSightQuery.TryGetComponent(eyeUid, out eyeSight);
+                worldAABB = args.WorldAABB;
+                break;
+        }
 
-        var eyeCoords = _transformSystem.GetMapCoordinates(eye, eyeTransform);
         if (!_mapManager.TryFindGridAt(eyeCoords, out var gridUid, out var grid))
             return;
 
-        _mobSightQuery.TryGetComponent(eye, out var mobSight);
+        _mobSightQuery.TryGetComponent(mob, out var mobSight);
         var seeVis = mobSight?.SeeInvisibility ?? 127;
-        var sight = mobSight?.Sight ?? 0;
+        var sight = eyeSight?.Sight ?? 0;
 
         var worldHandle = args.WorldHandle;
-        var worldAABB = args.WorldAABB;
 
         using (_prof.Group("lookup")) {
             //TODO use a sprite tree.