isaacscript-common 39.2.2 → 39.3.0

package/dist/index.rollup.d.ts

@@ -4775,7 +4775,7 @@ export declare function getBatteries(batterySubType?: BatterySubType | -1): Enti
 
 /**
  * Helper function to get the door that leads to the off-grid room that contains the hole to the
- * Blue Womb.
+ * Blue Womb. (In vanilla, the door will only appear in the It Lives Boss Room.)
  *
  * Returns undefined if the room has no Blue Womb doors.
  */
@@ -7494,6 +7494,14 @@ export declare function getVanillaTrinketTypeRange(): TrinketType[];
  */
 export declare function getVisibleHearts(player: EntityPlayer): int;
 
+/**
+ * Helper function to get the door that leads to the off-grid room that contains the portal to The
+ * Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+ *
+ * Returns undefined if the room has no Void doors.
+ */
+export declare function getVoidDoor(): GridEntityDoor | undefined;
+
 /**
  * Helper function to restore the player's trinkets back to the way they were before the
  * `temporarilyRemoveTrinket` function was used. It will re-smelt any smelted trinkets that were
@@ -8217,6 +8225,11 @@ export declare function isBitSet128(object: unknown): object is BitSet128;
  */
 export declare function isBlindCollectible(collectible: EntityPickup): boolean;
 
+/**
+ * Helper function to check if the provided door is the one that leads to the off-grid room that
+ * contains the hole to the Blue Womb. (In vanilla, the door will only appear in the It Lives Boss
+ * Room.)
+ */
 export declare function isBlueWombDoor(door: GridEntityDoor): boolean;
 
 /** Helper function to detect if a variable is of type `EntityBomb`. */
@@ -9355,6 +9368,12 @@ export declare function isVanillaWallGridIndex(gridIndex: int): boolean;
 /** Helper function to check if something is an instantiated `Vector` object. */
 export declare function isVector(object: unknown): object is Vector;
 
+/**
+ * Helper function to check if the provided door is the one that leads to the off-grid room that
+ * contains the portal to The Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+ */
+export declare function isVoidDoor(door: GridEntityDoor): boolean;
+
 /**
  * A cached version of the class returned from the `Isaac.GetItemConfig()` constructor.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 39.2.2
+isaacscript-common 39.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -23077,6 +23077,9 @@ function ____exports.isSecretRoomDoor(self, door)
     local fileName = sprite:GetFilename()
     return string.lower(fileName) == "gfx/grid/door_08_holeinwall.anm2"
 end
+function ____exports.isVoidDoor(self, door)
+    return door.TargetRoomIndex == asNumber(nil, GridRoom.THE_VOID)
+end
 function ____exports.removeDoor(self, door)
     local room = game:GetRoom()
     room:RemoveDoor(door.Slot)
@@ -23212,6 +23215,13 @@ function ____exports.getUnusedDoorSlots(self)
         function(____, doorSlot) return doorSlot ~= DoorSlot.NO_DOOR_SLOT and room:IsDoorSlotAllowed(doorSlot) and room:GetDoor(doorSlot) == nil end
     )
 end
+function ____exports.getVoidDoor(self)
+    local doors = ____exports.getDoors(nil)
+    return __TS__ArrayFind(
+        doors,
+        function(____, door) return ____exports.isVoidDoor(nil, door) end
+    )
+end
 function ____exports.hasDoorType(self, ...)
     local roomTypes = {...}
     local doors = ____exports.getDoors(nil)

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

@@ -18,7 +18,7 @@ export declare function doorSlotsToDoorSlotFlags(doorSlots: DoorSlot[] | readonl
 export declare function getAngelRoomDoor(): GridEntityDoor | undefined;
 /**
  * Helper function to get the door that leads to the off-grid room that contains the hole to the
- * Blue Womb.
+ * Blue Womb. (In vanilla, the door will only appear in the It Lives Boss Room.)
  *
  * Returns undefined if the room has no Blue Womb doors.
  */
