isaacscript-common 59.5.0 → 59.7.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
@@ -8654,6 +8672,30 @@ export declare function isBattery(pickup: EntityPickup): pickup is EntityPickupB
  */
 export declare function isBeastRoom(roomData: RoomConfig): boolean;
 
+/**
+ * Helper function to check if the current game frame count is lower than a specific game frame
+ * count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export declare function isBeforeGameFrame(gameFrameCount: int | null | undefined): boolean;
+
+/**
+ * Helper function to check if the current render frame count is lower than a specific render frame
+ * count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export declare function isBeforeRenderFrame(renderFrameCount: int | null | undefined): boolean;
+
+/**
+ * Helper function to check if the current room frame count is lower than a specific room frame
+ * count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export declare function isBeforeRoomFrame(roomFrameCount: int | null | undefined): boolean;
+
 /**
  * Helper function for detecting when a player is Bethany or Tainted Bethany. This is useful if you
  * need to adjust UI elements to account for Bethany's soul charges or Tainted Bethany's blood
@@ -9198,6 +9240,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;
 
@@ -14432,6 +14480,30 @@ export declare function onFirstFloor(): boolean;
  */
 export declare function onGameFrame(gameFrameCount: int | null | undefined): boolean;
 
+/**
+ * Helper function to check if the current game frame count is equal to or lower than a specific
+ * game frame count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export declare function onOrBeforeGameFrame(gameFrameCount: int | null | undefined): boolean;
+
+/**
+ * Helper function to check if the current render frame count is equal to or lower than a specific
+ * render frame count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export declare function onOrBeforeRenderFrame(renderFrameCount: int | null | undefined): boolean;
+
+/**
+ * Helper function to check if the current room frame count is equal to or lower than a specific
+ * room frame count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export declare function onOrBeforeRoomFrame(roomFrameCount: int | null | undefined): boolean;
+
 /**
  * Helper function to check if the current game frame count is equal to or higher than a specific
  * game frame count.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 59.5.0
+isaacscript-common 59.7.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19091,6 +19091,28 @@ function ____exports.getElapsedRoomFramesSince(self, roomFrameCount)
     local thisRoomFrameCount = room:GetFrameCount()
     return thisRoomFrameCount - roomFrameCount
 end
+function ____exports.isBeforeGameFrame(self, gameFrameCount)
+    if gameFrameCount == nil or gameFrameCount == nil then
+        return false
+    end
+    local thisGameFrameCount = game:GetFrameCount()
+    return thisGameFrameCount < gameFrameCount
+end
+function ____exports.isBeforeRenderFrame(self, renderFrameCount)
+    if renderFrameCount == nil or renderFrameCount == nil then
+        return false
+    end
+    local thisRenderFrameCount = Isaac.GetFrameCount()
+    return thisRenderFrameCount < renderFrameCount
+end
+function ____exports.isBeforeRoomFrame(self, roomFrameCount)
+    if roomFrameCount == nil or roomFrameCount == nil then
+        return false
+    end
+    local room = game:GetRoom()
+    local thisGameFrameCount = room:GetFrameCount()
+    return thisGameFrameCount < roomFrameCount
+end
 function ____exports.isPastGameFrame(self, gameFrameCount)
     if gameFrameCount == nil or gameFrameCount == nil then
         return false
@@ -19103,7 +19125,7 @@ function ____exports.isPastRenderFrame(self, renderFrameCount)
         return false
     end
     local thisRenderFrameCount = Isaac.GetFrameCount()
-    return thisRenderFrameCount >= renderFrameCount
+    return thisRenderFrameCount > renderFrameCount
 end
 function ____exports.isPastRoomFrame(self, roomFrameCount)
     if roomFrameCount == nil or roomFrameCount == nil then
@@ -19120,6 +19142,28 @@ function ____exports.onGameFrame(self, gameFrameCount)
     local thisGameFrameCount = game:GetFrameCount()
     return thisGameFrameCount == gameFrameCount
 end
+function ____exports.onOrBeforeGameFrame(self, gameFrameCount)
+    if gameFrameCount == nil or gameFrameCount == nil then
+        return false
+    end
+    local thisGameFrameCount = game:GetFrameCount()
+    return thisGameFrameCount <= gameFrameCount
+end
+function ____exports.onOrBeforeRenderFrame(self, renderFrameCount)
+    if renderFrameCount == nil or renderFrameCount == nil then
+        return false
+    end
+    local thisRenderFrameCount = Isaac.GetFrameCount()
+    return thisRenderFrameCount <= renderFrameCount
+end
+function ____exports.onOrBeforeRoomFrame(self, roomFrameCount)
+    if roomFrameCount == nil or roomFrameCount == nil then
+        return false
+    end
+    local room = game:GetRoom()
+    local thisGameFrameCount = room:GetFrameCount()
+    return thisGameFrameCount >= roomFrameCount
+end
 function ____exports.onOrPastGameFrame(self, gameFrameCount)
     if gameFrameCount == nil or gameFrameCount == nil then
         return false
@@ -28923,6 +28967,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 +29231,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 +29261,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
@@ -38056,7 +38122,7 @@ local ISCFeature = ____ISCFeature.ISCFeature
 local ____entities = require("src.functions.entities")
 local getEntityID = ____entities.getEntityID
 local ____frames = require("src.functions.frames")
-local isPastRoomFrame = ____frames.isPastRoomFrame
+local onOrBeforeRoomFrame = ____frames.onOrBeforeRoomFrame
 local ____roomData = require("src.functions.roomData")
 local getRoomListIndex = ____roomData.getRoomListIndex
 local ____stage = require("src.functions.stage")
@@ -38115,7 +38181,7 @@ function PickupIndexCreation.prototype.setPickupIndex(self, pickup)
     local pickupIndexFromLevelData = self:getPickupIndexFromPreviousData(pickup)
     local room = game:GetRoom()
     local isFirstVisit = room:IsFirstVisit()
-    if pickupIndexFromLevelData ~= nil and not isFirstVisit and not isPastRoomFrame(nil, 0) then
+    if pickupIndexFromLevelData ~= nil and not isFirstVisit and onOrBeforeRoomFrame(nil, 0) then
         v.room.pickupIndexes:set(ptrHash, pickupIndexFromLevelData)
         return
     end
@@ -42429,6 +42495,7 @@ local TrapdoorAnimation = ____TrapdoorAnimation.TrapdoorAnimation
 local ____easing = require("src.functions.easing")
 local easeOutSine = ____easing.easeOutSine
 local ____frames = require("src.functions.frames")
+local isBeforeRenderFrame = ____frames.isBeforeRenderFrame
 local isPastRoomFrame = ____frames.isPastRoomFrame
 local onOrPastRenderFrame = ____frames.onOrPastRenderFrame
 local ____log = require("src.functions.log")
@@ -42589,7 +42656,7 @@ function CustomTrapdoors.prototype.checkPixelationToBlackComplete(self)
         return
     end
     local renderFrameScreenBlack = v.run.stateRenderFrame + PIXELATION_TO_BLACK_FRAMES
-    if not onOrPastRenderFrame(nil, renderFrameScreenBlack) then
+    if isBeforeRenderFrame(nil, renderFrameScreenBlack) then
         return
     end
     v.run.state = StageTravelState.WAITING_FOR_FIRST_PIXELATION_TO_END
@@ -42634,7 +42701,7 @@ function CustomTrapdoors.prototype.checkSecondPixelationHalfWay(self)
         return
     end
     local renderFrameScreenBlack = v.run.stateRenderFrame + PIXELATION_TO_BLACK_FRAMES
-    if not onOrPastRenderFrame(nil, renderFrameScreenBlack) then
+    if isBeforeRenderFrame(nil, renderFrameScreenBlack) then
         return
     end
     v.run.state = StageTravelState.PIXELATION_TO_ROOM

package/dist/src/classes/features/other/CustomTrapdoors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomTrapdoors.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomTrapdoors.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,UAAU,EAKV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAmCtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAkDhD,qBAAa,eAAgB,SAAQ,OAAO;IAC1C,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAO/B;IAKJ;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAY;IAExC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAqB;IACxD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAmD5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAMzB;IAEF,OAAO,CAAC,2BAA2B;IA+BnC,OAAO,CAAC,8BAA8B;IAiDtC,OAAO,CAAC,6BAA6B;IAsBrC,OAAO,CAAC,kBAAkB;IAqB1B,OAAO,CAAC,4BAA4B;IA+CpC,OAAO,CAAC,iCAAiC;IAqBzC,OAAO,CAAC,eAAe;IAoBvB,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CAcjD;IAEF,OAAO,CAAC,4BAA4B;IAcpC,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,sBAAsB;IAkB9B,OAAO,CAAC,gCAAgC;IAuCxC,OAAO,CAAC,2BAA2B;IAoCnC,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,8BAA8B;IAmDtC,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAEzC;IAEF,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,uBAAuB;IA2B/B,OAAO,CAAC,eAAe;IAUvB;;;;;;;;;;;;;;;;;;OAkBG;IAEI,iCAAiC,CACtC,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,CACf,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,gBAAgB,EAAE,UAAU,EAC5B,oBAAoB,EAAE,SAAS,KAC5B,IAAI,GACR,IAAI;IAUP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEI,mBAAmB,CACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,eAAe,CAAC,EAAE,MAAM,EACxB,gBAAgB,CAAC,EAAE,UAAU,EAC7B,oBAAoB,CAAC,EAAE,SAAS,EAChC,QAAQ,SAAmC,EAC3C,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU;CAsDd"}
+{"version":3,"file":"CustomTrapdoors.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomTrapdoors.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,UAAU,EAKV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAoCtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAkDhD,qBAAa,eAAgB,SAAQ,OAAO;IAC1C,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAO/B;IAKJ;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAY;IAExC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAqB;IACxD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAmD5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAMzB;IAEF,OAAO,CAAC,2BAA2B;IA+BnC,OAAO,CAAC,8BAA8B;IAiDtC,OAAO,CAAC,6BAA6B;IAsBrC,OAAO,CAAC,kBAAkB;IAqB1B,OAAO,CAAC,4BAA4B;IA+CpC,OAAO,CAAC,iCAAiC;IAqBzC,OAAO,CAAC,eAAe;IAoBvB,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CAcjD;IAEF,OAAO,CAAC,4BAA4B;IAcpC,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,sBAAsB;IAkB9B,OAAO,CAAC,gCAAgC;IAuCxC,OAAO,CAAC,2BAA2B;IAoCnC,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,8BAA8B;IAmDtC,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAEzC;IAEF,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,uBAAuB;IA2B/B,OAAO,CAAC,eAAe;IAUvB;;;;;;;;;;;;;;;;;;OAkBG;IAEI,iCAAiC,CACtC,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,CACf,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,gBAAgB,EAAE,UAAU,EAC5B,oBAAoB,EAAE,SAAS,KAC5B,IAAI,GACR,IAAI;IAUP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEI,mBAAmB,CACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,eAAe,CAAC,EAAE,MAAM,EACxB,gBAAgB,CAAC,EAAE,UAAU,EAC7B,oBAAoB,CAAC,EAAE,SAAS,EAChC,QAAQ,SAAmC,EAC3C,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU;CAsDd"}

package/dist/src/classes/features/other/CustomTrapdoors.lua

@@ -41,6 +41,7 @@ local TrapdoorAnimation = ____TrapdoorAnimation.TrapdoorAnimation
 local ____easing = require("src.functions.easing")
 local easeOutSine = ____easing.easeOutSine
 local ____frames = require("src.functions.frames")
+local isBeforeRenderFrame = ____frames.isBeforeRenderFrame
 local isPastRoomFrame = ____frames.isPastRoomFrame
 local onOrPastRenderFrame = ____frames.onOrPastRenderFrame
 local ____log = require("src.functions.log")
@@ -202,7 +203,7 @@ function CustomTrapdoors.prototype.checkPixelationToBlackComplete(self)
         return
     end
     local renderFrameScreenBlack = v.run.stateRenderFrame + PIXELATION_TO_BLACK_FRAMES
-    if not onOrPastRenderFrame(nil, renderFrameScreenBlack) then
+    if isBeforeRenderFrame(nil, renderFrameScreenBlack) then
         return
     end
     v.run.state = StageTravelState.WAITING_FOR_FIRST_PIXELATION_TO_END
@@ -247,7 +248,7 @@ function CustomTrapdoors.prototype.checkSecondPixelationHalfWay(self)
         return
     end
     local renderFrameScreenBlack = v.run.stateRenderFrame + PIXELATION_TO_BLACK_FRAMES
-    if not onOrPastRenderFrame(nil, renderFrameScreenBlack) then
+    if isBeforeRenderFrame(nil, renderFrameScreenBlack) then
         return
     end
     v.run.state = StageTravelState.PIXELATION_TO_ROOM

package/dist/src/classes/features/other/PickupIndexCreation.lua

@@ -20,7 +20,7 @@ local ISCFeature = ____ISCFeature.ISCFeature
 local ____entities = require("src.functions.entities")
 local getEntityID = ____entities.getEntityID
 local ____frames = require("src.functions.frames")
-local isPastRoomFrame = ____frames.isPastRoomFrame
+local onOrBeforeRoomFrame = ____frames.onOrBeforeRoomFrame
 local ____roomData = require("src.functions.roomData")
 local getRoomListIndex = ____roomData.getRoomListIndex
 local ____stage = require("src.functions.stage")
@@ -79,7 +79,7 @@ function PickupIndexCreation.prototype.setPickupIndex(self, pickup)
     local pickupIndexFromLevelData = self:getPickupIndexFromPreviousData(pickup)
     local room = game:GetRoom()
     local isFirstVisit = room:IsFirstVisit()
-    if pickupIndexFromLevelData ~= nil and not isFirstVisit and not isPastRoomFrame(nil, 0) then
+    if pickupIndexFromLevelData ~= nil and not isFirstVisit and onOrBeforeRoomFrame(nil, 0) then
         v.room.pickupIndexes:set(ptrHash, pickupIndexFromLevelData)
         return
     end

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

@@ -2,6 +2,27 @@
 export declare function getElapsedGameFramesSince(gameFrameCount: int): int;
 export declare function getElapsedRenderFramesSince(renderFrameCount: int): int;
 export declare function getElapsedRoomFramesSince(roomFrameCount: int): int;
+/**
+ * Helper function to check if the current game frame count is lower than a specific game frame
+ * count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export declare function isBeforeGameFrame(gameFrameCount: int | null | undefined): boolean;
+/**
+ * Helper function to check if the current render frame count is lower than a specific render frame
+ * count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export declare function isBeforeRenderFrame(renderFrameCount: int | null | undefined): boolean;
+/**
+ * Helper function to check if the current room frame count is lower than a specific room frame
+ * count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export declare function isBeforeRoomFrame(roomFrameCount: int | null | undefined): boolean;
 /**
  * Helper function to check if the current game frame count is higher than a specific game frame
  * count.
@@ -30,6 +51,27 @@ export declare function isPastRoomFrame(roomFrameCount: int | null | undefined):
  * This returns false if the submitted game frame count is null or undefined.
  */
 export declare function onGameFrame(gameFrameCount: int | null | undefined): boolean;
