isaacscript-common 13.1.0 → 13.2.0

package/dist/index.d.ts

@@ -6628,15 +6628,6 @@ export declare function isVanillaTrinketType(trinketType: TrinketType): boolean;
  */
 export declare function isVanillaTSTLClass(object: unknown): boolean;
 
-/**
- * Helper function to determine if a given wall is a "real" wall generated by the vanilla game. This
- * is useful because mods can use custom spawned walls as a stand-in for custom grid entities.
- *
- * This function checks for identity via a combination of `StageAPI.IsCustomGrid` and the
- * `isVanillaWallGridIndex` function.
- */
-export declare function isVanillaWall(gridEntity: GridEntity): boolean;
-
 /**
  * Helper function to determine if a given grid index should have a wall generated by the vanilla
  * game. This is useful as a mechanism to distinguish between real walls and custom walls spawned by
@@ -9477,6 +9468,28 @@ export declare function preventChildEntities(entity: Entity): void;
  */
 export declare function preventCollectibleRotation(collectible: EntityPickup, collectibleType: CollectibleType): void;
 
+/**
+ * Helper function to prevent any removed grid entities from respawning if the player re-enters the
+ * room.
+ *
+ * This is accomplished by spawning a new grid entity on every tile that does not already have a
+ * grid entity. This will force the game to spawn the new grid entity instead of the old one. The
+ * natural grid entity to choose for this purpose is a decoration, since it is non-interacting.
+ * Then, the decorations are made invisible and any shovel uses are intercepted to avoid creating a
+ * crawl space (instead of a trapdoor).
+ *
+ * Another option besides decorations would be to use a pressure plates with a state of 1, which is
+ * a state that is normally unused by the game and makes it invisible & persistent. However, pickups
+ * will not be able to spawn on pressure plates, which lead to various bugs (e.g. pickups spawning
+ * on top of pits). Thus, using a decoration is preferable.
+ *
+ * Yet another option to accomplish this would be to replace the room data with that of an empty
+ * room. However, the room data must exactly match the room type, the room shape, and the doors, so
+ * this is not possible to do in a robust way without adding empty rooms to the mod's `content`
+ * folder to draw the data from.
+ */
+export declare function preventGridEntityRespawn(): void;
+
 /**
  * Helper function to print something to the in-game console. Use this instead of invoking the
  * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 13.1.0
+isaacscript-common 13.2.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -40874,6 +40874,302 @@ function ____exports.customTrapdoorInit(self, mod)
     mod:AddCallback(ModCallback.POST_PEFFECT_UPDATE, postPEffectUpdate)
     mod:AddCallbackCustom(ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_UPDATE, postGridEntityCustomUpdateTrapdoor, GridEntityTypeCustom.TRAPDOOR_CUSTOM)
 end
+return ____exports
+ end,
+["src.functions.gridIndex"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local ____roomShape = require("src.functions.roomShape")
+local getRoomShapeWidth = ____roomShape.getRoomShapeWidth
+local ____utils = require("src.functions.utils")
+local iRange = ____utils.iRange
+function ____exports.getGridIndexesBetween(self, gridIndex1, gridIndex2, roomShape)
+    if gridIndex1 > gridIndex2 then
+        local oldGridIndex1 = gridIndex1
+        local oldGridIndex2 = gridIndex2
+        gridIndex1 = oldGridIndex2
+        gridIndex2 = oldGridIndex1
+    end
+    local delta = gridIndex2 - gridIndex1
+    local gridWidth = getRoomShapeWidth(nil, roomShape)
+    local isOnHorizontalLine = delta <= gridWidth
+    if isOnHorizontalLine then
+        return iRange(nil, gridIndex1, gridIndex2)
+    end
+    local isOnVerticalLine = delta % gridWidth == 0
+    if isOnVerticalLine then
+        return iRange(nil, gridIndex1, gridIndex2, gridWidth)
+    end
+    error(((((((("Failed to get the grid indexes between " .. tostring(gridIndex1)) .. " and ") .. tostring(gridIndex2)) .. " for RoomShape.") .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ") since they are not on the same horizontal or vertical line.")
+end
+return ____exports
+ end,
+["src.functions.roomShapeWalls"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__SparseArrayNew = ____lualib.__TS__SparseArrayNew
+local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
+local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
+local Set = ____lualib.Set
+local ____exports = {}
+local getRoomShapeToWallGridIndexSet, getVanillaWallGridIndexSetForRoomShape, getWallGridIndexSetForRectangleRoomShape
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____CornerType = require("src.enums.CornerType")
+local CornerType = ____CornerType.CornerType
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____gridIndex = require("src.functions.gridIndex")
+local getGridIndexesBetween = ____gridIndex.getGridIndexesBetween
+local ____rooms = require("src.functions.rooms")
+local inBossRoomOf = ____rooms.inBossRoomOf
+local inHomeCloset = ____rooms.inHomeCloset
+local ____roomShape = require("src.functions.roomShape")
+local getRoomShapeCorners = ____roomShape.getRoomShapeCorners
+local isLRoom = ____roomShape.isLRoom
+function getRoomShapeToWallGridIndexSet(self)
+    local roomShapeToWallGridIndexSet = __TS__New(Map)
+    for ____, roomShape in ipairs(getEnumValues(nil, RoomShape)) do
+        local gridIndexSet = getVanillaWallGridIndexSetForRoomShape(nil, roomShape)
+        roomShapeToWallGridIndexSet:set(roomShape, gridIndexSet)
+    end
+    return roomShapeToWallGridIndexSet
+end
+function getVanillaWallGridIndexSetForRoomShape(self, roomShape)
+    local corners = getRoomShapeCorners(nil, roomShape)
+    local lRoom = isLRoom(nil, roomShape)
+    if lRoom and #corners ~= 6 then
+        error(((("Failed to get the correct amount of corners for: RoomShape." .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ")")
+    end
+    repeat
+        local ____switch7 = roomShape
+        local ____cond7 = ____switch7 == RoomShape.LTL
+        if ____cond7 then
+            do
+                local topMiddle, topRight, middleLeft, middle, bottomLeft, bottomRight = table.unpack(corners)
+                local ____Set_1 = Set
+                local ____array_0 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topMiddle.gridIndex, topRight.gridIndex, roomShape)))
+                __TS__SparseArrayPush(
+                    ____array_0,
+                    table.unpack(getGridIndexesBetween(nil, middleLeft.gridIndex, middle.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_0,
+                    table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomRight.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_0,
+                    table.unpack(getGridIndexesBetween(nil, middleLeft.gridIndex, bottomLeft.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_0,
+                    table.unpack(getGridIndexesBetween(nil, topMiddle.gridIndex, middle.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_0,
+                    table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, bottomRight.gridIndex, roomShape))
+                )
+                return __TS__New(
+                    ____Set_1,
+                    {__TS__SparseArraySpread(____array_0)}
+                )
+            end
+        end
+        ____cond7 = ____cond7 or ____switch7 == RoomShape.LTR
+        if ____cond7 then
+            do
+                local topLeft, topMiddle, middle, middleRight, bottomLeft, bottomRight = table.unpack(corners)
+                local ____Set_3 = Set
+                local ____array_2 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topMiddle.gridIndex, roomShape)))
+                __TS__SparseArrayPush(
+                    ____array_2,
+                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, middleRight.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_2,
+                    table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomRight.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_2,
+                    table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, bottomLeft.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_2,
+                    table.unpack(getGridIndexesBetween(nil, topMiddle.gridIndex, middle.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_2,
+                    table.unpack(getGridIndexesBetween(nil, middleRight.gridIndex, bottomRight.gridIndex, roomShape))
+                )
+                return __TS__New(
+                    ____Set_3,
+                    {__TS__SparseArraySpread(____array_2)}
+                )
+            end
+        end
+        ____cond7 = ____cond7 or ____switch7 == RoomShape.LBL
+        if ____cond7 then
+            do
+                local topLeft, topRight, middleLeft, middle, bottomMiddle, bottomRight = table.unpack(corners)
+                local ____Set_5 = Set
+                local ____array_4 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topRight.gridIndex, roomShape)))
+                __TS__SparseArrayPush(
+                    ____array_4,
+                    table.unpack(getGridIndexesBetween(nil, middleLeft.gridIndex, middle.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_4,
+                    table.unpack(getGridIndexesBetween(nil, bottomMiddle.gridIndex, bottomRight.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_4,
+                    table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, middleLeft.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_4,
+                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, bottomMiddle.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_4,
+                    table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, bottomRight.gridIndex, roomShape))
+                )
+                return __TS__New(
+                    ____Set_5,
+                    {__TS__SparseArraySpread(____array_4)}
+                )
+            end
+        end
+        ____cond7 = ____cond7 or ____switch7 == RoomShape.LBR
+        if ____cond7 then
+            do
+                local topLeft, topRight, middle, middleRight, bottomLeft, bottomMiddle = table.unpack(corners)
+                local ____Set_7 = Set
+                local ____array_6 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topRight.gridIndex, roomShape)))
+                __TS__SparseArrayPush(
+                    ____array_6,
+                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, middleRight.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_6,
+                    table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomMiddle.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_6,
+                    table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, bottomLeft.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_6,
+                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, bottomMiddle.gridIndex, roomShape))
+                )
+                __TS__SparseArrayPush(
+                    ____array_6,
+                    table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, middleRight.gridIndex, roomShape))
+                )
+                return __TS__New(
+                    ____Set_7,
+                    {__TS__SparseArraySpread(____array_6)}
+                )
+            end
+        end
+        do
+            do
+                return getWallGridIndexSetForRectangleRoomShape(nil, roomShape, corners)
+            end
+        end
+    until true
+end
+function getWallGridIndexSetForRectangleRoomShape(self, roomShape, corners)
+    if #corners ~= 4 then
+        error("Failed to get the correct amount of corners for rectangular room shape.")
+    end
+    local topLeft, topRight, bottomLeft, bottomRight = table.unpack(corners)
+    local ____Set_9 = Set
+    local ____array_8 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topRight.gridIndex, roomShape)))
+    __TS__SparseArrayPush(
+        ____array_8,
+        table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomRight.gridIndex, roomShape))
+    )
+    __TS__SparseArrayPush(
+        ____array_8,
+        table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, bottomLeft.gridIndex, roomShape))
+    )
+    __TS__SparseArrayPush(
+        ____array_8,
+        table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, bottomRight.gridIndex, roomShape))
+    )
+    return __TS__New(
+        ____Set_9,
+        {__TS__SparseArraySpread(____array_8)}
+    )
+end
+local ROOM_SHAPE_TO_WALL_GRID_INDEX_SET = getRoomShapeToWallGridIndexSet(nil)
+local HOME_CLOSET_CORNERS = {
+    {
+        type = CornerType.TOP_LEFT,
+        gridIndex = 30,
+        position = Vector(60, 220)
+    },
+    {
+        type = CornerType.TOP_RIGHT,
+        gridIndex = 38,
+        position = Vector(340, 220)
+    },
+    {
+        type = CornerType.BOTTOM_LEFT,
+        gridIndex = 90,
+        position = Vector(60, 340)
+    },
+    {
+        type = CornerType.BOTTOM_RIGHT,
+        gridIndex = 98,
+        position = Vector(340, 340)
+    }
+}
+local HOME_CLOSET_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.IH, HOME_CLOSET_CORNERS)
+local MOTHER_ROOM_CORNERS = {
+    {
+        type = CornerType.TOP_LEFT,
+        gridIndex = 0,
+        position = Vector(60, 140)
+    },
+    {
+        type = CornerType.TOP_RIGHT,
+        gridIndex = 14,
+        position = Vector(580, 140)
+    },
+    {
+        type = CornerType.BOTTOM_LEFT,
+        gridIndex = 150,
+        position = Vector(60, 500)
+    },
+    {
+        type = CornerType.BOTTOM_RIGHT,
+        gridIndex = 164,
+        position = Vector(580, 500)
+    }
+}
+local MOTHER_ROOM_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.SHAPE_1x2, MOTHER_ROOM_CORNERS)
+function ____exports.isVanillaWallGridIndex(self, gridIndex)
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local wallGridIndexSet
+    if inHomeCloset(nil) then
+        wallGridIndexSet = HOME_CLOSET_CORNERS_SET
+    elseif inBossRoomOf(nil, BossID.MOTHER) then
+        wallGridIndexSet = MOTHER_ROOM_CORNERS_SET
+    else
+        wallGridIndexSet = ROOM_SHAPE_TO_WALL_GRID_INDEX_SET:get(roomShape)
+    end
+    if wallGridIndexSet == nil then
+        error(((("Failed to find the wall grid index set for: RoomShape." .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ")")
+    end
+    return wallGridIndexSet:has(gridIndex)
+end
 return ____exports
  end,
 ["src.functions.emptyRoom"] = function(...) 
@@ -40881,7 +41177,7 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local emptyRoomEntities, emptyRoomGridEntities, EMPTY_ROOM_BLACKLIST_ENTITY_SET, EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET
+local emptyRoomEntities, emptyRoomGridEntities, EMPTY_ROOM_BLACKLIST_ENTITY_SET
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
@@ -40895,6 +41191,8 @@ local getGridEntities = ____gridEntities.getGridEntities
 local removeGridEntity = ____gridEntities.removeGridEntity
 local ____rooms = require("src.functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
+local ____roomShapeWalls = require("src.functions.roomShapeWalls")
+local isVanillaWallGridIndex = ____roomShapeWalls.isVanillaWallGridIndex
 function emptyRoomEntities(self)
     local room = game:GetRoom()
     for ____, entity in ipairs(getEntities(nil)) do
@@ -40920,7 +41218,11 @@ function emptyRoomGridEntities(self)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         do
             local gridEntityType = gridEntity:GetType()
-            if EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET:has(gridEntityType) then
+            local gridIndex = gridEntity:GetGridIndex()
+            if gridEntityType == GridEntityType.WALL and isVanillaWallGridIndex(nil, gridIndex) then
+                goto __continue10
+            end
+            if gridEntityType == GridEntityType.DOOR then
                 goto __continue10
             end
             removeGridEntity(nil, gridEntity, false)
@@ -40941,7 +41243,6 @@ EMPTY_ROOM_BLACKLIST_ENTITY_SET = __TS__New(Set, {
     EntityType.PROJECTILE,
     EntityType.DARK_ESAU
 })
-EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET = __TS__New(Set, {GridEntityType.WALL, GridEntityType.DOOR})
 function ____exports.emptyRoom(self)
     emptyRoomEntities(nil)
     emptyRoomGridEntities(nil)
@@ -41433,7 +41734,7 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EntityCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityCollisionClass
@@ -41469,6 +41770,7 @@ local getAllGridIndexes = ____gridEntities.getAllGridIndexes
 local getGridEntities = ____gridEntities.getGridEntities
 local removeGridEntity = ____gridEntities.removeGridEntity
 local setGridEntityInvisible = ____gridEntities.setGridEntityInvisible
+local spawnGridEntity = ____gridEntities.spawnGridEntity
 local spawnGridEntityWithVariant = ____gridEntities.spawnGridEntityWithVariant
 local ____jsonRoom = require("src.functions.jsonRoom")
 local getRandomJSONEntity = ____jsonRoom.getRandomJSONEntity
@@ -41519,12 +41821,16 @@ function preUseItemWeNeedToGoDeeper(self, _collectibleType, _rng, player, _useFl
             if futurePlayer == nil then
                 return
             end
+            local futureRoomListIndex = getRoomListIndex(nil)
+            if futureRoomListIndex ~= roomListIndex then
+                return
+            end
             v.room.manuallyUsingShovel = true
             futurePlayer:UseActiveItem(CollectibleType.WE_NEED_TO_GO_DEEPER)
             v.room.manuallyUsingShovel = false
             local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
             emptyArray(nil, decorationGridIndexes)
-            fillRoomWithDecorations(nil)
+            ____exports.preventGridEntityRespawn(nil)
         end
     )
     return true
@@ -41566,24 +41872,25 @@ function respawnPersistentEntities(self)
         )
     end
 end
-function fillRoomWithDecorations(self)
+function ____exports.preventGridEntityRespawn(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     local room = game:GetRoom()
     local roomListIndex = getRoomListIndex(nil)
+    v.level.deployedRoomListIndexes:add(roomListIndex)
     local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
     for ____, gridIndex in ipairs(getAllGridIndexes(nil)) do
         do
             local existingGridEntity = room:GetGridEntity(gridIndex)
             if existingGridEntity ~= nil then
-                goto __continue31
+                goto __continue32
             end
-            local position = room:GetGridPosition(gridIndex)
-            local decoration = Isaac.GridSpawn(GridEntityType.DECORATION, 0, position)
+            local decoration = spawnGridEntity(nil, GridEntityType.DECORATION, gridIndex)
             if decoration ~= nil then
                 setGridEntityInvisible(nil, decoration)
             end
             decorationGridIndexes[#decorationGridIndexes + 1] = gridIndex
         end
-        ::__continue31::
+        ::__continue32::
     end
 end
 function spawnAllEntities(self, jsonRoom, rng, verbose)
@@ -41840,7 +42147,7 @@ function getPitFrame(self, L, R, U, D, UL, UR, DL, DR)
     end
     return F
 end
-local FEATURE_NAME = "deployJSONRoom"
+FEATURE_NAME = "deployJSONRoom"
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
 local gridEntityXMLTypes = getEnumValues(nil, GridEntityXMLType)
 GRID_ENTITY_XML_TYPE_SET = __TS__New(Set, gridEntityXMLTypes)
@@ -41890,7 +42197,7 @@ function ____exports.deployJSONRoom(self, jsonRoom, seedOrRNG, verbose)
         log(nil, "Finished spawning all of the new entities and grid entities.")
     end
     fixPitGraphics(nil)
-    fillRoomWithDecorations(nil)
+    ____exports.preventGridEntityRespawn(nil)
 end
 function ____exports.deployRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
     if seedOrRNG == nil then
@@ -48579,35 +48886,6 @@ function ____exports.logNewGlobals(self)
         end
     )
 end
-return ____exports
- end,
-["src.functions.gridIndex"] = function(...) 
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
-local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
-local ____roomShape = require("src.functions.roomShape")
-local getRoomShapeWidth = ____roomShape.getRoomShapeWidth
-local ____utils = require("src.functions.utils")
-local iRange = ____utils.iRange
-function ____exports.getGridIndexesBetween(self, gridIndex1, gridIndex2, roomShape)
-    if gridIndex1 > gridIndex2 then
-        local oldGridIndex1 = gridIndex1
-        local oldGridIndex2 = gridIndex2
-        gridIndex1 = oldGridIndex2
-        gridIndex2 = oldGridIndex1
-    end
-    local delta = gridIndex2 - gridIndex1
-    local gridWidth = getRoomShapeWidth(nil, roomShape)
-    local isOnHorizontalLine = delta <= gridWidth
-    if isOnHorizontalLine then
-        return iRange(nil, gridIndex1, gridIndex2)
-    end
-    local isOnVerticalLine = delta % gridWidth == 0
-    if isOnVerticalLine then
-        return iRange(nil, gridIndex1, gridIndex2, gridWidth)
-    end
-    error(((((((("Failed to get the grid indexes between " .. tostring(gridIndex1)) .. " and ") .. tostring(gridIndex2)) .. " for RoomShape.") .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ") since they are not on the same horizontal or vertical line.")
-end
 return ____exports
  end,
 ["src.functions.hex"] = function(...) 
@@ -49676,280 +49954,6 @@ function ____exports.spawnRockAltReward(self, position, rockAltType, seedOrRNG)
         end
     until true
 end
-return ____exports
- end,
-["src.functions.roomShapeWalls"] = function(...) 
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local __TS__SparseArrayNew = ____lualib.__TS__SparseArrayNew
-local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
-local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
-local Set = ____lualib.Set
-local ____exports = {}
-local getRoomShapeToWallGridIndexSet, getVanillaWallGridIndexSetForRoomShape, getWallGridIndexSetForRectangleRoomShape, ROOM_SHAPE_TO_WALL_GRID_INDEX_SET, HOME_CLOSET_CORNERS_SET, MOTHER_ROOM_CORNERS_SET
-local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
-local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
-local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
-local ____cachedClasses = require("src.core.cachedClasses")
-local game = ____cachedClasses.game
-local ____CornerType = require("src.enums.CornerType")
-local CornerType = ____CornerType.CornerType
-local ____enums = require("src.functions.enums")
-local getEnumValues = ____enums.getEnumValues
-local ____gridIndex = require("src.functions.gridIndex")
-local getGridIndexesBetween = ____gridIndex.getGridIndexesBetween
-local ____rooms = require("src.functions.rooms")
-local inBossRoomOf = ____rooms.inBossRoomOf
-local inHomeCloset = ____rooms.inHomeCloset
-local ____roomShape = require("src.functions.roomShape")
-local getRoomShapeCorners = ____roomShape.getRoomShapeCorners
-local isLRoom = ____roomShape.isLRoom
-function getRoomShapeToWallGridIndexSet(self)
-    local roomShapeToWallGridIndexSet = __TS__New(Map)
-    for ____, roomShape in ipairs(getEnumValues(nil, RoomShape)) do
-        local gridIndexSet = getVanillaWallGridIndexSetForRoomShape(nil, roomShape)
-        roomShapeToWallGridIndexSet:set(roomShape, gridIndexSet)
-    end
-    return roomShapeToWallGridIndexSet
-end
-function getVanillaWallGridIndexSetForRoomShape(self, roomShape)
-    local corners = getRoomShapeCorners(nil, roomShape)
-    local lRoom = isLRoom(nil, roomShape)
-    if lRoom and #corners ~= 6 then
-        error(((("Failed to get the correct amount of corners for: RoomShape." .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ")")
-    end
-    repeat
-        local ____switch7 = roomShape
-        local ____cond7 = ____switch7 == RoomShape.LTL
-        if ____cond7 then
-            do
-                local topMiddle, topRight, middleLeft, middle, bottomLeft, bottomRight = table.unpack(corners)
-                local ____Set_1 = Set
-                local ____array_0 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topMiddle.gridIndex, topRight.gridIndex, roomShape)))
-                __TS__SparseArrayPush(
-                    ____array_0,
-                    table.unpack(getGridIndexesBetween(nil, middleLeft.gridIndex, middle.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_0,
-                    table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomRight.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_0,
-                    table.unpack(getGridIndexesBetween(nil, middleLeft.gridIndex, bottomLeft.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_0,
-                    table.unpack(getGridIndexesBetween(nil, topMiddle.gridIndex, middle.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_0,
-                    table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, bottomRight.gridIndex, roomShape))
-                )
-                return __TS__New(
-                    ____Set_1,
-                    {__TS__SparseArraySpread(____array_0)}
-                )
-            end
-        end
-        ____cond7 = ____cond7 or ____switch7 == RoomShape.LTR
-        if ____cond7 then
-            do
-                local topLeft, topMiddle, middle, middleRight, bottomLeft, bottomRight = table.unpack(corners)
-                local ____Set_3 = Set
-                local ____array_2 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topMiddle.gridIndex, roomShape)))
-                __TS__SparseArrayPush(
-                    ____array_2,
-                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, middleRight.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_2,
-                    table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomRight.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_2,
-                    table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, bottomLeft.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_2,
-                    table.unpack(getGridIndexesBetween(nil, topMiddle.gridIndex, middle.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_2,
-                    table.unpack(getGridIndexesBetween(nil, middleRight.gridIndex, bottomRight.gridIndex, roomShape))
-                )
-                return __TS__New(
-                    ____Set_3,
-                    {__TS__SparseArraySpread(____array_2)}
-                )
-            end
-        end
-        ____cond7 = ____cond7 or ____switch7 == RoomShape.LBL
-        if ____cond7 then
-            do
-                local topLeft, topRight, middleLeft, middle, bottomMiddle, bottomRight = table.unpack(corners)
-                local ____Set_5 = Set
-                local ____array_4 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topRight.gridIndex, roomShape)))
-                __TS__SparseArrayPush(
-                    ____array_4,
-                    table.unpack(getGridIndexesBetween(nil, middleLeft.gridIndex, middle.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_4,
-                    table.unpack(getGridIndexesBetween(nil, bottomMiddle.gridIndex, bottomRight.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_4,
-                    table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, middleLeft.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_4,
-                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, bottomMiddle.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_4,
-                    table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, bottomRight.gridIndex, roomShape))
-                )
-                return __TS__New(
-                    ____Set_5,
-                    {__TS__SparseArraySpread(____array_4)}
-                )
-            end
-        end
-        ____cond7 = ____cond7 or ____switch7 == RoomShape.LBR
-        if ____cond7 then
-            do
-                local topLeft, topRight, middle, middleRight, bottomLeft, bottomMiddle = table.unpack(corners)
-                local ____Set_7 = Set
-                local ____array_6 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topRight.gridIndex, roomShape)))
-                __TS__SparseArrayPush(
-                    ____array_6,
-                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, middleRight.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_6,
-                    table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomMiddle.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_6,
-                    table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, bottomLeft.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_6,
-                    table.unpack(getGridIndexesBetween(nil, middle.gridIndex, bottomMiddle.gridIndex, roomShape))
-                )
-                __TS__SparseArrayPush(
-                    ____array_6,
-                    table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, middleRight.gridIndex, roomShape))
-                )
-                return __TS__New(
-                    ____Set_7,
-                    {__TS__SparseArraySpread(____array_6)}
-                )
-            end
-        end
-        do
-            do
-                return getWallGridIndexSetForRectangleRoomShape(nil, roomShape, corners)
-            end
-        end
-    until true
-end
-function getWallGridIndexSetForRectangleRoomShape(self, roomShape, corners)
-    if #corners ~= 4 then
-        error("Failed to get the correct amount of corners for rectangular room shape.")
-    end
-    local topLeft, topRight, bottomLeft, bottomRight = table.unpack(corners)
-    local ____Set_9 = Set
-    local ____array_8 = __TS__SparseArrayNew(table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, topRight.gridIndex, roomShape)))
-    __TS__SparseArrayPush(
-        ____array_8,
-        table.unpack(getGridIndexesBetween(nil, bottomLeft.gridIndex, bottomRight.gridIndex, roomShape))
-    )
-    __TS__SparseArrayPush(
-        ____array_8,
-        table.unpack(getGridIndexesBetween(nil, topLeft.gridIndex, bottomLeft.gridIndex, roomShape))
-    )
-    __TS__SparseArrayPush(
-        ____array_8,
-        table.unpack(getGridIndexesBetween(nil, topRight.gridIndex, bottomRight.gridIndex, roomShape))
-    )
-    return __TS__New(
-        ____Set_9,
-        {__TS__SparseArraySpread(____array_8)}
-    )
-end
-function ____exports.isVanillaWallGridIndex(self, gridIndex)
-    local room = game:GetRoom()
-    local roomShape = room:GetRoomShape()
-    local wallGridIndexSet
-    if inHomeCloset(nil) then
-        wallGridIndexSet = HOME_CLOSET_CORNERS_SET
-    elseif inBossRoomOf(nil, BossID.MOTHER) then
-        wallGridIndexSet = MOTHER_ROOM_CORNERS_SET
-    else
-        wallGridIndexSet = ROOM_SHAPE_TO_WALL_GRID_INDEX_SET:get(roomShape)
-    end
-    if wallGridIndexSet == nil then
-        error(((("Failed to find the wall grid index set for: RoomShape." .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ")")
-    end
-    return wallGridIndexSet:has(gridIndex)
-end
-ROOM_SHAPE_TO_WALL_GRID_INDEX_SET = getRoomShapeToWallGridIndexSet(nil)
-local HOME_CLOSET_CORNERS = {
-    {
-        type = CornerType.TOP_LEFT,
-        gridIndex = 30,
-        position = Vector(60, 220)
-    },
-    {
-        type = CornerType.TOP_RIGHT,
-        gridIndex = 38,
-        position = Vector(340, 220)
-    },
-    {
-        type = CornerType.BOTTOM_LEFT,
-        gridIndex = 90,
-        position = Vector(60, 340)
-    },
-    {
-        type = CornerType.BOTTOM_RIGHT,
-        gridIndex = 98,
-        position = Vector(340, 340)
-    }
-}
-HOME_CLOSET_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.IH, HOME_CLOSET_CORNERS)
-local MOTHER_ROOM_CORNERS = {
-    {
-        type = CornerType.TOP_LEFT,
-        gridIndex = 0,
-        position = Vector(60, 140)
-    },
-    {
-        type = CornerType.TOP_RIGHT,
-        gridIndex = 14,
-        position = Vector(580, 140)
-    },
-    {
-        type = CornerType.BOTTOM_LEFT,
-        gridIndex = 150,
-        position = Vector(60, 500)
-    },
-    {
-        type = CornerType.BOTTOM_RIGHT,
-        gridIndex = 164,
-        position = Vector(580, 500)
-    }
-}
-MOTHER_ROOM_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.SHAPE_1x2, MOTHER_ROOM_CORNERS)
-function ____exports.isVanillaWall(self, gridEntity)
-    local gridIndex = gridEntity:GetGridIndex()
-    if StageAPI ~= nil and StageAPI.IsCustomGrid(gridIndex) then
-        return false
-    end
-    return ____exports.isVanillaWallGridIndex(nil, gridIndex)
-end
 return ____exports
  end,
 ["src.functions.saveFile"] = function(...) 

package/dist/src/features/deployJSONRoom.d.ts

@@ -63,4 +63,25 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom | Readonly<JSONRoom>,
  *                what the function is doing. Default is false.
  */
 export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
