Fixed several edge-cases issues for WaterParks and finished its basic…

… inventory/fishes sync/restore for larger water parks. Split PostSpawnProcessors into for Constructables and Modules.

NitroxClient/ClientAutoFacRegistrar.cs

@@ -121,8 +121,14 @@ private static void RegisterCoreDependencies(ContainerBuilder containerBuilder)
                             .SingleInstance();
 
             containerBuilder.RegisterAssemblyTypes(currentAssembly)
-                            .AssignableTo<IEntityPostSpawner>()
-                            .As<IEntityPostSpawner>()
+                            .AssignableTo<IConstructablePostSpawner>()
+                            .As<IConstructablePostSpawner>()
+                            .AsSelf()
+                            .SingleInstance();
+
+            containerBuilder.RegisterAssemblyTypes(currentAssembly)
+                            .AssignableTo<IBaseModulePostSpawner>()
+                            .As<IBaseModulePostSpawner>()
                             .AsSelf()
                             .SingleInstance();
 

NitroxClient/Communication/Packets/Processors/EntityReparentedProcessor.cs

@@ -34,6 +34,25 @@ public override void Process(EntityReparented packet)
 
         GameObject newParent = NitroxEntity.RequireObjectFrom(packet.NewParentId);
 
+        if (entity.Value.TryGetComponent(out Pickupable pickupable))
+        {
+            // If the entity is being parented to a WaterPark
+            if (newParent.TryGetComponent(out WaterPark waterPark))
+            {
+                pickupable.SetVisible(false);
+                pickupable.Activate(false);
+                waterPark.AddItem(pickupable);
+                // The reparenting is automatic here so we don't need to continue
+                return;
+            }
+            // If the entity was parented to a WaterPark but is picked up by someone
+            else if (pickupable.TryGetComponent(out WaterParkItem waterParkItem))
+            {
+                pickupable.Deactivate();
+                waterParkItem.SetWaterPark(null);
+            }
+        }
+
         using (PacketSuppressor<EntityReparented>.Suppress())
         {
             Type entityType = entities.RequireEntityType(packet.Id);

NitroxClient/GameLogic/Bases/New/BuildManager.cs

@@ -10,6 +10,7 @@
 using NitroxModel.DataStructures;
 using NitroxModel.DataStructures.GameLogic;
 using NitroxModel.DataStructures.GameLogic.Buildings.New;
+using NitroxModel.DataStructures.GameLogic.Entities;
 using NitroxModel.DataStructures.GameLogic.Entities.Bases;
 using NitroxModel.DataStructures.Util;
 using NitroxModel_Subnautica.DataStructures;
@@ -85,13 +86,21 @@ public static bool TryGetGhostFace(BaseGhost baseGhost, out Base.Face face)
         return false;
     }
 
