isaacscript-common 59.5.0 → 59.6.0

package/dist/index.rollup.d.ts

@@ -7642,6 +7642,24 @@ export declare function getSubPlayerParent(subPlayer: EntitySubPlayer): EntityPl
  */
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 
+/**
+ * Helper function to get the grid indexes on the surrounding tiles from the provided grid index.
+ *
+ * There are always 8 grid indexes returned (e.g. top-left + top + top-right + left + right +
+ * bottom-left + bottom + right), even if the computed values would be negative or otherwise
+ * invalid.
+ */
+export declare function getSurroundingGridIndexes(gridIndex: int): [
+topLeft: int,
+top: int,
+topRight: int,
+left: int,
+right: int,
+bottomLeft: int,
+bottom: int,
+bottomRight: int
+];
+
 /**
  * Helper function to determine how many heart containers that Tainted Magdalene has that will not
  * be automatically depleted over time. By default, this is 2, but this function will return 4 so
@@ -9198,6 +9216,12 @@ export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
  */
 export declare function isGridEntityXMLType(num: number): num is GridEntityXMLType;
 
+/**
+ * Helper function to check if the provided grid index has a door on it or if the surrounding 8 grid
+ * indexes have a door on it.
+ */
+export declare function isGridIndexAdjacentToDoor(gridIndex: int): boolean;
+
 /** For `PickupVariant.HEART` (10). */
 export declare function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 59.5.0
+isaacscript-common 59.6.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -28923,6 +28923,20 @@ function getRockPNGName(self)
         end
     until true
 end
+function ____exports.getSurroundingGridIndexes(self, gridIndex)
+    local room = game:GetRoom()
+    local gridWidth = room:GetGridWidth()
+    return {
+        gridIndex - gridWidth - 1,
+        gridIndex - gridWidth,
+        gridIndex - gridWidth + 1,
+        gridIndex - 1,
+        gridIndex + 1,
+        gridIndex + gridWidth - 1,
+        gridIndex + gridWidth,
+        gridIndex + gridWidth + 1
+    }
+end
 function ____exports.getTopLeftWallGridIndex(self)
     local room = game:GetRoom()
     local roomShape = room:GetRoomShape()
@@ -29173,18 +29187,8 @@ function ____exports.getRockPNGPath(self)
 end
 function ____exports.getSurroundingGridEntities(self, gridEntity)
     local room = game:GetRoom()
-    local gridWidth = room:GetGridWidth()
     local gridIndex = gridEntity:GetGridIndex()
-    local surroundingGridIndexes = {
-        gridIndex - 1,
-        gridIndex + 1,
-        gridIndex - gridWidth - 1,
-        gridIndex - gridWidth,
-        gridIndex - gridWidth + 1,
-        gridIndex + gridWidth - 1,
-        gridIndex + gridWidth,
-        gridIndex + gridWidth + 1
-    }
+    local surroundingGridIndexes = ____exports.getSurroundingGridIndexes(nil, gridIndex)
     local surroundingGridEntities = {}
     for ____, surroundingGridIndex in ipairs(surroundingGridIndexes) do
         local surroundingGridEntity = room:GetGridEntity(surroundingGridIndex)
@@ -29213,6 +29217,24 @@ end
 function ____exports.isGridEntityXMLType(self, num)
     return GRID_ENTITY_XML_TYPES_SET:has(num)
 end
+function ____exports.isGridIndexAdjacentToDoor(self, gridIndex)
+    local room = game:GetRoom()
+    local surroundingGridIndexes = ____exports.getSurroundingGridIndexes(nil, gridIndex)
+    local gridIndexes = {
+        gridIndex,
+        table.unpack(surroundingGridIndexes)
+    }
+    for ____, gridIndexToInspect in ipairs(gridIndexes) do
+        local gridEntity = room:GetGridEntity(gridIndexToInspect)
+        if gridEntity ~= nil then
+            local door = gridEntity:ToDoor()
+            if door ~= nil then
+                return true
+            end
+        end
+    end
+    return false
+end
 function ____exports.isPoopGridEntityXMLType(self, gridEntityXMLType)
     return POOP_GRID_ENTITY_XML_TYPES_SET:has(gridEntityXMLType)
 end

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

@@ -116,6 +116,23 @@ export declare function getRockPNGPath(): string;
  * rocks (e.g. top-left + top + top-right + left + right + bottom-left + bottom + right).
  */
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
+/**
+ * Helper function to get the grid indexes on the surrounding tiles from the provided grid index.
+ *
+ * There are always 8 grid indexes returned (e.g. top-left + top + top-right + left + right +
+ * bottom-left + bottom + right), even if the computed values would be negative or otherwise
+ * invalid.
+ */
+export declare function getSurroundingGridIndexes(gridIndex: int): [
+    topLeft: int,
+    top: int,
+    topRight: int,
+    left: int,
+    right: int,
+    bottomLeft: int,
+    bottom: int,
+    bottomRight: int
+];
 /**
  * Helper function to get the top left wall in the current room.
  *
@@ -149,6 +166,11 @@ export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
  * the `PRE_ROOM_ENTITY_SPAWN` callback for narrowing the type of the first argument.
  */
 export declare function isGridEntityXMLType(num: number): num is GridEntityXMLType;
