isaacscript-common 4.2.8 → 4.3.0

package/enums/StageTravelEntityState.d.ts

@@ -0,0 +1,4 @@
+export declare enum StageTravelEntityState {
+    OPEN = 0,
+    CLOSED = 1
+}

package/enums/StageTravelEntityState.lua

@@ -0,0 +1,7 @@
+local ____exports = {}
+____exports.StageTravelEntityState = {}
+____exports.StageTravelEntityState.OPEN = 0
+____exports.StageTravelEntityState[____exports.StageTravelEntityState.OPEN] = "OPEN"
+____exports.StageTravelEntityState.CLOSED = 1
+____exports.StageTravelEntityState[____exports.StageTravelEntityState.CLOSED] = "CLOSED"
+return ____exports

package/enums/StageTravelState.d.ts

@@ -0,0 +1,6 @@
+export declare enum StageTravelState {
+    DISABLED = 0,
+    FADING_TO_BLACK = 1,
+    GOING_TO_NEW_FLOOR = 2,
+    FADING_IN = 3
+}

package/enums/StageTravelState.lua

@@ -0,0 +1,11 @@
+local ____exports = {}
+____exports.StageTravelState = {}
+____exports.StageTravelState.DISABLED = 0
+____exports.StageTravelState[____exports.StageTravelState.DISABLED] = "DISABLED"
+____exports.StageTravelState.FADING_TO_BLACK = 1
+____exports.StageTravelState[____exports.StageTravelState.FADING_TO_BLACK] = "FADING_TO_BLACK"
+____exports.StageTravelState.GOING_TO_NEW_FLOOR = 2
+____exports.StageTravelState[____exports.StageTravelState.GOING_TO_NEW_FLOOR] = "GOING_TO_NEW_FLOOR"
+____exports.StageTravelState.FADING_IN = 3
+____exports.StageTravelState[____exports.StageTravelState.FADING_IN] = "FADING_IN"
+return ____exports

package/features/{getCollectibleItemPoolType.lua → collectibleItemPoolType.lua}

@@ -28,8 +28,8 @@ local FEATURE_NAME = "get collectible item pool type"
 v = {run = {collectibleItemPoolTypeMap = __TS__New(Map)}}
 ---
 -- @internal
-function ____exports.getCollectibleItemPoolTypeInit(self, mod)
-    saveDataManager(nil, "getCollectibleItemPoolType", v)
+function ____exports.collectibleItemPoolTypeInit(self, mod)
+    saveDataManager(nil, "collectibleItemPoolType", v)
     mod:AddCallback(ModCallback.POST_PICKUP_INIT, postPickupInitCollectible, PickupVariant.COLLECTIBLE)
 end
 --- Helper function to get the item pool type that a given collectible came from. Since there is no

package/features/customTrapdoor/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const STAGE_TRAVEL_FEATURE_NAME = "stageTravel";
+/** This also applies to crawl spaces. The value was determined through trial and error. */
+export declare const TRAPDOOR_OPEN_DISTANCE = 60;
+export declare const TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS: number;
+export declare const TRAPDOOR_BOSS_REACTION_FRAMES = 30;

package/features/customTrapdoor/constants.lua

@@ -0,0 +1,7 @@
+local ____exports = {}
+____exports.STAGE_TRAVEL_FEATURE_NAME = "stageTravel"
+--- This also applies to crawl spaces. The value was determined through trial and error.
+____exports.TRAPDOOR_OPEN_DISTANCE = 60
+____exports.TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS = ____exports.TRAPDOOR_OPEN_DISTANCE * 2.5
+____exports.TRAPDOOR_BOSS_REACTION_FRAMES = 30
+return ____exports

package/features/customTrapdoor/exports.d.ts

@@ -0,0 +1,37 @@
+import { LevelStage, StageType } from "isaac-typescript-definitions";
+/**
+ * Helper function to spawn a trapdoor grid entity that will have one or more of the following
+ * attributes:
+ *
+ * - custom destination (or custom logic for after the player enters)
+ * - custom graphics
+ * - custom logic for opening/closing
+ * - TODO: animation
+ *
+ * You can use this function to take the player to your custom stage. (See the `registerCustomStage`
+ * helper function.)
+ *
+ * Under the hood, the custom trapdoor is represented by a decoration grid entity and is manually
+ * respawned every time the player re-enters the room.
+ *
+ * @param gridIndexOrPosition The location in the room to spawn the trapdoor.
+ * @param _destination Used to specify where the player will go after jumping into the trapdoor. Can
+ *                     either be a tuple containing the stage and stage type, a string containing
+ *                     the name of a custom stage, or a function that returns one of these things.
+ *                     You can also specify a function that returns undefined in order to perform
+ *                     some custom behavior and/or handle the traveling part yourself. By default,
+ *                     the destination will be set to the next floor like that of a vanilla
+ *                     trapdoor.
+ * @param _anm2 Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2 of
+ *              "gfx/grid/door_11_trapdoor.anm2" will be used.
+ * @param _shouldOpenFunc Optional. If the trapdoor is currently closed, this function will run on
+ *                        every frame to determine if it should open. By default, a function that
+ *                        emulates a vanilla trapdoor will be used.
+ * @param _shouldCloseFunc Optional. If the trapdoor is currently open, this function will run on
+ *                         every frame to determine if it should close. By default, a function that
+ *                         emulates a vanilla trapdoor will be used.
+ * @param _spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. Can either be
+ *                   a boolean or a function returning a boolean. By default, a function that
+ *                   emulates a vanilla trapdoor will be used.
+ */
+export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector, _destination?: [stage: LevelStage, stageType: StageType] | string | ((gridEntity: GridEntity) => [stage: LevelStage, stageType: StageType] | string | undefined), _anm2?: string, _shouldOpenFunc?: (gridEntity: GridEntity) => boolean, _shouldCloseFunc?: (gridEntity: GridEntity) => boolean, _spawnOpen?: boolean | ((gridEntity: GridEntity) => boolean)): GridEntity;

package/features/customTrapdoor/exports.lua

