isaacscript-common 6.3.0 → 6.5.1

package/cachedClasses.d.ts

@@ -38,3 +38,18 @@ export declare const musicManager: MusicManager;
  * `Room`) is not safe and can lead to the game crashing in certain situations.
  */
 export declare const sfxManager: SFXManager;
+/**
+ * An object containing all 7 vanilla fonts that are pre-loaded and ready to use.
+ *
+ * For more information on the vanilla fonts and to see what they look like, see:
+ * https://wofsauge.github.io/IsaacDocs/rep/tutorials/Tutorial-Rendertext.html
+ */
+export declare const fonts: {
+    readonly droid: Font;
+    readonly pfTempestaSevenCondensed: Font;
+    readonly teamMeatFont10: Font;
+    readonly teamMeatFont12: Font;
+    readonly teamMeatFont16Bold: Font;
+    readonly terminus: Font;
+    readonly upheaval: Font;
+};

package/cachedClasses.lua

@@ -27,4 +27,24 @@ ____exports.musicManager = MusicManager()
 -- Caching the results of this constructor is safe, but caching other classes (like `Level` or
 -- `Room`) is not safe and can lead to the game crashing in certain situations.
 ____exports.sfxManager = SFXManager()
+--- An object containing all 7 vanilla fonts that are pre-loaded and ready to use.
+-- 
+-- For more information on the vanilla fonts and to see what they look like, see:
+-- https://wofsauge.github.io/IsaacDocs/rep/tutorials/Tutorial-Rendertext.html
+____exports.fonts = {
+    droid = Font(),
+    pfTempestaSevenCondensed = Font(),
+    teamMeatFont10 = Font(),
+    teamMeatFont12 = Font(),
+    teamMeatFont16Bold = Font(),
+    terminus = Font(),
+    upheaval = Font()
+}
+____exports.fonts.droid:Load("font/droid.fnt")
+____exports.fonts.pfTempestaSevenCondensed:Load("font/pftempestasevencondensed.fnt")
+____exports.fonts.teamMeatFont10:Load("font/teammeatfont10.fnt")
+____exports.fonts.teamMeatFont12:Load("font/teammeatfont12.fnt")
+____exports.fonts.teamMeatFont16Bold:Load("font/teammeatfont16bold.fnt")
+____exports.fonts.terminus:Load("font/terminus.fnt")
+____exports.fonts.upheaval:Load("font/upheaval.fnt")
 return ____exports

package/constants.d.ts

@@ -115,12 +115,25 @@ export declare const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000;
  */
 export declare const UI_HEART_WIDTH = 12;
 /**
- * This is a safer version of the `Vector.One` constant. (Other mods can mutate this `Vector.One`,
- * so it is not safe to use.)
+ * This is a safer version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
+ * is not safe to use.)
  */
 export declare const VectorOne: Readonly<Vector>;
 /**
- * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`
- * vector, so it is not safe to use.)
+ * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so
+ * it is not safe to use.)
  */
 export declare const VectorZero: Readonly<Vector>;
+/**
+ * This is a safer version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
+ * so it is not safe to use.)
+ *
+ * If you need to mutate this, make a copy first with the `copyColor` helper function.
+ */
+export declare const ColorDefault: Readonly<Color>;
+/**
+ * Equal to `KColor(1, 1, 1, 1)`.
+ *
+ * If you need to mutate this, make a copy first with the `copyKColor` helper function.
+ */
+export declare const KColorDefault: Readonly<KColor>;

package/constants.lua

@@ -97,10 +97,19 @@ ____exports.TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000
 --- This is the number of draw coordinates that each heart spans on the UI in the upper left hand
 -- corner.
 ____exports.UI_HEART_WIDTH = 12
---- This is a safer version of the `Vector.One` constant. (Other mods can mutate this `Vector.One`,
--- so it is not safe to use.)
+--- This is a safer version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
+-- is not safe to use.)
 ____exports.VectorOne = Vector(1, 1)
