isaacscript-common 14.1.2 → 14.1.3

package/dist/index.d.ts

@@ -79,6 +79,10 @@ import { TrapdoorVariant } from 'isaac-typescript-definitions';
 import { TrinketType } from 'isaac-typescript-definitions';
 import { UseFlag } from 'isaac-typescript-definitions';
 
+export declare const ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs";
+
+export declare const ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs";
+
 declare interface AddCallbackParametersCustom {
     [ModCallbackCustom.POST_AMBUSH_FINISHED]: PostAmbushFinishedRegisterParameters;
     [ModCallbackCustom.POST_AMBUSH_STARTED]: PostAmbushStartedRegisterParameters;
@@ -827,16 +831,18 @@ export declare function calculateStageTypeRepentance(stage: LevelStage): StageTy
 /**
  * A decorator function that signifies that the decorated class method should be automatically
  * registered with `Mod.AddCallback`.
+ *
+ * @ignore
  */
 export declare function Callback<T extends ModCallback>(modCallback: T, ...optionalArgs: AllButFirst<AddCallbackParameters[T]>): <Class extends ModFeature, Fn extends AddCallbackParameters[T][0]>(target: Class, propertyKey: string, _descriptor: TypedPropertyDescriptor<Fn>) => void;
 
 /**
  * A decorator function that signifies that the decorated class method should be automatically
  * registered with `ModUpgraded.AddCallbackCustom`.
+ *
+ * @ignore
  */
-export declare function CallbackCustom<T extends ModCallbackCustom2>(modCallbackCustom: T, ...optionalArgs: AllButFirst<AddCallbackParametersCustom2[T]>): <Class extends {
-    mod: ModUpgraded;
-}>(target: Class, propertyKey: string) => void;
+export declare function CallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>): <Class extends ModFeature, Fn extends AddCallbackParametersCustom[T][0]>(target: Class, propertyKey: string, _descriptor: TypedPropertyDescriptor<Fn>) => void;
 
 declare type CallbackSignatureGridEntity = ((gridEntity: GridEntity) => void) | ((gridEntity: GridEntity, oldState: int, newState: int) => void);
 
@@ -7519,8 +7525,6 @@ export declare function kColorEquals(kColor1: KColor, kColor2: KColor): boolean;
  */
 export declare function keyboardToString(keyboard: Keyboard, uppercase: boolean): string | undefined;
 