@@ -94,6 +94,13 @@ export declare function getRoomShapeDoorSlotCoordinates(roomShape: RoomShape, do
  * doors.
  */
 export declare function getUnusedDoorSlots(): DoorSlot[];
+/**
+ * Helper function to get the door that leads to the off-grid room that contains the portal to The
+ * Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+ *
+ * Returns undefined if the room has no Void doors.
+ */
+export declare function getVoidDoor(): GridEntityDoor | undefined;
 /**
  * Helper function to check if the current room has one or more doors that lead to the given room
  * type.
@@ -108,6 +115,11 @@ export declare function hasDoorType(...roomTypes: RoomType[]): boolean;
  */
 export declare function hasUnusedDoorSlot(): boolean;
 export declare function isAngelRoomDoor(door: GridEntityDoor): boolean;
+/**
+ * Helper function to check if the provided door is the one that leads to the off-grid room that
+ * contains the hole to the Blue Womb. (In vanilla, the door will only appear in the It Lives Boss
+ * Room.)
+ */
 export declare function isBlueWombDoor(door: GridEntityDoor): boolean;
 export declare function isDevilRoomDoor(door: GridEntityDoor): boolean;
 /** Helper function to see if a door slot could exist for a given room shape. */
@@ -152,6 +164,11 @@ export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
  * Secret Room door.
  */
 export declare function isSecretRoomDoor(door: GridEntityDoor): boolean;
+/**
+ * Helper function to check if the provided door is the one that leads to the off-grid room that
+ * contains the portal to The Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+ */
+export declare function isVoidDoor(door: GridEntityDoor): boolean;
 /**
  * Helper function to reset an unlocked door back to a locked state. Doing this is non-trivial
  * because in addition to calling the `GridEntityDoor.SetLocked` method, you must also:

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

@@ -1 +1 @@
-{"version":3,"file":"doors.d.ts","sourceRoot":"","sources":["../../../src/functions/doors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,YAAY,EACZ,SAAS,EACV,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,QAAQ,EAKR,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAuBtC,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAKxD;AAED,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,QAAQ,CAG3E;AAED,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,QAAQ,CAAC,YAAY,CAAC,GACpC,QAAQ,EAAE,CAWZ;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAEjE;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY,CAEvE;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EACL,QAAQ,EAAE,GACV,SAAS,QAAQ,EAAE,GACnB,GAAG,CAAC,QAAQ,CAAC,GACb,WAAW,CAAC,QAAQ,CAAC,GACxB,QAAQ,CAAC,YAAY,CAAC,CASxB;AAED,wBAAgB,gBAAgB,IAAI,cAAc,GAAG,SAAS,CAG7D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,cAAc,GAAG,SAAS,CAG5D;AAED,wBAAgB,gBAAgB,IAAI,cAAc,GAAG,SAAS,CAG7D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,cAAc,GAAG,SAAS,CAKxE;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,CAG3E;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAK7E;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,MAAM,CAAC,CAQlB;AAED,4FAA4F;AAC5F,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,CAAC,CAEvB;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,cAAc,EAAE,CA4BnE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,aAAa,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,CAI7E;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAE5E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,cAAc,GAAG,SAAS,CAG9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,SAAS,EACpB,CAAC,EAAE,GAAG,EACN,CAAC,EAAE,GAAG,GACL,QAAQ,GAAG,SAAS,CAiBtB;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,GACjB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,SAAS,CAMvC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,EAAE,CAU/C;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAM7D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAG3C;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE7D;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE5D;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE7D;AAED,gFAAgF;AAChF,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,SAAS,GACnB,OAAO,CAGT;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU9D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU/D;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAUrE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU3D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU/D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAKpE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE9D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAM9D;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAUnD;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAKvD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,CAK5D;AAED,+CAA+C;AAC/C,wBAAgB,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAGrD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,KAAK,EAAE,cAAc,EAAE,GAAG,IAAI,CAI5D"}
+{"version":3,"file":"doors.d.ts","sourceRoot":"","sources":["../../../src/functions/doors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,YAAY,EACZ,SAAS,EACV,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,QAAQ,EAKR,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAuBtC,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAKxD;AAED,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,QAAQ,CAG3E;AAED,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,QAAQ,CAAC,YAAY,CAAC,GACpC,QAAQ,EAAE,CAWZ;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAEjE;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY,CAEvE;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EACL,QAAQ,EAAE,GACV,SAAS,QAAQ,EAAE,GACnB,GAAG,CAAC,QAAQ,CAAC,GACb,WAAW,CAAC,QAAQ,CAAC,GACxB,QAAQ,CAAC,YAAY,CAAC,CASxB;AAED,wBAAgB,gBAAgB,IAAI,cAAc,GAAG,SAAS,CAG7D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,cAAc,GAAG,SAAS,CAG5D;AAED,wBAAgB,gBAAgB,IAAI,cAAc,GAAG,SAAS,CAG7D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,cAAc,GAAG,SAAS,CAKxE;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,CAG3E;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAK7E;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,MAAM,CAAC,CAQlB;AAED,4FAA4F;AAC5F,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,CAAC,CAEvB;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,cAAc,EAAE,CA4BnE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,aAAa,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,CAI7E;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAE5E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,cAAc,GAAG,SAAS,CAG9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,SAAS,EACpB,CAAC,EAAE,GAAG,EACN,CAAC,EAAE,GAAG,GACL,QAAQ,GAAG,SAAS,CAiBtB;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,GACjB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,SAAS,CAMvC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,EAAE,CAU/C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,IAAI,cAAc,GAAG,SAAS,CAGxD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAM7D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAG3C;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE5D;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE7D;AAED,gFAAgF;AAChF,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,SAAS,GACnB,OAAO,CAGT;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU9D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU/D;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAUrE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU3D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAU/D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAKpE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAE9D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAM9D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAExD;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAUnD;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAKvD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,CAK5D;AAED,+CAA+C;AAC/C,wBAAgB,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAGrD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,KAAK,EAAE,cAAc,EAAE,GAAG,IAAI,CAI5D"}

package/dist/src/functions/doors.lua

@@ -97,6 +97,9 @@ function ____exports.getDoors(self, ...)
     end
     return doors
 end
+--- Helper function to check if the provided door is the one that leads to the off-grid room that
+-- contains the hole to the Blue Womb. (In vanilla, the door will only appear in the It Lives Boss
+-- Room.)
 function ____exports.isBlueWombDoor(self, door)
     return door.TargetRoomIndex == asNumber(nil, GridRoom.BLUE_WOMB)
 end
@@ -116,6 +119,11 @@ function ____exports.isSecretRoomDoor(self, door)
     local fileName = sprite:GetFilename()
     return string.lower(fileName) == "gfx/grid/door_08_holeinwall.anm2"
 end
+--- Helper function to check if the provided door is the one that leads to the off-grid room that
+-- contains the portal to The Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+function ____exports.isVoidDoor(self, door)
+    return door.TargetRoomIndex == asNumber(nil, GridRoom.THE_VOID)
+end
 --- Helper function to remove a single door.
 function ____exports.removeDoor(self, door)
     local room = game:GetRoom()
@@ -180,7 +188,7 @@ function ____exports.getAngelRoomDoor(self)
     return ____temp_0
 end
 --- Helper function to get the door that leads to the off-grid room that contains the hole to the
--- Blue Womb.
+-- Blue Womb. (In vanilla, the door will only appear in the It Lives Boss Room.)
 -- 
 -- Returns undefined if the room has no Blue Womb doors.
 function ____exports.getBlueWombDoor(self)
@@ -289,6 +297,17 @@ function ____exports.getUnusedDoorSlots(self)
         function(____, doorSlot) return doorSlot ~= DoorSlot.NO_DOOR_SLOT and room:IsDoorSlotAllowed(doorSlot) and room:GetDoor(doorSlot) == nil end
     )
 end
+--- Helper function to get the door that leads to the off-grid room that contains the portal to The
+-- Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+-- 
+-- Returns undefined if the room has no Void doors.
+function ____exports.getVoidDoor(self)
+    local doors = ____exports.getDoors(nil)
+    return __TS__ArrayFind(
+        doors,
+        function(____, door) return ____exports.isVoidDoor(nil, door) end
+    )
+end
 --- Helper function to check if the current room has one or more doors that lead to the given room
 -- type.
 -- 

package/package.json

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

package/src/functions/doors.ts

@@ -106,7 +106,7 @@ export function getAngelRoomDoor(): GridEntityDoor | undefined {
 
 /**
  * Helper function to get the door that leads to the off-grid room that contains the hole to the
- * Blue Womb.
+ * Blue Womb. (In vanilla, the door will only appear in the It Lives Boss Room.)
  *
  * Returns undefined if the room has no Blue Womb doors.
  */
@@ -306,6 +306,17 @@ export function getUnusedDoorSlots(): DoorSlot[] {
   );
 }
 