---- This is a safer version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`
--- vector, so it is not safe to use.)
+--- This is a safer version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so
+-- it is not safe to use.)
 ____exports.VectorZero = Vector(0, 0)
+--- This is a safer version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
+-- so it is not safe to use.)
+-- 
+-- If you need to mutate this, make a copy first with the `copyColor` helper function.
+____exports.ColorDefault = Color(1, 1, 1)
+--- Equal to `KColor(1, 1, 1, 1)`.
+-- 
+-- If you need to mutate this, make a copy first with the `copyKColor` helper function.
+____exports.KColorDefault = KColor(1, 1, 1, 1)
 return ____exports

package/enums/DecorationVariant.d.ts

@@ -0,0 +1,9 @@
+export declare enum DecorationVariant {
+    VANILLA_DECORATION = 0,
+    /**
+     * The vanilla game does not support any custom grid entities. Under the hood, IsaacScript allows
+     * for custom grid entities by using decorations with this variant to represent custom grid
+     * entities.
+     */
+    CUSTOM_GRID_ENTITY = 1
+}

package/enums/DecorationVariant.lua

@@ -0,0 +1,7 @@
+local ____exports = {}
+____exports.DecorationVariant = {}
+____exports.DecorationVariant.VANILLA_DECORATION = 0
+____exports.DecorationVariant[____exports.DecorationVariant.VANILLA_DECORATION] = "VANILLA_DECORATION"
+____exports.DecorationVariant.CUSTOM_GRID_ENTITY = 1
+____exports.DecorationVariant[____exports.DecorationVariant.CUSTOM_GRID_ENTITY] = "CUSTOM_GRID_ENTITY"
+return ____exports

package/enums/RockAltType.d.ts

@@ -0,0 +1,7 @@
+export declare enum RockAltType {
+    URN = 0,
+    MUSHROOM = 1,
+    SKULL = 2,
+    POLYP = 3,
+    BUCKET = 4
+}

package/enums/RockAltType.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+____exports.RockAltType = {}
+____exports.RockAltType.URN = 0
+____exports.RockAltType[____exports.RockAltType.URN] = "URN"
+____exports.RockAltType.MUSHROOM = 1
+____exports.RockAltType[____exports.RockAltType.MUSHROOM] = "MUSHROOM"
+____exports.RockAltType.SKULL = 2
+____exports.RockAltType[____exports.RockAltType.SKULL] = "SKULL"
+____exports.RockAltType.POLYP = 3
+____exports.RockAltType[____exports.RockAltType.POLYP] = "POLYP"
+____exports.RockAltType.BUCKET = 4
+____exports.RockAltType[____exports.RockAltType.BUCKET] = "BUCKET"
+return ____exports

package/features/customGridEntity.d.ts

@@ -3,8 +3,8 @@ 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 to represent custom
- * grid entities.
+ * 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`.

package/features/customGridEntity.lua

@@ -10,13 +10,15 @@ 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 spawnGrid = ____gridEntity.spawnGrid
+local spawnGridWithVariant = ____gridEntity.spawnGridWithVariant
 local ____roomData = require("functions.roomData")
 local getRoomListIndex = ____roomData.getRoomListIndex
 local ____vector = require("functions.vector")