-declare type KeysToScrubFromModClass = keyof Feature | LowercaseKeys<ModUpgraded>;
-
 /**
  * For `EntityType.EFFECT` (1000), `EffectVariant.LADDER` (8).
  *
@@ -7710,8 +7714,8 @@ export declare function logSet(set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): vo
 export declare function logSounds(): void;
 
 /**
- * Helper function for logging every key and value of a table. This is a deep log; the function will
- * recursively call itself if it counters a table within a table.
+ * Helper function for logging every key and value of a Lua table. This is a deep log; the function
+ * will recursively call itself if it counters a table within a table.
  *
  * This function will only work on tables that have string keys (because it logs the keys in order,
  * instead of randomly). It will throw a run-time error if it encounters a non-string key.
@@ -7724,6 +7728,14 @@ export declare function logTable(luaTable: unknown, parentTables?: number): void
  */
 export declare function logTableDifferences<K extends AnyNotNil, V>(table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
 
+/**
+ * Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the
+ * top-most table will be logged.
+ *
+ * This function is useful for tables that have recursive references.
+ */
+export declare function logTableKeys(luaTable: unknown): void;
+
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void;
 
@@ -9447,12 +9459,22 @@ declare type ModCallbackCustomPlayer = MatchingCallbackCustom<CallbackSignatureP
 declare type ModCallbackCustomRevive = MatchingCallbackCustom<CallbackSignatureRevive>;
 
 /**
- * A helper class for a mod that wants to represent its individual features as classes. This is
- * useful if you are using decorators to represent class methods that should be automatically
- * subscribed to callbacks.
+ * A helper class for mods that wants to represent their individual features as classes. Extend your
+ * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
+ * that automatically subscribe to callbacks.
+ *
+ * For example:
+ *
+ * ```ts
+ * export class MyFeature extends ModFeature {
+ *   @Callback(ModCallback.POST_GAME_STARTED)
+ *   postGameStarted(isContinued: boolean): void {
+ *     Isaac.DebugString(`Callback fired: POST_GAME_STARTED`);
+ *   }
+ * }
+ * ```
  */
 export declare class ModFeature {
-    private mod;
     constructor(mod: ModUpgraded);
 }
 
@@ -9516,24 +9538,20 @@ export declare class ModUpgraded implements Mod {
      * conditions of how you registered the callback, it will be removed.
      */
     RemoveCallbackCustom<T extends ModCallbackCustom2>(modCallbackCustom: T, callback: AddCallbackParametersCustom2[T][0]): void;
-    /**
-     * This method should only be used by the `upgradeMod` function. Returns the names of the exported
-     * class methods from the features that were added.
-     */
-    initOptionalFeature(feature: ISCFeature): FunctionTuple[];
     /** This is used to initialize both custom callbacks and "extra features". */
     private initFeature;
     private uninitFeature;
+    /** Returns the names of the exported class methods from the features that were added. */
+    private initOptionalFeature;
 }
 
 /**
  * By specifying one or more optional features, end-users will get a version of `ModUpgraded` that
  * has extra methods corresponding to the features.
  *
- * We have to explicitly account for the empty array case, since `never` will cause mess up the
- * union.
+ * We have to explicitly account for the empty array case, since the `never` will mess up the union.
  */
-declare type ModUpgradedWithFeatures<T extends ISCFeature> = [T] extends [never] ? ModUpgraded : Omit<ModUpgraded & UnionToIntersection<ISCFeatureToClass[T]>, KeysToScrubFromModClass>;
+declare type ModUpgradedWithFeatures<T extends ISCFeature> = [T] extends [never] ? ModUpgraded : ModUpgraded & Omit<UnionToIntersection<ISCFeatureToClass[T]>, keyof Feature>;
 
 /**
  * Helper function to move all of the players to where they would normally go when arriving at a new

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 14.1.2
+isaacscript-common 14.1.3
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -24483,6 +24483,32 @@ function ____exports.logTableDifferences(self, table1, table2)
         end
     end
 end
+function ____exports.logTableKeys(self, luaTable)
+    log(nil, "Printing out the keys of a Lua table:")
+    if not isTable(nil, luaTable) then
+        log(
+            nil,
+            ("  n/a (encountered a variable of type \"" .. __TS__TypeOf(luaTable)) .. "\" instead of a table)"
+        )
+        return
+    end
+    local numElements = 0
+    iterateTableInOrder(
+        nil,
+        luaTable,
+        function(____, key)
+            log(
+                nil,
+                tostring(key)
+            )
+            numElements = numElements + 1
+        end
+    )
+    log(
+        nil,
+        "  The size of the table was: " .. tostring(numElements)
+    )
+end
 function ____exports.logTearFlags(self, flags)
     ____exports.logFlags(nil, flags, TearFlag, "tear")
 end
@@ -34947,11 +34973,6 @@ function ModUpgraded.prototype.RemoveCallbackCustom(self, modCallbackCustom, cal
         self:uninitFeature(callbackClass)
     end
 end
-function ModUpgraded.prototype.initOptionalFeature(self, feature)
-    local featureClass = self.features[feature]
-    self:initFeature(featureClass)
-    return getExportedMethodsFromFeature(nil, featureClass)
-end
 function ModUpgraded.prototype.initFeature(self, feature)
     if feature.initialized then
         return
@@ -35022,17 +35043,52 @@ function ModUpgraded.prototype.uninitFeature(self, feature)
         saveDataManagerRemove(nil, className)
     end
 end
+function ModUpgraded.prototype.initOptionalFeature(self, feature)
+    local featureClass = self.features[feature]
+    self:initFeature(featureClass)
+    return getExportedMethodsFromFeature(nil, featureClass)
+end
 return ____exports
  end,
 ["src.classes.ModFeature"] = function(...) 
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
+local __TS__Spread = ____lualib.__TS__Spread
 local ____exports = {}
+local addDecoratedCallbacks, addDecoratedCallbacksCustom
+local ____tstlClass = require("src.functions.tstlClass")
+local getTSTLClassConstructor = ____tstlClass.getTSTLClassConstructor
+function addDecoratedCallbacks(self, mod, modFeatureConstructor)
+    local addCallbackArgs = modFeatureConstructor[____exports.ADD_CALLBACK_ARGS_KEY]
+    if addCallbackArgs == nil then
+        return
+    end
+    for ____, args in ipairs(addCallbackArgs) do
+        mod:AddCallback(__TS__Spread(args))
+    end
+end
+function addDecoratedCallbacksCustom(self, mod, modFeatureConstructor)
+    local addCallbackCustomArgs = modFeatureConstructor[____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY]
+    if addCallbackCustomArgs == nil then
+        return
+    end
+    for ____, args in ipairs(addCallbackCustomArgs) do
+        mod:AddCallbackCustom(__TS__Spread(args))
+    end
+end
+____exports.ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs"
+____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs"
 ____exports.ModFeature = __TS__Class()
 local ModFeature = ____exports.ModFeature
 ModFeature.name = "ModFeature"
 function ModFeature.prototype.____constructor(self, mod)
-    self.mod = mod
+    local constructor = getTSTLClassConstructor(nil, self)
+    if constructor == nil then
+        error("Failed to get the TSTL class constructor for a mod feature.")
+    end
+    local modFeatureConstructor = constructor
+    addDecoratedCallbacks(nil, mod, modFeatureConstructor)
+    addDecoratedCallbacksCustom(nil, mod, modFeatureConstructor)
 end
 return ____exports
  end,
@@ -46641,14 +46697,6 @@ end
 function ____exports.loadShaderCrashFix(self, mod)
     mod:AddCallback(ModCallback.POST_PLAYER_INIT, postPlayerInit)
 end
-return ____exports
- end,
-["src.types.StartsWithLowercase"] = function(...) 
-local ____exports = {}
-return ____exports
- end,
-["src.types.LowercaseKeys"] = function(...) 
-local ____exports = {}
 return ____exports
  end,
 ["src.types.UnionToIntersection"] = function(...) 
@@ -51839,28 +51887,43 @@ return ____exports
 local ____lualib = require("lualib_bundle")
 local __TS__Spread = ____lualib.__TS__Spread
 local ____exports = {}
+local ____ModFeature = require("src.classes.ModFeature")
+local ADD_CALLBACK_ARGS_KEY = ____ModFeature.ADD_CALLBACK_ARGS_KEY
+local ADD_CALLBACK_CUSTOM_ARGS_KEY = ____ModFeature.ADD_CALLBACK_CUSTOM_ARGS_KEY
 function ____exports.Callback(self, modCallback, ...)
     local optionalArgs = {...}
     return function(____, target, propertyKey, _descriptor)
         local methodName = propertyKey
         local method = target[methodName]
-        target.mod:AddCallback(
+        local addCallbackArgs = {
             modCallback,
             method,
             __TS__Spread(optionalArgs)
-        )
+        }
+        local constructor = target.constructor
+        if not (constructor[ADD_CALLBACK_ARGS_KEY] ~= nil) then
+            constructor[ADD_CALLBACK_ARGS_KEY] = {}
+        end
+        local callbackTuples = constructor[ADD_CALLBACK_ARGS_KEY]
+        callbackTuples[#callbackTuples + 1] = addCallbackArgs
     end
 end
 function ____exports.CallbackCustom(self, modCallbackCustom, ...)
     local optionalArgs = {...}
-    return function(____, target, propertyKey)
+    return function(____, target, propertyKey, _descriptor)
         local methodName = propertyKey
         local method = target[methodName]
-        target.mod:AddCallbackCustom2(
+        local addCallbackArgs = {
             modCallbackCustom,
             method,
             __TS__Spread(optionalArgs)
-        )
+        }
+        local constructor = target.constructor
+        if not (constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] ~= nil) then
+            constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] = {}
+        end
+        local callbackTuples = constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY]
+        callbackTuples[#callbackTuples + 1] = addCallbackArgs
     end
 end
 return ____exports
@@ -53583,6 +53646,14 @@ return ____exports
  end,
 ["src.types.HasAllEnumKeys"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.StartsWithLowercase"] = function(...) 
+local ____exports = {}
+return ____exports
+ end,
+["src.types.LowercaseKeys"] = function(...) 
+local ____exports = {}
 return ____exports
  end,
 ["src.types.StartsWithUppercase"] = function(...) 

package/dist/src/classes/ModFeature.d.ts

@@ -1,11 +1,23 @@
 import { ModUpgraded } from "./ModUpgraded";
+export declare const ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs";
+export declare const ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs";
 /**
- * A helper class for a mod that wants to represent its individual features as classes. This is
- * useful if you are using decorators to represent class methods that should be automatically
- * subscribed to callbacks.
+ * A helper class for mods that wants to represent their individual features as classes. Extend your
+ * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
+ * that automatically subscribe to callbacks.
+ *
+ * For example:
+ *
+ * ```ts
+ * export class MyFeature extends ModFeature {
+ *   @Callback(ModCallback.POST_GAME_STARTED)
+ *   postGameStarted(isContinued: boolean): void {
+ *     Isaac.DebugString(`Callback fired: POST_GAME_STARTED`);
+ *   }
+ * }
+ * ```
  */
 export declare class ModFeature {
-    private mod;
     constructor(mod: ModUpgraded);
 }
 //# sourceMappingURL=ModFeature.d.ts.map

package/dist/src/classes/ModFeature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;GAIG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAc;gBAEb,GAAG,EAAE,WAAW;CAG7B"}
+{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,eAAO,MAAM,qBAAqB,sBAAsB,CAAC;AACzD,eAAO,MAAM,4BAA4B,4BAA4B,CAAC;AAOtE;;;;;;;;;;;;;;;GAeG;AAEH,qBAAa,UAAU;gBACT,GAAG,EAAE,WAAW;CAU7B"}

package/dist/src/classes/ModFeature.lua

@@ -1,13 +1,55 @@
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
+local __TS__Spread = ____lualib.__TS__Spread
 local ____exports = {}
---- A helper class for a mod that wants to represent its individual features as classes. This is
--- useful if you are using decorators to represent class methods that should be automatically
--- subscribed to callbacks.
+local addDecoratedCallbacks, addDecoratedCallbacksCustom
+local ____tstlClass = require("src.functions.tstlClass")
+local getTSTLClassConstructor = ____tstlClass.getTSTLClassConstructor
+function addDecoratedCallbacks(self, mod, modFeatureConstructor)
+    local addCallbackArgs = modFeatureConstructor[____exports.ADD_CALLBACK_ARGS_KEY]
+    if addCallbackArgs == nil then
+        return
+    end
+    for ____, args in ipairs(addCallbackArgs) do
+        mod:AddCallback(__TS__Spread(args))
+    end
+end
+function addDecoratedCallbacksCustom(self, mod, modFeatureConstructor)
+    local addCallbackCustomArgs = modFeatureConstructor[____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY]
+    if addCallbackCustomArgs == nil then
+        return
+    end
+    for ____, args in ipairs(addCallbackCustomArgs) do
+        mod:AddCallbackCustom(__TS__Spread(args))
+    end
+end
+____exports.ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs"
+____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs"
+--- A helper class for mods that wants to represent their individual features as classes. Extend your
+-- mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
+-- that automatically subscribe to callbacks.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- export class MyFeature extends ModFeature {
+-- 
+-- @Callback (ModCallback.POST_GAME_STARTED)
+-- postGameStarted(isContinued: boolean): void {
+-- Isaac.DebugString(`Callback fired: POST_GAME_STARTED`);
+-- }
+-- }
+-- ```
 ____exports.ModFeature = __TS__Class()
 local ModFeature = ____exports.ModFeature
 ModFeature.name = "ModFeature"
 function ModFeature.prototype.____constructor(self, mod)
-    self.mod = mod
+    local constructor = getTSTLClassConstructor(nil, self)
+    if constructor == nil then
+        error("Failed to get the TSTL class constructor for a mod feature.")
+    end
+    local modFeatureConstructor = constructor
+    addDecoratedCallbacks(nil, mod, modFeatureConstructor)
+    addDecoratedCallbacksCustom(nil, mod, modFeatureConstructor)
 end
 return ____exports

package/dist/src/classes/ModUpgraded.d.ts

@@ -1,10 +1,8 @@
 import { ModCallback } from "isaac-typescript-definitions";
-import { ISCFeature } from "../enums/ISCFeature";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { ModCallbackCustom2 } from "../enums/ModCallbackCustom2";
 import { AddCallbackParametersCustom } from "../interfaces/private/AddCallbackParametersCustom";
 import { AddCallbackParametersCustom2 } from "../interfaces/private/AddCallbackParametersCustom2";
-import { FunctionTuple } from "../types/FunctionTuple";
 /**
  * `isaacscript-common` has many custom callbacks that you can use in your mods. Instead of
  * hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to use, which
@@ -65,13 +63,10 @@ export declare class ModUpgraded implements Mod {
      * conditions of how you registered the callback, it will be removed.
      */
     RemoveCallbackCustom<T extends ModCallbackCustom2>(modCallbackCustom: T, callback: AddCallbackParametersCustom2[T][0]): void;
-    /**
-     * This method should only be used by the `upgradeMod` function. Returns the names of the exported
-     * class methods from the features that were added.
-     */
-    initOptionalFeature(feature: ISCFeature): FunctionTuple[];
     /** This is used to initialize both custom callbacks and "extra features". */
     private initFeature;
     private uninitFeature;
+    /** Returns the names of the exported class methods from the features that were added. */
+    private initOptionalFeature;
 }
 //# sourceMappingURL=ModUpgraded.d.ts.map

package/dist/src/classes/ModUpgraded.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModUpgraded.d.ts","sourceRoot":"","sources":["../../../src/classes/ModUpgraded.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAG3D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAYjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,4BAA4B,EAAE,MAAM,oDAAoD,CAAC;AAElG,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGvD;;;;;;GAMG;AACH,qBAAa,WAAY,YAAW,GAAG;IAKrC;;;OAGG;IACI,IAAI,EAAE,MAAM,CAAC;IAMpB,4FAA4F;IAC5F,OAAO,CAAC,GAAG,CAAM;IAEjB,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,aAAa,CAAoB;IAEzC,OAAO,CAAC,SAAS,CAAC;gBAUN,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,KAAK;IAa3D;;;;OAIG;IACI,WAAW,CAAC,CAAC,SAAS,WAAW,EACtC,WAAW,EAAE,CAAC,EACd,GAAG,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAChC,IAAI;IAkDP,0FAA0F;IACnF,OAAO,IAAI,OAAO;IAIzB;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;;OAKG;IACI,cAAc,CAAC,CAAC,SAAS,WAAW,EACzC,WAAW,EAAE,CAAC,EACd,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACpC,IAAI;IAIP,6EAA6E;IACtE,UAAU,IAAI,IAAI;IAIzB;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQnC;;;;OAIG;IAEI,iBAAiB,CAAC,CAAC,SAAS,iBAAiB,EAClD,iBAAiB,EAAE,CAAC,EACpB,GAAG,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACtC,IAAI;IAMP,wFAAwF;IACjF,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,EACpD,iBAAiB,EAAE,CAAC,EACpB,GAAG,IAAI,EAAE,4BAA4B,CAAC,CAAC,CAAC,GACvC,IAAI;IAOP;;;;;OAKG;IACI,oBAAoB,CAAC,CAAC,SAAS,kBAAkB,EACtD,iBAAiB,EAAE,CAAC,EACpB,QAAQ,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC3C,IAAI;IASP;;;OAGG;IACI,mBAAmB,CAAC,OAAO,EAAE,UAAU,GAAG,aAAa,EAAE;IAWhE,6EAA6E;IAC7E,OAAO,CAAC,WAAW;IAoCnB,OAAO,CAAC,aAAa;CAqCtB"}
+{"version":3,"file":"ModUpgraded.d.ts","sourceRoot":"","sources":["../../../src/classes/ModUpgraded.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAI3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAYjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,4BAA4B,EAAE,MAAM,oDAAoD,CAAC;AAKlG;;;;;;GAMG;AACH,qBAAa,WAAY,YAAW,GAAG;IAKrC;;;OAGG;IACI,IAAI,EAAE,MAAM,CAAC;IAMpB,4FAA4F;IAC5F,OAAO,CAAC,GAAG,CAAM;IAEjB,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,aAAa,CAAoB;IAEzC,OAAO,CAAC,SAAS,CAAC;gBAUN,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,KAAK;IAa3D;;;;OAIG;IACI,WAAW,CAAC,CAAC,SAAS,WAAW,EACtC,WAAW,EAAE,CAAC,EACd,GAAG,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAChC,IAAI;IAkDP,0FAA0F;IACnF,OAAO,IAAI,OAAO;IAIzB;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;;OAKG;IACI,cAAc,CAAC,CAAC,SAAS,WAAW,EACzC,WAAW,EAAE,CAAC,EACd,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACpC,IAAI;IAIP,6EAA6E;IACtE,UAAU,IAAI,IAAI;IAIzB;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQnC;;;;OAIG;IAEI,iBAAiB,CAAC,CAAC,SAAS,iBAAiB,EAClD,iBAAiB,EAAE,CAAC,EACpB,GAAG,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACtC,IAAI;IAMP,wFAAwF;IACjF,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,EACpD,iBAAiB,EAAE,CAAC,EACpB,GAAG,IAAI,EAAE,4BAA4B,CAAC,CAAC,CAAC,GACvC,IAAI;IAOP;;;;;OAKG;IACI,oBAAoB,CAAC,CAAC,SAAS,kBAAkB,EACtD,iBAAiB,EAAE,CAAC,EACpB,QAAQ,EAAE,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC3C,IAAI;IAaP,6EAA6E;IAC7E,OAAO,CAAC,WAAW;IAoCnB,OAAO,CAAC,aAAa;IAsCrB,yFAAyF;IACzF,OAAO,CAAC,mBAAmB;CAM5B"}

package/dist/src/classes/ModUpgraded.lua

@@ -124,11 +124,6 @@ function ModUpgraded.prototype.RemoveCallbackCustom(self, modCallbackCustom, cal
         self:uninitFeature(callbackClass)
     end
 end
-function ModUpgraded.prototype.initOptionalFeature(self, feature)
-    local featureClass = self.features[feature]
-    self:initFeature(featureClass)
-    return getExportedMethodsFromFeature(nil, featureClass)
-end
 function ModUpgraded.prototype.initFeature(self, feature)
     if feature.initialized then
         return
@@ -199,4 +194,9 @@ function ModUpgraded.prototype.uninitFeature(self, feature)
         saveDataManagerRemove(nil, className)
     end
 end
+function ModUpgraded.prototype.initOptionalFeature(self, feature)
+    local featureClass = self.features[feature]
+    self:initFeature(featureClass)
+    return getExportedMethodsFromFeature(nil, featureClass)
+end
 return ____exports

package/dist/src/core/upgradeMod.d.ts

@@ -4,17 +4,14 @@ import { ModUpgraded } from "../classes/ModUpgraded";
 import { Feature } from "../classes/private/Feature";
 import { ISCFeature } from "../enums/ISCFeature";
 import { ISCFeatureToClass } from "../features";
-import { LowercaseKeys } from "../types/LowercaseKeys";
 import { UnionToIntersection } from "../types/UnionToIntersection";
 /**
  * By specifying one or more optional features, end-users will get a version of `ModUpgraded` that
  * has extra methods corresponding to the features.
  *
- * We have to explicitly account for the empty array case, since `never` will cause mess up the
- * union.
+ * We have to explicitly account for the empty array case, since the `never` will mess up the union.
  */
-declare type ModUpgradedWithFeatures<T extends ISCFeature> = [T] extends [never] ? ModUpgraded : Omit<ModUpgraded & UnionToIntersection<ISCFeatureToClass[T]>, KeysToScrubFromModClass>;
-declare type KeysToScrubFromModClass = keyof Feature | LowercaseKeys<ModUpgraded>;
+declare type ModUpgradedWithFeatures<T extends ISCFeature> = [T] extends [never] ? ModUpgraded : ModUpgraded & Omit<UnionToIntersection<ISCFeatureToClass[T]>, keyof Feature>;
 /**
  * Use this function to enable the custom callbacks and other optional features provided by
  * `isaacscript-common`.

package/dist/src/core/upgradeMod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upgradeMod.d.ts","sourceRoot":"","sources":["../../../src/core/upgradeMod.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAchD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE;;;;;;GAMG;AACH,aAAK,uBAAuB,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACpE,WAAW,GACX,IAAI,CACF,WAAW,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EACvD,uBAAuB,CACxB,CAAC;AAEN,aAAK,uBAAuB,GAAG,MAAM,OAAO,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,KAAK,EACrD,UAAU,EAAE,GAAG,EACf,QAAQ,GAAE,CAAC,EAAO,EAClB,KAAK,UAAQ,EACb,aAAa,CAAC,EAAE,KAAK,GACpB,uBAAuB,CAAC,CAAC,CAAC,CA8B5B"}
+{"version":3,"file":"upgradeMod.d.ts","sourceRoot":"","sources":["../../../src/core/upgradeMod.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAchD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE;;;;;GAKG;AACH,aAAK,uBAAuB,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACpE,WAAW,GACX,WAAW,GACT,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,KAAK,EACrD,UAAU,EAAE,GAAG,EACf,QAAQ,GAAE,CAAC,EAAO,EAClB,KAAK,UAAQ,EACb,aAAa,CAAC,EAAE,KAAK,GACpB,uBAAuB,CAAC,CAAC,CAAC,CA+B5B"}

package/dist/src/decorators.d.ts

@@ -6,5 +6,5 @@ export declare const EXPORTED_METHOD_NAMES_KEY = "__exportedMethodNames";
  *
  * This is only meant to be used internally.
  */
-export declare function Exported(): <T extends Feature>(target: T, propertyKey: keyof T) => void;
+export declare function Exported(): <Class extends Feature>(target: Class, propertyKey: keyof Class) => void;
 //# sourceMappingURL=decorators.d.ts.map

package/dist/src/decorators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEpD,eAAO,MAAM,yBAAyB,0BAA0B,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,QAAQ,4DACuC,IAAI,CAgBlE"}
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEpD,eAAO,MAAM,yBAAyB,0BAA0B,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,QAAQ,wEAInB,IAAI,CAgBR"}

package/dist/src/functions/decorators.d.ts

@@ -1,19 +1,20 @@
 import { ModCallback } from "isaac-typescript-definitions";
 import { ModFeature } from "../classes/ModFeature";
-import { ModUpgraded } from "../classes/ModUpgraded";
-import { ModCallbackCustom2 } from "../enums/ModCallbackCustom2";
-import { AddCallbackParametersCustom2 } from "../interfaces/private/AddCallbackParametersCustom2";
+import { ModCallbackCustom } from "../enums/ModCallbackCustom";
+import { AddCallbackParametersCustom } from "../interfaces/private/AddCallbackParametersCustom";
 import { AllButFirst } from "../types/AllButFirst";
 /**
  * A decorator function that signifies that the decorated class method should be automatically
  * registered with `Mod.AddCallback`.
+ *
+ * @ignore
  */
 export declare function Callback<T extends ModCallback>(modCallback: T, ...optionalArgs: AllButFirst<AddCallbackParameters[T]>): <Class extends ModFeature, Fn extends AddCallbackParameters[T][0]>(target: Class, propertyKey: string, _descriptor: TypedPropertyDescriptor<Fn>) => void;
 /**
  * A decorator function that signifies that the decorated class method should be automatically
  * registered with `ModUpgraded.AddCallbackCustom`.
+ *
+ * @ignore
  */
-export declare function CallbackCustom<T extends ModCallbackCustom2>(modCallbackCustom: T, ...optionalArgs: AllButFirst<AddCallbackParametersCustom2[T]>): <Class extends {
-    mod: ModUpgraded;
-}>(target: Class, propertyKey: string) => void;
+export declare function CallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>): <Class extends ModFeature, Fn extends AddCallbackParametersCustom[T][0]>(target: Class, propertyKey: string, _descriptor: TypedPropertyDescriptor<Fn>) => void;
 //# sourceMappingURL=decorators.d.ts.map

package/dist/src/functions/decorators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../src/functions/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,4BAA4B,EAAE,MAAM,oDAAoD,CAAC;AAClG,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,WAAW,EAC5C,WAAW,EAAE,CAAC,EACd,GAAG,YAAY,EAAE,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,kGAIvC,MAAM,+CAElB,IAAI,CAMR;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,kBAAkB,EACzD,iBAAiB,EAAE,CAAC,EACpB,GAAG,YAAY,EAAE,WAAW,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;SAEhC,WAAW;+BAEzB,MAAM,KAClB,IAAI,CAMR"}
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../src/functions/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAGL,UAAU,EACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,WAAW,EAC5C,WAAW,EAAE,CAAC,EACd,GAAG,YAAY,EAAE,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,kGAIvC,MAAM,+CAElB,IAAI,CAwBR;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,iBAAiB,EACxD,iBAAiB,EAAE,CAAC,EACpB,GAAG,YAAY,EAAE,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,wGAO7C,MAAM,+CAElB,IAAI,CA0BR"}

package/dist/src/functions/decorators.lua

@@ -1,32 +1,51 @@
 local ____lualib = require("lualib_bundle")
 local __TS__Spread = ____lualib.__TS__Spread
 local ____exports = {}
+local ____ModFeature = require("src.classes.ModFeature")
+local ADD_CALLBACK_ARGS_KEY = ____ModFeature.ADD_CALLBACK_ARGS_KEY
+local ADD_CALLBACK_CUSTOM_ARGS_KEY = ____ModFeature.ADD_CALLBACK_CUSTOM_ARGS_KEY
 --- A decorator function that signifies that the decorated class method should be automatically
 -- registered with `Mod.AddCallback`.
+-- 
+-- @ignore
 function ____exports.Callback(self, modCallback, ...)
     local optionalArgs = {...}
     return function(____, target, propertyKey, _descriptor)
         local methodName = propertyKey
         local method = target[methodName]
-        target.mod:AddCallback(
+        local addCallbackArgs = {
             modCallback,
             method,
             __TS__Spread(optionalArgs)
-        )
+        }
+        local constructor = target.constructor
+        if not (constructor[ADD_CALLBACK_ARGS_KEY] ~= nil) then
+            constructor[ADD_CALLBACK_ARGS_KEY] = {}
+        end
+        local callbackTuples = constructor[ADD_CALLBACK_ARGS_KEY]
+        callbackTuples[#callbackTuples + 1] = addCallbackArgs
     end
 end
 --- A decorator function that signifies that the decorated class method should be automatically
 -- registered with `ModUpgraded.AddCallbackCustom`.
+-- 
+-- @ignore
 function ____exports.CallbackCustom(self, modCallbackCustom, ...)
     local optionalArgs = {...}
-    return function(____, target, propertyKey)
+    return function(____, target, propertyKey, _descriptor)
         local methodName = propertyKey
         local method = target[methodName]
-        target.mod:AddCallbackCustom2(
+        local addCallbackArgs = {
             modCallbackCustom,
             method,
             __TS__Spread(optionalArgs)
-        )
+        }
+        local constructor = target.constructor
+        if not (constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] ~= nil) then
+            constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] = {}
+        end
+        local callbackTuples = constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY]
+        callbackTuples[#callbackTuples + 1] = addCallbackArgs
     end
 end
 return ____exports

package/dist/src/functions/logMisc.d.ts

@@ -44,8 +44,8 @@ export declare function logSet(set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): vo
 /** Helper function for logging every sound effect that is currently playing. */
 export declare function logSounds(): void;
 /**
- * Helper function for logging every key and value of a table. This is a deep log; the function will
- * recursively call itself if it counters a table within a table.
+ * Helper function for logging every key and value of a Lua table. This is a deep log; the function
+ * will recursively call itself if it counters a table within a table.
  *
  * This function will only work on tables that have string keys (because it logs the keys in order,
  * instead of randomly). It will throw a run-time error if it encounters a non-string key.
@@ -56,6 +56,13 @@ export declare function logTable(luaTable: unknown, parentTables?: number): void
  * will only do a shallow comparison.
  */
 export declare function logTableDifferences<K extends AnyNotNil, V>(table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
+/**
+ * Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the
+ * top-most table will be logged.
+ *
+ * This function is useful for tables that have recursive references.
+ */
+export declare function logTableKeys(luaTable: unknown): void;
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */

package/dist/src/functions/logMisc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logMisc.d.ts","sourceRoot":"","sources":["../../../src/functions/logMisc.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EAKV,cAAc,EAGd,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAmBtC,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAG3D;AAED,wBAAgB,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,IAAI,CAS7E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAI3C;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAGhD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAI1C;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,UAAU,EACrD,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC3B,WAAW,SAAK,GACf,IAAI,CAmBN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAiBxC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAI9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAkBzC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAazD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CA0B3D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAoB1D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAC/C,IAAI,CAEN;AAED,sEAAsE;AACtE,wBAAgB,OAAO,IAAI,IAAI,CA2B9B;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAiBrC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAUzE;AAED,gFAAgF;AAChF,wBAAgB,SAAS,IAAI,IAAI,CAQhC;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,YAAY,SAAI,GAAG,IAAI,CA6ClE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EACxD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,IAAI,CA8BN;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAEvE;AAED,gGAAgG;AAChG,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAEpE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAoBnD;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI,CAG7D"}
+{"version":3,"file":"logMisc.d.ts","sourceRoot":"","sources":["../../../src/functions/logMisc.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EAKV,cAAc,EAGd,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAmBtC,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAG3D;AAED,wBAAgB,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,IAAI,CAS7E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAI3C;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAGhD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAI1C;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,UAAU,EACrD,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC3B,WAAW,SAAK,GACf,IAAI,CAmBN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAiBxC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAI9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAkBzC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAazD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CA0B3D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAoB1D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAC/C,IAAI,CAEN;AAED,sEAAsE;AACtE,wBAAgB,OAAO,IAAI,IAAI,CA2B9B;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAiBrC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAUzE;AAED,gFAAgF;AAChF,wBAAgB,SAAS,IAAI,IAAI,CAQhC;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,YAAY,SAAI,GAAG,IAAI,CA6ClE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EACxD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,IAAI,CA8BN;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAkBpD;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAEvE;AAED,gGAAgG;AAChG,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAEpE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAoBnD;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI,CAG7D"}

package/dist/src/functions/logMisc.lua

@@ -374,8 +374,8 @@ function ____exports.logSounds(self)
         end
     end
 end
---- Helper function for logging every key and value of a table. This is a deep log; the function will
--- recursively call itself if it counters a table within a table.
+--- Helper function for logging every key and value of a Lua table. This is a deep log; the function
+-- will recursively call itself if it counters a table within a table.
 -- 
 -- This function will only work on tables that have string keys (because it logs the keys in order,
 -- instead of randomly). It will throw a run-time error if it encounters a non-string key.
@@ -460,6 +460,36 @@ function ____exports.logTableDifferences(self, table1, table2)
         end
     end
 end
+--- Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the
+-- top-most table will be logged.
+-- 
+-- This function is useful for tables that have recursive references.
+function ____exports.logTableKeys(self, luaTable)
+    log(nil, "Printing out the keys of a Lua table:")
+    if not isTable(nil, luaTable) then
+        log(
+            nil,
+            ("  n/a (encountered a variable of type \"" .. __TS__TypeOf(luaTable)) .. "\" instead of a table)"
+        )
+        return
+    end
+    local numElements = 0
+    iterateTableInOrder(
+        nil,
+        luaTable,
+        function(____, key)
+            log(
+                nil,
+                tostring(key)
+            )
+            numElements = numElements + 1
+        end
+    )
+    log(
+        nil,
+        "  The size of the table was: " .. tostring(numElements)
+    )
+end
 --- Helper function for printing out every tear flag that is turned on. Useful when debugging.
 function ____exports.logTearFlags(self, flags)
     ____exports.logFlags(nil, flags, TearFlag, "tear")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "14.1.2",
+  "version": "14.1.3",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/classes/ModFeature.ts

@@ -1,14 +1,74 @@
+import { getTSTLClassConstructor } from "../functions/tstlClass";
+import { TSTLClassMetatable } from "../interfaces/TSTLClassMetatable";
 import { ModUpgraded } from "./ModUpgraded";
 
+export const ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs";
+export const ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs";
+
+type ModFeatureConstructor = TSTLClassMetatable["constructor"] & {
+  [ADD_CALLBACK_ARGS_KEY]: unknown[] | undefined;
+  [ADD_CALLBACK_CUSTOM_ARGS_KEY]: unknown[] | undefined;
+};
+
 /**
- * A helper class for a mod that wants to represent its individual features as classes. This is
- * useful if you are using decorators to represent class methods that should be automatically
- * subscribed to callbacks.
+ * A helper class for mods that wants to represent their individual features as classes. Extend your
+ * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
+ * that automatically subscribe to callbacks.
+ *
+ * For example:
+ *
+ * ```ts
+ * export class MyFeature extends ModFeature {
+ *   @Callback(ModCallback.POST_GAME_STARTED)
+ *   postGameStarted(isContinued: boolean): void {
+ *     Isaac.DebugString(`Callback fired: POST_GAME_STARTED`);
+ *   }
+ * }
+ * ```
  */
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export class ModFeature {
-  private mod: ModUpgraded;
-
   constructor(mod: ModUpgraded) {
-    this.mod = mod;
+    const constructor = getTSTLClassConstructor(this);
+    if (constructor === undefined) {
+      error("Failed to get the TSTL class constructor for a mod feature.");
+    }
+
+    const modFeatureConstructor = constructor as ModFeatureConstructor;
+    addDecoratedCallbacks(mod, modFeatureConstructor);
+    addDecoratedCallbacksCustom(mod, modFeatureConstructor);
+  }
+}
+
+function addDecoratedCallbacks(
+  mod: ModUpgraded,
+  modFeatureConstructor: ModFeatureConstructor,
+) {
+  const addCallbackArgs = modFeatureConstructor[ADD_CALLBACK_ARGS_KEY];
+  if (addCallbackArgs === undefined) {
+    return;
+  }
+
+  for (const args of addCallbackArgs) {
+    // @ts-expect-error The compiler does not know that the arguments match the method.
+    // eslint-disable-next-line isaacscript/strict-enums
+    mod.AddCallback(...args);
+  }
+}
+
+function addDecoratedCallbacksCustom(
+  mod: ModUpgraded,
+  modFeatureConstructor: ModFeatureConstructor,
+) {
+  const addCallbackCustomArgs =
+    modFeatureConstructor[ADD_CALLBACK_CUSTOM_ARGS_KEY];
+  if (addCallbackCustomArgs === undefined) {
+    return;
+  }
+
+  for (const args of addCallbackCustomArgs) {
+    // @ts-expect-error The compiler does not know that the arguments match the method.
+    // eslint-disable-next-line isaacscript/strict-enums
+    mod.AddCallbackCustom(...args);
   }
 }

package/src/classes/ModUpgraded.ts

@@ -216,17 +216,6 @@ export class ModUpgraded implements Mod {
     }
   }
 
-  /**
-   * This method should only be used by the `upgradeMod` function. Returns the names of the exported
-   * class methods from the features that were added.
-   */
-  public initOptionalFeature(feature: ISCFeature): FunctionTuple[] {
-    const featureClass = this.features[feature];
-    this.initFeature(featureClass);
-
-    return getExportedMethodsFromFeature(featureClass);
-  }
-
   // ----------------------
   // Custom private methods
   // ----------------------
@@ -305,6 +294,14 @@ export class ModUpgraded implements Mod {
       saveDataManagerRemove(className);
     }
   }
+
+  /** Returns the names of the exported class methods from the features that were added. */
+  private initOptionalFeature(feature: ISCFeature): FunctionTuple[] {
+    const featureClass = this.features[feature];
+    this.initFeature(featureClass);
+
+    return getExportedMethodsFromFeature(featureClass);
+  }
 }
 
 /**

package/src/core/upgradeMod.ts

@@ -16,24 +16,18 @@ import { initCustomCallbacks } from "../initCustomCallbacks";
 import { initFeatures } from "../initFeatures";
 import { patchErrorFunction } from "../patchErrorFunctions";
 import { loadShaderCrashFix } from "../shaderCrashFix";
-import { LowercaseKeys } from "../types/LowercaseKeys";
 import { UnionToIntersection } from "../types/UnionToIntersection";
 
 /**
  * By specifying one or more optional features, end-users will get a version of `ModUpgraded` that
  * has extra methods corresponding to the features.
  *
- * We have to explicitly account for the empty array case, since `never` will cause mess up the
- * union.
+ * We have to explicitly account for the empty array case, since the `never` will mess up the union.
  */
 type ModUpgradedWithFeatures<T extends ISCFeature> = [T] extends [never]
   ? ModUpgraded
-  : Omit<
-      ModUpgraded & UnionToIntersection<ISCFeatureToClass[T]>,
-      KeysToScrubFromModClass
-    >;
-
-type KeysToScrubFromModClass = keyof Feature | LowercaseKeys<ModUpgraded>;
+  : ModUpgraded &
+      Omit<UnionToIntersection<ISCFeatureToClass[T]>, keyof Feature>;
 
 /**
  * Use this function to enable the custom callbacks and other optional features provided by
@@ -83,6 +77,7 @@ export function upgradeMod<T extends ISCFeature = never>(
   legacyInit(mod); // TODO: remove
 
   for (const feature of features) {
+    // @ts-expect-error We intentionally access the private function here.
     const exportedMethodTuples = mod.initOptionalFeature(feature);
 
     // If the optional feature provides helper functions, attach them to the base mod object. (This

package/src/decorators.ts

@@ -9,7 +9,10 @@ export const EXPORTED_METHOD_NAMES_KEY = "__exportedMethodNames";
  * This is only meant to be used internally.
  */
 export function Exported() {
-  return <T extends Feature>(target: T, propertyKey: keyof T): void => {
+  return <Class extends Feature>(
+    target: Class,
+    propertyKey: keyof Class,
+  ): void => {
     // Since the decorator runs prior to instantiation, we only have access to get and set static
     // properties, which are located on the "constructor" table.
     const constructor = target.constructor as unknown as LuaTable<

package/src/functions/decorators.ts

@@ -1,13 +1,18 @@
 import { ModCallback } from "isaac-typescript-definitions";
-import { ModFeature } from "../classes/ModFeature";
-import { ModUpgraded } from "../classes/ModUpgraded";
-import { ModCallbackCustom2 } from "../enums/ModCallbackCustom2";
-import { AddCallbackParametersCustom2 } from "../interfaces/private/AddCallbackParametersCustom2";
+import {
+  ADD_CALLBACK_ARGS_KEY,
+  ADD_CALLBACK_CUSTOM_ARGS_KEY,
+  ModFeature,
+} from "../classes/ModFeature";
+import { ModCallbackCustom } from "../enums/ModCallbackCustom";
+import { AddCallbackParametersCustom } from "../interfaces/private/AddCallbackParametersCustom";
 import { AllButFirst } from "../types/AllButFirst";
 
 /**
  * A decorator function that signifies that the decorated class method should be automatically
  * registered with `Mod.AddCallback`.
+ *
+ * @ignore
  */
 export function Callback<T extends ModCallback>(
   modCallback: T,
@@ -18,28 +23,72 @@ export function Callback<T extends ModCallback>(
     propertyKey: string,
     _descriptor: TypedPropertyDescriptor<Fn>,
   ): void => {
+    // First, prepare the arguments for the `Mod.AddCallback` method.
     const methodName = propertyKey as keyof Class;
     const method = target[methodName] as AddCallbackParameters[T][0];
-    // @ts-expect-error The compiler is not smart enough to join the types together.
-    target.mod.AddCallback(modCallback, method, ...optionalArgs);
+    const addCallbackArgs = [
+      modCallback,
+      method,
+      ...optionalArgs,
+    ] as unknown as AddCallbackParameters[T];
+
+    // Since the decorator runs prior to instantiation, we only have access to get and set static
+    // properties, which are located on the "constructor" table. Thus, we store the callback
+    // arguments for later.
+    const constructor = target.constructor as unknown as LuaTable<
+      AnyNotNil,
+      unknown
+    >;
+    if (!constructor.has(ADD_CALLBACK_ARGS_KEY)) {
+      constructor.set(ADD_CALLBACK_ARGS_KEY, []);
+    }
+
+    const callbackTuples = constructor.get(ADD_CALLBACK_ARGS_KEY) as unknown[];
+    callbackTuples.push(addCallbackArgs);
   };
 }
 
 /**
  * A decorator function that signifies that the decorated class method should be automatically
  * registered with `ModUpgraded.AddCallbackCustom`.
+ *
+ * @ignore
  */
-export function CallbackCustom<T extends ModCallbackCustom2>(
+export function CallbackCustom<T extends ModCallbackCustom>(
   modCallbackCustom: T,
-  ...optionalArgs: AllButFirst<AddCallbackParametersCustom2[T]>
+  ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>
 ) {
-  return <Class extends { mod: ModUpgraded }>(
+  return <
+    Class extends ModFeature,
+    Fn extends AddCallbackParametersCustom[T][0],
+  >(
     target: Class,
     propertyKey: string,
+    _descriptor: TypedPropertyDescriptor<Fn>,
   ): void => {
+    // First, prepare the arguments for the `Mod.AddCallbackCustom` method.
     const methodName = propertyKey as keyof Class;
-    const method = target[methodName] as AddCallbackParametersCustom2[T][0];
-    // @ts-expect-error The compiler is not smart enough to join the types together.
-    target.mod.AddCallbackCustom2(modCallbackCustom, method, ...optionalArgs);
+    const method = target[methodName] as AddCallbackParametersCustom[T][0];
+    const addCallbackArgs = [
+      modCallbackCustom,
+      method,
+      ...optionalArgs,
+    ] as unknown as AddCallbackParametersCustom[T];
+
+    // Since the decorator runs prior to instantiation, we only have access to get and set static
+    // properties, which are located on the "constructor" table. Thus, we store the callback
+    // arguments for later.
+    const constructor = target.constructor as unknown as LuaTable<
+      AnyNotNil,
+      unknown
+    >;
+    if (!constructor.has(ADD_CALLBACK_CUSTOM_ARGS_KEY)) {
+      constructor.set(ADD_CALLBACK_CUSTOM_ARGS_KEY, []);
+    }
+
+    const callbackTuples = constructor.get(
+      ADD_CALLBACK_CUSTOM_ARGS_KEY,
+    ) as unknown[];
+    callbackTuples.push(addCallbackArgs);
   };
 }

package/src/functions/logMisc.ts

@@ -307,8 +307,8 @@ export function logSounds(): void {
 }
 
 /**
- * Helper function for logging every key and value of a table. This is a deep log; the function will
- * recursively call itself if it counters a table within a table.
+ * Helper function for logging every key and value of a Lua table. This is a deep log; the function
+ * will recursively call itself if it counters a table within a table.
  *
  * This function will only work on tables that have string keys (because it logs the keys in order,
  * instead of randomly). It will throw a run-time error if it encounters a non-string key.
@@ -399,6 +399,32 @@ export function logTableDifferences<K extends AnyNotNil, V>(
   }
 }
 
+/**
+ * Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the
+ * top-most table will be logged.
+ *
+ * This function is useful for tables that have recursive references.
+ */
+export function logTableKeys(luaTable: unknown): void {
+  log("Printing out the keys of a Lua table:");
+
+  if (!isTable(luaTable)) {
+    log(
+      `  n/a (encountered a variable of type "${typeof luaTable}" instead of a table)`,
+    );
+    return;
+  }
+
+  let numElements = 0;
+  iterateTableInOrder(luaTable, (key) => {
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    log(`${key}`);
+    numElements++;
+  });
+
+  log(`  The size of the table was: ${numElements}`);
+}
+
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void {
   logFlags(flags, TearFlag, "tear");