isaacscript-common 9.18.4 → 9.19.2

package/dist/src/features/ponyDetection.lua

@@ -0,0 +1,66 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local ____exports = {}
+local postPEffectUpdateReordered, FLAGS_WHEN_PONY_IS_ACTIVE, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("src.featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____flag = require("src.functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____playerDataStructures = require("src.functions.playerDataStructures")
+local setAddPlayer = ____playerDataStructures.setAddPlayer
+local setDeletePlayer = ____playerDataStructures.setDeletePlayer
+local setHasPlayer = ____playerDataStructures.setHasPlayer
+local ____playerIndex = require("src.functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
+local ____exports = require("src.features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postPEffectUpdateReordered(self, player)
+    local effects = player:GetEffects()
+    local entityFlags = player:GetEntityFlags()
+    local hasPonyCollectibleEffect = effects:HasCollectibleEffect(CollectibleType.PONY) or effects:HasCollectibleEffect(CollectibleType.WHITE_PONY)
+    local isPonyActiveOnPreviousFrame = setHasPlayer(nil, v.run.playersIsPonyActive, player)
+    local hasPonyFlags = hasFlag(
+        nil,
+        entityFlags,
+        table.unpack(FLAGS_WHEN_PONY_IS_ACTIVE)
+    )
+    local isPonyActiveNow = hasPonyCollectibleEffect or isPonyActiveOnPreviousFrame and hasPonyFlags
+    if isPonyActiveNow then
+        setAddPlayer(nil, v.run.playersIsPonyActive, player)
+    else
+        setDeletePlayer(nil, v.run.playersIsPonyActive, player)
+    end
+end
+local FEATURE_NAME = "ponyDetection"
+FLAGS_WHEN_PONY_IS_ACTIVE = {EntityFlag.NO_KNOCKBACK, EntityFlag.NO_PHYSICS_KNOCKBACK, EntityFlag.NO_DAMAGE_BLINK}
+v = {run = {playersIsPonyActive = __TS__New(Set)}}
+---
+-- @internal
+function ____exports.ponyDetectionInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)
+end
+--- Helper function to see if the player is under the effects of A Pony or White Pony charge.
+-- Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
+function ____exports.isPlayerUsingPony(self, player)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    return setHasPlayer(nil, v.run.playersIsPonyActive, player)
+end
+--- Helper function to see if any player is under the effects of A Pony or White Pony charge.
+-- Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
+function ____exports.anyPlayerUsingPony(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local players = getPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player) return ____exports.isPlayerUsingPony(nil, player) end
+    )
+end
+return ____exports

package/dist/src/features/preventChildEntities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preventChildEntities.d.ts","sourceRoot":"","sources":["../../../src/features/preventChildEntities.ts"],"names":[],"mappings":";AAiCA;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAGzD"}

package/dist/src/features/preventChildEntities.lua

@@ -0,0 +1,35 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local postNPCInit, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____exports = require("src.features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNPCInit(self, npc)
+    local spawnerEntityMatch = npc.SpawnerEntity ~= nil and v.room.preventingEntities:has(GetPtrHash(npc.SpawnerEntity))
+    local parentMatch = npc.Parent ~= nil and v.room.preventingEntities:has(GetPtrHash(npc.Parent))
+    if spawnerEntityMatch or parentMatch then
+        npc:Remove()
+    end
+end
+local FEATURE_NAME = "preventChildEntities"
+v = {room = {preventingEntities = __TS__New(Set)}}
+---
+-- @internal
+function ____exports.preventChildEntitiesInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallback(ModCallback.POST_NPC_INIT, postNPCInit)
+end
+--- Helper function to prevent an entity from spawning any other entities. Meant to be used on NPCs
+-- like Squirts. This behavior will only last for the current room.
+-- 
+-- Under the hood, this function will remove any new NPCs spawned that have a `Entity.SpawnerEntity`
+-- or `Entity.Parent` value that matches the provided entity. (They are removed during the
+-- `POST_NPC_INIT` callback specifically.)
+function ____exports.preventChildEntities(self, entity)
+    local ptrHash = GetPtrHash(entity)
+    v.room.preventingEntities:add(ptrHash)
+end
+return ____exports

package/dist/src/features/preventCollectibleRotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preventCollectibleRotation.d.ts","sourceRoot":"","sources":["../../../src/features/preventCollectibleRotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAwEtC;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAgBN"}

package/dist/src/features/preventCollectibleRotation.lua

@@ -0,0 +1,68 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local useCardSoulOfIsaac, postPickupUpdateCollectible, getMapIndex, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CardType = ____isaac_2Dtypescript_2Ddefinitions.CardType
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____featuresInitialized = require("src.featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____collectibles = require("src.functions.collectibles")
+local setCollectibleSubType = ____collectibles.setCollectibleSubType
+local ____entities = require("src.functions.entities")
+local getEntityID = ____entities.getEntityID
+local ____pickupVariants = require("src.functions.pickupVariants")
+local isCollectible = ____pickupVariants.isCollectible
+local ____exports = require("src.features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function useCardSoulOfIsaac(self)
+    v.room.trackedCollectibles:clear()
+end
+function postPickupUpdateCollectible(self, pickup)
+    local collectible = pickup
+    if collectible.SubType == CollectibleType.NULL then
+        return
+    end
+    local index = getMapIndex(nil, collectible)
+    local trackedCollectibleType = v.room.trackedCollectibles:get(index)
+    if trackedCollectibleType ~= nil and collectible.SubType ~= trackedCollectibleType then
+        setCollectibleSubType(nil, collectible, trackedCollectibleType)
+    end
+end
+function getMapIndex(self, collectible)
+    local room = game:GetRoom()
+    local gridIndex = room:GetGridIndex(collectible.Position)
+    return (tostring(gridIndex) .. ",") .. tostring(collectible.InitSeed)
+end
+local FEATURE_NAME = "preventCollectibleRotation"
+v = {room = {trackedCollectibles = __TS__New(Map)}}
+---
+-- @internal
+function ____exports.preventCollectibleRotationInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallback(ModCallback.POST_USE_CARD, useCardSoulOfIsaac, CardType.SOUL_ISAAC)
+    mod:AddCallback(ModCallback.POST_PICKUP_UPDATE, postPickupUpdateCollectible, PickupVariant.COLLECTIBLE)
+end
+--- Helper function to prevent a collectible from being affected by Tainted Isaac's rotation
+-- mechanic. (This mechanic also happens from Glitched Crown and Binge Eater.) This is useful
+-- because quest items that are manually spawned by mods will be automatically be affected by this
+-- mechanic.
+-- 
+-- It is required to pass the intended collectible type to this function since it is possible for
+-- collectibles to rotate on the first frame that they are spawned.
+function ____exports.preventCollectibleRotation(self, collectible, collectibleType)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"preventCollectibleRotate\" function was given a non-collectible: " .. entityID)
+    end
+    local index = getMapIndex(nil, collectible)
+    v.room.trackedCollectibles:set(index, collectibleType)
+    postPickupUpdateCollectible(nil, collectible)
+end
+return ____exports

package/dist/src/features/registerHotkey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registerHotkey.d.ts","sourceRoot":"","sources":["../../../src/features/registerHotkey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,8BAA8B,CAAC;AAyDrE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,cAAc,EAAE,QAAQ,GAAG,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAC,EACvD,WAAW,EAAE,MAAM,IAAI,GACtB,IAAI,CAoBN;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,cAAc,EAAE,QAAQ,GAAG,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAC,GACtD,IAAI,CAoBN"}

package/dist/src/features/registerHotkey.lua

@@ -0,0 +1,93 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local postRender, checkIfTriggered, staticHotkeyFunctionMap, dynamicHotkeyFunctionMap, keyPressedMap
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Keyboard = ____isaac_2Dtypescript_2Ddefinitions.Keyboard
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____DefaultMap = require("src.classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____featuresInitialized = require("src.featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____input = require("src.functions.input")
+local isKeyboardPressed = ____input.isKeyboardPressed
+local ____types = require("src.functions.types")
+local isFunction = ____types.isFunction
+function postRender(self)
+    for ____, ____value in __TS__Iterator(staticHotkeyFunctionMap:entries()) do
+        local keyboard = ____value[1]
+        local triggerFunc = ____value[2]
+        checkIfTriggered(nil, keyboard, triggerFunc)
+    end
+    for ____, ____value in __TS__Iterator(dynamicHotkeyFunctionMap:entries()) do
+        local keyboardFunc = ____value[1]
+        local triggerFunc = ____value[2]
+        local keyboard = keyboardFunc(nil)
+        if keyboard ~= nil then
+            checkIfTriggered(nil, keyboard, triggerFunc)
+        end
+    end
+end
+function checkIfTriggered(self, keyboard, triggerFunc)
+    local isPressed = isKeyboardPressed(nil, keyboard)
+    local wasPreviouslyPressed = keyPressedMap:getAndSetDefault(keyboard)
+    keyPressedMap:set(keyboard, isPressed)
+    if isPressed and not wasPreviouslyPressed then
+        triggerFunc(nil)
+    end
+end
+local FEATURE_NAME = "registerHotkeys"
+staticHotkeyFunctionMap = __TS__New(Map)
+dynamicHotkeyFunctionMap = __TS__New(Map)
+keyPressedMap = __TS__New(DefaultMap, false)
+---
+-- @internal
+function ____exports.registerHotkeyInit(self, mod)
+    mod:AddCallback(ModCallback.POST_RENDER, postRender)
+end
+--- Helper function to run arbitrary code when you press and release a specific keyboard key.
+-- 
+-- This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
+-- in debugging.
+-- 
+-- @param keyboardOrFunc Either the key that you want to trigger the hotkey or a function that
+-- returns the key that will trigger the hotkey. Normally, you would just
+-- specify the key directly, but you can use a function for situations where
+-- the key can change (like if end-users can specify a custom hotkey using Mod
+-- Config Menu).
+-- @param triggerFunc A function containing the arbitrary code that you want to execute when the
+-- hotkey is triggered.
+function ____exports.registerHotkey(self, keyboardOrFunc, triggerFunc)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if isFunction(nil, keyboardOrFunc) then
+        if dynamicHotkeyFunctionMap:has(keyboardOrFunc) then
+            error("Failed to register a hotkey due to a custom hotkey already being defined for the submitted function.")
+        end
+        dynamicHotkeyFunctionMap:set(keyboardOrFunc, triggerFunc)
+    else
+        if staticHotkeyFunctionMap:has(keyboardOrFunc) then
+            error(((("Failed to register a hotkey due to a hotkey already being defined for key: Keyboard." .. tostring(Keyboard[keyboardOrFunc])) .. " (") .. tostring(keyboardOrFunc)) .. ")")
+        end
+        staticHotkeyFunctionMap:set(keyboardOrFunc, triggerFunc)
+    end
+end
+--- Helper function to remove a hotkey created with the `registerHotkey` function.
+-- 
+-- @param keyboardOrFunc Equal to the value that you passed when initially registering the hotkey.
+function ____exports.unregisterHotkey(self, keyboardOrFunc)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if isFunction(nil, keyboardOrFunc) then
+        if not dynamicHotkeyFunctionMap:has(keyboardOrFunc) then
+            error("Failed to unregister a hotkey since there is no existing hotkey defined for the submitted function.")
+        end
+        dynamicHotkeyFunctionMap:delete(keyboardOrFunc)
+    else
+        if not staticHotkeyFunctionMap:has(keyboardOrFunc) then
+            error(((("Failed to unregister a hotkey since there is no existing hotkey defined for key: Keyboard." .. tostring(Keyboard[keyboardOrFunc])) .. " (") .. tostring(keyboardOrFunc)) .. ")")
+        end
+        staticHotkeyFunctionMap:delete(keyboardOrFunc)
+    end
+end
+return ____exports

package/dist/src/features/roomClearFrame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomClearFrame.d.ts","sourceRoot":"","sources":["../../../src/features/roomClearFrame.ts"],"names":[],"mappings":";AAqCA;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,GAAG,GAAG,SAAS,CAGvD;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,GAAG,GAAG,SAAS,CAGvD"}

package/dist/src/features/roomClearFrame.lua

@@ -0,0 +1,38 @@
+local ____exports = {}
+local postRoomClearChangedTrue, v
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("src.featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____exports = require("src.features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postRoomClearChangedTrue(self)
+    local gameFrameCount = game:GetFrameCount()
+    local room = game:GetRoom()
+    local roomFrameCount = room:GetFrameCount()
+    v.room.roomClearGameFrame = gameFrameCount
+    v.room.roomClearRoomFrame = roomFrameCount
+end
+local FEATURE_NAME = "roomClearFrame"
+v = {room = {roomClearGameFrame = nil, roomClearRoomFrame = nil}}
+---
+-- @internal
+function ____exports.roomClearFrameInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_ROOM_CLEAR_CHANGED, postRoomClearChangedTrue, true)
+end
+--- Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this room
+-- was cleared. Returns undefined if the room has never been cleared.
+function ____exports.getRoomClearGameFrame(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    return v.room.roomClearGameFrame
+end
+--- Helper function to get the room frame (i.e. `Room.GetFrameCount`) of the last time that this room
+-- was cleared. Returns undefined if the room has never been cleared.
+function ____exports.getRoomClearRoomFrame(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    return v.room.roomClearGameFrame
+end
+return ____exports

package/dist/src/features/roomHistory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomHistory.d.ts","sourceRoot":"","sources":["../../../src/features/roomHistory.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAmDhE;;;GAGG;AACH,wBAAgB,cAAc,IAAI,SAAS,eAAe,EAAE,CAG3D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,eAAe,CAe5D;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,eAAe,CAS1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,IAAI,OAAO,CASvC"}

package/dist/src/features/roomHistory.lua

@@ -0,0 +1,102 @@
+local ____exports = {}
+local postNewRoomEarly, v
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("src.featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____array = require("src.functions.array")
+local getLastElement = ____array.getLastElement
+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 ____exports = require("src.features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNewRoomEarly(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local stageID = getRoomStageID(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 = {
+        stage = stage,
+        stageType = stageType,
+        stageID = stageID,
+        roomType = roomType,
+        roomVariant = roomVariant,
+        roomSubType = roomSubType,
+        roomName = roomName,
+        roomGridIndex = roomGridIndex,
+        roomListIndex = roomListIndex,
+        roomVisitedCount = roomVisitedCount
+    }
+    local ____v_run_roomHistory_0 = v.run.roomHistory
+    ____v_run_roomHistory_0[#____v_run_roomHistory_0 + 1] = roomDescription
+end
+local FEATURE_NAME = "roomHistory"
+v = {run = {roomHistory = {}}}
+---
+-- @internal
+function ____exports.roomHistoryInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_EARLY, postNewRoomEarly)
+end
+--- Helper function to get information about all of the rooms that a player has visited thus far on
+-- this run.
+function ____exports.getRoomHistory(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    return v.run.roomHistory
+end
+--- Helper function to get information about the room that was previously visited.
+-- 
+-- In the special case of only one room having been visited thus far (i.e. the starting room of the
+-- run), the starting room will be returned.
+function ____exports.getPreviousRoomDescription(self)
+    local previousRoomDescription = v.run.roomHistory[#v.run.roomHistory - 2 + 1]
+    if previousRoomDescription ~= nil then
+        return previousRoomDescription
+    end
+    local startingRoomDescription = 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
+--- Helper function to get information about the most recent room that is stored in the room history
+-- array.
+-- 
+-- This is useful in the `POST_ENTITY_REMOVE` callback; see the `isLeavingRoom` function.
+function ____exports.getLatestRoomDescription(self)
+    local latestRoomDescription = getLastElement(nil, v.run.roomHistory)
+    if latestRoomDescription == nil then
+        error("Failed to get the latest room description since the room history array was empty.")
+    end
+    return latestRoomDescription
+end
+--- Helper function to detect if the game is in the state where the room index has changed to a new
+-- room, but the entities from the previous room are currently in the process of despawning. (At
+-- this point, the `POST_NEW_ROOM` callback will not have fired yet, and there will not be an entry
+-- in the room history array for the current room.)
+-- 
+-- This function is intended to be used in the `POST_ENTITY_REMOVE` callback to detect when an
+-- entity is pseudo-persistent entity such as a pickup is despawning.
+function ____exports.isLeavingRoom(self)
+    local roomListIndex = getRoomListIndex(nil)
+    local roomVisitedCount = getRoomVisitedCount(nil)
+    local latestRoomDescription = ____exports.getLatestRoomDescription(nil)
+    return roomListIndex ~= latestRoomDescription.roomListIndex or roomVisitedCount ~= latestRoomDescription.roomVisitedCount
+end
+return ____exports

package/dist/src/features/runInNFrames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runInNFrames.d.ts","sourceRoot":"","sources":["../../../src/features/runInNFrames.ts"],"names":[],"mappings":";AA0GA;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,IAAI,CAOxE;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,YAAY,EAAE,GAAG,GAAG,IAAI,CAO5E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI,CAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI,CAGzD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,OAAO,EACnB,UAAU,EAAE,GAAG,EACf,cAAc,EAAE,OAAO,GACtB,IAAI,CAWN;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,OAAO,EACnB,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,OAAO,GACtB,IAAI,CAWN"}

package/dist/src/features/runInNFrames.lua

@@ -0,0 +1,191 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local postUpdate, postRender, checkExecuteQueuedFunctions, checkExecuteIntervalFunctions, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____featuresInitialized = require("src.featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____array = require("src.functions.array")
+local arrayRemoveInPlace = ____array.arrayRemoveInPlace
+local ____exports = require("src.features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postUpdate(self)
+    local gameFrameCount = game:GetFrameCount()
+    checkExecuteQueuedFunctions(nil, gameFrameCount, v.run.queuedGameFunctionTuples)
+    checkExecuteIntervalFunctions(nil, gameFrameCount, v.run.intervalGameFunctionTuples)
+end
+function postRender(self)
+    local renderFrameCount = Isaac.GetFrameCount()
+    checkExecuteQueuedFunctions(nil, renderFrameCount, v.run.queuedRenderFunctionTuples)
+    checkExecuteIntervalFunctions(nil, renderFrameCount, v.run.intervalRenderFunctionTuples)
+end
+function checkExecuteQueuedFunctions(self, frameCount, functionTuples)
+    local firingFunctions = __TS__ArrayFilter(
+        functionTuples,
+        function(____, ____bindingPattern0)
+            local frameCountToFire
+            frameCountToFire = ____bindingPattern0[1]
+            return frameCount >= frameCountToFire
+        end
+    )
+    for ____, tuple in ipairs(firingFunctions) do
+        local _frameCountToFire, func = table.unpack(tuple)
+        func(nil)
+        arrayRemoveInPlace(nil, functionTuples, tuple)
+    end
+end
+function checkExecuteIntervalFunctions(self, frameCount, functionTuples)
+    local firingFunctions = __TS__ArrayFilter(
+        functionTuples,
+        function(____, ____bindingPattern0)
+            local frameCountToFire
+            frameCountToFire = ____bindingPattern0[1]
+            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)
+        if returnValue then
+            local nextFireFrame = frameCount + numIntervalFrames
+            local newTuple = {nextFireFrame, func, numIntervalFrames}
+            functionTuples[#functionTuples + 1] = newTuple
+        end
+    end
+end
+local FEATURE_NAME = "runInNFrames"
+v = {run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}, intervalGameFunctionTuples = {}, intervalRenderFunctionTuples = {}}}
+---
+-- @internal
+function ____exports.runInNFramesInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v, false)
+    mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
+    mod:AddCallback(ModCallback.POST_RENDER, postRender)
+end
+--- Supply a function to run N game frames from now in the `POST_UPDATE` callback.
+-- 
+-- For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
+-- way.
+-- 
+-- Note that this function will not handle saving and quitting. If a player saving and quitting
+-- before the deferred function fires would cause a bug in your mod, then you should handle deferred
+-- functions manually using serializable data.
+function ____exports.runInNGameFrames(self, func, gameFrames)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local gameFrameCount = game:GetFrameCount()
+    local functionFireFrame = gameFrameCount + gameFrames
+    local tuple = {functionFireFrame, func}
+    local ____v_run_queuedGameFunctionTuples_0 = v.run.queuedGameFunctionTuples
+    ____v_run_queuedGameFunctionTuples_0[#____v_run_queuedGameFunctionTuples_0 + 1] = tuple
+end
+--- Supply a function to run N render frames from now in the `POST_RENDER` callback.
+-- 
+-- For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
+-- way.
+-- 
+-- Note that this function will not handle saving and quitting. If a player saving and quitting
+-- before the deferred function fires would cause a bug in your mod, then you should handle deferred
+-- functions manually using serializable data.
+function ____exports.runInNRenderFrames(self, func, renderFrames)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local renderFrameCount = Isaac.GetFrameCount()
+    local functionFireFrame = renderFrameCount + renderFrames
+    local tuple = {functionFireFrame, func}
+    local ____v_run_queuedRenderFunctionTuples_1 = v.run.queuedRenderFunctionTuples
+    ____v_run_queuedRenderFunctionTuples_1[#____v_run_queuedRenderFunctionTuples_1 + 1] = tuple
+end
+--- Supply a function to run on the next `POST_UPDATE` callback.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const NUM_EXPLODER_EXPLOSIONS = 5;
+-- 
+-- function useItemExploder(player: EntityPlayer) {
+--   playSound("exploderBegin");
+--   explode(player, NUM_EXPLODER_EXPLOSIONS);
+-- }
+-- 
+-- function explode(player: EntityPlayer, numFramesLeft: int) {
+--   Isaac.Explode(player, undefined, 1);
+--   numFramesLeft -= 1;
+--   if (numFramesLeft === 0) {
+--     runNextFrame(() => {
+--       explode(player, numFramesLeft);
+--     });
+--   }
+-- }
+-- ```
+-- 
+-- Note that this function will not handle saving and quitting. If a player saving and quitting
+-- before the deferred function fires would cause a bug in your mod, then you should handle deferred
+-- functions manually using serializable data.
+function ____exports.runNextGameFrame(self, func)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    ____exports.runInNGameFrames(nil, func, 1)
+end
+--- Supply a function to run on the next `POST_RENDER` callback.
+-- 
+-- For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
+-- way.
+-- 
+-- Note that this function will not handle saving and quitting.
+function ____exports.runNextRenderFrame(self, func)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    ____exports.runInNRenderFrames(nil, func, 1)
+end
+--- 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.
+-- 
+-- This is similar to the `setInterval` vanilla JavaScript function, except there is no
+-- corresponding `clearInterval` function. (Instead, the return value from the supplied function is
+-- used to stop the interval.)
+-- 
+-- Note that this function will not handle saving and quitting. You must manually restart any
+-- intervals if the player saves and quits in the middle of a run.
+-- 
+-- @param func The function to repeatedly run on an interval.
+-- @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.
+function ____exports.setIntervalGameFrames(self, func, gameFrames, runImmediately)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local gameFrameCount = game:GetFrameCount()
+    local functionFireFrame = gameFrameCount + gameFrames
+    local tuple = {functionFireFrame, func, gameFrames}
+    local ____v_run_intervalGameFunctionTuples_2 = v.run.intervalGameFunctionTuples
+    ____v_run_intervalGameFunctionTuples_2[#____v_run_intervalGameFunctionTuples_2 + 1] = tuple
+    if runImmediately then
+        func(nil)
+    end
+end
+--- 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.
+-- 
+-- This is similar to the `setInterval` vanilla JavaScript function, except there is no
+-- corresponding `clearInterval` function. (Instead, the return value from the supplied function is
+-- used to stop the interval.)
+-- 
+-- Note that this function will not handle saving and quitting. You must manually restart any
+-- intervals if the player saves and quits in the middle of a run.
+-- 
+-- @param func The function to repeatedly run on an interval.
+-- @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.
+function ____exports.setIntervalRenderFrames(self, func, renderFrames, runImmediately)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local renderFrameCount = Isaac.GetFrameCount()
+    local functionFireFrame = renderFrameCount + renderFrames
+    local tuple = {functionFireFrame, func, renderFrames}
+    local ____v_run_intervalGameFunctionTuples_3 = v.run.intervalGameFunctionTuples
+    ____v_run_intervalGameFunctionTuples_3[#____v_run_intervalGameFunctionTuples_3 + 1] = tuple
+    if runImmediately then
+        func(nil)
+    end
+end
+return ____exports

package/dist/src/features/runNextRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runNextRoom.d.ts","sourceRoot":"","sources":["../../../src/features/runNextRoom.ts"],"names":[],"mappings":"AAiCA;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI,CAGlD"}