isaacscript-common 13.1.1 → 13.2.0

package/dist/index.d.ts

@@ -9468,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.1
+isaacscript-common 13.2.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -41734,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
@@ -41770,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
@@ -41820,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
@@ -41867,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)
@@ -42141,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)
@@ -42191,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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "13.1.1",
+  "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);
     }