@@ -0,0 +1,120 @@
+local ____exports = {}
+local defaultDestinationFunc, defaultShouldOpenFunc, isPlayerCloseAfterBoss, shouldBeClosedFromStartingInRoomWithEnemies, defaultShouldCloseFunc, defaultShouldSpawnOpenFunc
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____gridEntity = require("functions.gridEntity")
+local spawnGrid = ____gridEntity.spawnGrid
+local ____nextStage = require("functions.nextStage")
+local getNextStage = ____nextStage.getNextStage
+local getNextStageType = ____nextStage.getNextStageType
+local ____positionVelocity = require("functions.positionVelocity")
+local anyPlayerCloserThan = ____positionVelocity.anyPlayerCloserThan
+local ____roomClearFrame = require("features.roomClearFrame")
+local getRoomClearGameFrame = ____roomClearFrame.getRoomClearGameFrame
+local ____constants = require("features.customTrapdoor.constants")
+local TRAPDOOR_BOSS_REACTION_FRAMES = ____constants.TRAPDOOR_BOSS_REACTION_FRAMES
+local TRAPDOOR_OPEN_DISTANCE = ____constants.TRAPDOOR_OPEN_DISTANCE
+local TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS = ____constants.TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS
+local ____v = require("features.customTrapdoor.v")
+local getCustomTrapdoorDescription = ____v.getCustomTrapdoorDescription
+function defaultDestinationFunc(self)
+    local nextStage = getNextStage(nil)
+    local nextStageType = getNextStageType(nil)
+    return {nextStage, nextStageType}
+end
+function defaultShouldOpenFunc(self, gridEntity)
+    local entityDescription = getCustomTrapdoorDescription(nil, gridEntity)
+    if entityDescription == nil then
+        return false
+    end
+    local room = game:GetRoom()
+    local roomClear = room:IsClear()
+    return not anyPlayerCloserThan(nil, gridEntity.Position, TRAPDOOR_OPEN_DISTANCE) and not isPlayerCloseAfterBoss(nil, gridEntity.Position) and not shouldBeClosedFromStartingInRoomWithEnemies(nil, entityDescription.initial, roomClear)
+end
+function isPlayerCloseAfterBoss(self, position)
+    local gameFrameCount = game:GetFrameCount()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local roomClearGameFrame = getRoomClearGameFrame(nil)
+    if roomType ~= RoomType.BOSS or roomClearGameFrame == nil or gameFrameCount >= roomClearGameFrame + TRAPDOOR_BOSS_REACTION_FRAMES then
+        return false
+    end
+    return anyPlayerCloserThan(nil, position, TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS)
+end
+function shouldBeClosedFromStartingInRoomWithEnemies(self, initial, roomClear)
+    return initial and not roomClear
+end
+function defaultShouldCloseFunc(self)
+    return false
+end
+function defaultShouldSpawnOpenFunc(self, gridEntity)
+    local room = game:GetRoom()
+    local roomFrameCount = room:GetFrameCount()
+    local roomClear = room:IsClear()
+    if roomFrameCount > 0 then
+        return false
+    end
+    if not roomClear then
+        return false
+    end
+    return defaultShouldOpenFunc(nil, gridEntity)
+end
+--- Helper function to spawn a trapdoor grid entity that will have one or more of the following
+-- attributes:
+-- 
+-- - custom destination (or custom logic for after the player enters)
+-- - custom graphics
+-- - custom logic for opening/closing
+-- - TODO: animation
+-- 
+-- You can use this function to take the player to your custom stage. (See the `registerCustomStage`
+-- helper function.)
+-- 
+-- Under the hood, the custom trapdoor is represented by a decoration grid entity and is manually
+-- respawned every time the player re-enters the room.
+-- 
+-- @param gridIndexOrPosition The location in the room to spawn the trapdoor.
+-- @param _destination Used to specify where the player will go after jumping into the trapdoor. Can
+-- either be a tuple containing the stage and stage type, a string containing
+-- the name of a custom stage, or a function that returns one of these things.
+-- You can also specify a function that returns undefined in order to perform
+-- some custom behavior and/or handle the traveling part yourself. By default,
+-- the destination will be set to the next floor like that of a vanilla
+-- trapdoor.
+-- @param _anm2 Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2 of
+-- "gfx/grid/door_11_trapdoor.anm2" will be used.
+-- @param _shouldOpenFunc Optional. If the trapdoor is currently closed, this function will run on
+-- every frame to determine if it should open. By default, a function that
+-- emulates a vanilla trapdoor will be used.
+-- @param _shouldCloseFunc Optional. If the trapdoor is currently open, this function will run on
+-- every frame to determine if it should close. By default, a function that
+-- emulates a vanilla trapdoor will be used.
+-- @param _spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. Can either be
+-- a boolean or a function returning a boolean. By default, a function that
+-- emulates a vanilla trapdoor will be used.
+function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition, _destination, _anm2, _shouldOpenFunc, _shouldCloseFunc, _spawnOpen)
+    if _destination == nil then
+        _destination = defaultDestinationFunc
+    end
+    if _anm2 == nil then
+        _anm2 = "gfx/grid/door_11_trapdoor.anm2"
+    end
+    if _shouldOpenFunc == nil then
+        _shouldOpenFunc = defaultShouldOpenFunc
+    end
+    if _shouldCloseFunc == nil then
+        _shouldCloseFunc = defaultShouldCloseFunc
+    end
+    if _spawnOpen == nil then
+        _spawnOpen = defaultShouldSpawnOpenFunc
+    end
+    local decoration = spawnGrid(nil, GridEntityType.DECORATION, gridIndexOrPosition)
+    if decoration == nil then
+        error("Failed to spawn a custom trapdoor.")
+    end
+    return decoration
+end
+return ____exports

package/features/customTrapdoor/init.d.ts

@@ -0,0 +1 @@
+export declare function stageTravelInit(): void;

package/features/customTrapdoor/init.lua

@@ -0,0 +1,11 @@
+local ____exports = {}
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+local ____constants = require("features.customTrapdoor.constants")
+local STAGE_TRAVEL_FEATURE_NAME = ____constants.STAGE_TRAVEL_FEATURE_NAME
+local ____v = require("features.customTrapdoor.v")
+local v = ____v.default
+function ____exports.stageTravelInit(self)
+    saveDataManager(nil, STAGE_TRAVEL_FEATURE_NAME, v)
+end
+return ____exports

package/features/customTrapdoor/v.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="isaac-typescript-definitions" />
+import { StageTravelState } from "../../enums/StageTravelState";
+import { StageTravelEntityDescription } from "../../interfaces/StageTravelEntityDescription";
+declare const v: {
+    run: {
+        state: StageTravelState;
+    };
+    room: {
+        /** Indexed by grid index. */
+        trapdoors: Map<number, StageTravelEntityDescription>;
+    };
+};
+export default v;
+export declare function getCustomTrapdoorDescription(gridEntity: GridEntity): StageTravelEntityDescription | undefined;

