Merge branch 'master' into docs

SubnauticaModding · May 6, 2024 · a1d3154 · a1d3154
2 parents 4247854 + a36127f
commit a1d3154
Show file tree

Hide file tree

Showing 17 changed files with 12,462 additions and 37 deletions.
diff --git a/Nautilus/Assets/CustomPrefabExtensions.cs b/Nautilus/Assets/CustomPrefabExtensions.cs
@@ -0,0 +1,32 @@
+using Nautilus.Utility;
+
+namespace Nautilus.Assets;
+
+/// <summary>
+/// Represents extension methods for the <see cref="CustomPrefab"/> class.
+/// </summary>
+public static class CustomPrefabExtensions
+{
+    /// <summary>
+    /// Removes the current prefab from the prefab cache and doesn't allow it to get cached later.
+    /// </summary>
+    /// <param name="customPrefab">The custom prefab to remove from the prefab cache.</param>
+    /// <returns>A reference to this instance after the operation has completed.</returns>
+    public static ICustomPrefab RemoveFromCache(this CustomPrefab customPrefab)
+    {
+        if (customPrefab.Info == default)
+        {
+            return customPrefab;
+        }
+
+        if (string.IsNullOrWhiteSpace(customPrefab.Info.ClassID))
+        {
+            InternalLogger.Error($"Couldn't remove prefab '{customPrefab.Info}' from cache because the class ID is null.");
+            return customPrefab;
+        }
+
+        ModPrefabCache.RemovePrefabFromCache(customPrefab.Info.ClassID);
+
+        return customPrefab;
+    }
+}
diff --git a/Nautilus/Assets/ModPrefabCache.cs b/Nautilus/Assets/ModPrefabCache.cs
@@ -1,6 +1,7 @@
 using Nautilus.Utility;
 using System.Collections.Generic;
 using Nautilus.Extensions;
+using Nautilus.Handlers;
 using UnityEngine;
 
 namespace Nautilus.Assets;
@@ -16,7 +17,7 @@ public static class ModPrefabCache
     private static ModPrefabCacheInstance _cacheInstance;
 
     /// <summary> Adds the given prefab to the cache. </summary>
-    /// <param name="prefab"> The prefab object that is disabled and cached. </param>
+    /// <param name="prefab"> The prefab object that is disabled and cached.</param>
     public static void AddPrefab(GameObject prefab)
     {
         EnsureCacheExists();
@@ -38,10 +39,15 @@ public static bool IsPrefabCached(string classId)
     /// Any prefab with the matching <paramref name="classId"/> will be removed from the cache.
     /// </summary>
     /// <param name="classId">The class id of the prefab that will be removed.</param>
+    /// <remarks>This operation is extremely dangerous on custom prefabs that are directly registering an asset bundle prefab as it may make the prefab unusable in the current session.<br/>Avoid using this method unless you know what you're doing.</remarks>
     public static void RemovePrefabFromCache(string classId)
     {
-        if(_cacheInstance == null)
+        if (_cacheInstance == null)
+        {
+            InternalLogger.Debug($"Removed '{classId}' from prefab cache.");
+            ModPrefabCacheInstance.BannedPrefabs.Add(classId);
             return;
+        }
 
         _cacheInstance.RemoveCachedPrefab(classId);
     }
@@ -73,7 +79,10 @@ private static void EnsureCacheExists()
 
 internal class ModPrefabCacheInstance: MonoBehaviour
 {
-    public Dictionary<string, GameObject> Entries { get; } = new Dictionary<string, GameObject>();
+    public Dictionary<string, GameObject> Entries { get; } = new();
+
+    // Prefabs that are banned from getting cached
+    internal static readonly HashSet<string> BannedPrefabs = new();
 
     private Transform _prefabRoot;
 
@@ -85,7 +94,9 @@ private void Awake()
 
         gameObject.AddComponent<SceneCleanerPreserve>();
         DontDestroyOnLoad(gameObject);
+
         SaveUtils.RegisterOnQuitEvent(ModPrefabCache.RunningPrefabs.Clear);
+        SaveUtils.RegisterOnQuitEvent(RemoveFakePrefabs);
     }
 
     public void EnterPrefabIntoCache(GameObject prefab)
@@ -98,6 +109,11 @@ public void EnterPrefabIntoCache(GameObject prefab)
             return;
         }
 
