isaacscript-common 6.6.1-dev.2 → 6.6.1

package/dist/features/collectibleItemPoolType.lua

@@ -0,0 +1,48 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local postPickupInitCollectible, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
+local ____pickupVariants = require("functions.pickupVariants")
+local isCollectible = ____pickupVariants.isCollectible
+local ____rooms = require("functions.rooms")
+local getRoomItemPoolType = ____rooms.getRoomItemPoolType
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postPickupInitCollectible(self, pickup)
+    local itemPool = game:GetItemPool()
+    local ptrHash = GetPtrHash(pickup)
+    local lastItemPoolType = itemPool:GetLastPool()
+    v.run.collectibleItemPoolTypeMap:set(ptrHash, lastItemPoolType)
+end
+local FEATURE_NAME = "collectibleItemPoolType"
+v = {run = {collectibleItemPoolTypeMap = __TS__New(Map)}}
+---
+-- @internal
+function ____exports.collectibleItemPoolTypeInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, 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
+-- native method in the API to get this, we listen in the PreGetCollectible callback for item pool
+-- types, and then assume that the next spawned collectible will match.
+function ____exports.getCollectibleItemPoolType(self, collectible)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"getCollectibleItemPoolType\" function was given a non-collectible: " .. entityID)
+    end
+    local ptrHash = GetPtrHash(collectible)
+    local itemPoolType = v.run.collectibleItemPoolTypeMap:get(ptrHash)
+    return itemPoolType == nil and getRoomItemPoolType(nil) or itemPoolType
+end
+return ____exports

package/dist/features/customGridEntity.d.ts

@@ -0,0 +1,42 @@
+import { GridCollisionClass, GridEntityType } from "isaac-typescript-definitions";
+/**
+ * Helper function to spawn a custom grid entity.
+ *
+ * This is an IsaacScript feature because the vanilla game does not support any custom grid
+ * entities. Under the hood, IsaacScript accomplishes this by using decorations with an arbitrary
+ * non-zero variant to represent custom grid entities.
+ *
+ * Once a custom grid entity is spawned, you can take advantage of the custom grid callbacks such as
+ * `POST_GRID_ENTITY_CUSTOM_UPDATE`.
+ *
+ * @param gridEntityTypeCustom An integer that identifies what kind of grid entity you are creating.
+ *                             It should correspond to a local enum value in your mod. The integer
+ *                             can be any unique value and will not correspond to the actual grid
+ *                             entity type used. (This integer is used in the various custom grid
+ *                             entity callbacks.)
+ * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+ *                            entity at. If a position is specified, the closest grid index will be
+ *                            used.
+ * @param anm2 The path to the ANM2 file to use for the sprite.
+ * @param defaultAnimation The name of the animation to play after the sprite is initialized and
+ *                         after the player re-enters a room with this grid entity in it.
+ * @param gridCollisionClass The collision class that you want the custom grid entity to have.
+ */
+export declare function spawnCustomGrid(gridEntityTypeCustom: GridEntityType, gridIndexOrPosition: int | Vector, anm2: string, defaultAnimation: string, gridCollisionClass: GridCollisionClass): GridEntity;
+/**
+ * Helper function to remove a custom grid entity created by the `spawnCustomGrid` function.
+ *
+ * @param gridIndexOrPositionOrGridEntity You can specify the custom grid entity to remove by
+ *                                 providing the grid index, the room position, or the grid entity
+ *                                 itself.
+ * @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
+ *                   Default is true. This is generally a good idea because if the room is not
+ *                   updated, you will be unable to spawn another grid entity on the same tile until
+ *                   a frame has passed. However, doing this is expensive, since it involves a call
+ *                   to `Isaac.GetRoomEntities`, so set it to false if you need to invoke this
+ *                   function multiple times.
+ * @returns The grid entity that was removed. Returns undefined if no grid entity was found at the
+ *          given location or if the given grid entity was not a custom grid entity.
+ */
+export declare function removeCustomGrid(gridIndexOrPositionOrGridEntity: int | Vector | GridEntity, updateRoom?: boolean): GridEntity | undefined;
+//# sourceMappingURL=customGridEntity.d.ts.map