package/features/customTrapdoor/v.lua

@@ -0,0 +1,16 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____StageTravelState = require("enums.StageTravelState")
+local StageTravelState = ____StageTravelState.StageTravelState
+local v = {
+    run = {state = StageTravelState.DISABLED},
+    room = {trapdoors = __TS__New(Map)}
+}
+____exports.default = v
+function ____exports.getCustomTrapdoorDescription(self, gridEntity)
+    local gridIndex = gridEntity:GetGridIndex()
+    return v.room.trapdoors:get(gridIndex)
+end
+return ____exports

package/features/ponyDetection.d.ts

@@ -3,4 +3,9 @@
  * 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.
  */
-export declare function isPonyActive(player: EntityPlayer): boolean;
+export declare function isPlayerUsingPony(player: EntityPlayer): boolean;
+/**
+ * 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.
+ */
+export declare function anyPlayerUsingPony(): boolean;

package/features/ponyDetection.lua

@@ -1,6 +1,7 @@
 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")
@@ -16,6 +17,8 @@ local ____playerDataStructures = require("functions.playerDataStructures")
 local setAddPlayer = ____playerDataStructures.setAddPlayer
 local setDeletePlayer = ____playerDataStructures.setDeletePlayer
 local setHasPlayer = ____playerDataStructures.setHasPlayer
