isaacscript-common 37.0.1 → 37.1.0

package/dist/index.rollup.d.ts

@@ -7963,6 +7963,13 @@ export declare function inRange(num: int, start: int, end: int): boolean;
  */
 export declare function inRectangle(position: Vector, topLeft: Vector, bottomRight: Vector): boolean;
 
+/**
+ * Helper function to detect if the current room was created by the Red Key item.
+ *
+ * Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+ */
+export declare function inRedKeyRoom(): boolean;
+
 /**
  * Helper function to check if the current room shape matches one of the given room shapes.
  *
@@ -8936,12 +8943,13 @@ export declare function isRedHeart(pickup: EntityPickup): boolean;
 export declare function isRedHeartSubType(heartSubType: HeartSubType): boolean;
 
 /**
- * Helper function to detect if the provided room was created by the Red Key item. Under the hood,
- * this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+ * Helper function to detect if the provided room was created by the Red Key item.
+ *
+ * Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
  *
  * @param roomGridIndex Optional. Default is the current room index.
  */
-export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
+export declare function isRedKeyRoom(roomGridIndex: int): boolean;
 
 /**
  * Helper function to see if the current render callback is rendering a water reflection.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 37.0.1
+isaacscript-common 37.1.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -48282,6 +48282,10 @@ function ____exports.isDeadEnd(self, roomGridIndex)
     local adjacentExistingRoomGridIndexes = ____exports.getAdjacentExistingRoomGridIndexes(nil, roomGridIndex)
     return #adjacentExistingRoomGridIndexes == 1
 end
+function ____exports.isRedKeyRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+end
 function ____exports.isRoomInsideGrid(self, roomGridIndex)
     if roomGridIndex == nil then
         roomGridIndex = getRoomGridIndex(nil)
@@ -48351,6 +48355,10 @@ function ____exports.getRoomGridIndexesForType(self, ...)
         function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
     )
 end
+function ____exports.inRedKeyRoom(self)
+    local gridIndex = getRoomGridIndex(nil)
+    return ____exports.isRedKeyRoom(nil, gridIndex)
+end
 function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
     local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
     return allowedDoors:has(doorSlot)
@@ -48371,10 +48379,6 @@ function ____exports.isDoorSlotValidAtGridIndexForRedRoom(self, doorSlot, roomGr
     local redRoomGridIndex = roomGridIndex + delta
     return not ____exports.roomExists(nil, redRoomGridIndex) and ____exports.isRoomInsideGrid(nil, redRoomGridIndex)
 end
-function ____exports.isRedKeyRoom(self, roomGridIndex)
-    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
-    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
-end
 function ____exports.newRoom(self, seedOrRNG, ensureDeadEnd, customRoomData)
     if ensureDeadEnd == nil then
         ensureDeadEnd = true

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

@@ -153,6 +153,12 @@ export declare function getRoomShapeAdjacentGridIndexes(safeRoomGridIndex: int,
  * that function for more information.
  */
 export declare function getRoomShapeAdjacentNonExistingGridIndexes(safeRoomGridIndex: int, roomShape: RoomShape): ReadonlyMap<DoorSlot, int>;
+/**
+ * Helper function to detect if the current room was created by the Red Key item.
+ *
+ * Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+ */
+export declare function inRedKeyRoom(): boolean;
 /**
  * Helper function to check if the given room grid index is a dead end. Specifically, this is
  * defined as having only one adjacent room that exists.
@@ -169,12 +175,13 @@ export declare function isDeadEnd(roomGridIndex?: int): boolean;
 export declare function isDoorSlotValidAtGridIndex(doorSlot: DoorSlot, roomGridIndex: int): boolean;
 export declare function isDoorSlotValidAtGridIndexForRedRoom(doorSlot: DoorSlot, roomGridIndex: int): boolean;
 /**
- * Helper function to detect if the provided room was created by the Red Key item. Under the hood,
- * this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+ * Helper function to detect if the provided room was created by the Red Key item.
+ *
+ * Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
  *
  * @param roomGridIndex Optional. Default is the current room index.
  */