package/dist/features/customGridEntity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customGridEntity.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/features/customGridEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,cAAc,EACf,MAAM,8BAA8B,CAAC;AA0DtC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,eAAe,CAC7B,oBAAoB,EAAE,cAAc,EACpC,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,kBAAkB,GACrC,UAAU,CA4CZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAC9B,+BAA+B,EAAE,GAAG,GAAG,MAAM,GAAG,UAAU,EAC1D,UAAU,UAAO,GAChB,UAAU,GAAG,SAAS,CAqCxB"}

package/dist/features/customGridEntity.lua

@@ -0,0 +1,156 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local postNewRoomReordered, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____DecorationVariant = require("enums.DecorationVariant")
+local DecorationVariant = ____DecorationVariant.DecorationVariant
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____gridEntity = require("functions.gridEntity")
+local removeGrid = ____gridEntity.removeGrid
+local spawnGridWithVariant = ____gridEntity.spawnGridWithVariant
+local ____roomData = require("functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
+local ____vector = require("functions.vector")
+local isVector = ____vector.isVector
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNewRoomReordered(self)
+    local roomListIndex = getRoomListIndex(nil)
+    local roomCustomGridEntities = v.level.customGridEntities:get(roomListIndex)
+    if roomCustomGridEntities == nil then
+        return
+    end
+    local room = game:GetRoom()
+    for ____, ____value in __TS__Iterator(roomCustomGridEntities:entries()) do
+        local gridIndex = ____value[1]
+        local data = ____value[2]
+        do
+            local decoration = room:GetGridEntity(gridIndex)
+            if decoration == nil then
+                roomCustomGridEntities:delete(gridIndex)
+                goto __continue6
+            end
+            local sprite = decoration:GetSprite()
+            sprite:Load(data.anm2, true)
+            sprite:Play(data.defaultAnimation, true)
+        end
+        ::__continue6::
+    end
+end
+local FEATURE_NAME = "customGridEntity"
+v = {level = {customGridEntities = __TS__New(
+    DefaultMap,
+    function() return __TS__New(Map) end
+)}}
+---
+-- @internal
+function ____exports.customGridEntityInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
+end
+--- Helper function to spawn a custom grid entity.
+-- 
+-- This is an IsaacScript feature because the vanilla game does not support any custom grid
+-- entities. Under the hood, IsaacScript accomplishes this by using decorations with an arbitrary
+-- non-zero variant to represent custom grid entities.
+-- 
+-- Once a custom grid entity is spawned, you can take advantage of the custom grid callbacks such as
+-- `POST_GRID_ENTITY_CUSTOM_UPDATE`.
+-- 
+-- @param gridEntityTypeCustom An integer that identifies what kind of grid entity you are creating.
+-- It should correspond to a local enum value in your mod. The integer
+-- can be any unique value and will not correspond to the actual grid
+-- entity type used. (This integer is used in the various custom grid
+-- entity callbacks.)
+-- @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+-- entity at. If a position is specified, the closest grid index will be
+-- used.
+-- @param anm2 The path to the ANM2 file to use for the sprite.
+-- @param defaultAnimation The name of the animation to play after the sprite is initialized and
+-- after the player re-enters a room with this grid entity in it.
+-- @param gridCollisionClass The collision class that you want the custom grid entity to have.
+function ____exports.spawnCustomGrid(self, gridEntityTypeCustom, gridIndexOrPosition, anm2, defaultAnimation, gridCollisionClass)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local room = game:GetRoom()
+    local roomListIndex = getRoomListIndex(nil)
+    local gridIndex = isVector(nil, gridIndexOrPosition) and room:GetGridIndex(gridIndexOrPosition) or gridIndexOrPosition
+    local existingGridEntity = room:GetGridEntity(gridIndex)
+    local isExistingDecoration = existingGridEntity ~= nil and existingGridEntity:GetType() == GridEntityType.DECORATION and existingGridEntity:GetVariant() == DecorationVariant.CUSTOM_GRID_ENTITY
+    local decoration = isExistingDecoration and existingGridEntity or spawnGridWithVariant(nil, GridEntityType.DECORATION, DecorationVariant.CUSTOM_GRID_ENTITY, gridIndexOrPosition)
+    if decoration == nil then
+        error("Failed to spawn a decoration for a custom grid entity.")
+    end
+    local sprite = decoration:GetSprite()
+    sprite:Load(anm2, true)
+    sprite:Play(defaultAnimation, true)
+    local customGridEntityData = {
+        gridEntityTypeCustom = gridEntityTypeCustom,
+        roomListIndex = roomListIndex,
+        gridIndex = gridIndex,
+        anm2 = anm2,
+        defaultAnimation = defaultAnimation,
+        gridCollisionClass = gridCollisionClass
+    }
+    local roomCustomGridEntities = v.level.customGridEntities:getAndSetDefault(roomListIndex)
+    roomCustomGridEntities:set(gridIndex, customGridEntityData)
+    return decoration
+end
+--- Helper function to remove a custom grid entity created by the `spawnCustomGrid` function.
+-- 
+-- @param gridIndexOrPositionOrGridEntity You can specify the custom grid entity to remove by
+-- providing the grid index, the room position, or the grid entity
+-- itself.
+-- @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
+-- Default is true. This is generally a good idea because if the room is not
+-- updated, you will be unable to spawn another grid entity on the same tile until
+-- a frame has passed. However, doing this is expensive, since it involves a call
+-- to `Isaac.GetRoomEntities`, so set it to false if you need to invoke this
+-- function multiple times.
+-- @returns The grid entity that was removed. Returns undefined if no grid entity was found at the
+-- given location or if the given grid entity was not a custom grid entity.
+function ____exports.removeCustomGrid(self, gridIndexOrPositionOrGridEntity, updateRoom)
+    if updateRoom == nil then
+        updateRoom = true
+    end
+    local room = game:GetRoom()
+    local roomListIndex = getRoomListIndex(nil)
+    local decoration
+    if type(gridIndexOrPositionOrGridEntity) == "number" then
+        local gridIndex = gridIndexOrPositionOrGridEntity
+        local gridEntity = room:GetGridEntity(gridIndex)
+        if gridEntity == nil then
+            return nil
+        end
+        decoration = gridEntity
+    elseif isVector(nil, gridIndexOrPositionOrGridEntity) then
+        local position = gridIndexOrPositionOrGridEntity
+        local gridEntity = room:GetGridEntityFromPos(position)
+        if gridEntity == nil then
+            return nil
+        end
+        decoration = gridEntity
+    else
+        decoration = gridIndexOrPositionOrGridEntity
+    end
+    local gridIndex = decoration:GetGridIndex()
+    local roomCustomGridEntities = v.level.customGridEntities:getAndSetDefault(roomListIndex)
+    local exists = roomCustomGridEntities:has(gridIndex)
+    if not exists then
+        return nil
+    end
+    roomCustomGridEntities:delete(gridIndex)
+    removeGrid(nil, decoration, updateRoom)
+    return decoration
+end
+return ____exports

package/dist/features/customStage/backdrop.d.ts

@@ -0,0 +1,3 @@
+import { CustomStage } from "../../interfaces/CustomStage";
+export declare function setBackdrop(customStage: CustomStage): void;
+//# sourceMappingURL=backdrop.d.ts.map

package/dist/features/customStage/backdrop.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backdrop.d.ts","sourceRoot":"","sources":["../../../../../../packages/isaacscript-common/src/features/customStage/backdrop.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AA0E3D,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAc1D"}

package/dist/features/customStage/backdrop.lua

@@ -0,0 +1,193 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local getBackdropPNGPath, spawnWallEntity, spawnSecondWallEntity, spawnFloorEntity, getNumFloorLayers, BackdropKind, DEFAULT_BACKDROP, ROOM_SHAPE_WALL_ANM2_LAYERS, ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS, WALL_OFFSET, L_FLOOR_ANM2_LAYERS, N_FLOOR_ANM2_LAYERS, BACKDROP_EFFECT_VARIANT
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____array = require("functions.array")
+local getRandomArrayElement = ____array.getRandomArrayElement
+local ____entitySpecific = require("functions.entitySpecific")
+local spawnEffectWithSeed = ____entitySpecific.spawnEffectWithSeed
+local ____rng = require("functions.rng")
+local newRNG = ____rng.newRNG
+local ____roomShape = require("functions.roomShape")
+local isLRoom = ____roomShape.isLRoom
+local isNarrowRoom = ____roomShape.isNarrowRoom
+local ____string = require("functions.string")
+local trimPrefix = ____string.trimPrefix
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+local irange = ____utils.irange
+local ____customStageConstants = require("features.customStage.customStageConstants")
+local ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = ____customStageConstants.ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH
+function getBackdropPNGPath(self, customStage, backdropKind, rng)
+    local backdrop = customStage.backdropPNGPaths == nil and DEFAULT_BACKDROP or customStage.backdropPNGPaths
+    local pathArray = backdrop[backdropKind]
+    return getRandomArrayElement(nil, pathArray, rng)
+end
+function spawnWallEntity(self, customStage, rng, isExtraWall)
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local wallEffect = spawnEffectWithSeed(
+        nil,
+        BACKDROP_EFFECT_VARIANT,
+        0,
+        VectorZero,
+        1
+    )
+    wallEffect:AddEntityFlags(EntityFlag.RENDER_WALL)
+    local sprite = wallEffect:GetSprite()
+    sprite:Load(ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/wall-backdrop.anm2", false)
+    local wallLayersArray = isExtraWall and ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS or ROOM_SHAPE_WALL_ANM2_LAYERS
+    local numWallLayers = wallLayersArray[roomShape]
+    if numWallLayers == nil then
+        error("Failed to get the layers when creating the backdrop for custom stage: " .. customStage.name)
+    end
+    if isLRoom(nil, roomShape) then
+        local cornerPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.CORNER, rng)
+        sprite:ReplaceSpritesheet(0, cornerPNGPath)
+    end
+    for ____, layerID in ipairs(irange(nil, 1, numWallLayers)) do
+        local wallPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.WALL, rng)
+        sprite:ReplaceSpritesheet(layerID, wallPNGPath)
+    end
+    local topLeftPos = room:GetTopLeftPos()
+    local renderPos = topLeftPos + WALL_OFFSET
+    local modifiedOffset = renderPos / 40 * 26
+    wallEffect.SpriteOffset = modifiedOffset
+    sprite:LoadGraphics()
+    local roomShapeName = RoomShape[roomShape]
+    local animation = trimPrefix(nil, roomShapeName, "SHAPE_")
+    local modifiedAnimation = isExtraWall and animation .. "X" or animation
+    sprite:Play(modifiedAnimation, true)
+end
+function spawnSecondWallEntity(self, customStage, rng)
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local extraLayers = ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS[roomShape]
+    local roomShapeHasExtraLayers = extraLayers ~= nil
+    if roomShapeHasExtraLayers then
+        spawnWallEntity(nil, customStage, rng, true)
+    end
+end
+function spawnFloorEntity(self, customStage, rng)
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local floorEffect = spawnEffectWithSeed(
+        nil,
+        BACKDROP_EFFECT_VARIANT,
+        0,
+        VectorZero,
+        1
+    )
+    floorEffect:AddEntityFlags(EntityFlag.RENDER_FLOOR)
+    local sprite = floorEffect:GetSprite()
+    sprite:Load(ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/floor-backdrop.anm2", false)
+    local numFloorLayers = getNumFloorLayers(nil, roomShape)
+    if numFloorLayers ~= nil then
+        for ____, layerID in ipairs(erange(nil, 0, numFloorLayers)) do
+            local wallPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.WALL, rng)
+            sprite:ReplaceSpritesheet(layerID, wallPNGPath)
+        end
+    elseif isLRoom(nil, roomShape) then
+        for ____, layerID in ipairs(L_FLOOR_ANM2_LAYERS) do
+            local LFloorPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.L_FLOOR, rng)
+            sprite:ReplaceSpritesheet(layerID, LFloorPNGPath)
+        end
+    elseif isNarrowRoom(nil, roomShape) then
+        for ____, layerID in ipairs(N_FLOOR_ANM2_LAYERS) do
+            local NFloorPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.N_FLOOR, rng)
+            sprite:ReplaceSpritesheet(layerID, NFloorPNGPath)
+        end
+    end
+    local topLeftPos = room:GetTopLeftPos()
+    local renderPos = topLeftPos
+    local modifiedOffset = renderPos / 40 * 26
+    floorEffect.SpriteOffset = modifiedOffset
+    sprite:LoadGraphics()
+    local roomShapeName = RoomShape[roomShape]
+    local animation = trimPrefix(nil, roomShapeName, "SHAPE_")
+    sprite:Play(animation, true)
+end
+function getNumFloorLayers(self, roomShape)
+    repeat
+        local ____switch23 = roomShape
+        local ____cond23 = ____switch23 == RoomShape.SHAPE_1x1
+        if ____cond23 then
+            do
+                return 4
+            end
+        end
+        ____cond23 = ____cond23 or (____switch23 == RoomShape.SHAPE_1x2 or ____switch23 == RoomShape.SHAPE_2x1)
+        if ____cond23 then
+            do
+                return 8
+            end
+        end
+        ____cond23 = ____cond23 or ____switch23 == RoomShape.SHAPE_2x2
+        if ____cond23 then
+            do
+                return 16
+            end
+        end
+        do
+            do
+                return nil
+            end
+        end
+    until true
+end
+BackdropKind = BackdropKind or ({})
+BackdropKind.N_FLOOR = "nFloors"
+BackdropKind.L_FLOOR = "lFloors"
+BackdropKind.WALL = "walls"
+BackdropKind.CORNER = "corners"
+DEFAULT_BACKDROP = {nFloors = {ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/backdrop/nfloor.png"}, lFloors = {ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/backdrop/lfloor.png"}, walls = {ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/backdrop/wall.png"}, corners = {ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/backdrop/corner.png"}}
+ROOM_SHAPE_WALL_ANM2_LAYERS = {
+    [RoomShape.SHAPE_1x1] = 44,
+    [RoomShape.IH] = 36,
+    [RoomShape.IV] = 28,
+    [RoomShape.SHAPE_1x2] = 58,
+    [RoomShape.IIV] = 42,
+    [RoomShape.SHAPE_2x1] = 63,
+    [RoomShape.IIH] = 62,
+    [RoomShape.SHAPE_2x2] = 63,
+    [RoomShape.LTL] = 63,
+    [RoomShape.LTR] = 63,
+    [RoomShape.LBL] = 63,
+    [RoomShape.LBR] = 63
+}
+ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS = {
+    [RoomShape.SHAPE_2x1] = 7,
+    [RoomShape.SHAPE_2x2] = 21,
+    [RoomShape.LTL] = 19,
+    [RoomShape.LTR] = 19,
+    [RoomShape.LBL] = 19,
+    [RoomShape.LBR] = 19
+}
+WALL_OFFSET = Vector(-80, -80)
+L_FLOOR_ANM2_LAYERS = {16, 17}
+N_FLOOR_ANM2_LAYERS = {18, 19}
+BACKDROP_EFFECT_VARIANT = EffectVariant.LADDER
+local BACKDROP_ROOM_TYPE_SET = __TS__New(Set, {RoomType.DEFAULT, RoomType.BOSS, RoomType.MINI_BOSS})
+function ____exports.setBackdrop(self, customStage)
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local decorationSeed = room:GetDecorationSeed()
+    local rng = newRNG(nil, decorationSeed)
+    if not BACKDROP_ROOM_TYPE_SET:has(roomType) then
+        return
+    end
+    spawnWallEntity(nil, customStage, rng, false)
+    spawnSecondWallEntity(nil, customStage, rng)
+    spawnFloorEntity(nil, customStage, rng)
+end
+return ____exports