+/**
+ * Helper function to prevent any removed grid entities from respawning if the player re-enters the
+ * room.
+ *
+ * This is accomplished by spawning a new grid entity on every tile that does not already have a
+ * grid entity. This will force the game to spawn the new grid entity instead of the old one. The
+ * natural grid entity to choose for this purpose is a decoration, since it is non-interacting.
+ * Then, the decorations are made invisible and any shovel uses are intercepted to avoid creating a
+ * crawl space (instead of a trapdoor).
+ *
+ * Another option besides decorations would be to use a pressure plates with a state of 1, which is
+ * a state that is normally unused by the game and makes it invisible & persistent. However, pickups
+ * will not be able to spawn on pressure plates, which lead to various bugs (e.g. pickups spawning
+ * on top of pits). Thus, using a decoration is preferable.
+ *
+ * Yet another option to accomplish this would be to replace the room data with that of an empty
+ * room. However, the room data must exactly match the room type, the room shape, and the doors, so
+ * this is not possible to do in a robust way without adding empty rooms to the mod's `content`
+ * folder to draw the data from.
+ */
+export declare function preventGridEntityRespawn(): void;
 //# sourceMappingURL=deployJSONRoom.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAgDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAwKvD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CA4BN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN"}
+{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAiDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AA6KvD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CA4BN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CA0B/C"}

package/dist/src/features/deployJSONRoom.lua

@@ -4,7 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EntityCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityCollisionClass
@@ -40,6 +40,7 @@ local getAllGridIndexes = ____gridEntities.getAllGridIndexes
 local getGridEntities = ____gridEntities.getGridEntities
 local removeGridEntity = ____gridEntities.removeGridEntity
 local setGridEntityInvisible = ____gridEntities.setGridEntityInvisible
+local spawnGridEntity = ____gridEntities.spawnGridEntity
 local spawnGridEntityWithVariant = ____gridEntities.spawnGridEntityWithVariant
 local ____jsonRoom = require("src.functions.jsonRoom")
 local getRandomJSONEntity = ____jsonRoom.getRandomJSONEntity
@@ -90,12 +91,16 @@ function preUseItemWeNeedToGoDeeper(self, _collectibleType, _rng, player, _useFl
             if futurePlayer == nil then
                 return
             end
+            local futureRoomListIndex = getRoomListIndex(nil)
+            if futureRoomListIndex ~= roomListIndex then
+                return
+            end
             v.room.manuallyUsingShovel = true
             futurePlayer:UseActiveItem(CollectibleType.WE_NEED_TO_GO_DEEPER)
             v.room.manuallyUsingShovel = false
             local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
             emptyArray(nil, decorationGridIndexes)
-            fillRoomWithDecorations(nil)
+            ____exports.preventGridEntityRespawn(nil)
         end
     )
     return true
@@ -137,24 +142,43 @@ function respawnPersistentEntities(self)
         )
     end
 end