+        if (BannedPrefabs.Contains(prefabIdentifier.classId))
+        {
+            return;
+        }
+
         if (!Entries.ContainsKey(prefabIdentifier.classId))
         {
             Entries.Add(prefabIdentifier.classId, prefab);
@@ -122,12 +138,46 @@ public void EnterPrefabIntoCache(GameObject prefab)
 
     public void RemoveCachedPrefab(string classId)
     {
-        if (Entries.TryGetValue(classId, out var prefab))
+        BannedPrefabs.Add(classId);
+
+        if (!Entries.TryGetValue(classId, out var prefab))
+        {
+            return;
+        }
+
+        if (!prefab)
         {
-            if(!prefab.IsPrefab())
-                Destroy(prefab);
-            InternalLogger.Debug($"ModPrefabCache: removed prefab {classId}");
+            InternalLogger.Debug($"ModPrefabCache: Prefab for '{classId}' is null; removing entry.");
             Entries.Remove(classId);
+            return;
+        }
+
+        if (!prefab.IsPrefab())
+        {
+            Destroy(prefab);
+        }
+
+        Entries.Remove(classId);
+        InternalLogger.Debug($"ModPrefabCache: removing prefab '{classId}'");
+    }
+
+    private void RemoveFakePrefabs()
+    {
+        foreach (var prefab in new Dictionary<string, GameObject>(Entries))
+        {
+            if (prefab.Value.Exists() is null)
+            {
+                Entries.Remove(prefab.Key);
+                continue;
+            }
+
+            if (prefab.Value.IsPrefab())
+            {
+                continue;
+            }
+
+            Destroy(prefab.Value);
+            Entries.Remove(prefab.Key);
         }
     }
 

diff --git a/Nautilus/Assets/ModPrefabRequest.cs b/Nautilus/Assets/ModPrefabRequest.cs
@@ -50,7 +50,7 @@ public object Current
 
     public bool TryGetPrefab(out GameObject result)
     {
-        return ModPrefabCache.TryGetPrefabFromCache(prefabInfo.ClassID, out result) && result != null;
+        return result = taskResult.Get();
     }
 
     public bool MoveNext()
@@ -66,6 +66,7 @@ public bool MoveNext()
     public void Reset()
     {
         task.Reset();
+        taskResult.Set(null);
         Done = false;
     }
 

diff --git a/Nautilus/Assets/PrefabTemplates/AtmosphereVolumeTemplate.cs b/Nautilus/Assets/PrefabTemplates/AtmosphereVolumeTemplate.cs
@@ -66,6 +66,7 @@ public AtmosphereVolumeTemplate(PrefabInfo info, VolumeShape shape, string overr
     public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)
     {
         var prefab = new GameObject(info.ClassID);
+        prefab.SetActive(false);
         prefab.layer = AtmosphereVolumesLayer;
 
         Collider collider = Shape switch

diff --git a/Nautilus/Assets/PrefabTemplates/CloneTemplate.cs b/Nautilus/Assets/PrefabTemplates/CloneTemplate.cs
@@ -79,6 +79,7 @@ public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)
         GameObject obj = gameObject.Get();
         if (obj)
         {
+            obj.SetActive(false);
             ApplySkin(obj);
             ModifyPrefab?.Invoke(obj);
             if(ModifyPrefabAsync is { })
@@ -89,12 +90,13 @@ public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)
 
         if (_spawnType == SpawnType.TechType)
         {
-            yield return CraftData.InstantiateFromPrefabAsync(_techTypeToClone, gameObject);
-            obj = gameObject.Get();
+            var task = CraftData.GetPrefabForTechTypeAsync(_techTypeToClone);
+            yield return task;
+            obj = Utils.InstantiateDeactivated(task.GetResult());
         }
         else if(_spawnType == SpawnType.Prefab)
         {
-            var task = _prefabToClone.InstantiateAsync();
+            var task = _prefabToClone.LoadAssetAsync();
             yield return task;
 
             if (task.Status != UnityEngine.ResourceManagement.AsyncOperations.AsyncOperationStatus.Succeeded)
@@ -103,7 +105,7 @@ public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)
                 yield break;
             }
 
