Big refactoring of metadata

NitroxClient/ClientAutoFacRegistrar.cs

@@ -22,7 +22,8 @@
 using NitroxClient.GameLogic.PlayerLogic.PlayerPreferences;
 using NitroxClient.GameLogic.Settings;
 using NitroxClient.GameLogic.Spawning.Metadata;
-using NitroxClient.GameLogic.Spawning.Metadata.Extractor;
+using NitroxClient.GameLogic.Spawning.Metadata.Extractor.Abstract;
+using NitroxClient.GameLogic.Spawning.Metadata.Processor.Abstract;
 using NitroxClient.Map;
 using NitroxModel.Core;
 using NitroxModel.Helper;
@@ -48,12 +49,13 @@ public void RegisterDependencies(ContainerBuilder containerBuilder)
             }
 
             RegisterCoreDependencies(containerBuilder);
+            RegisterMetadataDependencies(containerBuilder);
             RegisterPacketProcessors(containerBuilder);
             RegisterColorSwapManagers(containerBuilder);
             RegisterInitialSyncProcessors(containerBuilder);
         }
 
-        private static void RegisterCoreDependencies(ContainerBuilder containerBuilder)
+        private void RegisterCoreDependencies(ContainerBuilder containerBuilder)
         {
 #if DEBUG
             containerBuilder.RegisterAssemblyTypes(currentAssembly)
@@ -99,18 +101,6 @@ private static void RegisterCoreDependencies(ContainerBuilder containerBuilder)
                             .As<IMap>()
                             .InstancePerLifetimeScope();
 
-            containerBuilder.RegisterAssemblyTypes(currentAssembly)
-                            .AssignableTo<EntityMetadataExtractor>()
-                            .As<EntityMetadataExtractor>()
-                            .AsSelf()
-                            .SingleInstance();
-
-            containerBuilder.RegisterAssemblyTypes(currentAssembly)
-                            .AssignableTo<EntityMetadataProcessor>()
-                            .As<EntityMetadataProcessor>()
-                            .AsSelf()
-                            .SingleInstance();
-
             containerBuilder.RegisterType<PlayerManager>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<PlayerModelManager>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<PlayerVitalsManager>().InstancePerLifetimeScope();
@@ -144,6 +134,21 @@ private static void RegisterCoreDependencies(ContainerBuilder containerBuilder)
             containerBuilder.RegisterType<TimeManager>().InstancePerLifetimeScope();
         }
 