+/**
+ * Helper function to get the door that leads to the off-grid room that contains the portal to The
+ * Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+ *
+ * Returns undefined if the room has no Void doors.
+ */
+export function getVoidDoor(): GridEntityDoor | undefined {
+  const doors = getDoors();
+  return doors.find((door) => isVoidDoor(door));
+}
+
 /**
  * Helper function to check if the current room has one or more doors that lead to the given room
  * type.
@@ -334,6 +345,11 @@ export function isAngelRoomDoor(door: GridEntityDoor): boolean {
   return door.TargetRoomType === RoomType.ANGEL;
 }
 
+/**
+ * Helper function to check if the provided door is the one that leads to the off-grid room that
+ * contains the hole to the Blue Womb. (In vanilla, the door will only appear in the It Lives Boss
+ * Room.)
+ */
 export function isBlueWombDoor(door: GridEntityDoor): boolean {
   return door.TargetRoomIndex === asNumber(GridRoom.BLUE_WOMB);
 }
@@ -462,6 +478,14 @@ export function isSecretRoomDoor(door: GridEntityDoor): boolean {
   return fileName.toLowerCase() === "gfx/grid/door_08_holeinwall.anm2"; // cspell:ignore holeinwall
 }
 
+/**
+ * Helper function to check if the provided door is the one that leads to the off-grid room that
+ * contains the portal to The Void. (In vanilla, the door will only appear in the Hush Boss Room.)
+ */
+export function isVoidDoor(door: GridEntityDoor): boolean {
+  return door.TargetRoomIndex === asNumber(GridRoom.THE_VOID);
+}
+
 /**
  * Helper function to reset an unlocked door back to a locked state. Doing this is non-trivial
  * because in addition to calling the `GridEntityDoor.SetLocked` method, you must also: