feat: log a warning if a mod accesses a manager too early

Valheim-Modding · Sep 25, 2023 · 818a343 · 818a343
1 parent 873fe86
commit 818a343
Show file tree

Hide file tree

Showing 19 changed files with 30 additions and 18 deletions.
diff --git a/JotunnLib/Main.cs b/JotunnLib/Main.cs
@@ -131,5 +131,17 @@ private void InitializePatches()
                 tuple.Item1.Invoke(null, null);
             }
         }
+
+        internal static void LogManagerInit(string manager)
+        {
+            Jotunn.Logger.LogInfo($"Initializing {manager}");
+
+            if (!Instance)
+            {
+                string message = $"{manager} was accessed before Jotunn Awake, this can cause unexpected behaviour. " +
+                                 "Please make sure to add `[BepInDependency(Jotunn.Main.ModGuid)]` next to your BaseUnityPlugin";
+                Jotunn.Logger.LogWarning(BepInExUtils.GetSourceModMetadata(), message);
+            }
+        }
     }
 }
diff --git a/JotunnLib/Managers/CommandManager.cs b/JotunnLib/Managers/CommandManager.cs
@@ -47,7 +47,7 @@ static CommandManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing CommandManager");
+            Main.LogManagerInit("CommandManager");
             AddConsoleCommand(new ClearCommand());
 
             Main.Harmony.PatchAll(typeof(Patches));

diff --git a/JotunnLib/Managers/CreatureManager.cs b/JotunnLib/Managers/CreatureManager.cs
@@ -69,7 +69,7 @@ static CreatureManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing CreatureManager");
+            Main.LogManagerInit("CreatureManager");
 
             SpawnListContainer = new GameObject("Creatures");
             SpawnListContainer.transform.parent = Main.RootObject.transform;

diff --git a/JotunnLib/Managers/GUIManager.cs b/JotunnLib/Managers/GUIManager.cs
@@ -291,7 +291,7 @@ private static void TextInput_IsVisible(ref bool __result)
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing GUIManager");
+            Main.LogManagerInit("GUIManager");
 
             // Cache headless state
             Headless = SystemInfo.graphicsDeviceType == GraphicsDeviceType.Null;

diff --git a/JotunnLib/Managers/InputManager.cs b/JotunnLib/Managers/InputManager.cs
@@ -218,7 +218,7 @@ static InputManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing InputManager");
+            Main.LogManagerInit("InputManager");
 
             // Dont init on a dedicated server
             if (!GUIManager.IsHeadless())

diff --git a/JotunnLib/Managers/ItemManager.cs b/JotunnLib/Managers/ItemManager.cs
@@ -73,7 +73,7 @@ static ItemManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing ItemManager");
+            Main.LogManagerInit("ItemManager");
             Main.Harmony.PatchAll(typeof(Patches));
         }
 

diff --git a/JotunnLib/Managers/KeyHintManager.cs b/JotunnLib/Managers/KeyHintManager.cs
@@ -68,7 +68,7 @@ static KeyHintManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing KeyHintManager");
+            Main.LogManagerInit("KeyHintManager");
 
             // Dont init on a headless server
             if (!GUIManager.IsHeadless())

diff --git a/JotunnLib/Managers/KitbashManager.cs b/JotunnLib/Managers/KitbashManager.cs
@@ -39,7 +39,7 @@ static KitbashManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing KitbashManager");
+            Main.LogManagerInit("KitbashManager");
             ItemManager.OnKitbashItemsAvailable += ApplyKitbashes;
         }
 

diff --git a/JotunnLib/Managers/LocalizationManager.cs b/JotunnLib/Managers/LocalizationManager.cs
@@ -91,7 +91,7 @@ static LocalizationManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing LocalizationManager");
+            Main.LogManagerInit("LocalizationManager");
 
             Main.Harmony.PatchAll(typeof(Patches));
 

diff --git a/JotunnLib/Managers/MinimapManager.cs b/JotunnLib/Managers/MinimapManager.cs
@@ -103,7 +103,7 @@ static MinimapManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing MinimapManager");
+            Main.LogManagerInit("MinimapManager");
 
             // Dont init on a headless server
             if (GUIManager.IsHeadless())

diff --git a/JotunnLib/Managers/MockSystem/MockManager.cs b/JotunnLib/Managers/MockSystem/MockManager.cs
@@ -56,7 +56,7 @@ private MockManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing MockManager");
+            Main.LogManagerInit("MockManager");
 
             MockPrefabContainer = new GameObject("MockPrefabs");
             MockPrefabContainer.transform.parent = Main.RootObject.transform;

diff --git a/JotunnLib/Managers/NetworkManager.cs b/JotunnLib/Managers/NetworkManager.cs
@@ -50,7 +50,7 @@ static NetworkManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing NetworkManager");
+            Main.LogManagerInit("NetworkManager");
             Main.Harmony.PatchAll(typeof(Patches));
         }
 

diff --git a/JotunnLib/Managers/PieceManager.cs b/JotunnLib/Managers/PieceManager.cs
@@ -91,7 +91,7 @@ public static class PieceCategorySettings
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing PieceManager");
+            Main.LogManagerInit("PieceManager");
             Main.Harmony.PatchAll(typeof(Patches));
         }
 

diff --git a/JotunnLib/Managers/PrefabManager.cs b/JotunnLib/Managers/PrefabManager.cs
@@ -61,7 +61,7 @@ static PrefabManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing PrefabManager");
+            Main.LogManagerInit("PrefabManager");
 
             PrefabContainer = new GameObject("Prefabs");
             PrefabContainer.transform.parent = Main.RootObject.transform;

diff --git a/JotunnLib/Managers/RenderManager.cs b/JotunnLib/Managers/RenderManager.cs
@@ -52,7 +52,7 @@ static RenderManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing RenderManager");
+            Main.LogManagerInit("RenderManager");
 
             if (GUIManager.IsHeadless())
             {

diff --git a/JotunnLib/Managers/SkillManager.cs b/JotunnLib/Managers/SkillManager.cs
@@ -36,7 +36,7 @@ static SkillManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing SkillManager");
+            Main.LogManagerInit("SkillManager");
             Main.Harmony.PatchAll(typeof(Patches));
         }
 

diff --git a/JotunnLib/Managers/SynchronizationManager.cs b/JotunnLib/Managers/SynchronizationManager.cs
@@ -62,7 +62,7 @@ private SynchronizationManager() { }
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing SynchronizationManager");
+            Main.LogManagerInit("SynchronizationManager");
 
             // Register RPCs and the admin watchdog
             ConfigRPC = NetworkManager.Instance.AddRPC(

diff --git a/JotunnLib/Managers/UndoManager.cs b/JotunnLib/Managers/UndoManager.cs
@@ -72,7 +72,7 @@ static UndoManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing UndoManager");
+            Main.LogManagerInit("UndoManager");
             Main.Harmony.PatchAll(typeof(Patches));
         }
 

diff --git a/JotunnLib/Managers/ZoneManager.cs b/JotunnLib/Managers/ZoneManager.cs
@@ -64,7 +64,7 @@ static ZoneManager()
         /// </summary>
         void IManager.Init()
         {
-            Logger.LogInfo("Initializing ZoneManager");
+            Main.LogManagerInit("ZoneManager");
 
             LocationContainer = new GameObject("Locations");
             LocationContainer.transform.parent = Main.RootObject.transform;