Merge branch 'master' into docs

SubnauticaModding · Jul 9, 2023 · 307debf · 307debf
2 parents 2815b40 + 4c4cded
commit 307debf
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 11 deletions.
diff --git a/Nautilus/Handlers/SaveDataHandler.cs b/Nautilus/Handlers/SaveDataHandler.cs
@@ -1,4 +1,4 @@
-using Nautilus.Json;
+using Nautilus.Json;
 using Nautilus.Utility;
 
 namespace Nautilus.Handlers;
@@ -18,7 +18,7 @@ public static class SaveDataHandler
     {
         T cache = new();
 
-        SaveUtils.RegisterOnLoadEvent(() => cache.Load());
+        SaveUtils.RegisterOnStartLoadingEvent(() => cache.Load());
         SaveUtils.RegisterOnSaveEvent(() => cache.Save());
 
         return cache;

diff --git a/Nautilus/Patchers/SaveUtilsPatcher.cs b/Nautilus/Patchers/SaveUtilsPatcher.cs
@@ -12,7 +12,8 @@ internal class SaveUtilsPatcher
     private static readonly List<Action> oneTimeUseOnQuitEvents = new();
 
     internal static Action OnSaveEvents;
-    internal static Action OnLoadEvents;
+    internal static Action OnFinishLoadingEvents;
+    internal static Action OnStartLoadingEvents;
     internal static Action OnQuitEvents;
 
     public static void Patch(Harmony harmony)
@@ -57,12 +58,14 @@ internal static void InvokeSaveEvents()
 
     internal static IEnumerator InvokeLoadEvents(IEnumerator enumerator)
     {
+        OnStartLoadingEvents?.Invoke();
+
         while (enumerator.MoveNext())
         {
             yield return enumerator.Current;
         }
 
-        OnLoadEvents?.Invoke();
+        OnFinishLoadingEvents?.Invoke();
 
         if (oneTimeUseOnLoadEvents.Count > 0)
         {

diff --git a/Nautilus/Utility/SaveUtils.cs b/Nautilus/Utility/SaveUtils.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using Nautilus.Patchers;
 
 namespace Nautilus.Utility;
@@ -26,11 +26,21 @@ public static void RegisterOnSaveEvent(Action onSaveAction)
 
     /// <summary>
     /// Registers a simple <see cref="Action"/> method to invoke the <c>first time</c> the player loads a saved game via the in game menu.
+    /// This is only invoked after the game (including most objects around the player) has FULLY loaded. For an earlier alternative, see <see cref="RegisterOnStartLoadingEvent"/>.
     /// </summary>
-    /// <param name="onLoadAction">The method to invoke. This action will not be invoked a second time.</param>
-    public static void RegisterOnLoadEvent(Action onLoadAction)
+    /// <param name="onFinishLoadingAction">The method to invoke. This action will not be invoked a second time.</param>
+    public static void RegisterOnFinishLoadingEvent(Action onFinishLoadingAction)
     {
-        SaveUtilsPatcher.OnLoadEvents += onLoadAction;
+        SaveUtilsPatcher.OnFinishLoadingEvents += onFinishLoadingAction;
+    }
+
+    /// <summary>
+    /// Registers a simple <see cref="Action"/> method to invoke immediately after the <c>first time</c> the player loads a saved game via the in game menu.
+    /// </summary>
+    /// <param name="onStartLoadingAction">The method to invoke. This action will not be invoked a second time.</param>
+    public static void RegisterOnStartLoadingEvent(Action onStartLoadingAction)
+    {
+        SaveUtilsPatcher.OnStartLoadingEvents += onStartLoadingAction;
     }
 
     /// <summary>
@@ -53,13 +63,23 @@ public static void UnregisterOnSaveEvent(Action onSaveAction)
     }
 
     /// <summary>
-    /// Removes a method previously added through <see cref="RegisterOnLoadEvent(Action)"/> so it is no longer invoked when loading the game.<para/>
+    /// Removes a method previously added through <see cref="RegisterOnFinishLoadingEvent(Action)"/> so it is no longer invoked when loading the game.<para/>
+    /// If you plan on using this, do not register an anonymous method.
+    /// </summary>
+    /// <param name="onLoadAction">The method invoked.</param>
+    public static void UnregisterOnFinishLoadingEvent(Action onLoadAction)
+    {
+        SaveUtilsPatcher.OnFinishLoadingEvents -= onLoadAction;
+    }
+
+    /// <summary>
+    /// Removes a method previously added through <see cref="RegisterOnStartLoadingEvent(Action)"/> so it is no longer invoked when loading the game.<para/>
     /// If you plan on using this, do not register an anonymous method.
     /// </summary>
     /// <param name="onLoadAction">The method invoked.</param>
-    public static void UnregisterOnLoadEvent(Action onLoadAction)
+    public static void UnregisterOnStartLoadingEvent(Action onLoadAction)
     {
-        SaveUtilsPatcher.OnLoadEvents -= onLoadAction;
+        SaveUtilsPatcher.OnStartLoadingEvents -= onLoadAction;
     }
 
     /// <summary>