package/dist/features/customStage/customStageConstants.d.ts

@@ -0,0 +1,2 @@
+export declare const ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = "gfx/isaacscript-custom-stage";
+//# sourceMappingURL=customStageConstants.d.ts.map

package/dist/features/customStage/customStageConstants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customStageConstants.d.ts","sourceRoot":"","sources":["../../../../../../packages/isaacscript-common/src/features/customStage/customStageConstants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iCAAiC,iCAAiC,CAAC"}

package/dist/features/customStage/customStageConstants.lua

@@ -0,0 +1,3 @@
+local ____exports = {}
+____exports.ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = "gfx/isaacscript-custom-stage"
+return ____exports

package/dist/features/customStage/exports.d.ts

@@ -0,0 +1,36 @@
+import { EntityType } from "isaac-typescript-definitions";
+/**
+ * Helper function to warp to a custom stage/level.
+ *
+ * Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation for
+ * more details: https://isaacscript.github.io/main/custom-stages/
+ */
+export declare function setCustomStage(name: string, verbose?: boolean): void;
+export declare function setCustomStageDebug(): void;
+/**
+ * By default, unknown bosses will be drawn on the boss "versus" screen as "???". If your custom
+ * stage has custom bosses, you can use this function to register the corresponding graphic file
+ * files for them.
+ *
+ * For reference:
+ * - The vanilla name sprite for Monstro is located at "C:\Program Files
+ *   (x86)\Steam\steamapps\common\The Binding of Isaac
+ *   Rebirth\resources\gfx\ui\boss\bossname_20.0_monstro.png".
+ * - The vanilla portrait sprite for Monstro is located at "C:\Program Files
+ *   (x86)\Steam\steamapps\common\The Binding of Isaac
+ *   Rebirth\resources\gfx\ui\boss\portrait_20.0_monstro.png".
+ *
+ * (Note that boss metadata like this cannot be specified with the rest of the custom stage metadata
+ * in the "tsconfig.json" file because there is not a way to retrieve the name of an entity at
+ * run-time.)
+ *
+ * @param entityType The entity type of the custom boss.
+ * @param variant The variant of the custom boss.
+ * @param subType The sub-type of the custom boss.
+ * @param namePNGPath The full path to the PNG file that contains the name of the boss that will be
+ *                    displayed on the top of the boss "versus" screen.
+ * @param portraitPNGPath The full path to the PNG file that contains the portrait of the boss that
+ *                        will be displayed on the right side of the boss "versus" screen.
+ */
+export declare function registerCustomBoss(entityType: EntityType, variant: int, subType: int, namePNGPath: string, portraitPNGPath: string): void;
+//# sourceMappingURL=exports.d.ts.map