+    /// <remarks>
+    /// Even if the corresponding module was found, in some cases (with WaterParks notably) we don't want to transfer the id
+    /// we then return false because the gameobject may have already been marked.
+    /// </remarks>
+    /// <returns>
+    /// Whether or not the id was successfully transferred
+    /// </returns>
     public static bool TryTransferIdFromGhostToModule(BaseGhost baseGhost, NitroxId id, ConstructableBase constructableBase, out GameObject moduleObject)
     {
         Log.Debug($"TryTransferIdFromGhostToModule({baseGhost},{id})");
+        // 1. Find the face of the target piece
         Base.Face? face = null;
         bool isWaterPark = baseGhost is BaseAddWaterPark;
         bool isMapRoomGhost = baseGhost is BaseAddMapRoomGhost;
-        // Only three types of ghost which spawn a module
+        // Only four types of ghost which spawn a module
         if ((baseGhost is BaseAddFaceGhost faceGhost && faceGhost.modulePrefab) ||
             (baseGhost is BaseAddModuleGhost moduleGhost && moduleGhost.modulePrefab) ||
             isMapRoomGhost ||
@@ -131,14 +140,10 @@ public static bool TryTransferIdFromGhostToModule(BaseGhost baseGhost, NitroxId
                     break;
 
                 case TechType.BaseMoonpool:
-                    // Moonpools are a very specific case, we tweak them to work as modules (while they're not)
+                    // Moonpools are a very specific case, we tweak them to work as interior pieces (while they're not)
                     Optional<GameObject> objectOptional = baseGhost.targetBase.gameObject.EnsureComponent<MoonpoolManager>().RegisterMoonpool(constructableBase.transform, id);
                     moduleObject = objectOptional.Value;
-                    if (objectOptional.HasValue)
-                    {
-                        return true;
-                    }
-                    return false;
+                    return moduleObject;
 
                 case TechType.BaseMapRoom:
                     // In the case the ghost is under a BaseDeconstructable, this is a good way to identify a MapRoom
@@ -152,59 +157,60 @@ public static bool TryTransferIdFromGhostToModule(BaseGhost baseGhost, NitroxId
             }
         }
 
-        if (face.HasValue)
+        if (!face.HasValue)
         {
-            if (isMapRoomGhost)
+            if (constructableBase.techType != TechType.BaseWaterPark)
             {
-                MapRoomFunctionality mapRoomFunctionality = baseGhost.targetBase.GetMapRoomFunctionalityForCell(face.Value.cell);
-                if (mapRoomFunctionality)
-                {
-                    // As MapRooms can be built as the first piece of a base, we need to make sure that they receive a new id if they're not in a base
-                    if (constructableBase.GetComponentInParent<Base>(true))
-                    {
-                        NitroxEntity.SetNewId(mapRoomFunctionality.gameObject, id);
-                    }
-                    else
-                    {
-                        NitroxEntity.SetNewId(mapRoomFunctionality.gameObject, id.Increment());
-                    }
-                    moduleObject = mapRoomFunctionality.gameObject;
-                    return true;
-                }
-                Log.Error($"Couldn't find MapRoomFunctionality of built MapRoom (cell: {face.Value.cell})");
-                moduleObject = null;
-                return false;
+                Log.Error($"No face could be found for ghost {baseGhost}");
             }
+            moduleObject = null;
+            return false;
+        }
 
-            IBaseModule module = baseGhost.targetBase.GetModule(face.Value);
-            if (module != null)
+        // 2. Use that face to find the newly created piece and set its id to the desired one
+        if (isMapRoomGhost)
+        {
+            MapRoomFunctionality mapRoomFunctionality = baseGhost.targetBase.GetMapRoomFunctionalityForCell(face.Value.cell);
+            if (mapRoomFunctionality)
             {
-                moduleObject = (module as Component).gameObject;
-                // If the WaterPark is higher than one, it means that the newly built WaterPark will be merged with one that already has a NitroxEntity
-                if (module is WaterPark waterPark && waterPark.height > 1)
+                // As MapRooms can be built as the first piece of a base, we need to make sure that they receive a new id if they're not in a base
+                if (constructableBase.GetComponentInParent<Base>(true))
                 {
-                    Log.Debug($"Found WaterPark higher than 1 {waterPark.height}, not transferring NitroxEntity to it");
-                    return true;
+                    NitroxEntity.SetNewId(mapRoomFunctionality.gameObject, id);
                 }
-
-                Log.Debug($"Successfully transferred NitroxEntity to {module} [{id}]");
-                NitroxEntity.SetNewId(moduleObject, id);
+                else
+                {
+                    NitroxEntity.SetNewId(mapRoomFunctionality.gameObject, id.Increment());
+                }
+                moduleObject = mapRoomFunctionality.gameObject;
                 return true;
             }
-            else
+            Log.Error($"Couldn't find MapRoomFunctionality of built MapRoom (cell: {face.Value.cell})");
+            moduleObject = null;
+            return false;
+        }
+
+        IBaseModule module = baseGhost.targetBase.GetModule(face.Value);
+        if (module != null)
+        {
+            // If the WaterPark is higher than one, it means that the newly built WaterPark will be merged with one that already has a NitroxEntity
+            if (module is WaterPark waterPark && waterPark.height > 1)
             {
-                // When a WaterPark is merged with another one, we won't find its module but we don't care about that
-                if (isWaterPark)
-                {
-                    moduleObject = null;
-                    return false;
-                }
-                Log.Error("Couldn't find the module's GameObject of built interior piece when transfering its NitroxEntity to the module.");
+                Log.Debug($"Found WaterPark higher than 1 [{waterPark.height}], not transferring NitroxEntity to it");
+                // as the WaterPark is necessarily merged, we won't need to do anything about it
+                moduleObject = null;
+                return false;
             }
+
+            Log.Debug($"Successfully transferred NitroxEntity to {module} [{id}]");
+            moduleObject = (module as Component).gameObject;
+            NitroxEntity.SetNewId(moduleObject, id);
+            return true;
         }
-        else
+        // When a WaterPark is merged with another one, we won't find its module but we don't care about that
+        else if (!isWaterPark)
         {
-            Log.Error($"No face could be found for ghost {baseGhost}");
+            Log.Error("Couldn't find the module's GameObject of built interior piece when transfering its NitroxEntity to the module.");
         }
 
         moduleObject = null;
@@ -237,9 +243,6 @@ public static Int3 GetMapRoomFunctionalityCell(BaseGhost baseGhost)
     }
 }
 