@@ -60,8 +62,8 @@ 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 to represent custom
--- grid entities.
+-- 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`.
@@ -84,8 +86,8 @@ function ____exports.spawnCustomGrid(self, gridEntityTypeCustom, gridIndexOrPosi
     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
-    local decoration = isExistingDecoration and existingGridEntity or spawnGrid(nil, GridEntityType.DECORATION, gridIndexOrPosition)
+    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

package/features/customStage/backdrop.lua

@@ -2,7 +2,7 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local getBackdropPNGPath, spawnWallEntity, spawnSecondWallEntity, spawnFloorEntity, getNumFloorLayers, BackdropKind, BackdropEntitySubType, ROOM_SHAPE_WALL_ANM2_LAYERS, ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS, WALL_OFFSET, BACKDROP_EFFECT_VARIANT
+local getBackdropPNGPath, spawnWallEntity, spawnSecondWallEntity, spawnFloorEntity, getNumFloorLayers, BackdropKind, DEFAULT_BACKDROP, ROOM_SHAPE_WALL_ANM2_LAYERS, ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS, WALL_OFFSET, BACKDROP_EFFECT_VARIANT
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
 local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
@@ -26,25 +26,26 @@ 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 pathArray = customStage.backdrop[backdropKind]
-    local path = getRandomArrayElement(nil, pathArray, rng)
-    return (customStage.backdrop.prefix .. path) .. customStage.backdrop.suffix
+    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 subType = isExtraWall and BackdropEntitySubType.WALL_EXTRA or BackdropEntitySubType.WALL
     local wallEffect = spawnEffectWithSeed(
         nil,
         BACKDROP_EFFECT_VARIANT,
-        subType,
+        0,
         VectorZero,
         1
     )
     wallEffect:AddEntityFlags(EntityFlag.RENDER_WALL)
     local sprite = wallEffect:GetSprite()
-    sprite:Load("gfx/isaacscript-custom-stage/wall-backdrop.anm2", false)
+    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
@@ -83,13 +84,13 @@ function spawnFloorEntity(self, customStage, rng)
     local floorEffect = spawnEffectWithSeed(
         nil,
         BACKDROP_EFFECT_VARIANT,
-        BackdropEntitySubType.FLOOR,
+        0,
         VectorZero,
         1
     )
     floorEffect:AddEntityFlags(EntityFlag.RENDER_FLOOR)
     local sprite = floorEffect:GetSprite()
-    sprite:Load("gfx/isaacscript-custom-stage/floor-backdrop.anm2", false)
+    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
@@ -151,15 +152,7 @@ BackdropKind.N_FLOOR = "nFloors"
 BackdropKind.L_FLOOR = "lFloors"
 BackdropKind.WALL = "walls"
 BackdropKind.CORNER = "corners"
-BackdropEntitySubType = BackdropEntitySubType or ({})
-BackdropEntitySubType.VANILLA_LADDER = 0
-BackdropEntitySubType[BackdropEntitySubType.VANILLA_LADDER] = "VANILLA_LADDER"
-BackdropEntitySubType.WALL = 1
-BackdropEntitySubType[BackdropEntitySubType.WALL] = "WALL"
-BackdropEntitySubType.WALL_EXTRA = 2
-BackdropEntitySubType[BackdropEntitySubType.WALL_EXTRA] = "WALL_EXTRA"
-BackdropEntitySubType.FLOOR = 3
-BackdropEntitySubType[BackdropEntitySubType.FLOOR] = "FLOOR"
+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,

package/features/customStage/customStageConstants.d.ts

@@ -0,0 +1 @@
+export declare const ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = "gfx/isaacscript-custom-stage";

package/features/customStage/customStageConstants.lua

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

package/features/customStage/exports.d.ts

@@ -1,3 +1,4 @@
+import { EntityType } from "isaac-typescript-definitions";
 /**
  * Helper function to warp to a custom stage/level.
  *
@@ -6,3 +7,29 @@
  */
 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;

package/features/customStage/exports.lua

@@ -13,6 +13,8 @@ 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
@@ -29,14 +31,15 @@ local getGotoCommand = ____stage.getGotoCommand
 local setStage = ____stage.setStage
 local ____runNextRoom = require("features.runNextRoom")
 local runNextRoom = ____runNextRoom.runNextRoom
-local ____boss = require("features.customStage.boss")
-local playBossRoomAnimation = ____boss.playBossRoomAnimation
 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
@@ -116,6 +119,33 @@ function ____exports.setCustomStageDebug(self)
         log("No custom stage is currently loaded.")
         return
     end
-    playBossRoomAnimation(nil, true)
+    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

package/features/customStage/gridEntities.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="isaac-typescript-definitions" />
+import { CustomStage } from "../../interfaces/CustomStage";
+/** For `GridEntityType.DECORATION` (1) */
+export declare function setCustomDecorationGraphics(customStage: CustomStage, gridEntity: GridEntity): void;
+/** For `GridEntityType.ROCK` (2) */
+export declare function setCustomRockGraphics(customStage: CustomStage, gridEntity: GridEntity): void;
+/** For `GridEntityType.PIT` (7) */
+export declare function setCustomPitGraphics(customStage: CustomStage, gridEntity: GridEntity): void;
+/** For GridEntityType.DOOR (16) */
+export declare function setCustomDoorGraphics(customStage: CustomStage, gridEntity: GridEntity): void;
+/**
+ * The rewards are based on the ones from the wiki:
+ * https://bindingofisaacrebirth.fandom.com/wiki/Rocks#Urns
+ *
+ * On the bugged stage of -1, only urns will spawn, so we do not have to handle the case of mushroom
+ * rewards, skull rewards, and so on.
+ */
+export declare function removeUrnRewards(customStage: CustomStage, gridEntity: GridEntity): void;

package/features/customStage/gridEntities.lua

@@ -0,0 +1,215 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local getNewDoorPNGPath, removeEntitiesSpawnedFromGridEntity
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____DecorationVariant = require("enums.DecorationVariant")
+local DecorationVariant = ____DecorationVariant.DecorationVariant
+local ____entity = require("functions.entity")
+local removeEntities = ____entity.removeEntities
+local ____entitySpecific = require("functions.entitySpecific")
+local getNPCs = ____entitySpecific.getNPCs
+local ____pickups = require("functions.pickups")
+local getCoins = ____pickups.getCoins
+local getCollectibles = ____pickups.getCollectibles
+local getTrinkets = ____pickups.getTrinkets
+local ____vector = require("functions.vector")
+local vectorEquals = ____vector.vectorEquals
+function getNewDoorPNGPath(self, customStage, fileName)
+    repeat
+        local ____switch16 = fileName
+        local ____cond16 = ____switch16 == "gfx/grid/door_01_normaldoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_normal_0 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_normal_0 ~= nil then
+                    ____customStage_doorPNGPaths_normal_0 = ____customStage_doorPNGPaths_normal_0.normal
+                end
+                return ____customStage_doorPNGPaths_normal_0
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_02_treasureroomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_treasureRoom_2 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_treasureRoom_2 ~= nil then
+                    ____customStage_doorPNGPaths_treasureRoom_2 = ____customStage_doorPNGPaths_treasureRoom_2.treasureRoom
+                end
+                return ____customStage_doorPNGPaths_treasureRoom_2
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_03_ambushroomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_normalChallengeRoom_4 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_normalChallengeRoom_4 ~= nil then
+                    ____customStage_doorPNGPaths_normalChallengeRoom_4 = ____customStage_doorPNGPaths_normalChallengeRoom_4.normalChallengeRoom
+                end
+                return ____customStage_doorPNGPaths_normalChallengeRoom_4
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_04_selfsacrificeroomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_curseRoom_6 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_curseRoom_6 ~= nil then
+                    ____customStage_doorPNGPaths_curseRoom_6 = ____customStage_doorPNGPaths_curseRoom_6.curseRoom
+                end
+                return ____customStage_doorPNGPaths_curseRoom_6
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_05_arcaderoomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_arcade_8 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_arcade_8 ~= nil then
+                    ____customStage_doorPNGPaths_arcade_8 = ____customStage_doorPNGPaths_arcade_8.arcade
+                end
+                return ____customStage_doorPNGPaths_arcade_8
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_07_devilroomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_devilRoom_10 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_devilRoom_10 ~= nil then
+                    ____customStage_doorPNGPaths_devilRoom_10 = ____customStage_doorPNGPaths_devilRoom_10.devilRoom
+                end
+                return ____customStage_doorPNGPaths_devilRoom_10
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_07_holyroomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_angelRoom_12 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_angelRoom_12 ~= nil then
+                    ____customStage_doorPNGPaths_angelRoom_12 = ____customStage_doorPNGPaths_angelRoom_12.angelRoom
+                end
+                return ____customStage_doorPNGPaths_angelRoom_12
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_08_holeinwall.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_secretRoom_14 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_secretRoom_14 ~= nil then
+                    ____customStage_doorPNGPaths_secretRoom_14 = ____customStage_doorPNGPaths_secretRoom_14.secretRoom
+                end
+                return ____customStage_doorPNGPaths_secretRoom_14
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_09_bossambushroomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_bossChallengeRoom_16 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_bossChallengeRoom_16 ~= nil then
+                    ____customStage_doorPNGPaths_bossChallengeRoom_16 = ____customStage_doorPNGPaths_bossChallengeRoom_16.bossChallengeRoom
+                end
+                return ____customStage_doorPNGPaths_bossChallengeRoom_16
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_10_bossroomdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_bossRoom_18 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_bossRoom_18 ~= nil then
+                    ____customStage_doorPNGPaths_bossRoom_18 = ____customStage_doorPNGPaths_bossRoom_18.bossRoom
+                end
+                return ____customStage_doorPNGPaths_bossRoom_18
+            end
+        end
+        ____cond16 = ____cond16 or ____switch16 == "gfx/grid/door_15_bossrushdoor.anm2"
+        if ____cond16 then
+            do
+                local ____customStage_doorPNGPaths_bossRush_20 = customStage.doorPNGPaths
+                if ____customStage_doorPNGPaths_bossRush_20 ~= nil then
+                    ____customStage_doorPNGPaths_bossRush_20 = ____customStage_doorPNGPaths_bossRush_20.bossRush
+                end
+                return ____customStage_doorPNGPaths_bossRush_20
+            end
+        end
+    until true
+    return nil
+end
+function removeEntitiesSpawnedFromGridEntity(self, entities, gridEntity)
+    local entitiesFromGridEntity = __TS__ArrayFilter(
+        entities,
+        function(____, entity) return entity.FrameCount == 0 and vectorEquals(nil, entity.Position, gridEntity.Position) end
+    )
+    removeEntities(nil, entitiesFromGridEntity)
+end
+--- For `GridEntityType.DECORATION` (1)
+function ____exports.setCustomDecorationGraphics(self, customStage, gridEntity)
+    if customStage.decorationsPNGPath == nil then
+        return
+    end
+    local variant = gridEntity:GetVariant()
+    if variant ~= DecorationVariant.VANILLA_DECORATION then
+        return
+    end
+    local sprite = gridEntity:GetSprite()
+    local fileName = sprite:GetFilename()
+    if string.lower(fileName) == "gfx/grid/props_01_basement.anm2" then
+        sprite:ReplaceSpritesheet(0, customStage.decorationsPNGPath)
+        sprite:LoadGraphics()
+    end
+end
+--- For `GridEntityType.ROCK` (2)
+function ____exports.setCustomRockGraphics(self, customStage, gridEntity)
+    if customStage.rocksPNGPath == nil then
+        return
+    end
+    local sprite = gridEntity:GetSprite()
+    local fileName = sprite:GetFilename()
+    if fileName == "gfx/grid/grid_rock.anm2" then
+        sprite:ReplaceSpritesheet(0, customStage.rocksPNGPath)
+        sprite:LoadGraphics()
+    elseif fileName == "gfx/grid/grid_pit.anm2" then
+        sprite:ReplaceSpritesheet(1, customStage.rocksPNGPath)
+        sprite:LoadGraphics()
+    end
+end
+--- For `GridEntityType.PIT` (7)
+function ____exports.setCustomPitGraphics(self, customStage, gridEntity)
+    if customStage.pitsPNGPath == nil then
+        return
+    end
+    local sprite = gridEntity:GetSprite()
+    local fileName = sprite:GetFilename()
+    if fileName == "gfx/grid/grid_pit.anm2" then
+        sprite:ReplaceSpritesheet(0, customStage.pitsPNGPath)
+        sprite:LoadGraphics()
+    end
+end
+--- For GridEntityType.DOOR (16)
+function ____exports.setCustomDoorGraphics(self, customStage, gridEntity)
+    local sprite = gridEntity:GetSprite()
+    local fileName = sprite:GetFilename()
+    local doorPNGPath = getNewDoorPNGPath(nil, customStage, fileName)
+    if doorPNGPath ~= nil then
+        sprite:ReplaceSpritesheet(0, doorPNGPath)
+        sprite:LoadGraphics()
+    end
+end
+--- The rewards are based on the ones from the wiki:
+-- https://bindingofisaacrebirth.fandom.com/wiki/Rocks#Urns
+-- 
+-- On the bugged stage of -1, only urns will spawn, so we do not have to handle the case of mushroom
+-- rewards, skull rewards, and so on.
+function ____exports.removeUrnRewards(self, customStage, gridEntity)
+    if customStage.rocksPNGPath == nil then
+        return
+    end
+    local spiders = getNPCs(nil, EntityType.SPIDER)
+    removeEntitiesSpawnedFromGridEntity(nil, spiders, gridEntity)
+    local coins = getCoins(nil)
+    removeEntitiesSpawnedFromGridEntity(nil, coins, gridEntity)
+    local quarters = getCollectibles(nil, CollectibleType.QUARTER)
+    removeEntitiesSpawnedFromGridEntity(nil, quarters, gridEntity)
+    local swallowedPennies = getTrinkets(nil, TrinketType.SWALLOWED_PENNY)
+    removeEntitiesSpawnedFromGridEntity(nil, swallowedPennies, gridEntity)
+end
+return ____exports