🧩 Bring IHookFactory<T> back for backwards compatibility

Chasmical · Jul 27, 2023 · 9643adc · 9643adc
1 parent 95002a0
commit 9643adc
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 5 deletions.
diff --git a/RogueLibsCore/Compat/IHookFactory.cs b/RogueLibsCore/Compat/IHookFactory.cs
@@ -0,0 +1,11 @@
+using System;
+
+namespace RogueLibsCore
+{
+    /// <summary>
+    ///   <para>Represents a hook factory, that creates hooks attachable to instances of type <typeparamref name="T"/>.</para>
+    /// </summary>
+    /// <typeparam name="T">The type of objects that the created hooks can be attached to.</typeparam>
+    [Obsolete("IHookFactory<T> interface was deprecated in RogueLibs v4.0.0. Use the non-generic IHookFactory interface instead.")]
+    public interface IHookFactory<in T> : IHookFactory where T : notnull { }
+}
diff --git a/RogueLibsCore/Hooks/HookFactoryBase.cs b/RogueLibsCore/Hooks/HookFactoryBase.cs
@@ -6,7 +6,11 @@ namespace RogueLibsCore
     ///   <para>Represents a hook factory base. Implements the interfaces, leaving only one abstract method to implement.</para>
     /// </summary>
     /// <typeparam name="T">The type of objects that the created hooks can be attached to.</typeparam>
-    public abstract class HookFactoryBase<T> : IHookFactory where T : notnull
+    public abstract class HookFactoryBase<T>
+#pragma warning disable CS0618
+        : IHookFactory<object>
+#pragma warning restore CS0618
+        where T : notnull
     {
         /// <summary>
         ///   <para>Tries to create a hook for the specified <paramref name="instance"/> of type <typeparamref name="T"/>, and returns a value that indicates whether a hook was created successfully.</para>

diff --git a/RogueLibsCore/RogueFramework.cs b/RogueLibsCore/RogueFramework.cs
@@ -66,22 +66,24 @@ internal static void LogError(MethodBase method)
 
         internal const int SpecialInt = -488755541;
 
+#pragma warning disable CS0618
         /// <summary>
         ///   <para>The list of item hook factories, used by RogueLibs.</para>
         /// </summary>
-        public static readonly List<IHookFactory> ItemFactories = new List<IHookFactory>();
+        public static readonly List<IHookFactory<InvItem>> ItemFactories = new();
         /// <summary>
         ///   <para>The list of trait hook factories, used by RogueLibs.</para>
         /// </summary>
-        public static readonly List<IHookFactory> TraitFactories = new List<IHookFactory>();
+        public static readonly List<IHookFactory<Trait>> TraitFactories = new();
         /// <summary>
         ///   <para>The list of effect hook factories, used by RogueLibs.</para>
         /// </summary>
-        public static readonly List<IHookFactory> EffectFactories = new List<IHookFactory>();
+        public static readonly List<IHookFactory<StatusEffect>> EffectFactories = new();
         /// <summary>
         ///   <para>The list of object hook factories, used by RogueLibs.</para>
         /// </summary>
-        public static readonly List<IHookFactory> ObjectFactories = new List<IHookFactory>();
+        public static readonly List<IHookFactory<PlayfieldObject>> ObjectFactories = new();
+#pragma warning restore CS0618
 
         /// <summary>
         ///   <para>The list of name providers, used by RogueLibs.</para>