+/**
+ * Helper function to check if the provided grid index has a door on it or if the surrounding 8 grid
+ * indexes have a door on it.
+ */
+export declare function isGridIndexAdjacentToDoor(gridIndex: int): boolean;
 /** Helper function to see if a `GridEntityXMLType` is some kind of poop. */
 export declare function isPoopGridEntityXMLType(gridEntityXMLType: GridEntityXMLType): boolean;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAIL,cAAc,EAIf,MAAM,8BAA8B,CAAC;AAYtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AA0C1D;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAenC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,cAAc,EAC9B,OAAO,SAAK,GACX,OAAO,CAiBT;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;;;;GASG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CAoBV;AAED,qFAAqF;AACrF,wBAAgB,+BAA+B,CAC7C,YAAY,EAAE,YAAY,GACzB,CAAC,cAAc,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,CAuBhD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD,uFAAuF;AACvF,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,GACb,UAAU,EAAE,CAyCd;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,mEAAmE;AACnE,wBAAgB,qBAAqB,CACnC,cAAc,EAAE,cAAc,GAC7B,MAAM,GAAG,SAAS,CAGpB;AAkID,2FAA2F;AAC3F,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAWA;AAED,qFAAqF;AACrF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,YAAY,CAIpE;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,YAAY,CAEd;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAGvC;AAkJD;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CA2Bd;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAO7C;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAEzE;AAED,4EAA4E;AAC5E,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAET;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAQpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,MAAM,EAAE,EAClB,UAAU,EAAE,UAAU,GACrB,IAAI,CAON;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,cAAc,GAC7B,IAAI,CAmBN;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAwD7D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}
+{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAIL,cAAc,EAIf,MAAM,8BAA8B,CAAC;AAYtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AA0C1D;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAenC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,cAAc,EAC9B,OAAO,SAAK,GACX,OAAO,CAiBT;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;;;;GASG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CAoBV;AAED,qFAAqF;AACrF,wBAAgB,+BAA+B,CAC7C,YAAY,EAAE,YAAY,GACzB,CAAC,cAAc,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,CAuBhD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD,uFAAuF;AACvF,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,GACb,UAAU,EAAE,CAyCd;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,mEAAmE;AACnE,wBAAgB,qBAAqB,CACnC,cAAc,EAAE,cAAc,GAC7B,MAAM,GAAG,SAAS,CAGpB;AAkID,2FAA2F;AAC3F,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAWA;AAED,qFAAqF;AACrF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,YAAY,CAIpE;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,YAAY,CAEd;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAGvC;AAkJD;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CAed;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,GAAG,GACb;IACD,OAAO,EAAE,GAAG;IACZ,GAAG,EAAE,GAAG;IACR,QAAQ,EAAE,GAAG;IACb,IAAI,EAAE,GAAG;IACT,KAAK,EAAE,GAAG;IACV,UAAU,EAAE,GAAG;IACf,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,GAAG;CACjB,CAgBA;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAO7C;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAEzE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAgBjE;AAED,4EAA4E;AAC5E,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAET;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAQpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,MAAM,EAAE,EAClB,UAAU,EAAE,UAAU,GACrB,IAAI,CAON;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,cAAc,GAC7B,IAAI,CAmBN;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAwD7D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}

package/dist/src/functions/gridEntities.lua

@@ -340,6 +340,25 @@ function getRockPNGName(self)
         end
     until true
 end
+--- Helper function to get the grid indexes on the surrounding tiles from the provided grid index.
+-- 
+-- There are always 8 grid indexes returned (e.g. top-left + top + top-right + left + right +
+-- bottom-left + bottom + right), even if the computed values would be negative or otherwise
+-- invalid.
+function ____exports.getSurroundingGridIndexes(self, gridIndex)
+    local room = game:GetRoom()
+    local gridWidth = room:GetGridWidth()
+    return {
+        gridIndex - gridWidth - 1,
+        gridIndex - gridWidth,
+        gridIndex - gridWidth + 1,
+        gridIndex - 1,
+        gridIndex + 1,
+        gridIndex + gridWidth - 1,
+        gridIndex + gridWidth,
+        gridIndex + gridWidth + 1
+    }
+end
 --- Helper function to get the grid index of the top left wall. (This will depend on what the current
 -- room shape is.)
 -- 
@@ -683,18 +702,8 @@ end
 -- rocks (e.g. top-left + top + top-right + left + right + bottom-left + bottom + right).
 function ____exports.getSurroundingGridEntities(self, gridEntity)
     local room = game:GetRoom()
-    local gridWidth = room:GetGridWidth()
     local gridIndex = gridEntity:GetGridIndex()