-            obj = task.Result;
+            obj = Utils.InstantiateDeactivated(task.Result);
         }
         else if(_spawnType == SpawnType.ClassId)
         {
@@ -116,7 +118,7 @@ public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)
                 yield break;
             }
 
-            obj = Object.Instantiate(prefab);
+            obj = Utils.InstantiateDeactivated(prefab);
         }
 
         ApplySkin(obj);

diff --git a/Nautilus/Assets/PrefabTemplates/EggTemplate.cs b/Nautilus/Assets/PrefabTemplates/EggTemplate.cs
@@ -213,6 +213,7 @@ public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)
         var obj = gameObject.Get();
         if (obj)
         {
+            obj.SetActive(false);
             yield return ProcessEgg(obj);
             yield break;
         }
@@ -231,6 +232,7 @@ Please use one of the constructor overloads that take a game object or pass a ga
                                    """);
             yield break;
         }
+        obj.SetActive(false);
         yield return ProcessEgg(obj);
 
         gameObject.Set(obj);

diff --git a/Nautilus/Assets/PrefabTemplates/EnergySourceTemplate.cs b/Nautilus/Assets/PrefabTemplates/EnergySourceTemplate.cs
@@ -55,6 +55,7 @@ public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)
         var obj = gameObject.Get();
         if (obj)
         {
+            obj.SetActive(false);
             ApplyModifications(obj);
             yield break;
         }
@@ -68,7 +69,7 @@ private IEnumerator CreateEnergySource(IOut<GameObject> gameObject)
         var task = CraftData.GetPrefabForTechTypeAsync(tt, false);
         yield return task;
 
-        var obj = GameObject.Instantiate(task.GetResult());
+        var obj = UWE.Utils.InstantiateDeactivated(task.GetResult());
 
         yield return ApplyModifications(obj);
 

diff --git a/Nautilus/Assets/PrefabTemplates/FabricatorTemplate.cs b/Nautilus/Assets/PrefabTemplates/FabricatorTemplate.cs
@@ -140,7 +140,7 @@ private IEnumerator CreateFabricator(IOut<GameObject> gameObject)
             InternalLogger.Error($"Failed to get prefab for {FabricatorModel}!!!!!!!!   PLEASE REPORT THIS BUG TO THE NAUTILUS TEAM!");
         }
 
-        var obj = GameObject.Instantiate(prefab);
+        var obj = Utils.InstantiateDeactivated(prefab);
         yield return ApplyCrafterPrefab(obj);
         gameObject.Set(obj);
     }

diff --git a/Nautilus/Crafting/TabNode.cs b/Nautilus/Crafting/TabNode.cs
@@ -1,7 +1,8 @@
 namespace Nautilus.Crafting;
 
-using Nautilus.Assets;
-using Nautilus.Patchers;
+using Assets;
+using Handlers;
+using Utility;
 
 #if SUBNAUTICA
 using Sprite = Atlas.Sprite;
@@ -15,15 +16,25 @@ internal class TabNode : Node
     internal Sprite Sprite { get; set; }
     internal string DisplayName { get; set; }
     internal string Name { get; set; }
+    internal string Id { get; }
 
-    internal TabNode(string[] path, CraftTree.Type scheme, Sprite sprite, string name, string displayName, string language = "English") : base(path, scheme)
+    internal TabNode(string[] path, CraftTree.Type scheme, Sprite sprite, string name, string displayName) : base(path, scheme)
     {
         Sprite = sprite;
         DisplayName = displayName;
         Name = name;
+        Id = $"{Scheme.ToString()}_{Name}";
 
-        ModSprite.Add(new ModSprite(SpriteManager.Group.Category, $"{Scheme.ToString()}_{Name}", Sprite));
-        LanguagePatcher.AddCustomLanguageLine($"{Scheme.ToString()}Menu_{Name}", DisplayName, language);
+        ModSprite.Add(new ModSprite(SpriteManager.Group.Category, Id, Sprite));
+
+        if (!string.IsNullOrEmpty(displayName))
+        {
+            LanguageHandler.SetLanguageLine(Id, displayName);
+        }
+        else if (string.IsNullOrEmpty(Language.main.Get(name)))
+        {
+            InternalLogger.Warn($"Display name was not specified and no existing language line has been found for Tab node '{name}'.");
+        }
     }
 
 }