-function fillRoomWithDecorations(self)
+--- Helper function to prevent any removed grid entities from respawning if the player re-enters the
+-- room.
+-- 
+-- This is accomplished by spawning a new grid entity on every tile that does not already have a
+-- grid entity. This will force the game to spawn the new grid entity instead of the old one. The
+-- natural grid entity to choose for this purpose is a decoration, since it is non-interacting.
+-- Then, the decorations are made invisible and any shovel uses are intercepted to avoid creating a
+-- crawl space (instead of a trapdoor).
+-- 
+-- Another option besides decorations would be to use a pressure plates with a state of 1, which is
+-- a state that is normally unused by the game and makes it invisible & persistent. However, pickups
+-- will not be able to spawn on pressure plates, which lead to various bugs (e.g. pickups spawning
+-- on top of pits). Thus, using a decoration is preferable.
+-- 
+-- Yet another option to accomplish this would be to replace the room data with that of an empty
+-- room. However, the room data must exactly match the room type, the room shape, and the doors, so
+-- this is not possible to do in a robust way without adding empty rooms to the mod's `content`
+-- folder to draw the data from.
+function ____exports.preventGridEntityRespawn(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     local room = game:GetRoom()
     local roomListIndex = getRoomListIndex(nil)
+    v.level.deployedRoomListIndexes:add(roomListIndex)
     local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
     for ____, gridIndex in ipairs(getAllGridIndexes(nil)) do
         do
             local existingGridEntity = room:GetGridEntity(gridIndex)
             if existingGridEntity ~= nil then
-                goto __continue31
+                goto __continue32
             end
-            local position = room:GetGridPosition(gridIndex)
-            local decoration = Isaac.GridSpawn(GridEntityType.DECORATION, 0, position)
+            local decoration = spawnGridEntity(nil, GridEntityType.DECORATION, gridIndex)
             if decoration ~= nil then
                 setGridEntityInvisible(nil, decoration)
             end
             decorationGridIndexes[#decorationGridIndexes + 1] = gridIndex
         end
-        ::__continue31::
+        ::__continue32::
     end
 end
 function spawnAllEntities(self, jsonRoom, rng, verbose)
@@ -411,7 +435,7 @@ function getPitFrame(self, L, R, U, D, UL, UR, DL, DR)
     end
     return F
 end
-local FEATURE_NAME = "deployJSONRoom"
+FEATURE_NAME = "deployJSONRoom"
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
 local gridEntityXMLTypes = getEnumValues(nil, GridEntityXMLType)
 GRID_ENTITY_XML_TYPE_SET = __TS__New(Set, gridEntityXMLTypes)
@@ -489,7 +513,7 @@ function ____exports.deployJSONRoom(self, jsonRoom, seedOrRNG, verbose)
         log(nil, "Finished spawning all of the new entities and grid entities.")
     end
     fixPitGraphics(nil)
-    fillRoomWithDecorations(nil)
+    ____exports.preventGridEntityRespawn(nil)
 end
 --- Helper function to deconstruct a vanilla room and set up a custom room in its place.
 -- Specifically, this will clear the current room of all entities and grid entities, and then spawn

package/dist/src/functions/emptyRoom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emptyRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/emptyRoom.ts"],"names":[],"mappings":"AA0BA;;;;;GAKG;AACH,wBAAgB,SAAS,IAAI,IAAI,CAGhC"}
+{"version":3,"file":"emptyRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/emptyRoom.ts"],"names":[],"mappings":"AAqBA;;;;;GAKG;AACH,wBAAgB,SAAS,IAAI,IAAI,CAGhC"}

package/dist/src/functions/emptyRoom.lua

@@ -2,7 +2,7 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local emptyRoomEntities, emptyRoomGridEntities, EMPTY_ROOM_BLACKLIST_ENTITY_SET, EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET
+local emptyRoomEntities, emptyRoomGridEntities, EMPTY_ROOM_BLACKLIST_ENTITY_SET
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
@@ -16,6 +16,8 @@ local getGridEntities = ____gridEntities.getGridEntities
 local removeGridEntity = ____gridEntities.removeGridEntity
 local ____rooms = require("src.functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
+local ____roomShapeWalls = require("src.functions.roomShapeWalls")
+local isVanillaWallGridIndex = ____roomShapeWalls.isVanillaWallGridIndex
 function emptyRoomEntities(self)
     local room = game:GetRoom()
     for ____, entity in ipairs(getEntities(nil)) do
@@ -41,7 +43,11 @@ function emptyRoomGridEntities(self)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         do
             local gridEntityType = gridEntity:GetType()
-            if EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET:has(gridEntityType) then
+            local gridIndex = gridEntity:GetGridIndex()
+            if gridEntityType == GridEntityType.WALL and isVanillaWallGridIndex(nil, gridIndex) then
+                goto __continue10
+            end
+            if gridEntityType == GridEntityType.DOOR then
                 goto __continue10
             end
             removeGridEntity(nil, gridEntity, false)
@@ -62,7 +68,6 @@ EMPTY_ROOM_BLACKLIST_ENTITY_SET = __TS__New(Set, {
     EntityType.PROJECTILE,
     EntityType.DARK_ESAU
 })
-EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET = __TS__New(Set, {GridEntityType.WALL, GridEntityType.DOOR})
 --- Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
 -- this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
 -- (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most

package/dist/src/functions/roomShapeWalls.d.ts

@@ -1,13 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/**
- * Helper function to determine if a given wall is a "real" wall generated by the vanilla game. This
- * is useful because mods can use custom spawned walls as a stand-in for custom grid entities.
- *
- * This function checks for identity via a combination of `StageAPI.IsCustomGrid` and the
- * `isVanillaWallGridIndex` function.
- */
-export declare function isVanillaWall(gridEntity: GridEntity): boolean;
 /**
  * Helper function to determine if a given grid index should have a wall generated by the vanilla
  * game. This is useful as a mechanism to distinguish between real walls and custom walls spawned by

package/dist/src/functions/roomShapeWalls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roomShapeWalls.d.ts","sourceRoot":"","sources":["../../../src/functions/roomShapeWalls.ts"],"names":[],"mappings":";;AAwTA;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAQ7D;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAqB9D"}
+{"version":3,"file":"roomShapeWalls.d.ts","sourceRoot":"","sources":["../../../src/functions/roomShapeWalls.ts"],"names":[],"mappings":";AAwTA;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAqB9D"}

package/dist/src/functions/roomShapeWalls.lua

@@ -6,7 +6,7 @@ local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
 local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
 local Set = ____lualib.Set
 local ____exports = {}
-local getRoomShapeToWallGridIndexSet, getVanillaWallGridIndexSetForRoomShape, getWallGridIndexSetForRectangleRoomShape, ROOM_SHAPE_TO_WALL_GRID_INDEX_SET, HOME_CLOSET_CORNERS_SET, MOTHER_ROOM_CORNERS_SET
+local getRoomShapeToWallGridIndexSet, getVanillaWallGridIndexSetForRoomShape, getWallGridIndexSetForRectangleRoomShape
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
@@ -199,29 +199,7 @@ function getWallGridIndexSetForRectangleRoomShape(self, roomShape, corners)
         {__TS__SparseArraySpread(____array_8)}
     )
 end
---- Helper function to determine if a given grid index should have a wall generated by the vanilla
--- game. This is useful as a mechanism to distinguish between real walls and custom walls spawned by
--- mods.
--- 
--- This function properly handles the special cases of the Mother boss room and the Home closet
--- rooms, which are both non-standard room shapes.
-function ____exports.isVanillaWallGridIndex(self, gridIndex)
-    local room = game:GetRoom()
-    local roomShape = room:GetRoomShape()
-    local wallGridIndexSet
-    if inHomeCloset(nil) then
-        wallGridIndexSet = HOME_CLOSET_CORNERS_SET
-    elseif inBossRoomOf(nil, BossID.MOTHER) then
-        wallGridIndexSet = MOTHER_ROOM_CORNERS_SET
-    else
-        wallGridIndexSet = ROOM_SHAPE_TO_WALL_GRID_INDEX_SET:get(roomShape)
-    end
-    if wallGridIndexSet == nil then
-        error(((("Failed to find the wall grid index set for: RoomShape." .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ")")
-    end
-    return wallGridIndexSet:has(gridIndex)
-end
-ROOM_SHAPE_TO_WALL_GRID_INDEX_SET = getRoomShapeToWallGridIndexSet(nil)
+local ROOM_SHAPE_TO_WALL_GRID_INDEX_SET = getRoomShapeToWallGridIndexSet(nil)
 --- The Home closet is is 9x3, which is different from `RoomShape.IH` (which is 13x3).
 local HOME_CLOSET_CORNERS = {
     {
@@ -245,7 +223,7 @@ local HOME_CLOSET_CORNERS = {
         position = Vector(340, 340)
     }
 }
-HOME_CLOSET_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.IH, HOME_CLOSET_CORNERS)
+local HOME_CLOSET_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.IH, HOME_CLOSET_CORNERS)
 --- The Mother Boss Room is 15x11, which is different from `RoomShape.SHAPE_1x2` (which is 15x16).
 local MOTHER_ROOM_CORNERS = {
     {
@@ -269,17 +247,27 @@ local MOTHER_ROOM_CORNERS = {
         position = Vector(580, 500)
     }
 }
-MOTHER_ROOM_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.SHAPE_1x2, MOTHER_ROOM_CORNERS)
---- Helper function to determine if a given wall is a "real" wall generated by the vanilla game. This
--- is useful because mods can use custom spawned walls as a stand-in for custom grid entities.
+local MOTHER_ROOM_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(nil, RoomShape.SHAPE_1x2, MOTHER_ROOM_CORNERS)
+--- Helper function to determine if a given grid index should have a wall generated by the vanilla
+-- game. This is useful as a mechanism to distinguish between real walls and custom walls spawned by
+-- mods.
 -- 
--- This function checks for identity via a combination of `StageAPI.IsCustomGrid` and the
--- `isVanillaWallGridIndex` function.
-function ____exports.isVanillaWall(self, gridEntity)
-    local gridIndex = gridEntity:GetGridIndex()
-    if StageAPI ~= nil and StageAPI.IsCustomGrid(gridIndex) then
-        return false
+-- This function properly handles the special cases of the Mother boss room and the Home closet
+-- rooms, which are both non-standard room shapes.
+function ____exports.isVanillaWallGridIndex(self, gridIndex)
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local wallGridIndexSet
+    if inHomeCloset(nil) then
+        wallGridIndexSet = HOME_CLOSET_CORNERS_SET
+    elseif inBossRoomOf(nil, BossID.MOTHER) then
+        wallGridIndexSet = MOTHER_ROOM_CORNERS_SET
+    else
+        wallGridIndexSet = ROOM_SHAPE_TO_WALL_GRID_INDEX_SET:get(roomShape)
     end
-    return ____exports.isVanillaWallGridIndex(nil, gridIndex)
+    if wallGridIndexSet == nil then
+        error(((("Failed to find the wall grid index set for: RoomShape." .. tostring(RoomShape[roomShape])) .. " (") .. tostring(roomShape)) .. ")")
+    end
+    return wallGridIndexSet:has(gridIndex)
 end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "13.1.0",
+  "version": "13.2.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/features/deployJSONRoom.ts

@@ -36,6 +36,7 @@ import {
   getGridEntities,
   removeGridEntity,
   setGridEntityInvisible,
+  spawnGridEntity,
   spawnGridEntityWithVariant,
 } from "../functions/gridEntities";
 import { getRandomJSONEntity, getRandomJSONRoom } from "../functions/jsonRoom";
@@ -145,6 +146,11 @@ function preUseItemWeNeedToGoDeeper(
       return;
     }
 
+    const futureRoomListIndex = getRoomListIndex();
+    if (futureRoomListIndex !== roomListIndex) {
+      return;
+    }
+
     v.room.manuallyUsingShovel = true;
     futurePlayer.UseActiveItem(CollectibleType.WE_NEED_TO_GO_DEEPER);
     v.room.manuallyUsingShovel = false;
@@ -152,7 +158,7 @@ function preUseItemWeNeedToGoDeeper(
     const decorationGridIndexes =
       v.level.roomToDecorationGridIndexesMap.getAndSetDefault(roomListIndex);
     emptyArray(decorationGridIndexes);
-    fillRoomWithDecorations();
+    preventGridEntityRespawn();
   });
 
   // Cancel the original effect.
@@ -273,7 +279,7 @@ export function deployJSONRoom(
   }
 
   fixPitGraphics();
-  fillRoomWithDecorations();
+  preventGridEntityRespawn();
 }
 
 /**
@@ -328,27 +334,35 @@ export function deployRandomJSONRoom(
 }
 
 /**
- * We removed most normal entities, which should prevent them from respawning when the player
- * re-enters the room. However, this is not the case for grid entities; even if they are removed,
- * they will come back when the player re-enters the room.
+ * Helper function to prevent any removed grid entities from respawning if the player re-enters the
+ * room.
  *
- * In order to prevent this from happening, we can spawn a grid entity on every tile that does not
- * already have a grid entity. The natural grid entity to choose for this purpose is a decoration,
- * since it is non-interacting.
+ * This is accomplished by spawning a new grid entity on every tile that does not already have a
+ * grid entity. This will force the game to spawn the new grid entity instead of the old one. The
+ * natural grid entity to choose for this purpose is a decoration, since it is non-interacting.
+ * Then, the decorations are made invisible and any shovel uses are intercepted to avoid creating a
+ * crawl space (instead of a trapdoor).
  *
  * Another option besides decorations would be to use a pressure plates with a state of 1, which is
  * a state that is normally unused by the game and makes it invisible & persistent. However, pickups
  * will not be able to spawn on pressure plates, which lead to various bugs (e.g. pickups spawning
- * on top of pits). Thus, we use a decoration and remove its sprite to make it invisible.
+ * on top of pits). Thus, using a decoration is preferable.
  *
- * Yet another option is to replace the room data with that of an empty room. However, the room data
- * must exactly match the room type, the room shape, and the doors, so this is not possible to do in
- * a robust way without adding empty rooms to the mod's `content` folder to draw the data from.
+ * Yet another option to accomplish this would be to replace the room data with that of an empty
+ * room. However, the room data must exactly match the room type, the room shape, and the doors, so
+ * this is not possible to do in a robust way without adding empty rooms to the mod's `content`
+ * folder to draw the data from.
  */
-function fillRoomWithDecorations() {
+export function preventGridEntityRespawn(): void {
+  errorIfFeaturesNotInitialized(FEATURE_NAME);
+
   const room = game.GetRoom();
   const roomListIndex = getRoomListIndex();
 
+  // Ensure that this room is in the deployed room set, or else the shovel interception code will
+  // not work properly.
+  v.level.deployedRoomListIndexes.add(roomListIndex);
+
   const decorationGridIndexes =
     v.level.roomToDecorationGridIndexesMap.getAndSetDefault(roomListIndex);
 
@@ -358,9 +372,7 @@ function fillRoomWithDecorations() {
       continue;
     }
 
-    const position = room.GetGridPosition(gridIndex);
-    const decoration = Isaac.GridSpawn(GridEntityType.DECORATION, 0, position);
-
+    const decoration = spawnGridEntity(GridEntityType.DECORATION, gridIndex);
     if (decoration !== undefined) {
       setGridEntityInvisible(decoration);
     }

package/src/functions/emptyRoom.ts

@@ -7,6 +7,7 @@ import { game } from "../core/cachedClasses";
 import { getEntities } from "./entities";
 import { getGridEntities, removeGridEntity } from "./gridEntities";
 import { roomUpdateSafe } from "./rooms";
+import { isVanillaWallGridIndex } from "./roomShapeWalls";
 
 const EMPTY_ROOM_BLACKLIST_ENTITY_SET: ReadonlySet<EntityType> = new Set([
   EntityType.PLAYER, // 1
@@ -18,12 +19,6 @@ const EMPTY_ROOM_BLACKLIST_ENTITY_SET: ReadonlySet<EntityType> = new Set([
   EntityType.DARK_ESAU, // 866
 ]);
 
-const EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET: ReadonlySet<GridEntityType> =
-  new Set([
-    GridEntityType.WALL, // 15
-    GridEntityType.DOOR, // 16
-  ]);
-
 /**
  * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
  * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
@@ -68,11 +63,23 @@ function emptyRoomEntities() {
   }
 }
 
+/** We want to remove all grid entities except for walls and doors. */
 function emptyRoomGridEntities() {
   let removedOneOrMoreGridEntities = false;
   for (const gridEntity of getGridEntities()) {
     const gridEntityType = gridEntity.GetType();
-    if (EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET.has(gridEntityType)) {
+    const gridIndex = gridEntity.GetGridIndex();
+
+    // We cannot simply check if the grid entity type is equal to a wall because other mods use
+    // walls as a base for custom grid entities.
+    if (
+      gridEntityType === GridEntityType.WALL &&
+      isVanillaWallGridIndex(gridIndex)
+    ) {
+      continue;
+    }
+
+    if (gridEntityType === GridEntityType.DOOR) {
       continue;
     }
 

package/src/functions/roomShapeWalls.ts

@@ -310,23 +310,6 @@ const MOTHER_ROOM_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(
   MOTHER_ROOM_CORNERS,
 );
 
-/**
- * Helper function to determine if a given wall is a "real" wall generated by the vanilla game. This
- * is useful because mods can use custom spawned walls as a stand-in for custom grid entities.
- *
- * This function checks for identity via a combination of `StageAPI.IsCustomGrid` and the
- * `isVanillaWallGridIndex` function.
- */
-export function isVanillaWall(gridEntity: GridEntity): boolean {
-  const gridIndex = gridEntity.GetGridIndex();
-
-  if (StageAPI !== undefined && StageAPI.IsCustomGrid(gridIndex)) {
-    return false;
-  }
-
-  return isVanillaWallGridIndex(gridIndex);
-}
-
 /**
  * Helper function to determine if a given grid index should have a wall generated by the vanilla
  * game. This is useful as a mechanism to distinguish between real walls and custom walls spawned by