-export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
+export declare function isRedKeyRoom(roomGridIndex: int): boolean;
 /**
  * Helper function to determine if a given room grid index is inside of the normal 13x13 level grid.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAIL,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAoCtC;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAChD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,CACnD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAchB;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,SAAS,GAAG,EAAE,CAGtD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,aAAa,UAAO,GAElB;IACE,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,GACD,SAAS,CAOZ;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,EACnB,aAAa,UAAO,GACnB,aAAa,CAAC;IAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAA;CAAE,CAAC,CAiD7E;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAC1C,aAAa,UAAO,GACnB,aAAa,CAAC;IACf,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,CAAC,CAoCD;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAgB5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,cAAc,EAAE,CASlB;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,SAAS,GAAG,EAAE,CAGhB;AAED;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAE5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,CACxD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAKtD;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAGT;AAED,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAqBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM7D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,OAAO,CACrB,SAAS,CAAC,EAAE,IAAI,GAAG,GAAG,EACtB,aAAa,UAAO,EACpB,cAAc,CAAC,EAAE,UAAU,GAC1B,GAAG,GAAG,SAAS,CAuDjB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,CAK1E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAE7D"}
+{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAIL,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAoCtC;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAChD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,CACnD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAchB;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,SAAS,GAAG,EAAE,CAGtD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,aAAa,UAAO,GAElB;IACE,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,GACD,SAAS,CAOZ;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,EACnB,aAAa,UAAO,GACnB,aAAa,CAAC;IAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAA;CAAE,CAAC,CAiD7E;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAC1C,aAAa,UAAO,GACnB,aAAa,CAAC;IACf,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,CAAC,CAoCD;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAgB5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,cAAc,EAAE,CASlB;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,SAAS,GAAG,EAAE,CAGhB;AAED;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAE5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,CACxD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAKtD;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAGT;AAED,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAqBT;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGxD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM7D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,OAAO,CACrB,SAAS,CAAC,EAAE,IAAI,GAAG,GAAG,EACtB,aAAa,UAAO,EACpB,cAAc,CAAC,EAAE,UAAU,GAC1B,GAAG,GAAG,SAAS,CAuDjB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,CAK1E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAE7D"}

package/dist/src/functions/levelGrid.lua

@@ -236,6 +236,15 @@ function ____exports.isDeadEnd(self, roomGridIndex)
     local adjacentExistingRoomGridIndexes = ____exports.getAdjacentExistingRoomGridIndexes(nil, roomGridIndex)
     return #adjacentExistingRoomGridIndexes == 1
 end
+--- Helper function to detect if the provided room was created by the Red Key item.
+-- 
+-- Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isRedKeyRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+end
 --- Helper function to determine if a given room grid index is inside of the normal 13x13 level grid.
 -- 
 -- For example, Devil Rooms and the Mega Satan room are not considered to be inside the grid.
@@ -351,6 +360,13 @@ function ____exports.getRoomGridIndexesForType(self, ...)
         function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
     )
 end
+--- Helper function to detect if the current room was created by the Red Key item.
+-- 
+-- Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+function ____exports.inRedKeyRoom(self)
+    local gridIndex = getRoomGridIndex(nil)
+    return ____exports.isRedKeyRoom(nil, gridIndex)
+end
 function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
     local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
     return allowedDoors:has(doorSlot)
@@ -371,14 +387,6 @@ function ____exports.isDoorSlotValidAtGridIndexForRedRoom(self, doorSlot, roomGr
     local redRoomGridIndex = roomGridIndex + delta
     return not ____exports.roomExists(nil, redRoomGridIndex) and ____exports.isRoomInsideGrid(nil, redRoomGridIndex)
 end
---- Helper function to detect if the provided room was created by the Red Key item. Under the hood,
--- this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.isRedKeyRoom(self, roomGridIndex)
-    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
-    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
-end
 --- Helper function to generate a new room on the floor.
 -- 
 -- Under the hood, this function uses the `Level.MakeRedRoomDoor` method to create the room.

package/package.json

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

package/src/functions/levelGrid.ts

@@ -426,6 +426,16 @@ export function getRoomShapeAdjacentNonExistingGridIndexes(
   return roomShapeAdjacentGridIndexes;
 }
 
+/**
+ * Helper function to detect if the current room was created by the Red Key item.
+ *
+ * Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+ */
+export function inRedKeyRoom(): boolean {
+  const gridIndex = getRoomGridIndex();
+  return isRedKeyRoom(gridIndex);
+}
+
 /**
  * Helper function to check if the given room grid index is a dead end. Specifically, this is
  * defined as having only one adjacent room that exists.
@@ -480,12 +490,13 @@ export function isDoorSlotValidAtGridIndexForRedRoom(
 }
 
 /**
- * Helper function to detect if the provided room was created by the Red Key item. Under the hood,
- * this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+ * Helper function to detect if the provided room was created by the Red Key item.
+ *
+ * Under the hood, this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
  *
  * @param roomGridIndex Optional. Default is the current room index.
  */
-export function isRedKeyRoom(roomGridIndex?: int): boolean {
+export function isRedKeyRoom(roomGridIndex: int): boolean {
   const roomDescriptor = getRoomDescriptor(roomGridIndex);
   return hasFlag(roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM);
 }