isaacscript-common 20.10.0 → 20.11.1

package/dist/index.d.ts

@@ -2068,11 +2068,12 @@ export declare interface CustomStageTSConfig {
      * Mandatory. An arbitrarily chosen prefix in the range of 101-999 that will be unique to this
      * stage.
      *
-     * Make sure the chosen prefix does not conflict with any other mods. You can find a list of
-     * registered room variant prefixes on the IsaacScript website:
+     * Use a value of 100 when testing locally. When publishing to the workshop or otherwise
+     * distributing your mod, make sure that you have chosen a prefix that does not conflict with any
+     * other mods. You can find a list of registered room variant prefixes on the IsaacScript website:
      * https://isaacscript.github.io/main/custom-stages
      *
-     * @minimum 101
+     * @minimum 100
      * @maximum 999
      */
     roomVariantPrefix: number;
@@ -11462,8 +11463,7 @@ export declare class ModFeature {
      */
     protected shouldCallbackMethodsFire: (<T extends boolean>(vanilla: T, modCallback: T extends true ? ModCallback : ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
     /**
-     * Whether or not the feature has registered its callbacks yet (and submitted its variables to the
-     * save data manager, if any).
+     * Whether or not the feature has registered its callbacks yet.
      *
      * This will almost always be equal to true unless you explicitly passed `false` to the second
      * argument of the constructor.
@@ -11472,15 +11472,14 @@ export declare class ModFeature {
     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.
+     * callbacks.
      *
      * @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.
+     * decorated callbacks.
      *
      * This is just an alias for `ModFeature.init(false)`.
      */
@@ -13172,12 +13171,12 @@ export declare function roomGridIndexToXY(roomGridIndex: int): [x: int, y: int];
 declare class RoomHistory extends Feature {
     private postNewRoomEarly;
     /**
-     * Helper function to get the total number of rooms that the player has visited thus far on the
-     * run.
+     * Helper function to get the total number of rooms that the player has entered thus far on the
+     * run. (Re-entering the same room will increment the number returned.)
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
      */
-    getNumRoomsVisited(): ReadonlyArray<Readonly<RoomDescription>>;
+    getNumRoomsEntered(): int;
     /**
      * Helper function to get information about all of the rooms that a player has visited thus far on
      * this run.
@@ -13246,6 +13245,7 @@ export declare function runDeepCopyTests(): void;
 
 declare class RunInNFrames extends Feature {
     vConditionalFunc: () => boolean;
+    private roomHistory;
     private postUpdate;
     private postRender;
     /**
@@ -13269,8 +13269,13 @@ declare class RunInNFrames extends Feature {
      * deferred functions manually using serializable data.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
+     *
+     * @param func The function to run.
+     * @param gameFrames The amount of game frames to wait before running the function.
+     * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
+     *                            room is loaded in the interim. Default is false.
      */
-    runInNGameFrames(func: () => void, gameFrames: int): void;
+    runInNGameFrames(func: () => void, gameFrames: int, cancelIfRoomChanges?: boolean): void;
     /**
      * Supply a function to run N render frames from now in the `POST_RENDER` callback.
      *
@@ -13282,8 +13287,13 @@ declare class RunInNFrames extends Feature {
      * deferred functions manually using serializable data.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
+     *
+     * @param func The function to run.
+     * @param renderFrames The amount of render frames to wait before running the function.
+     * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
+     *                            room is loaded in the interim. Default is false.
      */
-    runInNRenderFrames(func: () => void, renderFrames: int): void;
+    runInNRenderFrames(func: () => void, renderFrames: int, cancelIfRoomChanges?: boolean): void;
     /**
      * Supply a function to run on the next `POST_UPDATE` callback.
      *
@@ -13313,8 +13323,12 @@ declare class RunInNFrames extends Feature {
      * deferred functions manually using serializable data.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
+     *
+     * @param func The function to run.
+     * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
+     *                            room is loaded in the interim. Default is false.
      */
-    runNextGameFrame(func: () => void): void;
+    runNextGameFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
     /**
      * Supply a function to run on the next `POST_RENDER` callback.
      *
@@ -13324,8 +13338,12 @@ declare class RunInNFrames extends Feature {
      * Note that this function will not handle saving and quitting.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
+     *
+     * @param func The function to run.
+     * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
+     *                            room is loaded in the interim. Default is false.
      */
-    runNextRenderFrame(func: () => void): void;
+    runNextRenderFrame(func: () => void, cancelIfRoomChanges?: boolean): void;
     /**
      * Supply a function to be repeatedly run on an interval of N game frames in the `POST_UPDATE`
      * callback. The function will continue to be fired until `false` is returned from the function.
@@ -13343,8 +13361,10 @@ declare class RunInNFrames extends Feature {
      * @param gameFrames The amount of game frames to wait between each run.
      * @param runImmediately Whether or not to execute the function right now before waiting for the
      *                       interval.
+     * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
+     *                            room is loaded in the interim. Default is false.
      */
-    setIntervalGameFrames(func: () => boolean, gameFrames: int, runImmediately: boolean): void;
+    setIntervalGameFrames(func: () => boolean, gameFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
     /**
      * Supply a function to be repeatedly run on an interval of N render frames in the `POST_RENDER`
      * callback. The function will continue to be fired until `false` is returned from the function.
@@ -13362,8 +13382,10 @@ declare class RunInNFrames extends Feature {
      * @param renderFrames The amount of game frames to wait between each run.
      * @param runImmediately Whether or not to execute the function right now before waiting for the
      *                       interval.
+     * @param cancelIfRoomChanges Optional. Whether or not to cancel running the function if a new
+     *                            room is loaded in the interim. Default is false.
      */
-    setIntervalRenderFrames(func: () => boolean, renderFrames: int, runImmediately: boolean): void;
+    setIntervalRenderFrames(func: () => boolean, renderFrames: int, runImmediately: boolean, cancelIfRoomChanges?: boolean): void;
 }
 
 /**

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 20.10.0
+isaacscript-common 20.11.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -31619,6 +31619,119 @@ return ____exports
  end,
 ["src.interfaces.GridEntityCustomData"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.interfaces.RoomDescription"] = function(...) 
+local ____exports = {}
+return ____exports
+ end,
+["src.classes.features.other.RoomHistory"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____array = require("src.functions.array")
+local getLastElement = ____array.getLastElement
+local ____dimensions = require("src.functions.dimensions")
+local getDimension = ____dimensions.getDimension
+local ____roomData = require("src.functions.roomData")
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomListIndex = ____roomData.getRoomListIndex
+local getRoomName = ____roomData.getRoomName
+local getRoomStageID = ____roomData.getRoomStageID
+local getRoomSubType = ____roomData.getRoomSubType
+local getRoomVariant = ____roomData.getRoomVariant
+local getRoomVisitedCount = ____roomData.getRoomVisitedCount
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+____exports.RoomHistory = __TS__Class()
+local RoomHistory = ____exports.RoomHistory
+RoomHistory.name = "RoomHistory"
+__TS__ClassExtends(RoomHistory, Feature)
+function RoomHistory.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.v = {run = {roomHistory = {}}}
+    self.postNewRoomEarly = function()
+        local level = game:GetLevel()
+        local stage = level:GetStage()
+        local stageType = level:GetStageType()
+        local room = game:GetRoom()
+        local roomType = room:GetType()
+        local seeds = game:GetSeeds()
+        local startSeedString = seeds:GetStartSeedString()
+        local stageID = getRoomStageID(nil)
+        local dimension = getDimension(nil)
+        local roomVariant = getRoomVariant(nil)
+        local roomSubType = getRoomSubType(nil)
+        local roomName = getRoomName(nil)
+        local roomGridIndex = getRoomGridIndex(nil)
+        local roomListIndex = getRoomListIndex(nil)
+        local roomVisitedCount = getRoomVisitedCount(nil)
+        local roomDescription = {
+            startSeedString = startSeedString,
+            stage = stage,
+            stageType = stageType,
+            stageID = stageID,
+            dimension = dimension,
+            roomType = roomType,
+            roomVariant = roomVariant,
+            roomSubType = roomSubType,
+            roomName = roomName,
+            roomGridIndex = roomGridIndex,
+            roomListIndex = roomListIndex,
+            roomVisitedCount = roomVisitedCount
+        }
+        local ____self_v_run_roomHistory_0 = self.v.run.roomHistory
+        ____self_v_run_roomHistory_0[#____self_v_run_roomHistory_0 + 1] = roomDescription
+    end
+    self.customCallbacksUsed = {{ModCallbackCustom.POST_NEW_ROOM_EARLY, self.postNewRoomEarly}}
+end
+function RoomHistory.prototype.getNumRoomsEntered(self)
+    return #self.v.run.roomHistory
+end
+function RoomHistory.prototype.getRoomHistory(self)
+    return self.v.run.roomHistory
+end
+function RoomHistory.prototype.getPreviousRoomDescription(self)
+    local previousRoomDescription = self.v.run.roomHistory[#self.v.run.roomHistory - 2 + 1]
+    if previousRoomDescription ~= nil then
+        return previousRoomDescription
+    end
+    local startingRoomDescription = self.v.run.roomHistory[1]
+    if startingRoomDescription ~= nil then
+        return startingRoomDescription
+    end
+    error("Failed to find a room description for any rooms thus far on this run.")
+end
+function RoomHistory.prototype.getLatestRoomDescription(self)
+    return getLastElement(nil, self.v.run.roomHistory)
+end
+function RoomHistory.prototype.isLeavingRoom(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    local seeds = game:GetSeeds()
+    local startSeedString = seeds:GetStartSeedString()
+    local roomListIndex = getRoomListIndex(nil)
+    local roomVisitedCount = getRoomVisitedCount(nil)
+    local latestRoomDescription = self:getLatestRoomDescription()
+    if latestRoomDescription == nil then
+        return false
+    end
+    return startSeedString ~= latestRoomDescription.startSeedString or stage ~= latestRoomDescription.stage or stageType ~= latestRoomDescription.stageType or roomListIndex ~= latestRoomDescription.roomListIndex or roomVisitedCount ~= latestRoomDescription.roomVisitedCount
+end
+__TS__Decorate({Exported}, RoomHistory.prototype, "getNumRoomsEntered", true)
+__TS__Decorate({Exported}, RoomHistory.prototype, "getRoomHistory", true)
+__TS__Decorate({Exported}, RoomHistory.prototype, "getPreviousRoomDescription", true)
+__TS__Decorate({Exported}, RoomHistory.prototype, "getLatestRoomDescription", true)
+__TS__Decorate({Exported}, RoomHistory.prototype, "isLeavingRoom", true)
 return ____exports
  end,
 ["src.classes.features.other.RunInNFrames"] = function(...) 
@@ -31635,44 +31748,61 @@ local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
 local ____decorators = require("src.decorators")
 local Exported = ____decorators.Exported
+local ____ISCFeature = require("src.enums.ISCFeature")
+local ISCFeature = ____ISCFeature.ISCFeature
 local ____array = require("src.functions.array")
 local arrayRemoveInPlace = ____array.arrayRemoveInPlace
 local ____run = require("src.functions.run")
 local restart = ____run.restart
 local ____Feature = require("src.classes.private.Feature")
 local Feature = ____Feature.Feature
-function checkExecuteQueuedFunctions(self, frameCount, functionTuples)
+function checkExecuteQueuedFunctions(self, functionTuples, frameCount, newNumRoomsEntered)
     local firingFunctions = __TS__ArrayFilter(
         functionTuples,
         function(____, ____bindingPattern0)
             local frameCountToFire
-            frameCountToFire = ____bindingPattern0[1]
+            frameCountToFire = ____bindingPattern0.frameCountToFire
             return frameCount >= frameCountToFire
         end
     )
-    for ____, tuple in ipairs(firingFunctions) do
-        local _frameCountToFire, func = table.unpack(tuple)
-        func(nil)
-        arrayRemoveInPlace(nil, functionTuples, tuple)
+    for ____, firingFunction in ipairs(firingFunctions) do
+        local func = firingFunction.func
+        local cancelIfRoomChanges = firingFunction.cancelIfRoomChanges
+        local numRoomsEntered = firingFunction.numRoomsEntered
+        if not cancelIfRoomChanges or numRoomsEntered == newNumRoomsEntered then
+            func(nil)
+        end
+        arrayRemoveInPlace(nil, functionTuples, firingFunction)
     end
 end
-function checkExecuteIntervalFunctions(self, frameCount, functionTuples)
+function checkExecuteIntervalFunctions(self, functionTuples, frameCount, newNumRoomsEntered)
     local firingFunctions = __TS__ArrayFilter(
         functionTuples,
         function(____, ____bindingPattern0)
             local frameCountToFire
-            frameCountToFire = ____bindingPattern0[1]
+            frameCountToFire = ____bindingPattern0.frameCountToFire
             return frameCount >= frameCountToFire
         end
     )
-    for ____, tuple in ipairs(firingFunctions) do
-        local _frameCountToFire, func, numIntervalFrames = table.unpack(tuple)
-        local returnValue = func(nil)
-        arrayRemoveInPlace(nil, functionTuples, tuple)
+    for ____, firingFunction in ipairs(firingFunctions) do
+        local func = firingFunction.func
+        local cancelIfRoomChanges = firingFunction.cancelIfRoomChanges
+        local numRoomsEntered = firingFunction.numRoomsEntered
+        local numIntervalFrames = firingFunction.numIntervalFrames
+        local returnValue = false
+        if not cancelIfRoomChanges or numRoomsEntered == newNumRoomsEntered then
+            returnValue = func(nil)
+        end
+        arrayRemoveInPlace(nil, functionTuples, firingFunction)
         if returnValue then
-            local nextFireFrame = frameCount + numIntervalFrames
-            local newTuple = {nextFireFrame, func, numIntervalFrames}
-            functionTuples[#functionTuples + 1] = newTuple
+            local newIntervalFunction = {
+                func = func,
+                frameCountToFire = frameCount + numIntervalFrames,
+                numRoomsEntered = numRoomsEntered,
+                cancelIfRoomChanges = cancelIfRoomChanges,
+                numIntervalFrames = numIntervalFrames
+            }
+            functionTuples[#functionTuples + 1] = newIntervalFunction
         end
     end
 end
@@ -31680,63 +31810,99 @@ ____exports.RunInNFrames = __TS__Class()
 local RunInNFrames = ____exports.RunInNFrames
 RunInNFrames.name = "RunInNFrames"
 __TS__ClassExtends(RunInNFrames, Feature)
-function RunInNFrames.prototype.____constructor(self)
+function RunInNFrames.prototype.____constructor(self, roomHistory)
     Feature.prototype.____constructor(self)
-    self.v = {run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}, intervalGameFunctionTuples = {}, intervalRenderFunctionTuples = {}}}
+    self.v = {run = {queuedGameFunctions = {}, queuedRenderFunctions = {}, intervalGameFunctions = {}, intervalRenderFunctions = {}}}
     self.vConditionalFunc = function() return false end
     self.postUpdate = function()
         local gameFrameCount = game:GetFrameCount()
-        checkExecuteQueuedFunctions(nil, gameFrameCount, self.v.run.queuedGameFunctionTuples)
-        checkExecuteIntervalFunctions(nil, gameFrameCount, self.v.run.intervalGameFunctionTuples)
+        local numRoomsEntered = self.roomHistory:getNumRoomsEntered()
+        checkExecuteQueuedFunctions(nil, self.v.run.queuedGameFunctions, gameFrameCount, numRoomsEntered)
+        checkExecuteIntervalFunctions(nil, self.v.run.intervalGameFunctions, gameFrameCount, numRoomsEntered)
     end
     self.postRender = function()
         local renderFrameCount = Isaac.GetFrameCount()
-        checkExecuteQueuedFunctions(nil, renderFrameCount, self.v.run.queuedRenderFunctionTuples)
-        checkExecuteIntervalFunctions(nil, renderFrameCount, self.v.run.intervalRenderFunctionTuples)
+        local numRoomsEntered = self.roomHistory:getNumRoomsEntered()
+        checkExecuteQueuedFunctions(nil, self.v.run.queuedRenderFunctions, renderFrameCount, numRoomsEntered)
+        checkExecuteIntervalFunctions(nil, self.v.run.intervalRenderFunctions, renderFrameCount, numRoomsEntered)
     end
+    self.featuresUsed = {ISCFeature.ROOM_HISTORY}
     self.callbacksUsed = {{ModCallback.POST_UPDATE, self.postUpdate}, {ModCallback.POST_RENDER, self.postRender}}
+    self.roomHistory = roomHistory
 end
 function RunInNFrames.prototype.restartNextRenderFrame(self, character)
     self:runNextRenderFrame(function()
         restart(nil, character)
     end)
 end
-function RunInNFrames.prototype.runInNGameFrames(self, func, gameFrames)
+function RunInNFrames.prototype.runInNGameFrames(self, func, gameFrames, cancelIfRoomChanges)
+    if cancelIfRoomChanges == nil then
+        cancelIfRoomChanges = false
+    end
     local gameFrameCount = game:GetFrameCount()
-    local functionFireFrame = gameFrameCount + gameFrames
-    local tuple = {functionFireFrame, func}
-    local ____self_v_run_queuedGameFunctionTuples_0 = self.v.run.queuedGameFunctionTuples
-    ____self_v_run_queuedGameFunctionTuples_0[#____self_v_run_queuedGameFunctionTuples_0 + 1] = tuple
+    local numRoomsEntered = self.roomHistory:getNumRoomsEntered()
+    local frameCountToFire = gameFrameCount + gameFrames
+    local queuedFunction = {func = func, frameCountToFire = frameCountToFire, numRoomsEntered = numRoomsEntered, cancelIfRoomChanges = cancelIfRoomChanges}
+    local ____self_v_run_queuedGameFunctions_0 = self.v.run.queuedGameFunctions
+    ____self_v_run_queuedGameFunctions_0[#____self_v_run_queuedGameFunctions_0 + 1] = queuedFunction
 end
-function RunInNFrames.prototype.runInNRenderFrames(self, func, renderFrames)
+function RunInNFrames.prototype.runInNRenderFrames(self, func, renderFrames, cancelIfRoomChanges)
+    if cancelIfRoomChanges == nil then
+        cancelIfRoomChanges = false
+    end
     local renderFrameCount = Isaac.GetFrameCount()
-    local functionFireFrame = renderFrameCount + renderFrames
-    local tuple = {functionFireFrame, func}
-    local ____self_v_run_queuedRenderFunctionTuples_1 = self.v.run.queuedRenderFunctionTuples
-    ____self_v_run_queuedRenderFunctionTuples_1[#____self_v_run_queuedRenderFunctionTuples_1 + 1] = tuple
+    local numRoomsEntered = self.roomHistory:getNumRoomsEntered()
+    local frameCountToFire = renderFrameCount + renderFrames
+    local queuedFunction = {func = func, frameCountToFire = frameCountToFire, numRoomsEntered = numRoomsEntered, cancelIfRoomChanges = cancelIfRoomChanges}
+    local ____self_v_run_queuedRenderFunctions_1 = self.v.run.queuedRenderFunctions
+    ____self_v_run_queuedRenderFunctions_1[#____self_v_run_queuedRenderFunctions_1 + 1] = queuedFunction
 end
-function RunInNFrames.prototype.runNextGameFrame(self, func)
-    self:runInNGameFrames(func, 1)
+function RunInNFrames.prototype.runNextGameFrame(self, func, cancelIfRoomChanges)
+    if cancelIfRoomChanges == nil then
+        cancelIfRoomChanges = false
+    end
+    self:runInNGameFrames(func, 1, cancelIfRoomChanges)
 end
-function RunInNFrames.prototype.runNextRenderFrame(self, func)
-    self:runInNRenderFrames(func, 1)
+function RunInNFrames.prototype.runNextRenderFrame(self, func, cancelIfRoomChanges)
+    if cancelIfRoomChanges == nil then
+        cancelIfRoomChanges = false
+    end
+    self:runInNRenderFrames(func, 1, cancelIfRoomChanges)
 end
-function RunInNFrames.prototype.setIntervalGameFrames(self, func, gameFrames, runImmediately)
+function RunInNFrames.prototype.setIntervalGameFrames(self, func, gameFrames, runImmediately, cancelIfRoomChanges)
+    if cancelIfRoomChanges == nil then
+        cancelIfRoomChanges = false
+    end
     local gameFrameCount = game:GetFrameCount()
-    local functionFireFrame = gameFrameCount + gameFrames
-    local tuple = {functionFireFrame, func, gameFrames}
-    local ____self_v_run_intervalGameFunctionTuples_2 = self.v.run.intervalGameFunctionTuples
-    ____self_v_run_intervalGameFunctionTuples_2[#____self_v_run_intervalGameFunctionTuples_2 + 1] = tuple
+    local numRoomsEntered = self.roomHistory:getNumRoomsEntered()
+    local intervalFunction = {
+        func = func,
+        frameCountToFire = gameFrameCount + gameFrames,
+        numRoomsEntered = numRoomsEntered,
+        cancelIfRoomChanges = cancelIfRoomChanges,
+        numIntervalFrames = gameFrames
+    }
+    local ____self_v_run_intervalGameFunctions_2 = self.v.run.intervalGameFunctions
+    ____self_v_run_intervalGameFunctions_2[#____self_v_run_intervalGameFunctions_2 + 1] = intervalFunction
     if runImmediately then
         func(nil)
     end
 end
-function RunInNFrames.prototype.setIntervalRenderFrames(self, func, renderFrames, runImmediately)
+function RunInNFrames.prototype.setIntervalRenderFrames(self, func, renderFrames, runImmediately, cancelIfRoomChanges)
+    if cancelIfRoomChanges == nil then
+        cancelIfRoomChanges = false
+    end
     local renderFrameCount = Isaac.GetFrameCount()
-    local functionFireFrame = renderFrameCount + renderFrames
-    local tuple = {functionFireFrame, func, renderFrames}
-    local ____self_v_run_intervalGameFunctionTuples_3 = self.v.run.intervalGameFunctionTuples
-    ____self_v_run_intervalGameFunctionTuples_3[#____self_v_run_intervalGameFunctionTuples_3 + 1] = tuple
+    local numRoomsEntered = self.roomHistory:getNumRoomsEntered()
+    local intervalFunction = {
+        func = func,
+        frameCountToFire = renderFrameCount + renderFrames,
+        numRoomsEntered = numRoomsEntered,
+        cancelIfRoomChanges = cancelIfRoomChanges,
+        numIntervalFrames = renderFrames
+    }
+    local ____self_v_run_intervalGameFunctions_3 = self.v.run.intervalGameFunctions
+    ____self_v_run_intervalGameFunctions_3[#____self_v_run_intervalGameFunctions_3 + 1] = intervalFunction
     if runImmediately then
         func(nil)
     end
@@ -34113,119 +34279,6 @@ function ____exports.isSlotMachine(self, entity)
     end
     return SLOT_MACHINE_VARIANTS:has(entity.Variant)
 end
-return ____exports
- end,
-["src.interfaces.RoomDescription"] = function(...) 
-local ____exports = {}
-return ____exports
- end,
-["src.classes.features.other.RoomHistory"] = function(...) 
-local ____lualib = require("lualib_bundle")
-local __TS__Class = ____lualib.__TS__Class
-local __TS__ClassExtends = ____lualib.__TS__ClassExtends
-local __TS__Decorate = ____lualib.__TS__Decorate
-local ____exports = {}
-local ____cachedClasses = require("src.core.cachedClasses")
-local game = ____cachedClasses.game
-local ____decorators = require("src.decorators")
-local Exported = ____decorators.Exported
-local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
-local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
-local ____array = require("src.functions.array")
-local getLastElement = ____array.getLastElement
-local ____dimensions = require("src.functions.dimensions")
-local getDimension = ____dimensions.getDimension
-local ____roomData = require("src.functions.roomData")
-local getRoomGridIndex = ____roomData.getRoomGridIndex
-local getRoomListIndex = ____roomData.getRoomListIndex
-local getRoomName = ____roomData.getRoomName
-local getRoomStageID = ____roomData.getRoomStageID
-local getRoomSubType = ____roomData.getRoomSubType
-local getRoomVariant = ____roomData.getRoomVariant
-local getRoomVisitedCount = ____roomData.getRoomVisitedCount
-local ____Feature = require("src.classes.private.Feature")
-local Feature = ____Feature.Feature
-____exports.RoomHistory = __TS__Class()
-local RoomHistory = ____exports.RoomHistory
-RoomHistory.name = "RoomHistory"
-__TS__ClassExtends(RoomHistory, Feature)
-function RoomHistory.prototype.____constructor(self)
-    Feature.prototype.____constructor(self)
-    self.v = {run = {roomHistory = {}}}
-    self.postNewRoomEarly = function()
-        local level = game:GetLevel()
-        local stage = level:GetStage()
-        local stageType = level:GetStageType()
-        local room = game:GetRoom()
-        local roomType = room:GetType()
-        local seeds = game:GetSeeds()
-        local startSeedString = seeds:GetStartSeedString()
-        local stageID = getRoomStageID(nil)
-        local dimension = getDimension(nil)
-        local roomVariant = getRoomVariant(nil)
-        local roomSubType = getRoomSubType(nil)
-        local roomName = getRoomName(nil)
-        local roomGridIndex = getRoomGridIndex(nil)
-        local roomListIndex = getRoomListIndex(nil)
-        local roomVisitedCount = getRoomVisitedCount(nil)
-        local roomDescription = {
-            startSeedString = startSeedString,
-            stage = stage,
-            stageType = stageType,
-            stageID = stageID,
-            dimension = dimension,
-            roomType = roomType,
-            roomVariant = roomVariant,
-            roomSubType = roomSubType,
-            roomName = roomName,
-            roomGridIndex = roomGridIndex,
-            roomListIndex = roomListIndex,
-            roomVisitedCount = roomVisitedCount
-        }
-        local ____self_v_run_roomHistory_0 = self.v.run.roomHistory
-        ____self_v_run_roomHistory_0[#____self_v_run_roomHistory_0 + 1] = roomDescription
-    end
-    self.customCallbacksUsed = {{ModCallbackCustom.POST_NEW_ROOM_EARLY, self.postNewRoomEarly}}
-end
-function RoomHistory.prototype.getNumRoomsVisited(self)
-    return self.v.run.roomHistory
-end
-function RoomHistory.prototype.getRoomHistory(self)
-    return self.v.run.roomHistory
-end
-function RoomHistory.prototype.getPreviousRoomDescription(self)
-    local previousRoomDescription = self.v.run.roomHistory[#self.v.run.roomHistory - 2 + 1]
-    if previousRoomDescription ~= nil then
-        return previousRoomDescription
-    end
-    local startingRoomDescription = self.v.run.roomHistory[1]
-    if startingRoomDescription ~= nil then
-        return startingRoomDescription
-    end
-    error("Failed to find a room description for any rooms thus far on this run.")
-end
-function RoomHistory.prototype.getLatestRoomDescription(self)
-    return getLastElement(nil, self.v.run.roomHistory)
-end
-function RoomHistory.prototype.isLeavingRoom(self)
-    local level = game:GetLevel()
-    local stage = level:GetStage()
-    local stageType = level:GetStageType()
-    local seeds = game:GetSeeds()
-    local startSeedString = seeds:GetStartSeedString()
-    local roomListIndex = getRoomListIndex(nil)
-    local roomVisitedCount = getRoomVisitedCount(nil)
-    local latestRoomDescription = self:getLatestRoomDescription()
-    if latestRoomDescription == nil then
-        return false
-    end
-    return startSeedString ~= latestRoomDescription.startSeedString or stage ~= latestRoomDescription.stage or stageType ~= latestRoomDescription.stageType or roomListIndex ~= latestRoomDescription.roomListIndex or roomVisitedCount ~= latestRoomDescription.roomVisitedCount
-end
-__TS__Decorate({Exported}, RoomHistory.prototype, "getNumRoomsVisited", true)
-__TS__Decorate({Exported}, RoomHistory.prototype, "getRoomHistory", true)
-__TS__Decorate({Exported}, RoomHistory.prototype, "getPreviousRoomDescription", true)
-__TS__Decorate({Exported}, RoomHistory.prototype, "getLatestRoomDescription", true)
-__TS__Decorate({Exported}, RoomHistory.prototype, "isLeavingRoom", true)
 return ____exports
  end,
 ["src.classes.features.callbackLogic.SlotDestroyedDetection"] = function(...) 
@@ -34239,6 +34292,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescri
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____ISCFeature = require("src.enums.ISCFeature")
+local ISCFeature = ____ISCFeature.ISCFeature
 local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____SlotDestructionType = require("src.enums.SlotDestructionType")
@@ -34273,6 +34328,7 @@ function SlotDestroyedDetection.prototype.____constructor(self, postSlotDestroye
         end
         self:checkDestroyedFromCollisionClass(slot)
     end
+    self.featuresUsed = {ISCFeature.ROOM_HISTORY}
     self.callbacksUsed = {{ModCallback.POST_ENTITY_REMOVE, self.postEntityRemoveSlot, {EntityType.SLOT}}}
     self.customCallbacksUsed = {{ModCallbackCustom.POST_SLOT_UPDATE, self.postSlotUpdate}}
     self.postSlotDestroyed = postSlotDestroyed
@@ -49383,10 +49439,10 @@ function ____exports.getFeatures(self, mod, callbacks)
     local preventCollectibleRotation = __TS__New(PreventCollectibleRotation)
     local roomClearFrame = __TS__New(RoomClearFrame)
     local roomHistory = __TS__New(RoomHistory)
-    local runInNFrames = __TS__New(RunInNFrames)
     local runNextRoom = __TS__New(RunNextRoom)
     local saveDataManager = __TS__New(SaveDataManager, mod)
     local stageHistory = __TS__New(StageHistory)
+    local runInNFrames = __TS__New(RunInNFrames, roomHistory)
     local customGridEntities = __TS__New(CustomGridEntities, runInNFrames)
     local moddedElementSets = __TS__New(ModdedElementSets, moddedElementDetection)
     local itemPoolDetection = __TS__New(ItemPoolDetection, moddedElementSets)

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

@@ -48,8 +48,7 @@ export declare class ModFeature {
      */
     protected shouldCallbackMethodsFire: (<T extends boolean>(vanilla: T, modCallback: T extends true ? ModCallback : ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
     /**
-     * Whether or not the feature has registered its callbacks yet (and submitted its variables to the
-     * save data manager, if any).
+     * Whether or not the feature has registered its callbacks yet.
      *
      * This will almost always be equal to true unless you explicitly passed `false` to the second
      * argument of the constructor.
@@ -58,15 +57,14 @@ export declare class ModFeature {
     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.
+     * callbacks.
      *
      * @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.
+     * decorated callbacks.
      *
      * This is just an alias for `ModFeature.init(false)`.
      */