isaacscript-common 15.2.1 → 15.3.1

package/dist/index.d.ts

@@ -3780,7 +3780,13 @@ export declare const GAME_FRAMES_PER_SECOND = 30;
  * It is easier to write mod code if the callbacks run in a more logical order:
  * - `POST_GAME_STARTED` --> `POST_NEW_LEVEL` --> `POST_NEW_ROOM`
  *
- * Manually reorganize the callback execution so that this is the case.
+ * `isaacscript-common` provides three new callbacks that change the order to this:
+ * - `POST_GAME_STARTED_REORDERED`
+ * - `POST_NEW_LEVEL_REORDERED`
+ * - `POST_NEW_ROOM_REORDERED`
+ *
+ * Additionally, there are some helper functions listed below that can deal with some edge cases
+ * that you may run into with these callbacks.
  */
 declare class GameReorderedCallbacks extends Feature {
     private currentStage;
@@ -3802,12 +3808,13 @@ declare class GameReorderedCallbacks extends Feature {
      * the next `POST_NEW_LEVEL`.
      *
      * If some specific cases, mods can change the current level during run initialization on the 0th
-     * frame. However, due to how the callback reordering works, the custom `POST_NEW_LEVEL` callback
-     * will never fire on the 0th frame. To get around this, call this function before changing levels
-     * to temporarily force the callback to fire.
+     * frame. (For example, if you had a mod that made the player start the run in Caves instead of
+     * Basement.) However, due to how the callback reordering works, the `POST_NEW_LEVEL_REORDERED`
+     * callback will never fire on the 0th frame. To get around this, call this function before
+     * changing levels to temporarily force the callback to fire.
      *
      * In order to use this function, you must upgrade your mod with
-     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+     * `ISCFeature.GAME_REORDERED_CALLBACKS`.
      */
     forceNewLevelCallback(): void;
     /**
@@ -3815,23 +3822,24 @@ declare class GameReorderedCallbacks extends Feature {
      * the next `POST_NEW_ROOM`.
      *
      * If some specific cases, mods can change the current room during run initialization on the 0th
-     * frame. However, due to how the callback reordering works, the custom `POST_NEW_ROOM` callback
-     * will never fire on the 0th frame. To get around this, call this function before changing rooms
-     * to temporarily force the callback to fire.
+     * frame. (For example, if you had a mod that made the player start the Treasure Room of Basement
+     * 1 instead of the normal starting room.) However, due to how the callback reordering works, the
+     * `POST_NEW_ROOM_REORDERED` callback will never fire on the 0th frame. To get around this, call
+     * this function before changing rooms to temporarily force the callback to fire.
      *
      * In order to use this function, you must upgrade your mod with
-     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+     * `ISCFeature.GAME_REORDERED_CALLBACKS`.
      */
     forceNewRoomCallback(): void;
     /**
-     * Helper function to manually set the variable that the reordered callback logic uses to track
+     * Helper function to manually set the variables that the reordered callback logic uses to track
      * the current stage and stage type.
      *
-     * This is useful because if the stage is changed with the `Game.SetStage` method, the reordered
-     * callbacks will stop working.
+     * This is useful because if the stage is changed with the `Game.SetStage` method (or the
+     * `setStage` helper function), the reordered callbacks will stop working.
      *
      * In order to use this function, you must upgrade your mod with
-     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+     * `ISCFeature.GAME_REORDERED_CALLBACKS`.
      */
     reorderedCallbacksSetStage(stage: LevelStage, stageType: StageType): void;
 }
@@ -8972,8 +8980,8 @@ export declare enum ModCallbackCustom {
     /**
      * Fires when a new grid entity is initialized. Specifically, this is either:
      *
-     * - in the `POST_NEW_ROOM` callback (firing every time a room is entered, even if the entity was
-     *   previously there on a previous room entry)
+     * - in the `POST_NEW_ROOM_REORDERED` callback (firing every time a room is entered, even if the
+     *   entity was previously there on a previous room entry)
      * - in the `POST_UPDATE` callback (if the entity appeared mid-way through the room, like when the
      *   trapdoor appears after defeating It Lives!)
      *
@@ -9073,8 +9081,8 @@ export declare enum ModCallbackCustom {
      */
     POST_GRID_ENTITY_UPDATE = 36,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when the player loses a Holy Mantle temporary
-     * collectible effect.
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when the player loses a Holy Mantle
+     * temporary collectible effect.
      *
      * This callback is useful because you might want to have code that happens when the player is hit
      * from an enemy. Normally, you would accomplish this via the `ENTITY_TAKE_DMG` callback, but that
@@ -9096,8 +9104,8 @@ export declare enum ModCallbackCustom {
      */
     POST_HOLY_MANTLE_REMOVED = 37,
     /**
-     * Fires from `POST_PEFFECT_UPDATE` callback when the player loses charge on their active
-     * collectible item, implying that the item was just used.
+     * Fires from `POST_PEFFECT_UPDATE_REORDERED` callback when the player loses charge on their
+     * active collectible item, implying that the item was just used.
      *
      * This callback is useful because the `USE_ITEM` callback does not fire when The Candle, Red
      * Candle, and Bob's Rotten Brain are discharged.
@@ -9119,9 +9127,9 @@ export declare enum ModCallbackCustom {
      */
     POST_ITEM_DISCHARGE = 38,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when an item is no longer queued (i.e. when the
-     * animation of the player holding the item above their head is finished and the item is actually
-     * added to the player's inventory).
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when an item is no longer queued (i.e.
+     * when the animation of the player holding the item above their head is finished and the item is
+     * actually added to the player's inventory).
      *
      * Note that this callback will only fire once per Forgotten/Soul pair.
      *
@@ -9404,8 +9412,9 @@ export declare enum ModCallbackCustom {
      */
     POST_PIT_UPDATE = 55,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when a player's health (i.e. hearts) is different
-     * than what it was on the previous frame. For more information, see the `PlayerHealth` enum.
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's health (i.e. hearts) is
+     * different than what it was on the previous frame. For more information, see the `PlayerHealth`
+     * enum.
      *
      * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
      * - You can provide an optional third argument that will make the callback only fire if it
@@ -9425,8 +9434,8 @@ export declare enum ModCallbackCustom {
      */
     POST_PLAYER_CHANGE_HEALTH = 56,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when one of the player's stats change from what
-     * they were on the previous frame.
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when one of the player's stats change
+     * from what they were on the previous frame.
      *
      * The type of `oldValue` and `newValue` will depend on what kind of stat it is. For example,
      * `StatType.FLYING` will be a boolean. (You can use the "Types" helper functions to narrow the
@@ -9455,7 +9464,8 @@ export declare enum ModCallbackCustom {
      */
     POST_PLAYER_CHANGE_STAT = 57,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when a player entity changes its player type
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player entity changes its player
+     * type
      * (i.e. character) from what it was on the previous frame. For example, it will fire after using
      * Clicker, after dying with the Judas' Shadow collectible, etc.
      *
@@ -9477,9 +9487,9 @@ export declare enum ModCallbackCustom {
      */
     POST_PLAYER_CHANGE_TYPE = 58,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is higher than
-     * what it was on the previous frame, or when the active items change, or when the build is
-     * rerolled.
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's collectible count is
+     * higher than what it was on the previous frame, or when the active items change, or when the
+     * build is rerolled.
      *
      * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
      * - You can provide an optional third argument that will make the callback only fire if the
@@ -9494,9 +9504,9 @@ export declare enum ModCallbackCustom {
      */
     POST_PLAYER_COLLECTIBLE_ADDED = 59,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is lower than
-     * what it was on the previous frame, or when the active items change, or when the build is
-     * rerolled.
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's collectible count is
+     * lower than what it was on the previous frame, or when the active items change, or when the
+     * build is rerolled.
      *
      * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
      * - You can provide an optional third argument that will make the callback only fire if the
@@ -9685,8 +9695,9 @@ export declare enum ModCallbackCustom {
      */
     POST_PROJECTILE_INIT_LATE = 70,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when a player first picks up a new item. The
-     * pickup returned in the callback is assumed to be the first pickup that no longer exists.
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player first picks up a new
+     * item. The pickup returned in the callback is assumed to be the first pickup that no longer
+     * exists.
      *
      * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
      * - You can provide an optional third argument that will make the callback only fire if it
@@ -9815,8 +9826,8 @@ export declare enum ModCallbackCustom {
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
-     * - in the `POST_NEW_ROOM` callback (firing every time a room is entered, even if the entity was
-     *   previously there on a previous room entry)
+     * - in the `POST_NEW_ROOM_REORDERED` callback (firing every time a room is entered, even if the
+     *   entity was previously there on a previous room entry)
      * - in the `POST_UPDATE` callback (if the entity appeared mid-way through the room, like when a
      *   Wheel of Fortune card is used)
      *
@@ -9943,7 +9954,7 @@ export declare enum ModCallbackCustom {
      */
     POST_TNT_UPDATE = 87,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when a player gains or loses a new
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
      *
      * Note that this callback will only fire once per Forgotten/Soul pair.
@@ -9977,9 +9988,9 @@ export declare enum ModCallbackCustom {
      */
     POST_TRINKET_BREAK = 89,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback on the frame before a Berserk effect ends when
-     * the player is predicted to die (e.g. they currently have no health left or they took damage in
-     * a "Lost" form).
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback on the frame before a Berserk effect
+     * ends when the player is predicted to die (e.g. they currently have no health left or they took
+     * damage in a "Lost" form).
      *
      * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
      * - You can provide an optional third argument that will make the callback only fire if it
@@ -10032,8 +10043,8 @@ export declare enum ModCallbackCustom {
      */
     PRE_GET_PEDESTAL = 92,
     /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when an item becomes queued (i.e. when the player
-     * begins to hold the item above their head).
+     * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when an item becomes queued (i.e. when
+     * the player begins to hold the item above their head).
      *
      * Note that this callback will only fire once per Forgotten/Soul pair.
      *
@@ -10703,9 +10714,30 @@ declare class ModdedElementSets extends Feature {
  *   }
  * }
  * ```
+ *
+ * In almost all cases, you will want the callback functions to be immediately subscribed after
+ * instantiating the class. However, if this is not the case, you can pass `false` as the optional
+ * second argument to the constructor.
  */
 export declare class ModFeature {
-    constructor(mod: ModUpgradedBase);
+    private mod;
+    private initialized;
+    constructor(mod: ModUpgradedBase, init?: boolean);
+    /**
+     * Runs the `Mod.AddCallback` and `ModUpgraded.AddCallbackCustom` methods for all of the decorated
+     * callbacks. Additionally, subscribes the `v` object to the save data manager, if present.
+     *
+     * @param init Optional. Whether to initialize or uninitialize. Default is true.
+     */
+    init(init?: boolean): void;
+    /**
+     * Runs the `Mod.RemoveCallback` and `ModUpgraded.RemoveCallbackCustom` methods for all of the
+     * decorated callbacks. Additionally, unsubscribes the `v` object from the save data manager, if
+     * present.
+     *
+     * This is just an alias for `ModFeature.init(false)`.
+     */
+    uninit(): void;
 }
 
 /**

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 15.2.1
+isaacscript-common 15.3.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -27607,8 +27607,6 @@ return ____exports
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
 local __TS__ClassExtends = ____lualib.__TS__ClassExtends
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
@@ -27622,7 +27620,6 @@ PostNPCInitFilter.name = "PostNPCInitFilter"
 __TS__ClassExtends(PostNPCInitFilter, CustomCallback)
 function PostNPCInitFilter.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
-    self.v = {room = {firedSet = __TS__New(Set)}}
     self.shouldFire = shouldFireNPC
     self.postNPCInit = function(____, npc)
         self:fire(npc)
@@ -27705,8 +27702,6 @@ return ____exports
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
 local __TS__ClassExtends = ____lualib.__TS__ClassExtends
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
@@ -27720,7 +27715,6 @@ PostNPCUpdateFilter.name = "PostNPCUpdateFilter"
 __TS__ClassExtends(PostNPCUpdateFilter, CustomCallback)
 function PostNPCUpdateFilter.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
-    self.v = {room = {firedSet = __TS__New(Set)}}
     self.shouldFire = shouldFireNPC
     self.postNPCUpdate = function(____, npc)
         self:fire(npc)
@@ -48346,66 +48340,122 @@ return ____exports
 ["src.classes.ModFeature"] = function(...) 
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local checkAddDecoratedCallbacks, checkAddDecoratedCallbacksCustom, checkRegisterSaveDataManager
+local initDecoratedCallbacks, addCallback, removeCallback, initSaveDataManager, WRAPPED_CALLBACK_METHODS_KEY, WRAPPED_CUSTOM_CALLBACK_METHODS_KEY
+local ____array = require("src.functions.array")
+local isArray = ____array.isArray
+local ____deepCopy = require("src.functions.deepCopy")
+local deepCopy = ____deepCopy.deepCopy
 local ____tstlClass = require("src.functions.tstlClass")
 local getTSTLClassConstructor = ____tstlClass.getTSTLClassConstructor
 local getTSTLClassName = ____tstlClass.getTSTLClassName
 local ____types = require("src.functions.types")
+local isFunction = ____types.isFunction
+local isNumber = ____types.isNumber
 local isTable = ____types.isTable
-function checkAddDecoratedCallbacks(self, mod, modFeatureConstructor, modFeature)
-    local addCallbackArgs = modFeatureConstructor[____exports.ADD_CALLBACK_ARGS_KEY]
+function initDecoratedCallbacks(self, modFeature, constructor, tstlClassName, vanilla, init)
+    local modFeatureConstructor = constructor
+    local argsKey = vanilla and ____exports.ADD_CALLBACK_ARGS_KEY or ____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY
+    local addCallbackArgs = modFeatureConstructor[argsKey]
     if addCallbackArgs == nil then
         return
     end
-    local tstlClassName = getTSTLClassName(nil, modFeatureConstructor) or "Unknown"
+    if not isArray(nil, addCallbackArgs) then
+        error(("Failed to initialize/uninitialize the decorated callbacks on a mod feature since the callback arguments on the key of \"" .. argsKey) .. "\" was not an array.")
+    end
     for ____, args in ipairs(addCallbackArgs) do
-        local parameters = args
+        if not isArray(nil, args) then
+            error("Failed to initialize/uninitialize the decorated callbacks on a mod feature since one of the callback arguments was not an array.")
+        end
+        local parameters = deepCopy(nil, args)
         local modCallback = table.remove(parameters, 1)
-        if modCallback == nil then
-            error("Failed to get the ModCallback from the parameters for class: " .. tstlClassName)
+        if not isNumber(nil, modCallback) then
+            error("Failed to get the callback number from the parameters for class: " .. tstlClassName)
         end
         local callback = table.remove(parameters, 1)
-        if callback == nil then
-            error("Failed to get the callback from the parameters for class: " .. tstlClassName)
+        if not isFunction(nil, callback) then
+            error("Failed to get the callback function from the parameters for class: " .. tstlClassName)
         end
-        local function newCallback(____, ...)
-            callback(modFeature, ...)
+        local mod = modFeature.mod
+        if init then
+            addCallback(
+                nil,
+                modFeature,
+                modFeatureConstructor,
+                mod,
+                modCallback,
+                callback,
+                parameters,
+                vanilla
+            )
+        else
+            removeCallback(
+                nil,
+                modFeatureConstructor,
+                mod,
+                modCallback,
+                vanilla
+            )
         end
-        mod:AddCallback(
-            modCallback,
-            newCallback,
-            table.unpack(parameters)
-        )
     end
 end
-function checkAddDecoratedCallbacksCustom(self, mod, modFeatureConstructor, modFeature)
-    local addCallbackCustomArgs = modFeatureConstructor[____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY]
-    if addCallbackCustomArgs == nil then
-        return
+function addCallback(self, modFeature, modFeatureConstructor, mod, modCallback, callback, parameters, vanilla)
+    local function wrappedCallback(____, ...)
+        callback(nil, modFeature, ...)
     end
-    local tstlClassName = getTSTLClassName(nil, modFeatureConstructor) or "Unknown"
-    for ____, args in ipairs(addCallbackCustomArgs) do
-        local parameters = args
-        local modCallbackCustom = table.remove(parameters, 1)
-        if modCallbackCustom == nil then
-            error("Failed to get the ModCallbackCustom from the parameters for class: " .. tstlClassName)
-        end
-        local callback = table.remove(parameters, 1)
-        if callback == nil then
-            error("Failed to get the callback from the parameters for class: " .. tstlClassName)
+    if vanilla then
+        local modCallbackVanilla = modCallback
+        local wrappedMethodsMap = modFeatureConstructor[WRAPPED_CALLBACK_METHODS_KEY]
+        if wrappedMethodsMap == nil then
+            wrappedMethodsMap = __TS__New(Map)
+            modFeatureConstructor[WRAPPED_CALLBACK_METHODS_KEY] = wrappedMethodsMap
         end
-        local function newCallback(____, ...)
-            callback(modFeature, ...)
+        wrappedMethodsMap:set(modCallbackVanilla, wrappedCallback)
+    else
+        local modCallbackCustom = modCallback
+        local wrappedMethodsMap = modFeatureConstructor[WRAPPED_CUSTOM_CALLBACK_METHODS_KEY]
+        if wrappedMethodsMap == nil then
+            wrappedMethodsMap = __TS__New(Map)
+            modFeatureConstructor[WRAPPED_CUSTOM_CALLBACK_METHODS_KEY] = wrappedMethodsMap
         end
+        wrappedMethodsMap:set(modCallbackCustom, wrappedCallback)
+    end
+    if vanilla then
+        mod:AddCallback(
+            modCallback,
+            wrappedCallback,
+            table.unpack(parameters)
+        )
+    else
         mod:AddCallbackCustom(
-            modCallbackCustom,
-            newCallback,
+            modCallback,
+            wrappedCallback,
             table.unpack(parameters)
         )
     end
 end
-function checkRegisterSaveDataManager(self, mod, modFeature)
+function removeCallback(self, modFeatureConstructor, mod, modCallback, vanilla)
+    if vanilla then
+        local modCallbackVanilla = modCallback
+        local wrappedMethodsMap = modFeatureConstructor[WRAPPED_CALLBACK_METHODS_KEY]
+        if wrappedMethodsMap == nil then
+            return
+        end
+        local wrappedCallback = wrappedMethodsMap:get(modCallbackVanilla)
+        mod:RemoveCallback(modCallback, wrappedCallback)
+    else
+        local modCallbackCustom = modCallback
+        local wrappedMethodsMap = modFeatureConstructor[WRAPPED_CUSTOM_CALLBACK_METHODS_KEY]
+        if wrappedMethodsMap == nil then
+            return
+        end
+        local wrappedCallback = wrappedMethodsMap:get(modCallbackCustom)
+        mod:RemoveCallbackCustom(modCallback, wrappedCallback)
+    end
+end
+function initSaveDataManager(self, modFeature, tstlClassName, init)
     local ____modFeature_0 = modFeature
     local v = ____modFeature_0.v
     if v == nil then
@@ -48414,28 +48464,74 @@ function checkRegisterSaveDataManager(self, mod, modFeature)
     if not isTable(nil, v) then
         error("Failed to initialize a mod feature class due to having a \"v\" property that is not an object. (The \"v\" property is supposed to be an object that holds the variables for the class, managed by the save data manager.)")
     end
-    local ____mod_1 = mod
-    local saveDataManager = ____mod_1.saveDataManager
-    if saveDataManager == nil then
+    local mod = modFeature.mod
+    local saveDataManagerMethodName = init and "saveDataManager" or "saveDataManagerRemove"
+    local saveDataManagerMethod = mod[saveDataManagerMethodName]
+    if saveDataManagerMethod == nil then
         error("Failed to initialize a mod feature class due to having a \"v\" object and not having the save data manager initialized. You must pass \"ISCFeature.SAVE_DATA_MANAGER\" to the \"upgradeMod\" function.")
     end
-    local tstlClassName = getTSTLClassName(nil, modFeature)
-    saveDataManager(nil, tstlClassName, v)
+    if type(saveDataManagerMethod) ~= "function" then
+        error(("The \"" .. saveDataManagerMethodName) .. "\" property of the \"ModUpgraded\" object was not a function.")
+    end
+    if init then
+        saveDataManagerMethod(nil, tstlClassName, v)
+    else
+        saveDataManagerMethod(nil, tstlClassName)
+    end
 end
 ____exports.ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs"
 ____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs"
+WRAPPED_CALLBACK_METHODS_KEY = "__wrappedCallbackMethods"
+WRAPPED_CUSTOM_CALLBACK_METHODS_KEY = "__wrappedCustomCallbacksMethods"
 ____exports.ModFeature = __TS__Class()
 local ModFeature = ____exports.ModFeature
 ModFeature.name = "ModFeature"
-function ModFeature.prototype.____constructor(self, mod)
+function ModFeature.prototype.____constructor(self, mod, init)
+    if init == nil then
+        init = true
+    end
+    self.initialized = false
+    self.mod = mod
+    if init then
+        self:init()
+    end
+end
+function ModFeature.prototype.init(self, init)
+    if init == nil then
+        init = true
+    end
+    if self.initialized == init then
+        return
+    end
+    self.initialized = init
     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
-    checkAddDecoratedCallbacks(nil, mod, modFeatureConstructor, self)
-    checkAddDecoratedCallbacksCustom(nil, mod, modFeatureConstructor, self)
-    checkRegisterSaveDataManager(nil, mod, self)
+    local tstlClassName = getTSTLClassName(nil, self)
+    if tstlClassName == nil then
+        error("Failed to get the TSTL class name for a mod feature.")
+    end
+    initDecoratedCallbacks(
+        nil,
+        self,
+        constructor,
+        tstlClassName,
+        true,
+        init
+    )
+    initDecoratedCallbacks(
+        nil,
+        self,
+        constructor,
+        tstlClassName,
+        false,
+        init
+    )
+    initSaveDataManager(nil, self, tstlClassName, init)
+end
+function ModFeature.prototype.uninit(self)
+    self:init(false)
 end
 return ____exports
  end,

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

@@ -26,8 +26,29 @@ export declare const ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs";
  *   }
  * }
  * ```
+ *
+ * In almost all cases, you will want the callback functions to be immediately subscribed after
+ * instantiating the class. However, if this is not the case, you can pass `false` as the optional
+ * second argument to the constructor.
  */
 export declare class ModFeature {
-    constructor(mod: ModUpgradedBase);
+    private mod;
+    private initialized;
+    constructor(mod: ModUpgradedBase, init?: boolean);
+    /**
+     * Runs the `Mod.AddCallback` and `ModUpgraded.AddCallbackCustom` methods for all of the decorated
+     * callbacks. Additionally, subscribes the `v` object to the save data manager, if present.
+     *
+     * @param init Optional. Whether to initialize or uninitialize. Default is true.
+     */
+    init(init?: boolean): void;
+    /**
+     * Runs the `Mod.RemoveCallback` and `ModUpgraded.RemoveCallbackCustom` methods for all of the
+     * decorated callbacks. Additionally, unsubscribes the `v` object from the save data manager, if
+     * present.
+     *
+     * This is just an alias for `ModFeature.init(false)`.
+     */
+    uninit(): void;
 }
 //# 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":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,qBAAqB,sBAAsB,CAAC;AACzD,eAAO,MAAM,4BAA4B,4BAA4B,CAAC;AAOtE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,qBAAa,UAAU;gBACT,GAAG,EAAE,eAAe;CAWjC"}
+{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,qBAAqB,sBAAsB,CAAC;AACzD,eAAO,MAAM,4BAA4B,4BAA4B,CAAC;AAatE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAC7B,OAAO,CAAC,WAAW,CAAS;gBAEhB,GAAG,EAAE,eAAe,EAAE,IAAI,UAAO;IAQ7C;;;;;OAKG;IACI,IAAI,CAAC,IAAI,UAAO,GAAG,IAAI;IAqB9B;;;;;;OAMG;IACI,MAAM,IAAI,IAAI;CAGtB"}