Added a new system for persisting entity metadata and broadcasting those updates; this is modeled after drop actions and build metadata processors. Initial implementation uses the keypad class as an example (though it doesn't work in game as the nitrox ids for this entity type are not yet spawned by the server).

Sunrunner37 · Sunrunner37 · commit 936a62118f96 · 2020-04-23T23:21:47.000-07:00
diff --git a/NitroxClient/Communication/Packets/Processors/EntityMetadataUpdateProcessor.cs b/NitroxClient/Communication/Packets/Processors/EntityMetadataUpdateProcessor.cs
@@ -0,0 +1,23 @@
+﻿using NitroxClient.Communication.Packets.Processors.Abstract;
+using NitroxClient.GameLogic.Spawning.Metadata;
+using NitroxClient.MonoBehaviours;
+using NitroxModel.DataStructures.Util;
+using NitroxModel.Helper;
+using NitroxModel.Packets;
+using UnityEngine;
+
+namespace NitroxClient.Communication.Packets.Processors
+{
+    public class EntityMetadataUpdateProcessor : ClientPacketProcessor<EntityMetadataUpdate>
+    {
+        public override void Process(EntityMetadataUpdate update)
+        {
+            GameObject gameObject = NitroxEntity.RequireObjectFrom(update.Id);
+
+            Optional<EntityMetadataProcessor> metadataProcessor = EntityMetadataProcessor.FromMetaData(update.NewValue);
+            Validate.IsTrue(metadataProcessor.HasValue, $"No processor found for EntityMetadata of type {update.NewValue.GetType()}");
+            
+            metadataProcessor.Value.ProcessMetadata(gameObject, update.NewValue);
+        }
+    }
+}
diff --git a/NitroxClient/GameLogic/Entities.cs b/NitroxClient/GameLogic/Entities.cs
@@ -5,6 +5,7 @@
 using NitroxClient.MonoBehaviours;
 using NitroxModel.DataStructures;
 using NitroxModel.DataStructures.GameLogic;
+using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
 using NitroxModel.DataStructures.Util;
 using NitroxModel.Helper;
 using NitroxModel.Logger;
@@ -50,6 +51,12 @@ public void BroadcastTransforms(Dictionary<NitroxId, GameObject> gameObjectsById
             packetSender.Send(update);
         }
 
+        public void BroadcastMetadataUpdate(NitroxId id, EntityMetadata metadata)
+        {
+            EntityMetadataUpdate update = new EntityMetadataUpdate(id, metadata);
+            packetSender.Send(update);
+        }
+
         public void Spawn(List<Entity> entities)
         {
             foreach (Entity entity in entities)
diff --git a/NitroxClient/GameLogic/Spawning/DefaultEntitySpawner.cs b/NitroxClient/GameLogic/Spawning/DefaultEntitySpawner.cs
@@ -1,4 +1,5 @@
-﻿using NitroxClient.MonoBehaviours;
+﻿using NitroxClient.GameLogic.Spawning.Metadata;
+using NitroxClient.MonoBehaviours;
 using NitroxModel.DataStructures.GameLogic;
 using NitroxModel.DataStructures.Util;
 using NitroxModel_Subnautica.Helper;
@@ -45,6 +46,13 @@ public Optional<GameObject> Spawn(Entity entity, Optional<GameObject> parent, En
                 gameObject.SetActive(true);
             }
 
+            Optional<EntityMetadataProcessor> metadataProcessor = EntityMetadataProcessor.FromMetaData(entity.Metadata);
+
+            if (metadataProcessor.HasValue)
+            {
+                metadataProcessor.Value.ProcessMetadata(gameObject, entity.Metadata);
+            }
+
             return Optional.Of(gameObject);
         }
 
diff --git a/NitroxClient/GameLogic/Spawning/Metadata/EntityMetadataProcessor.cs b/NitroxClient/GameLogic/Spawning/Metadata/EntityMetadataProcessor.cs
@@ -0,0 +1,47 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
+using NitroxModel.DataStructures.Util;
+using UnityEngine;
+
+namespace NitroxClient.GameLogic.Spawning.Metadata
+{
+    public abstract class EntityMetadataProcessor
+    {
+        public abstract void ProcessMetadata(GameObject gameObject, EntityMetadata metadata);
+        
+        private static Dictionary<Type, Optional<EntityMetadataProcessor>> processorsByType = new Dictionary<Type, Optional<EntityMetadataProcessor>>();
+
+        static EntityMetadataProcessor()
+        {
+            IEnumerable<EntityMetadataProcessor> processors = Assembly.GetExecutingAssembly()
+                                                                         .GetTypes()
+                                                                         .Where(t => typeof(EntityMetadataProcessor).IsAssignableFrom(t) &&
+                                                                                     t.IsClass && 
+                                                                                     !t.IsAbstract
+                                                                               )
+                                                                         .Select(Activator.CreateInstance)
+                                                                         .Cast<EntityMetadataProcessor>();
+
+            foreach (EntityMetadataProcessor processor in processors)
+            {                
+                Type metadataType = processor.GetType().BaseType.GetGenericArguments()[0];
+                processorsByType.Add(metadataType, Optional.Of(processor));
+            }
+        }
+
+        public static Optional<EntityMetadataProcessor> FromMetaData(EntityMetadata metadata)
+        {
+            Optional<EntityMetadataProcessor> processor;
+
+            if (metadata != null && processorsByType.TryGetValue(metadata.GetType(), out processor))
+            {
+                return processor;
+            }
+
+            return Optional.Empty;
+        }
+    }
+}
diff --git a/NitroxClient/GameLogic/Spawning/Metadata/GenericEntityMetadataProcessor.cs b/NitroxClient/GameLogic/Spawning/Metadata/GenericEntityMetadataProcessor.cs
@@ -0,0 +1,15 @@
+﻿using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
+using UnityEngine;
+
+namespace NitroxClient.GameLogic.Spawning.Metadata
+{
+    public abstract class GenericEntityMetadataProcessor<T> : EntityMetadataProcessor where T : EntityMetadata
+    {
+        public abstract void ProcessMetadata(GameObject gameObject, T metadata);
+
+        public override void ProcessMetadata(GameObject gameObject, EntityMetadata metadata)
+        {
+            ProcessMetadata(gameObject, (T)metadata);
+        }
+    }
+}
diff --git a/NitroxClient/GameLogic/Spawning/Metadata/KeypadMetadataProcessor.cs b/NitroxClient/GameLogic/Spawning/Metadata/KeypadMetadataProcessor.cs
@@ -0,0 +1,31 @@
+﻿using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
+using NitroxModel.Logger;
+using UnityEngine;
+
+namespace NitroxClient.GameLogic.Spawning.Metadata
+{
+    public class KeypadMetadataProcessor : GenericEntityMetadataProcessor<KeypadMetadata>
+    {
+        public override void ProcessMetadata(GameObject gameObject, KeypadMetadata metadata)
+        {
+            Log.Info($"Received keypad metadata chagen for {gameObject.name} with data of {metadata}");
+
+            KeypadDoorConsole keypad = gameObject.GetComponent<KeypadDoorConsole>();
+            keypad.unlocked = metadata.Unlocked;
+
+            if (metadata.Unlocked)
+            {
+                if (keypad.root)
+                {
+                    keypad.root.BroadcastMessage("UnlockDoor");
+                }
+                else
+                {
+                    keypad.BroadcastMessage("UnlockDoor");
+                }
+
+                keypad.UnlockDoor();
+            }
+        }
+    }
+}
diff --git a/NitroxClient/GameLogic/Spawning/SerializedEntitySpawner.cs b/NitroxClient/GameLogic/Spawning/SerializedEntitySpawner.cs
@@ -1,5 +1,6 @@
 ﻿using NitroxClient.GameLogic.Helper;
 using NitroxClient.GameLogic.ItemDropActions;
+using NitroxClient.GameLogic.Spawning.Metadata;
 using NitroxClient.MonoBehaviours;
 using NitroxClient.Unity.Helper;
 using NitroxModel.DataStructures;
@@ -30,6 +31,13 @@ public Optional<GameObject> Spawn(Entity entity, Optional<GameObject> parent, En
 
             NitroxEntity.SetNewId(gameObject, entity.Id);
 
+            Optional<EntityMetadataProcessor> metadataProcessor = EntityMetadataProcessor.FromMetaData(entity.Metadata);
+
+            if (metadataProcessor.HasValue)
+            {
+                metadataProcessor.Value.ProcessMetadata(gameObject, entity.Metadata);
+            }
+
             return Optional.Of(gameObject);
         }
 
diff --git a/NitroxClient/NitroxClient.csproj b/NitroxClient/NitroxClient.csproj
@@ -234,6 +234,7 @@
     <Compile Include="ClientAutoFacRegistrar.cs" />
     <Compile Include="Communication\PacketReceiver.cs" />
     <Compile Include="Communication\Packets\Processors\BedEnterProcessor.cs" />
+    <Compile Include="Communication\Packets\Processors\EntityMetadataUpdateProcessor.cs" />
     <Compile Include="Communication\Packets\Processors\PingRenamedProcessor.cs" />
     <Compile Include="Communication\Packets\Processors\RadioPlayPendingMessageProcessor.cs" />
     <Compile Include="Communication\Packets\Processors\ExosuitArmActionProcessor.cs" />
@@ -242,6 +243,9 @@
     <Compile Include="GameLogic\Bases\Spawning\BaseLadderSpawnProcessor.cs" />
     <Compile Include="GameLogic\Bases\Spawning\NoOpBasePieceSpawnProcessor.cs" />
     <Compile Include="GameLogic\ChatUI\PlayerChatManager.cs" />
+    <Compile Include="GameLogic\Spawning\Metadata\KeypadMetadataProcessor.cs" />
+    <Compile Include="GameLogic\Spawning\Metadata\EntityMetadataProcessor.cs" />
+    <Compile Include="GameLogic\Spawning\Metadata\GenericEntityMetadataProcessor.cs" />
     <Compile Include="GameLogic\InitialSync\CyclopsInitialAsyncProcessor.cs" />
     <Compile Include="GameLogic\InitialSync\PlayerModulesInitialSyncProcessor.cs" />
     <Compile Include="GameLogic\InitialSync\StorageSlotsInitialSyncProcessor.cs" />
diff --git a/NitroxModel/DataStructures/GameLogic/Entities/Metadata/EntityMetadata.cs b/NitroxModel/DataStructures/GameLogic/Entities/Metadata/EntityMetadata.cs
@@ -0,0 +1,11 @@
+﻿using System;
+using ProtoBufNet;
+
+namespace NitroxModel.DataStructures.GameLogic.Entities.Metadata
+{
+    [Serializable]
+    [ProtoContract, ProtoInclude(50, typeof(KeypadMetadata))]
+    public abstract class EntityMetadata
+    {
+    }
+}
diff --git a/NitroxModel/DataStructures/GameLogic/Entities/Metadata/KeypadMetadata.cs b/NitroxModel/DataStructures/GameLogic/Entities/Metadata/KeypadMetadata.cs
@@ -0,0 +1,23 @@
+﻿using System;
+using ProtoBufNet;
+
+namespace NitroxModel.DataStructures.GameLogic.Entities.Metadata
+{
+    [Serializable]
+    [ProtoContract]
+    public class KeypadMetadata : EntityMetadata
+    {
+        [ProtoMember(1)]
+        public bool Unlocked { get; }
+        
+        public KeypadMetadata()
+        {
+            // Constructor for serialization
+        }
+
+        public KeypadMetadata(bool unlocked)
+        {
+            Unlocked = Unlocked;
+        }
+    }
+}
diff --git a/NitroxModel/DataStructures/GameLogic/Entity.cs b/NitroxModel/DataStructures/GameLogic/Entity.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
 using ProtoBufNet;
 using UnityEngine;
 
@@ -50,6 +51,9 @@ public class Entity
 
         [ProtoMember(10)]
         public NitroxId ParentId { get; set; }
+        
+        [ProtoMember(11)]
+        public EntityMetadata Metadata { get; set; }
 
         public List<Entity> ChildEntities { get; set; } = new List<Entity>();
 
@@ -68,6 +72,7 @@ public Entity(Vector3 localPosition, Quaternion localRotation, Vector3 scale, Te
             SpawnedByServer = spawnedByServer;
             WaterParkId = null;
             SerializedGameObject = null;
+            Metadata = null;
             ExistsInGlobalRoot = false;
 
             if (parentEntity != null)
diff --git a/NitroxModel/NitroxModel.csproj b/NitroxModel/NitroxModel.csproj
@@ -230,6 +230,8 @@
     <Compile Include="Core\IAutoFacRegistrar.cs" />
     <Compile Include="Core\NitroxEnvironment.cs" />
     <Compile Include="Core\NitroxServiceLocator.cs" />
+    <Compile Include="DataStructures\GameLogic\Entities\Metadata\KeypadMetadata.cs" />
+    <Compile Include="DataStructures\GameLogic\Entities\Metadata\EntityMetadata.cs" />
     <Compile Include="DataStructures\GameLogic\Entities\UwePrefab.cs" />
     <Compile Include="DataStructures\GameLogic\Entities\UwePrefabFactory.cs" />
     <Compile Include="DataStructures\GameLogic\Entities\UweWorldEntity.cs" />
@@ -276,6 +278,7 @@
     <Compile Include="Helper\IPHelper.cs" />
     <Compile Include="Logger\InGameLogger.cs" />
     <Compile Include="Networking\NitroxDeliveryMethod.cs" />
+    <Compile Include="Packets\EntityMetadataUpdate.cs" />
     <Compile Include="Packets\BedEnter.cs" />
     <Compile Include="Packets\EscapePodRadioRepair.cs" />
     <Compile Include="Packets\EscapePodRepair.cs" />
diff --git a/NitroxModel/Packets/EntityMetadataUpdate.cs b/NitroxModel/Packets/EntityMetadataUpdate.cs
@@ -0,0 +1,25 @@
+﻿using System;
+using NitroxModel.DataStructures;
+using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
+
+namespace NitroxModel.Packets
+{
+    [Serializable]
+    public class EntityMetadataUpdate : Packet
+    {
+        public NitroxId Id { get; }
+
+        public EntityMetadata NewValue { get; }
+
+        public EntityMetadataUpdate(NitroxId id, EntityMetadata newValue)
+        {
+            Id = id;
+            NewValue = newValue;
+        }
+
+        public override string ToString()
+        {
+            return $"[EntityMetadataUpdate id={Id} NewValue={NewValue} ]";
+        }
+    }
+}
diff --git a/NitroxPatcher/NitroxPatcher.csproj b/NitroxPatcher/NitroxPatcher.csproj
@@ -227,6 +227,7 @@
     </Compile>
     <Compile Include="Main.cs" />
     <Compile Include="Modules\NitroxPatchesModule.cs" />
+    <Compile Include="Patches\Dynamic\KeypadDoorConsole_AcceptNumberField_Patch.cs" />
     <Compile Include="Patches\Dynamic\Base_CopyFrom_Patch.cs" />
     <Compile Include="Patches\Dynamic\Constructable_SetState_Patch.cs" />
     <Compile Include="Patches\Dynamic\CrashHome_Spawn_Patch.cs" />
diff --git a/NitroxPatcher/Patches/Dynamic/KeypadDoorConsole_AcceptNumberField_Patch.cs b/NitroxPatcher/Patches/Dynamic/KeypadDoorConsole_AcceptNumberField_Patch.cs
@@ -0,0 +1,31 @@
+﻿using System;
+using System.Reflection;
+using Harmony;
+using NitroxClient.GameLogic;
+using NitroxClient.MonoBehaviours;
+using NitroxModel.Core;
+using NitroxModel.DataStructures;
+using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
+
+namespace NitroxPatcher.Patches.Dynamic
+{
+    public class KeypadDoorConsole_AcceptNumberField_Patch : NitroxPatch, IDynamicPatch
+    {
+        public static readonly Type TARGET_CLASS = typeof(KeypadDoorConsole);
+        public static readonly MethodInfo TARGET_METHOD = TARGET_CLASS.GetMethod("AcceptNumberField", BindingFlags.NonPublic | BindingFlags.Instance);
+        
+        public static void Postfix(KeypadDoorConsole __instance)
+        {
+            NitroxId id = NitroxEntity.GetId(__instance.gameObject);
+            KeypadMetadata keypadMetadata = new KeypadMetadata(__instance.unlocked);
+            
+            Entities entities = NitroxServiceLocator.LocateService<Entities>();
+            entities.BroadcastMetadataUpdate(id, keypadMetadata);
+        }
+
+        public override void Patch(HarmonyInstance harmony)
+        {
+            PatchPostfix(harmony, TARGET_METHOD);
+        }
+    }
+}
diff --git a/NitroxServer/Communication/Packets/Processors/EntityMetadataUpdateProcessor.cs b/NitroxServer/Communication/Packets/Processors/EntityMetadataUpdateProcessor.cs
@@ -0,0 +1,50 @@
+﻿using NitroxModel.DataStructures.GameLogic;
+using NitroxModel.DataStructures.Util;
+using NitroxModel.Logger;
+using NitroxModel.Packets;
+using NitroxServer.Communication.Packets.Processors.Abstract;
+using NitroxServer.GameLogic;
+using NitroxServer.GameLogic.Entities;
+
+namespace NitroxServer.Communication.Packets.Processors
+{
+    public class EntityMetadataUpdateProcessor : AuthenticatedPacketProcessor<EntityMetadataUpdate>
+    {
+        private readonly PlayerManager playerManager;
+        private readonly EntityManager entityManager;
+
+        public EntityMetadataUpdateProcessor(PlayerManager playerManager, EntityManager entityManager)
+        {
+            this.playerManager = playerManager;
+            this.entityManager = entityManager;
+        }
+
+        public override void Process(EntityMetadataUpdate packet, Player sendingPlayer)
+        {
+            Optional<Entity> entity = entityManager.GetEntityById(packet.Id);
+
+            if (entity.HasValue)
+            {
+                entity.Value.Metadata = packet.NewValue;
+                SendUpdateToVisiblePlayers(packet, sendingPlayer, entity.Value);
+            }
+            else
+            {
+                Log.Error($"Entity metadata updated on an entity unknown to the server {packet.Id} {packet.NewValue.GetType()} ");
+            }
+        }
+        
+        private void SendUpdateToVisiblePlayers(EntityMetadataUpdate packet, Player sendingPlayer, Entity entity)
+        {
+            foreach (Player player in playerManager.GetConnectedPlayers())
+            {
+                bool updateVisibleToPlayer = player.CanSee(entity) || entity.ExistsInGlobalRoot;
+
+                if (player != sendingPlayer && updateVisibleToPlayer)
+                {
+                    player.SendPacket(packet);
+                }
+            }
+        }
+    }
+}
diff --git a/NitroxServer/NitroxServer.csproj b/NitroxServer/NitroxServer.csproj