-
-// TODO: Add further metadata in modules and interior pieces
-
 public static class NitroxGlobalRoot
 {
     public static SavedGlobalRoot From(Transform globalRoot)
@@ -461,7 +464,6 @@ public static IEnumerator RestoreModule(Transform parent, ModuleEntity moduleEnt
 
         Constructable constructable = moduleObject.GetComponent<Constructable>();
         constructable.SetIsInside(moduleEntity.IsInside);
-        // TODO: If IsInside is false, maybe set a null environment
         SkyEnvironmentChanged.Send(moduleObject, moduleObject.GetComponentInParent<SubRoot>(true));
         constructable.constructedAmount = moduleEntity.ConstructedAmount;
         constructable.SetState(moduleEntity.ConstructedAmount >= 1f, false);
@@ -517,8 +519,6 @@ public static IEnumerator RestoreGhost(Transform parent, GhostEntity ghostEntity
 
         yield return NitroxGhostMetadata.ApplyMetadataToGhost(baseGhost, ghostEntity.Metadata, @base);
 
-        // TODO: Fix hatch ghosts showing the wrong model
-        // TODO: Fix ghost visual glitch (probably a duplicate model) (black ghost)
         // Necessary to wait for BaseGhost.Start()
         yield return null;
         // Verify that the metadata didn't destroy the GameObject
@@ -766,9 +766,17 @@ public static InteriorPieceEntity From(IBaseModule module)
         }
 
         // TODO: Verify if this is necessary or not
-        // EDIT: This is most likely not
+        // EDIT: This is most likely not, apart from the PlanterEntity which is important
         switch (module)
         {
+            case LargeRoomWaterPark largeRoomWaterPark:
+                PlanterEntity leftPlanter = new(interiorPiece.Id.Increment(), interiorPiece.Id);
+                PlanterEntity rightPlanter = new(leftPlanter.Id.Increment(), interiorPiece.Id);
+                interiorPiece.ChildEntities.Add(leftPlanter);
+                interiorPiece.ChildEntities.Add(rightPlanter);
+                // TODO: Eventually add the children items as entities
+                interiorPiece.Constructed = largeRoomWaterPark.constructed;
+                break;
             case WaterPark waterPark:
                 interiorPiece.Constructed = waterPark.constructed;
                 break;

NitroxClient/GameLogic/Bases/New/BuildingTester.cs

@@ -31,9 +31,8 @@ public class BuildingTester : MonoBehaviour
     public int Slot = 0;
     private JsonSerializer serializer;
     public string SavePath = Path.Combine(NitroxUser.LauncherPath, "SavedBases");
-
-    public NitroxId TempId;
-    public InteriorPieceEntity NewWaterPark;
+
+    public TemporaryBuildData Temp;
     public Dictionary<NitroxId, DateTimeOffset> BasesCooldown;
     /// <summary>
     /// Time in milliseconds before local player can build on a base that was modified by another player
@@ -44,6 +43,7 @@ public void Start()
     {
         Main = this;
         BuildQueue = new();
+        Temp = new();
         BasesCooldown = new();
         serializer = new();
         serializer.NullValueHandling = NullValueHandling.Ignore;
@@ -173,14 +173,16 @@ public IEnumerator BuildBase(PlaceBase placeBase)
     public IEnumerator UpdatePlacedBase(UpdateBase updateBase)
     {
         // Is probably useless check but can probably be useful for desync detection
-        if (!NitroxEntity.TryGetComponentFrom(updateBase.BaseId, out Base parentBase))
+        if (!NitroxEntity.TryGetComponentFrom<Base>(updateBase.BaseId, out _))
         {
             Log.Debug("Couldn't find the parentBase");
             // TODO: Ask for resync
             yield break;
         }
         if (NitroxEntity.TryGetComponentFrom(updateBase.FormerGhostId, out ConstructableBase constructableBase))
         {
+            Temp.ChildrenTransfer = updateBase.ChildrenTransfer;
+
             BaseGhost baseGhost = constructableBase.model.GetComponent<BaseGhost>();
             constructableBase.SetState(true, true);
             BasesCooldown[updateBase.BaseId] = DateTimeOffset.Now;
@@ -251,18 +253,13 @@ public IEnumerator DeconstructPiece(PieceDeconstructed pieceDeconstructed)
                 continue;
             }
             Log.Debug($"Found a BaseDeconstructable {baseDeconstructable.name}, will now deconstruct it manually");
-            using (new PacketSuppressor<BaseDeconstructed>())
-            using (new PacketSuppressor<PieceDeconstructed>())
-            using (new PacketSuppressor<WaterParkDeconstructed>())
+            using (PacketSuppressor<BaseDeconstructed>.Suppress())
+            using (PacketSuppressor<PieceDeconstructed>.Suppress())
+            using (PacketSuppressor<WaterParkDeconstructed>.Suppress())
             {
-                TempId = pieceDeconstructed.PieceId;
-                if (pieceDeconstructed is WaterParkDeconstructed waterParkDeconstructed)
-                {
-                    NewWaterPark = waterParkDeconstructed.NewWaterPark;
-                }
+                Temp.Fill(pieceDeconstructed);
                 baseDeconstructable.Deconstruct();
-                TempId = null;
-                NewWaterPark = null;
+                Temp.Reset();
             }
             BasesCooldown[pieceDeconstructed.BaseId] = DateTimeOffset.Now;
             yield break;
@@ -442,4 +439,32 @@ public void DeleteTargetBase()
         }
     }
 
+    public class TemporaryBuildData
+    {
+        public NitroxId Id;
+        public InteriorPieceEntity NewWaterPark;
+        public List<NitroxId> MovedChildrenIds;
+        public (NitroxId, NitroxId) ChildrenTransfer;
+        public bool Transfer;
+
+        public void Fill(PieceDeconstructed pieceDeconstructed)
+        {
+            Id = pieceDeconstructed.PieceId;
+            if (pieceDeconstructed is WaterParkDeconstructed waterParkDeconstructed)
+            {
+                NewWaterPark = waterParkDeconstructed.NewWaterPark;
+                MovedChildrenIds = waterParkDeconstructed.MovedChildrenIds;
+                Transfer = waterParkDeconstructed.Transfer;
+            }
+        }
+
+        public void Reset()
+        {
+            Id = null;
+            NewWaterPark = null;
+            MovedChildrenIds = null;
+            ChildrenTransfer = (null, null);
+            Transfer = false;
+        }
+    }
 }

NitroxClient/GameLogic/Bases/New/NitroxGhostMetadata.cs

@@ -12,8 +12,10 @@ public static class NitroxGhostMetadata
 {
     public static T From<T>(BaseGhost baseGhost) where T : GhostMetadata, new()
     {
-        T metadata = new();
-        metadata.TargetOffset = baseGhost.targetOffset.ToDto();
+        T metadata = new()
+        {
+            TargetOffset = baseGhost.targetOffset.ToDto()
+        };
         return metadata;
     }
 
@@ -91,8 +93,10 @@ public static BaseDeconstructableGhostMetadata From(BaseGhost baseGhost)
         BaseDeconstructableGhostMetadata metadata = NitroxGhostMetadata.From<BaseDeconstructableGhostMetadata>(baseGhost);
         if (baseGhost.TryGetComponentInParent(out ConstructableBase constructableBase) && constructableBase.moduleFace.HasValue)
         {
-            metadata.ModuleFace = constructableBase.moduleFace.Value.ToDto();
-            IBaseModule baseModule = baseGhost.targetBase.GetModule(constructableBase.moduleFace.Value);
+            Base.Face moduleFace = constructableBase.moduleFace.Value;
+            metadata.ModuleFace = moduleFace.ToDto();
+            moduleFace.cell += baseGhost.targetBase.GetAnchor();
+            IBaseModule baseModule = baseGhost.targetBase.GetModule(moduleFace);
             if (baseModule != null && (baseModule as MonoBehaviour).TryGetComponent(out PrefabIdentifier identifier))
             {
                 metadata.ClassId = identifier.ClassId;

NitroxClient/GameLogic/Entities.cs

@@ -48,6 +48,7 @@ public Entities(IPacketSender packetSender, ThrottledPacketSender throttledPacke
             entitySpawnersByType[typeof(EscapePodWorldEntity)] = entitySpawnersByType[typeof(WorldEntity)];
             entitySpawnersByType[typeof(PlayerWorldEntity)] = entitySpawnersByType[typeof(WorldEntity)];
             entitySpawnersByType[typeof(VehicleWorldEntity)] = entitySpawnersByType[typeof(WorldEntity)];
+            entitySpawnersByType[typeof(GlobalRootEntity)] = entitySpawnersByType[typeof(WorldEntity)];
             entitySpawnersByType[typeof(BuildEntity)] = new BuildEntitySpawner(this);
             entitySpawnersByType[typeof(ModuleEntity)] = new ModuleEntitySpawner(this);
             entitySpawnersByType[typeof(GhostEntity)] = new GhostEntitySpawner();
@@ -100,7 +101,7 @@ public IEnumerator SpawnAsync(IEnumerable<Entity> entities)
                         UpdatePosition(worldEntity);
                     }
                 }
-                else if (entity.ParentId != null && !WasParentSpawned(entity.ParentId))
+                else if (entity.ParentId != null && !IsParentReady(entity.ParentId))
                 {
                     AddPendingParentEntity(entity);
                 }
@@ -214,6 +215,11 @@ public Type RequireEntityType(NitroxId id)
             throw new InvalidOperationException($"Did not have a type for {id}");
         }
 
+        public bool IsParentReady(NitroxId id)
+        {
+            return WasParentSpawned(id) || (NitroxEntity.TryGetObjectFrom(id, out GameObject o) && o);
+        }
+
         public bool WasParentSpawned(NitroxId id)
         {
             return spawnedAsType.ContainsKey(id);