+        private void RegisterMetadataDependencies(ContainerBuilder containerBuilder)
+        {
+            containerBuilder.RegisterAssemblyTypes(currentAssembly)
+                            .AssignableTo<IEntityMetadataExtractor>()
+                            .As<IEntityMetadataExtractor>()
+                            .AsSelf()
+                            .SingleInstance();
+            containerBuilder.RegisterAssemblyTypes(currentAssembly)
+                            .AssignableTo<IEntityMetadataProcessor>()
+                            .As<IEntityMetadataProcessor>()
+                            .AsSelf()
+                            .SingleInstance();
+            containerBuilder.RegisterType<EntityMetadataManager>().InstancePerLifetimeScope();
+        }
+
         private void RegisterPacketProcessors(ContainerBuilder containerBuilder)
         {
             containerBuilder

NitroxClient/Communication/Packets/Processors/BuildingResyncProcessor.cs

@@ -7,6 +7,7 @@
 using NitroxClient.GameLogic;
 using NitroxClient.GameLogic.Bases;
 using NitroxClient.GameLogic.Spawning.Bases;
+using NitroxClient.GameLogic.Spawning.Metadata;
 using NitroxClient.MonoBehaviours;
 using NitroxClient.Unity.Helper;
 using NitroxModel.DataStructures;
@@ -22,10 +23,12 @@ namespace NitroxClient.Communication.Packets.Processors;
 public class BuildingResyncProcessor : ClientPacketProcessor<BuildingResync>
 {
     private readonly Entities entities;
+    private readonly EntityMetadataManager entityMetadataManager;
 
-    public BuildingResyncProcessor(Entities entities)
+    public BuildingResyncProcessor(Entities entities, EntityMetadataManager entityMetadataManager)
     {
         this.entities = entities;
+        this.entityMetadataManager = entityMetadataManager;
     }
 
     public override void Process(BuildingResync packet)
@@ -132,6 +135,7 @@ public IEnumerator OverwriteModule(Constructable constructable, ModuleEntity mod
     {
         Log.Info($"[Module RESYNC] Overwriting module with id {moduleEntity.Id}");
         ModuleEntitySpawner.ApplyModuleData(moduleEntity, constructable.gameObject);
+        entityMetadataManager.ApplyMetadata(constructable.gameObject, moduleEntity.Metadata);
         yield break;
     }
 

NitroxClient/Communication/Packets/Processors/EntityMetadataUpdateProcessor.cs

@@ -1,23 +1,30 @@
-using NitroxClient.Communication.Packets.Processors.Abstract;
+using NitroxClient.Communication.Packets.Processors.Abstract;
 using NitroxClient.GameLogic.Spawning.Metadata;
+using NitroxClient.GameLogic.Spawning.Metadata.Processor.Abstract;
 using NitroxClient.MonoBehaviours;
 using NitroxModel.DataStructures.Util;
 using NitroxModel.Helper;
 using NitroxModel.Packets;
 using UnityEngine;
 
-namespace NitroxClient.Communication.Packets.Processors
+namespace NitroxClient.Communication.Packets.Processors;
+
+public class EntityMetadataUpdateProcessor : ClientPacketProcessor<EntityMetadataUpdate>
 {
-    public class EntityMetadataUpdateProcessor : ClientPacketProcessor<EntityMetadataUpdate>
+    private readonly EntityMetadataManager entityMetadataManager;
+
+    public EntityMetadataUpdateProcessor(EntityMetadataManager entityMetadataManager)
+    {
+        this.entityMetadataManager = entityMetadataManager;
+    }
+
+    public override void Process(EntityMetadataUpdate update)
     {
-        public override void Process(EntityMetadataUpdate update)
-        {
-            GameObject gameObject = NitroxEntity.RequireObjectFrom(update.Id);
+        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()}");
+        Optional<IEntityMetadataProcessor> metadataProcessor = entityMetadataManager.FromMetaData(update.NewValue);
+        Validate.IsTrue(metadataProcessor.HasValue, $"No processor found for EntityMetadata of type {update.NewValue.GetType()}");
 
-            metadataProcessor.Value.ProcessMetadata(gameObject, update.NewValue);
-        }
+        metadataProcessor.Value.ProcessMetadata(gameObject, update.NewValue);
     }
 }

NitroxClient/GameLogic/Bases/BuildUtils.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using NitroxClient.GameLogic.Spawning.Bases;
+using NitroxClient.GameLogic.Spawning.Metadata;
 using NitroxClient.MonoBehaviours;
 using NitroxClient.Unity.Helper;
 using NitroxModel.DataStructures;
@@ -236,14 +237,15 @@ public static MapRoomEntity CreateMapRoomEntityFrom(MapRoomFunctionality mapRoom
         return new(id, parentId, mapRoomCell.ToDto());
     }
 
-    public static List<GlobalRootEntity> GetGlobalRootChildren(Transform globalRoot)
+    // TODO: Use this for a latter singleplayer save converter
+    public static List<GlobalRootEntity> GetGlobalRootChildren(Transform globalRoot, EntityMetadataManager entityMetadataManager)
     {
         List<GlobalRootEntity> entities = new();
         foreach (Transform child in globalRoot)
         {
             if (child.TryGetComponent(out Base @base))
             {
-                entities.Add(BuildEntitySpawner.From(@base));
+                entities.Add(BuildEntitySpawner.From(@base, entityMetadataManager));
             }
             else if (child.TryGetComponent(out Constructable constructable))
             {
@@ -258,7 +260,7 @@ public static List<GlobalRootEntity> GetGlobalRootChildren(Transform globalRoot)
         return entities;
     }
 
-    public static List<Entity> GetChildEntities(Base targetBase, NitroxId baseId)
+    public static List<Entity> GetChildEntities(Base targetBase, NitroxId baseId, EntityMetadataManager entityMetadataManager)
     {
         List<Entity> childEntities = new();
         void AddChild(Entity childEntity)
@@ -286,7 +288,7 @@ void AddChild(Entity childEntity)
                     continue;
                 }
                 MonoBehaviour moduleMB = baseModule as MonoBehaviour;
-                AddChild(InteriorPieceEntitySpawner.From(baseModule));
+                AddChild(InteriorPieceEntitySpawner.From(baseModule, entityMetadataManager));
             }
             else if (transform.TryGetComponent(out Constructable constructable))
             {

NitroxClient/GameLogic/Bases/BuildingHandler.cs

@@ -5,12 +5,14 @@
 using NitroxClient.Communication;
 using NitroxClient.Communication.Abstract;
 using NitroxClient.GameLogic.Spawning.Bases;
+using NitroxClient.GameLogic.Spawning.Metadata;
 using NitroxClient.MonoBehaviours;
 using NitroxClient.Unity.Helper;
 using NitroxModel.DataStructures;
 using NitroxModel.DataStructures.GameLogic;
 using NitroxModel.DataStructures.GameLogic.Bases;
 using NitroxModel.DataStructures.GameLogic.Entities.Bases;
+using NitroxModel.DataStructures.Util;
 using NitroxModel.Packets;
 using NitroxModel_Subnautica.DataStructures;
 using UnityEngine;
@@ -126,7 +128,12 @@ public IEnumerator BuildModule(PlaceModule placeModule)
     {
         ModuleEntity moduleEntity = placeModule.ModuleEntity;
         Transform parent = GetParentOrGlobalRoot(moduleEntity.ParentId);
-        yield return ModuleEntitySpawner.RestoreModule(parent, moduleEntity);
+        TaskResult<Optional<GameObject>> result = new();
+        yield return ModuleEntitySpawner.RestoreModule(parent, moduleEntity, result);
+        if (result.value.HasValue)
+        {
+            this.Resolve<EntityMetadataManager>().ApplyMetadata(result.value.Value.gameObject, moduleEntity.Metadata);
+        }
         BasesCooldown[moduleEntity.ParentId ?? moduleEntity.Id] = DateTimeOffset.UtcNow;
     }
 

NitroxClient/GameLogic/Entities.cs

@@ -2,13 +2,13 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
+using NitroxClient.Communication;
 using NitroxClient.Communication.Abstract;
 using NitroxClient.GameLogic.PlayerLogic.PlayerModel.Abstract;
 using NitroxClient.GameLogic.Spawning;
 using NitroxClient.GameLogic.Spawning.Abstract;
 using NitroxClient.GameLogic.Spawning.Bases;
 using NitroxClient.GameLogic.Spawning.Metadata;
-using NitroxClient.GameLogic.Spawning.Metadata.Extractor;
 using NitroxClient.MonoBehaviours;
 using NitroxClient.Unity.Helper;
 using NitroxModel.DataStructures;
@@ -28,6 +28,7 @@ public class Entities
     {
         private readonly IPacketSender packetSender;
         private readonly ThrottledPacketSender throttledPacketSender;
+        private readonly EntityMetadataManager entityMetadataManager;
 
         private readonly Dictionary<NitroxId, Type> spawnedAsType = new();
         private readonly Dictionary<NitroxId, List<Entity>> pendingParentEntitiesByParentId = new Dictionary<NitroxId, List<Entity>>();
@@ -37,10 +38,11 @@ public class Entities
         public List<Entity> EntitiesToSpawn { get; private init; }
         private bool spawningEntities;
 
-        public Entities(IPacketSender packetSender, ThrottledPacketSender throttledPacketSender, PlayerManager playerManager, ILocalNitroxPlayer localPlayer)
+        public Entities(IPacketSender packetSender, ThrottledPacketSender throttledPacketSender, EntityMetadataManager entityMetadataManager, PlayerManager playerManager, ILocalNitroxPlayer localPlayer)
         {
             this.packetSender = packetSender;
             this.throttledPacketSender = throttledPacketSender;
+            this.entityMetadataManager = entityMetadataManager;
             EntitiesToSpawn = new();
 
             entitySpawnersByType[typeof(PrefabChildEntity)] = new PrefabChildEntitySpawner();
@@ -49,7 +51,7 @@ public Entities(IPacketSender packetSender, ThrottledPacketSender throttledPacke
             entitySpawnersByType[typeof(InstalledBatteryEntity)] = new InstalledBatteryEntitySpawner();
             entitySpawnersByType[typeof(InventoryEntity)] = new InventoryEntitySpawner();
             entitySpawnersByType[typeof(InventoryItemEntity)] = new InventoryItemEntitySpawner();
-            entitySpawnersByType[typeof(WorldEntity)] = new WorldEntitySpawner(playerManager, localPlayer, this);
+            entitySpawnersByType[typeof(WorldEntity)] = new WorldEntitySpawner(entityMetadataManager, playerManager, localPlayer, this);
             entitySpawnersByType[typeof(PlaceholderGroupWorldEntity)] = entitySpawnersByType[typeof(WorldEntity)];
             entitySpawnersByType[typeof(EscapePodWorldEntity)] = entitySpawnersByType[typeof(WorldEntity)];
             entitySpawnersByType[typeof(PlayerWorldEntity)] = entitySpawnersByType[typeof(WorldEntity)];
@@ -58,12 +60,12 @@ public Entities(IPacketSender packetSender, ThrottledPacketSender throttledPacke
             entitySpawnersByType[typeof(BuildEntity)] = new BuildEntitySpawner(this);
             entitySpawnersByType[typeof(ModuleEntity)] = new ModuleEntitySpawner(this);
             entitySpawnersByType[typeof(GhostEntity)] = new GhostEntitySpawner();
-            entitySpawnersByType[typeof(InteriorPieceEntity)] = new InteriorPieceEntitySpawner(this);
+            entitySpawnersByType[typeof(InteriorPieceEntity)] = new InteriorPieceEntitySpawner(this, entityMetadataManager);
         }
 
         public void EntityMetadataChanged(object o, NitroxId id)
         {
-            Optional<EntityMetadata> metadata = EntityMetadataExtractor.Extract(o);
+            Optional<EntityMetadata> metadata = entityMetadataManager.Extract(o);
 
             if (metadata.HasValue)
             {
@@ -73,7 +75,12 @@ public void EntityMetadataChanged(object o, NitroxId id)
 
         public void EntityMetadataChangedThrottled(object o, NitroxId id, float throttleTime = 0.2f)
         {
-            Optional<EntityMetadata> metadata = EntityMetadataExtractor.Extract(o);
+            // As throttled broadcasting is done after some time by a different function, this is where the packet sending should be interrupted
+            if (PacketSuppressor<EntityMetadataUpdate>.IsSuppressed)
+            {
+                return;
+            }
+            Optional<EntityMetadata> metadata = entityMetadataManager.Extract(o);
 
             if (metadata.HasValue)
             {
@@ -175,7 +182,7 @@ public IEnumerator SpawnBatchAsync(List<Entity> batch, bool forceRespawn = false
 
                 MarkAsSpawned(entity);
 
-                EntityMetadataProcessor.ApplyMetadata(entityResult.Get().Value, entity.Metadata);
+                entityMetadataManager.ApplyMetadata(entityResult.Get().Value, entity.Metadata);
 
                 // Finding out about all children (can be hidden in the object's hierarchy or in a pending list)
 

NitroxClient/GameLogic/ItemContainers.cs

@@ -2,26 +2,28 @@
 using NitroxClient.Communication.Abstract;
 using NitroxClient.GameLogic.Helper;
 using NitroxClient.GameLogic.PlayerLogic;
-using NitroxClient.GameLogic.Spawning.Metadata.Extractor;
+using NitroxClient.GameLogic.Spawning.Metadata;
 using NitroxClient.MonoBehaviours;
 using NitroxClient.Unity.Helper;
 using NitroxModel.DataStructures;
-using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
 using NitroxModel.DataStructures.GameLogic.Entities;
+using NitroxModel.DataStructures.GameLogic.Entities.Metadata;
 using NitroxModel.DataStructures.Util;
 using NitroxModel.Packets;
-using UnityEngine;
 using NitroxModel_Subnautica.DataStructures;
+using UnityEngine;
 
 namespace NitroxClient.GameLogic
 {
     public class ItemContainers
     {
         private readonly IPacketSender packetSender;
+        private readonly EntityMetadataManager entityMetadataManager;
 
-        public ItemContainers(IPacketSender packetSender)
+        public ItemContainers(IPacketSender packetSender, EntityMetadataManager entityMetadataManager)
         {
             this.packetSender = packetSender;
+            this.entityMetadataManager = entityMetadataManager;
         }
 
         public void BroadcastItemAdd(Pickupable pickupable, Transform containerTransform)
@@ -85,7 +87,7 @@ public void BroadcastBatteryAdd(GameObject gameObject, GameObject parent, TechTy
                 return;
             }
 
-            Optional<EntityMetadata> metadata = EntityMetadataExtractor.Extract(gameObject);
+            Optional<EntityMetadata> metadata = entityMetadataManager.Extract(gameObject);
 
             InstalledBatteryEntity installedBattery = new(id, techType.ToDto(), metadata.OrNull(), parentId, new());