+local ____playerIndex = require("functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 function postPEffectUpdateReordered(self, player)
@@ -46,8 +49,18 @@ function ____exports.ponyDetectionInit(self, mod)
 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.isPonyActive(self, player)
+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/features/roomClearFrame.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * 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.
+ */
+export declare function getRoomClearGameFrame(): int | undefined;
+/**
+ * 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.
+ */
+export declare function getRoomClearRoomFrame(): int | undefined;

package/features/roomClearFrame.lua

@@ -0,0 +1,38 @@
+local ____exports = {}
+local postRoomClearChangedTrue, v
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____exports = require("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 = "room clear frame"
+v = {room = {roomClearGameFrame = nil, roomClearRoomFrame = nil}}
+---
+-- @internal
+function ____exports.roomClearFrameInit(self, mod)
+    saveDataManager(nil, "roomClearFrame", 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/features/stageHistory.d.ts

@@ -0,0 +1,15 @@
+import { LevelStage, StageType } from "isaac-typescript-definitions";
+/** Helper function to get all of the stages that a player has visited thus far on this run. */
+export declare function getStageHistory(): ReadonlyArray<[
+    stage: LevelStage,
+    stageType: StageType
+]>;
+/**
+ * Helper function to check if a player has previous visited a particular stage (or stage + stage
+ * type combination) on this run.
+ *
+ * @param stage The stage to check for.
+ * @param stageType Optional. If provided, will check for a specific stage and stage type
+ *                  combination.
+ */
+export declare function hasVisitedStage(stage: LevelStage, stageType?: StageType): boolean;

package/features/stageHistory.lua

@@ -0,0 +1,62 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local ____exports = {}
+local postNewLevelReordered, v
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNewLevelReordered(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    local ____v_run_stageHistory_0 = v.run.stageHistory
+    ____v_run_stageHistory_0[#____v_run_stageHistory_0 + 1] = {stage, stageType}
+end
+local FEATURE_NAME = "stage history"
+v = {run = {stageHistory = {}}}
+---
+-- @internal
+function ____exports.stageHistoryInit(self, mod)
+    saveDataManager(nil, "stageHistory", v)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_LEVEL_REORDERED, postNewLevelReordered)
+end
+--- Helper function to get all of the stages that a player has visited thus far on this run.
+function ____exports.getStageHistory(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    return v.run.stageHistory
+end
+--- Helper function to check if a player has previous visited a particular stage (or stage + stage
+-- type combination) on this run.
+-- 
+-- @param stage The stage to check for.
+-- @param stageType Optional. If provided, will check for a specific stage and stage type
+-- combination.
+function ____exports.hasVisitedStage(self, stage, stageType)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if stageType == nil then
+        return __TS__ArraySome(
+            v.run.stageHistory,
+            function(____, ____bindingPattern0)
+                local previousStage
+                previousStage = ____bindingPattern0[1]
+                return previousStage == stage
+            end
+        )
+    end
+    return __TS__ArraySome(
+        v.run.stageHistory,
+        function(____, ____bindingPattern0)
+            local previousStageType
+            local previousStage
+            previousStage = ____bindingPattern0[1]
+            previousStageType = ____bindingPattern0[2]
+            return previousStage == stage and previousStageType == stageType
+        end
+    )
+end
+return ____exports

package/functions/gridEntity.d.ts

@@ -48,6 +48,11 @@ export declare function getGridEntities(...gridEntityTypes: GridEntityType[]): G
 export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[]): Map<int, GridEntity>;
 /** Helper function to return a string containing the grid entity's type and variant. */
 export declare function getGridEntityID(gridEntity: GridEntity): string;
+/**
+ * Helper function to get all of the grid entities in the room that specifically match the type and
+ * variant provided.
+ */
+export declare function getMatchingGridEntities(gridEntityType: GridEntityType, variant: int): GridEntity[];
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 export declare function getTopLeftWall(): GridEntity | undefined;
 /**

package/functions/gridEntity.lua

@@ -214,6 +214,15 @@ function ____exports.getGridEntityID(self, gridEntity)
     local gridEntityVariant = gridEntity:GetVariant()
     return (tostring(gridEntityType) .. ".") .. tostring(gridEntityVariant)
 end
+--- Helper function to get all of the grid entities in the room that specifically match the type and
+-- variant provided.
+function ____exports.getMatchingGridEntities(self, gridEntityType, variant)
+    local gridEntities = ____exports.getGridEntities(nil, gridEntityType)
+    return __TS__ArrayFilter(
+        gridEntities,
+        function(____, gridEntity) return gridEntity:GetVariant() == variant end
+    )
+end
 function ____exports.getSurroundingGridEntities(self, gridEntity)
     local room = game:GetRoom()
     local gridWidth = room:GetGridWidth()

package/functions/gridEntitySpecific.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
+import { CrawlSpaceState, TrapdoorVariant } from "isaac-typescript-definitions";
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` in the room.
+ * Specify a specific trapdoor variant to select only trapdoors of that variant.
+ */
+export declare function getCrawlSpaces(crawlSpaceVariant?: CrawlSpaceState): GridEntity[];
 /** Helper function to get all of the `GridEntityPit` in the room. */
 export declare function getPits(): GridEntityPit[];
 /** Helper function to get all of the `GridEntityPoop` in the room. */
@@ -16,6 +16,11 @@ export declare function getRocks(): GridEntityRock[];
 export declare function getSpikes(): GridEntitySpikes[];
 /** Helper function to get all of the `GridEntityTNT` in the room. */
 export declare function getTNT(): GridEntityTNT[];
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` in the room.
+ * Specify a specific trapdoor variant to select only trapdoors of that variant.
+ */
+export declare function getTrapdoors(trapdoorVariant?: TrapdoorVariant): GridEntity[];
 /**
  * Helper function to determine if all of the pressure plates in the current room are pushed.
  * Returns true if there are no pressure plates in the room.

package/functions/gridEntitySpecific.lua

@@ -2,11 +2,21 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
 local PressurePlateState = ____isaac_2Dtypescript_2Ddefinitions.PressurePlateState
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____gridEntity = require("functions.gridEntity")
 local getGridEntities = ____gridEntity.getGridEntities
+local getMatchingGridEntities = ____gridEntity.getMatchingGridEntities
+--- Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` in the room.
+-- Specify a specific trapdoor variant to select only trapdoors of that variant.
+function ____exports.getCrawlSpaces(self, crawlSpaceVariant)
+    if crawlSpaceVariant == nil then
+        return getGridEntities(nil, GridEntityType.CRAWL_SPACE)
+    end
+    return getMatchingGridEntities(nil, GridEntityType.CRAWL_SPACE, crawlSpaceVariant)
+end
 --- Helper function to get all of the `GridEntityPit` in the room.
 function ____exports.getPits(self)
     local gridEntities = getGridEntities(nil)
@@ -79,6 +89,14 @@ function ____exports.getTNT(self)
     end
     return tntArray
 end
+--- Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` in the room.
+-- Specify a specific trapdoor variant to select only trapdoors of that variant.
+function ____exports.getTrapdoors(self, trapdoorVariant)
+    if trapdoorVariant == nil then
+        return getGridEntities(nil, GridEntityType.TRAPDOOR)
+    end
+    return getMatchingGridEntities(nil, GridEntityType.TRAPDOOR, trapdoorVariant)
+end
 --- Helper function to determine if all of the pressure plates in the current room are pushed.
 -- Returns true if there are no pressure plates in the room.
 function ____exports.isAllPressurePlatesPushed(self)

package/functions/log.lua

@@ -14,6 +14,7 @@ local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
 local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local GameStateFlag = ____isaac_2Dtypescript_2Ddefinitions.GameStateFlag
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
 local LevelStateFlag = ____isaac_2Dtypescript_2Ddefinitions.LevelStateFlag
 local ProjectileFlag = ____isaac_2Dtypescript_2Ddefinitions.ProjectileFlag
 local SeedEffect = ____isaac_2Dtypescript_2Ddefinitions.SeedEffect
@@ -412,7 +413,12 @@ function ____exports.logRoom()
         ____exports.log((((("Current room type/variant/sub-type: " .. tostring(roomData.Type)) .. ".") .. tostring(roomData.Variant)) .. ".") .. tostring(roomData.Subtype))
         ____exports.log("Current room name: " .. roomData.Name)
     end
-    ____exports.log("Current room grid index: " .. tostring(roomGridIndex))
+    local roomGridIndexName = GridRoom[roomGridIndex]
+    if roomGridIndexName == nil then
+        ____exports.log("Current room grid index: " .. tostring(roomGridIndex))
+    else
+        ____exports.log(((("Current room grid index: " .. tostring(roomGridIndex)) .. " (GridRoom.") .. roomGridIndexName) .. ")")
+    end
     ____exports.log("Current room list index: " .. tostring(roomListIndex))
 end
 --- Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the

package/functions/nextStage.d.ts

@@ -0,0 +1,18 @@
+import { LevelStage, StageType } from "isaac-typescript-definitions";
+/**
+ * Helper function to get the stage that a trapdoor or heaven door would take the player to, based
+ * on the current stage, room, and game state flags.
+ *
+ * Note that in non-upgraded mods, this function will not account for the player having visited
+ * Repentance floors in The Ascent. (Handling this requires stateful tracking as the player
+ * progresses through the run.)
+ */
+export declare function getNextStage(): LevelStage;
+/**
+ * Helper function to get the stage type that a trapdoor or heaven door would take the player to,
+ * based on the current stage, room, and game state flags.
+ *
+ * @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
+ *                2. Defaults to false.
+ */
+export declare function getNextStageType(upwards?: boolean): StageType;

package/functions/nextStage.lua

@@ -0,0 +1,245 @@
+local ____exports = {}
+local getNextStageBackwardsPath, getStageTypeBackwardsPath
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GameStateFlag = ____isaac_2Dtypescript_2Ddefinitions.GameStateFlag
+local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
+local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
+local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____stageHistory = require("features.stageHistory")
+local hasVisitedStage = ____stageHistory.hasVisitedStage
+local ____featuresInitialized = require("featuresInitialized")
+local areFeaturesInitialized = ____featuresInitialized.areFeaturesInitialized
+local ____roomData = require("functions.roomData")
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local ____stage = require("functions.stage")
+local calculateStageType = ____stage.calculateStageType
+local calculateStageTypeRepentance = ____stage.calculateStageTypeRepentance
+local onRepentanceStage = ____stage.onRepentanceStage
+function getNextStageBackwardsPath(self, stage, repentanceStage)
+    if not areFeaturesInitialized(nil) then
+        return stage - 1
+    end
+    local visitedDownpour1 = hasVisitedStage(nil, LevelStage.BASEMENT_1, StageType.REPENTANCE)
+    local visitedDross1 = hasVisitedStage(nil, LevelStage.BASEMENT_1, StageType.REPENTANCE_B)
+    local visitedDownpour2 = hasVisitedStage(nil, LevelStage.BASEMENT_2, StageType.REPENTANCE)
+    local visitedDross2 = hasVisitedStage(nil, LevelStage.BASEMENT_2, StageType.REPENTANCE_B)
+    local visitedMines1 = hasVisitedStage(nil, LevelStage.CAVES_1, StageType.REPENTANCE)
+    local visitedAshpit1 = hasVisitedStage(nil, LevelStage.CAVES_1, StageType.REPENTANCE_B)
+    local visitedMines2 = hasVisitedStage(nil, LevelStage.DEPTHS_2, StageType.REPENTANCE)
+    local visitedAshpit2 = hasVisitedStage(nil, LevelStage.DEPTHS_2, StageType.REPENTANCE_B)
+    if stage == LevelStage.BASEMENT_1 then
+        if repentanceStage then
+            return LevelStage.BASEMENT_1
+        end
+        return LevelStage.HOME
+    end
+    if stage == LevelStage.BASEMENT_2 then
+        if repentanceStage then
+            if visitedDownpour1 or visitedDross1 then
+                return LevelStage.BASEMENT_1
+            end
+            return LevelStage.BASEMENT_2
+        end
+        return LevelStage.BASEMENT_1
+    end
+    if stage == LevelStage.CAVES_1 then
+        if repentanceStage then
+            if visitedDownpour2 or visitedDross2 then
+                return LevelStage.BASEMENT_2
+            end
+            return LevelStage.CAVES_1
+        end
+        return LevelStage.BASEMENT_2
+    end
+    if stage == LevelStage.CAVES_2 then
+        if repentanceStage then
+            if visitedMines1 or visitedAshpit1 then
+                return LevelStage.CAVES_1
+            end
+            return LevelStage.CAVES_2
+        end
+        return LevelStage.CAVES_1
+    end
+    if stage == LevelStage.DEPTHS_1 then
+        if repentanceStage then
+            if visitedMines2 or visitedAshpit2 then
+                return LevelStage.CAVES_2
+            end
+            return LevelStage.DEPTHS_1
+        end
+        return LevelStage.CAVES_2
+    end
+    if stage == LevelStage.DEPTHS_2 then
+        if repentanceStage then
+            return LevelStage.DEPTHS_2
+        end
+        return LevelStage.DEPTHS_1
+    end
+    return stage - 1
+end
+function getStageTypeBackwardsPath(self, stage, nextStage, repentanceStage)
+    local visitedDownpour1 = hasVisitedStage(nil, LevelStage.BASEMENT_1, StageType.REPENTANCE)
+    local visitedDross1 = hasVisitedStage(nil, LevelStage.BASEMENT_1, StageType.REPENTANCE_B)
+    local visitedDownpour2 = hasVisitedStage(nil, LevelStage.BASEMENT_2, StageType.REPENTANCE)
+    local visitedDross2 = hasVisitedStage(nil, LevelStage.BASEMENT_2, StageType.REPENTANCE_B)
+    local visitedMines1 = hasVisitedStage(nil, LevelStage.CAVES_1, StageType.REPENTANCE)
+    local visitedAshpit1 = hasVisitedStage(nil, LevelStage.CAVES_1, StageType.REPENTANCE_B)
+    local visitedMines2 = hasVisitedStage(nil, LevelStage.DEPTHS_2, StageType.REPENTANCE)
+    local visitedAshpit2 = hasVisitedStage(nil, LevelStage.DEPTHS_2, StageType.REPENTANCE_B)
+    if stage == LevelStage.BASEMENT_2 and repentanceStage then
+        if visitedDownpour1 then
+            return StageType.REPENTANCE
+        end
+        if visitedDross1 then
+            return StageType.REPENTANCE_B
+        end
+    end
+    if stage == LevelStage.CAVES_1 and repentanceStage then
+        if visitedDownpour2 then
+            return StageType.REPENTANCE
+        end
+        if visitedDross2 then
+            return StageType.REPENTANCE_B
+        end
+    end
+    if stage == LevelStage.CAVES_2 and not repentanceStage then
+        if visitedDownpour2 then
+            return StageType.REPENTANCE
+        end
+        if visitedDross2 then
+            return StageType.REPENTANCE_B
+        end
+    end
+    if stage == LevelStage.CAVES_2 and repentanceStage then
+        if visitedMines1 then
+            return StageType.REPENTANCE
+        end
+        if visitedAshpit1 then
+            return StageType.REPENTANCE_B
+        end
+    end
+    if stage == LevelStage.DEPTHS_2 and not repentanceStage then
+        if visitedAshpit2 then
+            return StageType.REPENTANCE_B
+        end
+        if visitedMines2 then
+            return StageType.REPENTANCE
+        end
+    end
+    return calculateStageType(nil, nextStage)
+end
+--- Helper function to get the stage that a trapdoor or heaven door would take the player to, based
+-- on the current stage, room, and game state flags.
+-- 
+-- Note that in non-upgraded mods, this function will not account for the player having visited
+-- Repentance floors in The Ascent. (Handling this requires stateful tracking as the player
+-- progresses through the run.)
+function ____exports.getNextStage(self)
+    local level = game:GetLevel()
+    local backwardsPath = game:GetStateFlag(GameStateFlag.BACKWARDS_PATH)
+    local mausoleumHeartKilled = game:GetStateFlag(GameStateFlag.MAUSOLEUM_HEART_KILLED)
+    local stage = level:GetStage()
+    local repentanceStage = onRepentanceStage(nil)
+    local roomGridIndex = getRoomGridIndex(nil)
+    if backwardsPath then
+        return getNextStageBackwardsPath(nil, stage, repentanceStage)
+    end
+    repeat
+        local ____switch4 = roomGridIndex
+        local ____cond4 = ____switch4 == GridRoom.BLUE_WOMB
+        if ____cond4 then
+            do
+                return LevelStage.BLUE_WOMB
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == GridRoom.THE_VOID
+        if ____cond4 then
+            do
+                return LevelStage.THE_VOID
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == GridRoom.SECRET_EXIT
+        if ____cond4 then
+            do
+                if repentanceStage then
+                    return stage + 1
+                end
+                if stage == LevelStage.DEPTHS_2 then
+                    return LevelStage.DEPTHS_2
+                end
+                return stage
+            end
+        end
+    until true
+    if repentanceStage and stage == LevelStage.BASEMENT_2 then
+        return LevelStage.CAVES_2
+    end
+    if repentanceStage and stage == LevelStage.CAVES_2 then
+        return LevelStage.DEPTHS_2
+    end
+    if repentanceStage and stage == LevelStage.DEPTHS_2 then
+        if mausoleumHeartKilled then
+            return LevelStage.WOMB_1
+        end
+        return LevelStage.WOMB_2
+    end
+    if stage == LevelStage.WOMB_2 then
+        return LevelStage.SHEOL_CATHEDRAL
+    end
+    if stage == LevelStage.DARK_ROOM_CHEST then
+        return LevelStage.DARK_ROOM_CHEST
+    end
+    if stage == LevelStage.THE_VOID then
+        return LevelStage.THE_VOID
+    end
+    return stage + 1
+end
+--- Helper function to get the stage type that a trapdoor or heaven door would take the player to,
+-- based on the current stage, room, and game state flags.
+-- 
+-- @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
+-- 2. Defaults to false.
+function ____exports.getNextStageType(self, upwards)
+    if upwards == nil then
+        upwards = false
+    end
+    local backwardsPath = game:GetStateFlag(GameStateFlag.BACKWARDS_PATH)
+    local mausoleumHeartKilled = game:GetStateFlag(GameStateFlag.MAUSOLEUM_HEART_KILLED)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    local repentanceStage = onRepentanceStage(nil)
+    local roomGridIndex = getRoomGridIndex(nil)
+    local nextStage = ____exports.getNextStage(nil)
+    if backwardsPath then
+        return getStageTypeBackwardsPath(nil, stage, nextStage, repentanceStage)
+    end
+    if roomGridIndex == GridRoom.SECRET_EXIT then
+        return calculateStageTypeRepentance(nil, nextStage)
+    end
+    if repentanceStage and (stage == LevelStage.BASEMENT_1 or stage == LevelStage.CAVES_1 or stage == LevelStage.DEPTHS_1 or stage == LevelStage.WOMB_1) then
+        return calculateStageTypeRepentance(nil, nextStage)
+    end
+    if repentanceStage and stage == LevelStage.DEPTHS_2 and mausoleumHeartKilled then
+        return calculateStageTypeRepentance(nil, nextStage)
+    end
+    if nextStage == LevelStage.BLUE_WOMB then
+        return StageType.ORIGINAL
+    end
+    if nextStage == LevelStage.SHEOL_CATHEDRAL then
+        if upwards then
+            return StageType.WRATH_OF_THE_LAMB
+        end
+        return StageType.ORIGINAL
+    end
+    if nextStage == LevelStage.DARK_ROOM_CHEST then
+        if stageType == StageType.ORIGINAL then
+            return StageType.ORIGINAL
+        end
+        return StageType.WRATH_OF_THE_LAMB
+    end
+    return calculateStageType(nil, nextStage)
+end
+return ____exports

package/functions/stage.d.ts

@@ -1,4 +1,14 @@
 import { LevelStage, StageType } from "isaac-typescript-definitions";
+/**
+ * Helper function that calculates what the stage type should be for the provided stage. This
+ * emulates what the game's internal code does.
+ */
+export declare function calculateStageType(stage: LevelStage): StageType;
+/**
+ * Helper function that calculates what the Repentance stage type should be for the provided stage.
+ * This emulates what the game's internal code does.
+ */
+export declare function calculateStageTypeRepentance(stage: LevelStage): StageType;
 /**
  * Helper function to account for Repentance floors being offset by 1. For example, Downpour 2 is
  * the third level of the run, but the game considers it to have a stage of 2. This function will

package/functions/stage.lua

@@ -21,6 +21,34 @@ end
 function ____exports.stageTypeToLetter(self, stageType)
     return STAGE_TYPE_TO_LETTER[stageType]
 end
+--- Helper function that calculates what the stage type should be for the provided stage. This
+-- emulates what the game's internal code does.
+function ____exports.calculateStageType(self, stage)
+    local seeds = game:GetSeeds()
+    local stageSeed = seeds:GetStageSeed(stage)
+    if stageSeed % 2 == 0 then
+        return StageType.WRATH_OF_THE_LAMB
+    end
+    if stageSeed % 3 == 0 then
+        return StageType.AFTERBIRTH
+    end
+    return StageType.ORIGINAL
+end
+--- Helper function that calculates what the Repentance stage type should be for the provided stage.
+-- This emulates what the game's internal code does.
+function ____exports.calculateStageTypeRepentance(self, stage)
+    if stage == LevelStage.WOMB_1 or stage == LevelStage.WOMB_2 then
+        return StageType.REPENTANCE
+    end
+    local seeds = game:GetSeeds()
+    local adjustedStage = stage + 1
+    local stageSeed = seeds:GetStageSeed(adjustedStage)
+    local halfStageSeed = math.floor(stageSeed / 2)
+    if halfStageSeed % 2 == 0 then
+        return StageType.REPENTANCE_B
+    end
+    return StageType.REPENTANCE
+end
 --- Helper function to account for Repentance floors being offset by 1. For example, Downpour 2 is
 -- the third level of the run, but the game considers it to have a stage of 2. This function will
 -- consider Downpour 2 to have a stage of 3.

package/index.d.ts

@@ -11,6 +11,8 @@ export * from "./enums/PocketItemType";
 export * from "./enums/SerializationType";
 export { ConversionHeartSubType, registerCharacterHealthConversion, } from "./features/characterHealthConversion";
 export { registerCharacterStats } from "./features/characterStats";
+export { getCollectibleItemPoolType } from "./features/collectibleItemPoolType";
+export * from "./features/customTrapdoor/exports";
 export * from "./features/debugDisplay/exports";
 export { deployJSONRoom, deployRandomJSONRoom, emptyRoom, } from "./features/deployJSONRoom";
 export { disableAllInputs, disableAllInputsExceptFor, disableMovementInputs, disableShootingInputs, enableAllInputs, enableAllInputsExceptFor, } from "./features/disableInputs";
@@ -19,14 +21,15 @@ export { addConsoleCommand, enableExtraConsoleCommands, removeConsoleCommand, }
 export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
 export { disableFastReset, enableFastReset } from "./features/fastReset";
 export { forgottenSwitch } from "./features/forgottenSwitch";
-export { getCollectibleItemPoolType } from "./features/getCollectibleItemPoolType";
 export { removePersistentEntity, spawnPersistentEntity, } from "./features/persistentEntities";
 export { getPlayerInventory } from "./features/playerInventory";
-export * from "./features/ponyDetection";
+export { anyPlayerUsingPony, isPlayerUsingPony as isPonyActive, } from "./features/ponyDetection";
 export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
+export { getRoomClearGameFrame, getRoomClearRoomFrame, } from "./features/roomClearFrame";
 export { runInNGameFrames, runInNRenderFrames, runNextGameFrame, runNextRenderFrame, } from "./features/runInNFrames";
 export * from "./features/saveDataManager/exports";
 export { hasSirenStolenFamiliar, setFamiliarNoSirenSteal, } from "./features/sirenHelpers";
+export { getStageHistory, hasVisitedStage } from "./features/stageHistory";
 export { getTaintedLazarusSubPlayer } from "./features/taintedLazarusPlayers";
 export * from "./functions/ambush";
 export * from "./functions/array";
@@ -46,8 +49,8 @@ export * from "./functions/collectibleSet";
 export * from "./functions/collectibleTag";
 export * from "./functions/color";
 export * from "./functions/debug";
-export { deepCopy } from "./functions/deepCopy";
-export { deepCopyTests } from "./functions/deepCopyTests";
+export * from "./functions/deepCopy";
+export * from "./functions/deepCopyTests";
 export * from "./functions/direction";
 export * from "./functions/doors";
 export * from "./functions/easing";
@@ -73,7 +76,7 @@ export * from "./functions/level";
 export * from "./functions/log";
 export * from "./functions/map";
 export * from "./functions/math";
-export { mergeTests } from "./functions/mergeTests";
+export * from "./functions/mergeTests";
 export * from "./functions/npc";
 export * from "./functions/pickups";
 export * from "./functions/pickupVariants";

package/index.lua

@@ -95,6 +95,19 @@ do
     local registerCharacterStats = ____characterStats.registerCharacterStats
     ____exports.registerCharacterStats = registerCharacterStats
 end
+do
+    local ____collectibleItemPoolType = require("features.collectibleItemPoolType")
+    local getCollectibleItemPoolType = ____collectibleItemPoolType.getCollectibleItemPoolType
+    ____exports.getCollectibleItemPoolType = getCollectibleItemPoolType
+end
+do
+    local ____export = require("features.customTrapdoor.exports")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("features.debugDisplay.exports")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -162,11 +175,6 @@ do
     local forgottenSwitch = ____forgottenSwitch.forgottenSwitch
     ____exports.forgottenSwitch = forgottenSwitch
 end
-do
-    local ____getCollectibleItemPoolType = require("features.getCollectibleItemPoolType")
-    local getCollectibleItemPoolType = ____getCollectibleItemPoolType.getCollectibleItemPoolType
-    ____exports.getCollectibleItemPoolType = getCollectibleItemPoolType
-end
 do
     local ____persistentEntities = require("features.persistentEntities")
     local removePersistentEntity = ____persistentEntities.removePersistentEntity
@@ -180,18 +188,24 @@ do
     ____exports.getPlayerInventory = getPlayerInventory
 end
 do
-    local ____export = require("features.ponyDetection")
-    for ____exportKey, ____exportValue in pairs(____export) do
-        if ____exportKey ~= "default" then
-            ____exports[____exportKey] = ____exportValue
-        end
-    end
+    local ____ponyDetection = require("features.ponyDetection")
+    local anyPlayerUsingPony = ____ponyDetection.anyPlayerUsingPony
+    local isPonyActive = ____ponyDetection.isPlayerUsingPony
+    ____exports.anyPlayerUsingPony = anyPlayerUsingPony
+    ____exports.isPonyActive = isPonyActive
 end
 do
     local ____preventCollectibleRotation = require("features.preventCollectibleRotation")
     local preventCollectibleRotation = ____preventCollectibleRotation.preventCollectibleRotation
     ____exports.preventCollectibleRotation = preventCollectibleRotation
 end
+do
+    local ____roomClearFrame = require("features.roomClearFrame")
+    local getRoomClearGameFrame = ____roomClearFrame.getRoomClearGameFrame
+    local getRoomClearRoomFrame = ____roomClearFrame.getRoomClearRoomFrame
+    ____exports.getRoomClearGameFrame = getRoomClearGameFrame
+    ____exports.getRoomClearRoomFrame = getRoomClearRoomFrame
+end
 do
     local ____runInNFrames = require("features.runInNFrames")
     local runInNGameFrames = ____runInNFrames.runInNGameFrames
@@ -218,6 +232,13 @@ do
     ____exports.hasSirenStolenFamiliar = hasSirenStolenFamiliar
     ____exports.setFamiliarNoSirenSteal = setFamiliarNoSirenSteal
 end
+do
+    local ____stageHistory = require("features.stageHistory")
+    local getStageHistory = ____stageHistory.getStageHistory
+    local hasVisitedStage = ____stageHistory.hasVisitedStage
+    ____exports.getStageHistory = getStageHistory
+    ____exports.hasVisitedStage = hasVisitedStage
+end
 do
     local ____taintedLazarusPlayers = require("features.taintedLazarusPlayers")
     local getTaintedLazarusSubPlayer = ____taintedLazarusPlayers.getTaintedLazarusSubPlayer
@@ -368,14 +389,20 @@ do
     end
 end
 do
-    local ____deepCopy = require("functions.deepCopy")
-    local deepCopy = ____deepCopy.deepCopy
-    ____exports.deepCopy = deepCopy
+    local ____export = require("functions.deepCopy")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
 end
 do
-    local ____deepCopyTests = require("functions.deepCopyTests")
-    local deepCopyTests = ____deepCopyTests.deepCopyTests
-    ____exports.deepCopyTests = deepCopyTests
+    local ____export = require("functions.deepCopyTests")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
 end
 do
     local ____export = require("functions.direction")
@@ -578,9 +605,12 @@ do
     end
 end
 do
-    local ____mergeTests = require("functions.mergeTests")
-    local mergeTests = ____mergeTests.mergeTests
-    ____exports.mergeTests = mergeTests
+    local ____export = require("functions.mergeTests")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
 end
 do
     local ____export = require("functions.npc")

package/initFeatures.lua

@@ -3,6 +3,10 @@ local ____characterHealthConversion = require("features.characterHealthConversio
 local characterHealthConversionInit = ____characterHealthConversion.characterHealthConversionInit
 local ____characterStats = require("features.characterStats")
 local characterStatsInit = ____characterStats.characterStatsInit
+local ____collectibleItemPoolType = require("features.collectibleItemPoolType")
+local collectibleItemPoolTypeInit = ____collectibleItemPoolType.collectibleItemPoolTypeInit
+local ____init = require("features.customTrapdoor.init")
+local stageTravelInit = ____init.stageTravelInit
 local ____deployJSONRoom = require("features.deployJSONRoom")
 local deployJSONRoomInit = ____deployJSONRoom.deployJSONRoomInit
 local ____disableInputs = require("features.disableInputs")
@@ -15,8 +19,6 @@ local ____fastReset = require("features.fastReset")
 local fastResetInit = ____fastReset.fastResetInit
 local ____forgottenSwitch = require("features.forgottenSwitch")
 local forgottenSwitchInit = ____forgottenSwitch.forgottenSwitchInit
-local ____getCollectibleItemPoolType = require("features.getCollectibleItemPoolType")
-local getCollectibleItemPoolTypeInit = ____getCollectibleItemPoolType.getCollectibleItemPoolTypeInit
 local ____persistentEntities = require("features.persistentEntities")
 local persistentEntitiesInit = ____persistentEntities.persistentEntitiesInit
 local ____playerInventory = require("features.playerInventory")
@@ -25,10 +27,14 @@ local ____ponyDetection = require("features.ponyDetection")
 local ponyDetectionInit = ____ponyDetection.ponyDetectionInit
 local ____preventCollectibleRotation = require("features.preventCollectibleRotation")
 local preventCollectibleRotationInit = ____preventCollectibleRotation.preventCollectibleRotationInit
+local ____roomClearFrame = require("features.roomClearFrame")
+local roomClearFrameInit = ____roomClearFrame.roomClearFrameInit
 local ____runInNFrames = require("features.runInNFrames")
 local runInNFramesInit = ____runInNFrames.runInNFramesInit
 local ____sirenHelpers = require("features.sirenHelpers")
 local sirenHelpersInit = ____sirenHelpers.sirenHelpersInit
+local ____stageHistory = require("features.stageHistory")
+local stageHistoryInit = ____stageHistory.stageHistoryInit
 local ____taintedLazarusPlayers = require("features.taintedLazarusPlayers")
 local taintedLazarusPlayersInit = ____taintedLazarusPlayers.taintedLazarusPlayersInit
 function ____exports.initFeaturesMajor(self, mod)
@@ -43,12 +49,15 @@ function ____exports.initFeaturesMinor(self, mod)
     fadeInRemoverInit(nil, mod)
     fastResetInit(nil, mod)
     forgottenSwitchInit(nil, mod)
-    getCollectibleItemPoolTypeInit(nil, mod)
+    collectibleItemPoolTypeInit(nil, mod)
     persistentEntitiesInit(nil, mod)
     playerInventoryInit(nil, mod)
     ponyDetectionInit(nil, mod)
     preventCollectibleRotationInit(nil, mod)
+    roomClearFrameInit(nil, mod)
     sirenHelpersInit(nil, mod)
+    stageHistoryInit(nil, mod)
+    stageTravelInit(nil)
     taintedLazarusPlayersInit(nil, mod)
 end
 return ____exports

package/interfaces/StageTravelEntityDescription.d.ts

@@ -0,0 +1,5 @@
+import { StageTravelEntityState } from "../enums/StageTravelEntityState";
+export interface StageTravelEntityDescription {
+    initial: boolean;
+    state: StageTravelEntityState;
+}

package/interfaces/StageTravelEntityDescription.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.2.8",
+  "version": "4.3.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.12"
+    "isaac-typescript-definitions": "^3.0.13"
   }
 }

package/enums/StageTravelEntityType.d.ts

@@ -1,5 +0,0 @@
-export declare enum StageTravelEntityType {
-    TRAPDOOR = 0,
-    CRAWLSPACE = 1,
-    HEAVEN_DOOR = 2
-}

package/enums/StageTravelEntityType.lua

@@ -1,9 +0,0 @@
-local ____exports = {}
-____exports.StageTravelEntityType = {}
-____exports.StageTravelEntityType.TRAPDOOR = 0
-____exports.StageTravelEntityType[____exports.StageTravelEntityType.TRAPDOOR] = "TRAPDOOR"
-____exports.StageTravelEntityType.CRAWLSPACE = 1
-____exports.StageTravelEntityType[____exports.StageTravelEntityType.CRAWLSPACE] = "CRAWLSPACE"
-____exports.StageTravelEntityType.HEAVEN_DOOR = 2
-____exports.StageTravelEntityType[____exports.StageTravelEntityType.HEAVEN_DOOR] = "HEAVEN_DOOR"
-return ____exports

package/features/stageTravel/exports.d.ts

@@ -1,23 +0,0 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/**
- * Spawn a trapdoor grid entity that will have one or more of the following custom attributes:
- *
- * - custom sprite
- * - custom opening/closing logic
- * - custom destination / logic for after the player enters
- */
-export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector): GridEntity;
-/**
- * Convert an existing trapdoor into a custom trapdoor that will have one or more of the following
- * custom attributes:
- *
- * - custom sprite
- * - custom opening/closing logic
- * - custom destination / logic for after the player enters
- */
-export declare function initCustomTrapdoor(_trapdoor: GridEntity, _shouldSpawnOpenFunc?: typeof defaultShouldSpawnOpenFunc): void;
-declare function defaultShouldSpawnOpenFunc(_entity: GridEntity | EntityEffect): boolean;
-export {};

package/features/stageTravel/exports.lua

@@ -1,44 +0,0 @@
-local ____exports = {}
-local defaultShouldSpawnOpenFunc
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____gridEntity = require("functions.gridEntity")
-local spawnGrid = ____gridEntity.spawnGrid
---- Convert an existing trapdoor into a custom trapdoor that will have one or more of the following
--- custom attributes:
--- 
--- - custom sprite
--- - custom opening/closing logic
--- - custom destination / logic for after the player enters
-function ____exports.initCustomTrapdoor(self, _trapdoor, _shouldSpawnOpenFunc)
-    if _shouldSpawnOpenFunc == nil then
-        _shouldSpawnOpenFunc = defaultShouldSpawnOpenFunc
-    end
-end
-function defaultShouldSpawnOpenFunc(self, _entity)
-    local room = game:GetRoom()
-    local roomFrameCount = room:GetFrameCount()
-    local roomClear = room:IsClear()
-    if roomFrameCount == 0 then
-        if not roomClear then
-            return false
-        end
-    end
-    return false
-end
---- Spawn a trapdoor grid entity that will have one or more of the following custom attributes:
--- 
--- - custom sprite
--- - custom opening/closing logic
--- - custom destination / logic for after the player enters
-function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition)
-    local trapdoor = spawnGrid(nil, GridEntityType.TRAPDOOR, gridIndexOrPosition)
-    if trapdoor == nil then
-        error("Failed to spawn a custom trapdoor.")
-    end
-    ____exports.initCustomTrapdoor(nil, trapdoor)
-    return trapdoor
-end
-return ____exports