package/dist/features/customStage/exports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../../../../packages/isaacscript-common/src/features/customStage/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EAOX,MAAM,8BAA8B,CAAC;AAsBtC;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,UAAQ,GAAG,IAAI,CA+GlE;AAQD,wBAAgB,mBAAmB,IAAI,IAAI,CAQ1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,GACtB,IAAI,CAGN"}

package/dist/features/customStage/exports.lua

@@ -0,0 +1,156 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local ____exports = {}
+local postRoomTransition
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
+local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local RoomTransitionAnim = ____isaac_2Dtypescript_2Ddefinitions.RoomTransitionAnim
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____reorderedCallbacks = require("callbacks.reorderedCallbacks")
+local reorderedCallbacksSetStage = ____reorderedCallbacks.reorderedCallbacksSetStage
+local ____entity = require("functions.entity")
+local getEntityIDFromConstituents = ____entity.getEntityIDFromConstituents
+local ____log = require("functions.log")
+local log = ____log.log
+local logError = ____log.logError
+local ____playerCenter = require("functions.playerCenter")
+local movePlayersToCenter = ____playerCenter.movePlayersToCenter
+local ____rng = require("functions.rng")
+local newRNG = ____rng.newRNG
+local ____roomData = require("functions.roomData")
+local getRoomData = ____roomData.getRoomData
+local ____rooms = require("functions.rooms")
+local getRooms = ____rooms.getRooms
+local ____stage = require("functions.stage")
+local getGotoCommand = ____stage.getGotoCommand
+local setStage = ____stage.setStage
+local ____runNextRoom = require("features.runNextRoom")
+local runNextRoom = ____runNextRoom.runNextRoom
+local ____util = require("features.customStage.util")
+local getRandomCustomStageRoom = ____util.getRandomCustomStageRoom
+local ____v = require("features.customStage.v")
+local v = ____v.default
+local customBossPNGPaths = ____v.customBossPNGPaths
+local customStageCachedRoomData = ____v.customStageCachedRoomData
+local customStagesMap = ____v.customStagesMap
+local ____versusScreen = require("features.customStage.versusScreen")
+local playVersusScreenAnimation = ____versusScreen.playVersusScreenAnimation
+function postRoomTransition(self)
+    movePlayersToCenter(nil)
+end
+local DEFAULT_BASE_STAGE = LevelStage.BASEMENT_2
+local DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL
+--- Helper function to warp to a custom stage/level.
+-- 
+-- Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation for
+-- more details: https://isaacscript.github.io/main/custom-stages/
+function ____exports.setCustomStage(self, name, verbose)
+    if verbose == nil then
+        verbose = false
+    end
+    local customStage = customStagesMap:get(name)
+    if customStage == nil then
+        error(("Failed to set the custom stage of \"" .. name) .. "\" because it was not found in the custom stages map. (This means that you probably forgot to define it in your \"tsconfig.json\" file.) See the website for more details on how to set up custom stages.")
+    end
+    local level = game:GetLevel()
+    local startingRoomGridIndex = level:GetStartingRoomIndex()
+    local seeds = game:GetSeeds()
+    local startSeed = seeds:GetStartSeed()
+    local rng = newRNG(nil, startSeed)
+    v.run.currentCustomStage = customStage
+    local baseStage = customStage.baseStage == nil and DEFAULT_BASE_STAGE or customStage.baseStage
+    local baseStageType = customStage.baseStageType == nil and DEFAULT_BASE_STAGE_TYPE or customStage.baseStageType
+    setStage(nil, baseStage, baseStageType)
+    for ____, room in ipairs(getRooms(nil)) do
+        do
+            if room.SafeGridIndex == startingRoomGridIndex then
+                goto __continue4
+            end
+            if room.Data == nil then
+                goto __continue4
+            end
+            local roomType = room.Data.Type
+            local roomShapeMap = customStage.roomTypeMap:get(roomType)
+            if roomShapeMap == nil then
+                if roomType == RoomType.DEFAULT then
+                    logError((((("Failed to find any custom rooms for RoomType." .. tostring(RoomType[roomType])) .. " (") .. tostring(roomType)) .. ") for custom stage: ") .. name)
+                end
+                goto __continue4
+            end
+            local roomShape = room.Data.Shape
+            local roomDoorSlotFlagMap = roomShapeMap:get(roomShape)
+            if roomDoorSlotFlagMap == nil then
+                logError((((((((("Failed to find any custom rooms for RoomType." .. tostring(RoomType[roomType])) .. " (") .. tostring(roomType)) .. ") + RoomShape.") .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ") for custom stage: ") .. name)
+                goto __continue4
+            end
+            local doorSlotFlags = room.Data.Doors
+            local roomsMetadata = roomDoorSlotFlagMap:get(doorSlotFlags)
+            if roomsMetadata == nil then
+                logError((((((((((("Failed to find any custom rooms for RoomType." .. tostring(RoomType[roomType])) .. " (") .. tostring(roomType)) .. ") + RoomShape.") .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ") + DoorSlotFlags ") .. tostring(doorSlotFlags)) .. " for custom stage: ") .. name)
+                goto __continue4
+            end
+            local randomRoom = getRandomCustomStageRoom(nil, roomsMetadata, rng, verbose)
+            local newRoomData = customStageCachedRoomData:get(randomRoom.variant)
+            if newRoomData == nil then
+                local command = getGotoCommand(nil, roomType, randomRoom.variant)
+                Isaac.ExecuteCommand(command)
+                newRoomData = getRoomData(nil, GridRoom.DEBUG)
+                if newRoomData == nil then
+                    logError((("Failed to get the room data for room variant " .. tostring(randomRoom.variant)) .. " for custom stage: ") .. name)
+                    goto __continue4
+                end
+                customStageCachedRoomData:set(randomRoom.variant, newRoomData)
+            end
+            room.Data = newRoomData
+        end
+        ::__continue4::
+    end
+    local stage = -1
+    local stageType = StageType.WRATH_OF_THE_LAMB
+    level:SetStage(stage, stageType)
+    reorderedCallbacksSetStage(nil, stage, stageType)
+    game:StartRoomTransition(startingRoomGridIndex, Direction.NO_DIRECTION, RoomTransitionAnim.FADE)
+    runNextRoom(nil, postRoomTransition)
+end
+function ____exports.setCustomStageDebug(self)
+    local customStage = v.run.currentCustomStage
+    if customStage == nil then
+        log("No custom stage is currently loaded.")
+        return
+    end
+    playVersusScreenAnimation(nil, customStage, true)
+end
+--- By default, unknown bosses will be drawn on the boss "versus" screen as "???". If your custom
+-- stage has custom bosses, you can use this function to register the corresponding graphic file
+-- files for them.
+-- 
+-- For reference:
+-- - The vanilla name sprite for Monstro is located at "C:\Program Files
+--   (x86)\Steam\steamapps\common\The Binding of Isaac
+--   Rebirth\resources\gfx\ui\boss\bossname_20.0_monstro.png".
+-- - The vanilla portrait sprite for Monstro is located at "C:\Program Files
+--   (x86)\Steam\steamapps\common\The Binding of Isaac
+--   Rebirth\resources\gfx\ui\boss\portrait_20.0_monstro.png".
+-- 
+-- (Note that boss metadata like this cannot be specified with the rest of the custom stage metadata
+-- in the "tsconfig.json" file because there is not a way to retrieve the name of an entity at
+-- run-time.)
+-- 
+-- @param entityType The entity type of the custom boss.
+-- @param variant The variant of the custom boss.
+-- @param subType The sub-type of the custom boss.
+-- @param namePNGPath The full path to the PNG file that contains the name of the boss that will be
+-- displayed on the top of the boss "versus" screen.
+-- @param portraitPNGPath The full path to the PNG file that contains the portrait of the boss that
+-- will be displayed on the right side of the boss "versus" screen.
+function ____exports.registerCustomBoss(self, entityType, variant, subType, namePNGPath, portraitPNGPath)
+    local entityID = getEntityIDFromConstituents(nil, entityType, variant, subType)
+    customBossPNGPaths:set(entityID, {namePNGPath, portraitPNGPath})
+end
+return ____exports