Merge pull request #11 from DekuDesu/development

added QOL improvments for developers

Author: artyredd

MiniMapLibrary/ISpriteManager.cs

@@ -0,0 +1,18 @@
+using System;
+using UnityEngine;
+
+namespace MiniMapLibrary
+{
+    /// <summary>
+    /// Represents some object that should provide sprites to be displayed on the minimap
+    /// </summary>
+    public interface ISpriteManager : IDisposable
+    {
+        /// <summary>
+        /// Uses the provided <see cref="InteractableKind"/> to generate/provide and return a sprite that should represent that kind in the minimap
+        /// </summary>
+        /// <param name="type"></param>
+        /// <returns></returns>
+        Sprite GetSprite(InteractableKind type);
+    }
+}

MiniMapLibrary/SpriteManager.cs

@@ -8,7 +8,7 @@
 #nullable enable
 namespace MiniMapLibrary
 {
-    public sealed class SpriteManager : IDisposable
+    public sealed class SpriteManager : IDisposable, ISpriteManager
     {
         public const string DefaultResourcePath = "Textures/MiscIcons/texMysteryIcon";
 
@@ -23,7 +23,7 @@ static SpriteManager()
 
         private static void InitializeResources()
         {
-            void Add(InteractableKind type, string ResourcePath)
+            static void Add(InteractableKind type, string ResourcePath)
             {
                 s_ResourceDictionary.Add(type, ResourcePath);
             }

MiniMapMod/MiniMapPlugin.cs

@@ -15,7 +15,7 @@ namespace MiniMapMod
     [BepInPlugin("MiniMap", "Mini Map Mod", "2.0.4")]
     public class MiniMapPlugin : BaseUnityPlugin
     {
-        private readonly SpriteManager SpriteManager = new();
+        private readonly ISpriteManager SpriteManager = new SpriteManager();
 
         private readonly List<ITrackedObject> TrackedObjects = new();
 

MiniMapMod/Minimap.cs

@@ -18,7 +18,7 @@ public class Minimap
 
         public bool Created { get; private set; } = false;
 
-        public void CreateMinimap(SpriteManager spriteManager, GameObject Parent)
+        public void CreateMinimap(ISpriteManager spriteManager, GameObject Parent)
         {
             if (Created)
             {
@@ -67,7 +67,7 @@ public void SetRotation(Quaternion rotation)
             ContainerTransform.localRotation = Quaternion.Euler(0, 0, euler.y);
         }
 
-        public RectTransform CreateIcon(InteractableKind type, Vector3 minimapPosition, SpriteManager spriteManager)
+        public RectTransform CreateIcon(InteractableKind type, Vector3 minimapPosition, ISpriteManager spriteManager)
         {
             var icon = CreateIcon(type, spriteManager.GetSprite(type));
 
@@ -96,7 +96,7 @@ private void CreateIconContainer()
             Container = container;
         }
 
-        private void CreatePlayerIcon(SpriteManager spriteManager)
+        private void CreatePlayerIcon(ISpriteManager spriteManager)
         {
             GameObject playerIcon = CreateIcon(InteractableKind.Player, spriteManager.GetSprite(InteractableKind.Player));