-    local surroundingGridIndexes = {
-        gridIndex - 1,
-        gridIndex + 1,
-        gridIndex - gridWidth - 1,
-        gridIndex - gridWidth,
-        gridIndex - gridWidth + 1,
-        gridIndex + gridWidth - 1,
-        gridIndex + gridWidth,
-        gridIndex + gridWidth + 1
-    }
+    local surroundingGridIndexes = ____exports.getSurroundingGridIndexes(nil, gridIndex)
     local surroundingGridEntities = {}
     for ____, surroundingGridIndex in ipairs(surroundingGridIndexes) do
         local surroundingGridEntity = room:GetGridEntity(surroundingGridIndex)
@@ -737,6 +746,26 @@ end
 function ____exports.isGridEntityXMLType(self, num)
     return GRID_ENTITY_XML_TYPES_SET:has(num)
 end
+--- Helper function to check if the provided grid index has a door on it or if the surrounding 8 grid
+-- indexes have a door on it.
+function ____exports.isGridIndexAdjacentToDoor(self, gridIndex)
+    local room = game:GetRoom()
+    local surroundingGridIndexes = ____exports.getSurroundingGridIndexes(nil, gridIndex)
+    local gridIndexes = {
+        gridIndex,
+        table.unpack(surroundingGridIndexes)
+    }
+    for ____, gridIndexToInspect in ipairs(gridIndexes) do
+        local gridEntity = room:GetGridEntity(gridIndexToInspect)
+        if gridEntity ~= nil then
+            local door = gridEntity:ToDoor()
+            if door ~= nil then
+                return true
+            end
+        end
+    end
+    return false
+end
 --- Helper function to see if a `GridEntityXMLType` is some kind of poop.
 function ____exports.isPoopGridEntityXMLType(self, gridEntityXMLType)
     return POOP_GRID_ENTITY_XML_TYPES_SET:has(gridEntityXMLType)

package/package.json

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

package/src/functions/gridEntities.ts

@@ -690,21 +690,9 @@ export function getSurroundingGridEntities(
   gridEntity: GridEntity,
 ): GridEntity[] {
   const room = game.GetRoom();
-  const gridWidth = room.GetGridWidth();
   const gridIndex = gridEntity.GetGridIndex();
 
-  const surroundingGridIndexes: int[] = [
-    gridIndex - 1, // Left
-    gridIndex + 1, // Right
-
-    gridIndex - gridWidth - 1, // Top-left
-    gridIndex - gridWidth, // Top
-    gridIndex - gridWidth + 1, // Top-right
-
-    gridIndex + gridWidth - 1, // Bottom-left
-    gridIndex + gridWidth, // Bottom
-    gridIndex + gridWidth + 1, // Bottom-right
-  ];
+  const surroundingGridIndexes = getSurroundingGridIndexes(gridIndex);
 
   const surroundingGridEntities: GridEntity[] = [];
   for (const surroundingGridIndex of surroundingGridIndexes) {
@@ -717,6 +705,42 @@ export function getSurroundingGridEntities(
   return surroundingGridEntities;
 }
 
+/**
+ * Helper function to get the grid indexes on the surrounding tiles from the provided grid index.
+ *
+ * There are always 8 grid indexes returned (e.g. top-left + top + top-right + left + right +
+ * bottom-left + bottom + right), even if the computed values would be negative or otherwise
+ * invalid.
+ */
+export function getSurroundingGridIndexes(
+  gridIndex: int,
+): [
+  topLeft: int,
+  top: int,
+  topRight: int,
+  left: int,
+  right: int,
+  bottomLeft: int,
+  bottom: int,
+  bottomRight: int,
+] {
+  const room = game.GetRoom();
+  const gridWidth = room.GetGridWidth();
+
+  return [
+    gridIndex - gridWidth - 1, // Top-left
+    gridIndex - gridWidth, // Top
+    gridIndex - gridWidth + 1, // Top-right
+
+    gridIndex - 1, // Left
+    gridIndex + 1, // Right
+
+    gridIndex + gridWidth - 1, // Bottom-left
+    gridIndex + gridWidth, // Bottom
+    gridIndex + gridWidth + 1, // Bottom-right
+  ];
+}
+
 /**
  * Helper function to get the top left wall in the current room.
  *
@@ -785,6 +809,28 @@ export function isGridEntityXMLType(num: number): num is GridEntityXMLType {
   return GRID_ENTITY_XML_TYPES_SET.has(num); // eslint-disable-line isaacscript/strict-enums
 }
 
+/**
+ * Helper function to check if the provided grid index has a door on it or if the surrounding 8 grid
+ * indexes have a door on it.
+ */
+export function isGridIndexAdjacentToDoor(gridIndex: int): boolean {
+  const room = game.GetRoom();
+  const surroundingGridIndexes = getSurroundingGridIndexes(gridIndex);
+  const gridIndexes = [gridIndex, ...surroundingGridIndexes];
+
+  for (const gridIndexToInspect of gridIndexes) {
+    const gridEntity = room.GetGridEntity(gridIndexToInspect);
+    if (gridEntity !== undefined) {
+      const door = gridEntity.ToDoor();
+      if (door !== undefined) {
+        return true;
+      }
+    }
+  }
+
+  return false;
+}
+
 /** Helper function to see if a `GridEntityXMLType` is some kind of poop. */
 export function isPoopGridEntityXMLType(
   gridEntityXMLType: GridEntityXMLType,