+/**
+ * Helper function to check if the current game frame count is equal to or lower than a specific
+ * game frame count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export declare function onOrBeforeGameFrame(gameFrameCount: int | null | undefined): boolean;
+/**
+ * Helper function to check if the current render frame count is equal to or lower than a specific
+ * render frame count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export declare function onOrBeforeRenderFrame(renderFrameCount: int | null | undefined): boolean;
+/**
+ * Helper function to check if the current room frame count is equal to or lower than a specific
+ * room frame count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export declare function onOrBeforeRoomFrame(roomFrameCount: int | null | undefined): boolean;
 /**
  * Helper function to check if the current game frame count is equal to or higher than a specific
  * game frame count.

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

@@ -1 +1 @@
-{"version":3,"file":"frames.d.ts","sourceRoot":"","sources":["../../../src/functions/frames.ts"],"names":[],"mappings":";AAEA,wBAAgB,yBAAyB,CAAC,cAAc,EAAE,GAAG,GAAG,GAAG,CAGlE;AAED,wBAAgB,2BAA2B,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,CAGtE;AAED,wBAAgB,yBAAyB,CAAC,cAAc,EAAE,GAAG,GAAG,GAAG,CAIlE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAO3E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAS3E"}
+{"version":3,"file":"frames.d.ts","sourceRoot":"","sources":["../../../src/functions/frames.ts"],"names":[],"mappings":";AAEA,wBAAgB,yBAAyB,CAAC,cAAc,EAAE,GAAG,GAAG,GAAG,CAGlE;AAED,wBAAgB,2BAA2B,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,CAGtE;AAED,wBAAgB,yBAAyB,CAAC,cAAc,EAAE,GAAG,GAAG,GAAG,CAIlE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAO3E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACrC,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,gBAAgB,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAS3E"}

package/dist/src/functions/frames.lua

@@ -14,6 +14,40 @@ function ____exports.getElapsedRoomFramesSince(self, roomFrameCount)
     local thisRoomFrameCount = room:GetFrameCount()
     return thisRoomFrameCount - roomFrameCount
 end
+--- Helper function to check if the current game frame count is lower than a specific game frame
+-- count.
+-- 
+-- This returns false if the submitted game frame count is null or undefined.
+function ____exports.isBeforeGameFrame(self, gameFrameCount)
+    if gameFrameCount == nil or gameFrameCount == nil then
+        return false
+    end
+    local thisGameFrameCount = game:GetFrameCount()
+    return thisGameFrameCount < gameFrameCount
+end
+--- Helper function to check if the current render frame count is lower than a specific render frame
+-- count.
+-- 
+-- This returns false if the submitted render frame count is null or undefined.
+function ____exports.isBeforeRenderFrame(self, renderFrameCount)
+    if renderFrameCount == nil or renderFrameCount == nil then
+        return false
+    end
+    local thisRenderFrameCount = Isaac.GetFrameCount()
+    return thisRenderFrameCount < renderFrameCount
+end
+--- Helper function to check if the current room frame count is lower than a specific room frame
+-- count.
+-- 
+-- This returns false if the submitted room frame count is null or undefined.
+function ____exports.isBeforeRoomFrame(self, roomFrameCount)
+    if roomFrameCount == nil or roomFrameCount == nil then
+        return false
+    end
+    local room = game:GetRoom()
+    local thisGameFrameCount = room:GetFrameCount()
+    return thisGameFrameCount < roomFrameCount
+end
 --- Helper function to check if the current game frame count is higher than a specific game frame
 -- count.
 -- 
@@ -34,7 +68,7 @@ function ____exports.isPastRenderFrame(self, renderFrameCount)
         return false
     end
     local thisRenderFrameCount = Isaac.GetFrameCount()
-    return thisRenderFrameCount >= renderFrameCount
+    return thisRenderFrameCount > renderFrameCount
 end
 --- Helper function to check if the current room frame count is higher than a specific room frame
 -- count.
@@ -59,6 +93,40 @@ function ____exports.onGameFrame(self, gameFrameCount)
     local thisGameFrameCount = game:GetFrameCount()
     return thisGameFrameCount == gameFrameCount
 end
+--- Helper function to check if the current game frame count is equal to or lower than a specific
+-- game frame count.
+-- 
+-- This returns false if the submitted game frame count is null or undefined.
+function ____exports.onOrBeforeGameFrame(self, gameFrameCount)
+    if gameFrameCount == nil or gameFrameCount == nil then
+        return false
+    end
+    local thisGameFrameCount = game:GetFrameCount()
+    return thisGameFrameCount <= gameFrameCount
+end
+--- Helper function to check if the current render frame count is equal to or lower than a specific
+-- render frame count.
+-- 
+-- This returns false if the submitted render frame count is null or undefined.
+function ____exports.onOrBeforeRenderFrame(self, renderFrameCount)
+    if renderFrameCount == nil or renderFrameCount == nil then
+        return false
+    end
+    local thisRenderFrameCount = Isaac.GetFrameCount()
+    return thisRenderFrameCount <= renderFrameCount
+end
+--- Helper function to check if the current room frame count is equal to or lower than a specific
+-- room frame count.
+-- 
+-- This returns false if the submitted room frame count is null or undefined.
+function ____exports.onOrBeforeRoomFrame(self, roomFrameCount)
+    if roomFrameCount == nil or roomFrameCount == nil then
+        return false
+    end
+    local room = game:GetRoom()
+    local thisGameFrameCount = room:GetFrameCount()
+    return thisGameFrameCount >= roomFrameCount
+end
 --- Helper function to check if the current game frame count is equal to or higher than a specific
 -- game frame count.
 -- 

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.7.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/classes/features/other/CustomTrapdoors.ts

@@ -22,6 +22,7 @@ import { StageTravelState } from "../../../enums/private/StageTravelState";
 import { TrapdoorAnimation } from "../../../enums/private/TrapdoorAnimation";
 import { easeOutSine } from "../../../functions/easing";
 import {
+  isBeforeRenderFrame,
   isPastRoomFrame,
   onOrPastRenderFrame,
 } from "../../../functions/frames";
@@ -224,7 +225,7 @@ export class CustomTrapdoors extends Feature {
 
     const renderFrameScreenBlack =
       v.run.stateRenderFrame + PIXELATION_TO_BLACK_FRAMES;
-    if (!onOrPastRenderFrame(renderFrameScreenBlack)) {
+    if (isBeforeRenderFrame(renderFrameScreenBlack)) {
       return;
     }
 
@@ -317,7 +318,7 @@ export class CustomTrapdoors extends Feature {
 
     const renderFrameScreenBlack =
       v.run.stateRenderFrame + PIXELATION_TO_BLACK_FRAMES;
-    if (!onOrPastRenderFrame(renderFrameScreenBlack)) {
+    if (isBeforeRenderFrame(renderFrameScreenBlack)) {
       return;
     }
 

package/src/classes/features/other/PickupIndexCreation.ts

@@ -7,7 +7,7 @@ import { game } from "../../../core/cachedClasses";
 import { Exported } from "../../../decorators";
 import { ISCFeature } from "../../../enums/ISCFeature";
 import { getEntityID } from "../../../functions/entities";
-import { isPastRoomFrame } from "../../../functions/frames";
+import { onOrBeforeRoomFrame } from "../../../functions/frames";
 import { getRoomListIndex } from "../../../functions/roomData";
 import { onAscent } from "../../../functions/stage";
 import { vectorEquals } from "../../../functions/vector";
@@ -97,7 +97,7 @@ export class PickupIndexCreation extends Feature {
     if (
       pickupIndexFromLevelData !== undefined &&
       !isFirstVisit &&
-      !isPastRoomFrame(0)
+      onOrBeforeRoomFrame(0)
     ) {
       v.room.pickupIndexes.set(ptrHash, pickupIndexFromLevelData);
       return;

package/src/functions/frames.ts

@@ -16,6 +16,59 @@ export function getElapsedRoomFramesSince(roomFrameCount: int): int {
   return thisRoomFrameCount - roomFrameCount;
 }
 
+/**
+ * Helper function to check if the current game frame count is lower than a specific game frame
+ * count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export function isBeforeGameFrame(
+  gameFrameCount: int | null | undefined,
+): boolean {
+  if (gameFrameCount === null || gameFrameCount === undefined) {
+    return false;
+  }
+
+  const thisGameFrameCount = game.GetFrameCount();
+  return thisGameFrameCount < gameFrameCount;
+}
+
+/**
+ * Helper function to check if the current render frame count is lower than a specific render frame
+ * count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export function isBeforeRenderFrame(
+  renderFrameCount: int | null | undefined,
+): boolean {
+  if (renderFrameCount === null || renderFrameCount === undefined) {
+    return false;
+  }
+
+  const thisRenderFrameCount = Isaac.GetFrameCount();
+  return thisRenderFrameCount < renderFrameCount;
+}
+
+/**
+ * Helper function to check if the current room frame count is lower than a specific room frame
+ * count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export function isBeforeRoomFrame(
+  roomFrameCount: int | null | undefined,
+): boolean {
+  if (roomFrameCount === null || roomFrameCount === undefined) {
+    return false;
+  }
+
+  const room = game.GetRoom();
+
+  const thisGameFrameCount = room.GetFrameCount();
+  return thisGameFrameCount < roomFrameCount;
+}
+
 /**
  * Helper function to check if the current game frame count is higher than a specific game frame
  * count.
@@ -47,7 +100,7 @@ export function isPastRenderFrame(
   }
 
   const thisRenderFrameCount = Isaac.GetFrameCount();
-  return thisRenderFrameCount >= renderFrameCount;
+  return thisRenderFrameCount > renderFrameCount;
 }
 
 /**
@@ -84,6 +137,59 @@ export function onGameFrame(gameFrameCount: int | null | undefined): boolean {
   return thisGameFrameCount === gameFrameCount;
 }
 
+/**
+ * Helper function to check if the current game frame count is equal to or lower than a specific
+ * game frame count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export function onOrBeforeGameFrame(
+  gameFrameCount: int | null | undefined,
+): boolean {
+  if (gameFrameCount === null || gameFrameCount === undefined) {
+    return false;
+  }
+
+  const thisGameFrameCount = game.GetFrameCount();
+  return thisGameFrameCount <= gameFrameCount;
+}
+
+/**
+ * Helper function to check if the current render frame count is equal to or lower than a specific
+ * render frame count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export function onOrBeforeRenderFrame(
+  renderFrameCount: int | null | undefined,
+): boolean {
+  if (renderFrameCount === null || renderFrameCount === undefined) {
+    return false;
+  }
+
+  const thisRenderFrameCount = Isaac.GetFrameCount();
+  return thisRenderFrameCount <= renderFrameCount;
+}
+
+/**
+ * Helper function to check if the current room frame count is equal to or lower than a specific
+ * room frame count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export function onOrBeforeRoomFrame(
+  roomFrameCount: int | null | undefined,
+): boolean {
+  if (roomFrameCount === null || roomFrameCount === undefined) {
+    return false;
+  }
+
+  const room = game.GetRoom();
+
+  const thisGameFrameCount = room.GetFrameCount();
+  return thisGameFrameCount >= roomFrameCount;
+}
+
 /**
  * Helper function to check if the current game frame count is equal to or higher than a specific
  * game frame count.

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,