isaacscript-common 33.12.1 → 33.13.0

package/dist/index.rollup.d.ts

@@ -4292,7 +4292,7 @@ declare abstract class Feature {
     constructor();
 }
 
-/** Helper function to fill every possible square with a red room. */
+/** Helper function to fill every possible level grid square with a red room. */
 export declare function fillLevelWithRedRooms(): void;
 
 /**
@@ -5724,6 +5724,15 @@ export declare function getLastElement<T>(array: T[]): T | undefined;
  */
 export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: string): int;
 
+/**
+ * Helper function to get the boss IDs of all of the Boss Rooms on this floor. (This is equivalent
+ * to the sub-type of the room data.)
+ *
+ * Note that this will only look at Boss Rooms inside of the grid, so e.g. Reverse Emperor card
+ * rooms will not count.
+ */
+export declare function getLevelBossIDs(): BossID[];
+
 /**
  * Helper function to get the lowest value in an array. Returns undefined if there were no elements
  * in the array.
@@ -6672,7 +6681,7 @@ export declare function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor>;
  * Helper function to get an array of all of the room descriptors for rooms that match the specified
  * room type.
  *
- * This function only searches through rooms in the current dimension.
+ * This function only searches through rooms in the current dimension and rooms inside the grid.
  *
  * This function is variadic, meaning that you can specify N arguments to get the combined room
  * descriptors for N room types.
@@ -9498,6 +9507,14 @@ export declare const LEVEL_GRID_COLUMN_HEIGHT = 13;
  */
 export declare const LEVEL_GRID_ROW_WIDTH = 13;
 
+/**
+ * Helper function to check if the current floor has a Boss Room that matches the boss ID provided.
+ *
+ * This function is variadic, meaning that you can pass as many boss IDs as you want to check for.
+ * It will return true if one or more of the boss IDs are matched.
+ */
+export declare function levelHasBossID(...bossIDs: BossID[]): boolean;
+
 /**
  * Helper function to check to see if the current floor has one or more of a specific room type in
  * it.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 33.12.1
+isaacscript-common 33.13.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -27737,8 +27737,8 @@ function ____exports.changeRoom(self, roomGridIndex)
     game:ChangeRoom(roomGridIndex)
 end
 function ____exports.getNumRooms(self)
-    local rooms = ____exports.getRoomsInsideGrid(nil)
-    return #rooms
+    local roomsInsideGrid = ____exports.getRoomsInsideGrid(nil)
+    return #roomsInsideGrid
 end
 function ____exports.getRoomDataForTypeVariant(self, roomType, roomVariant, cancelRoomTransition, useSpecialRoomsForRoomTypeDefault)
     if cancelRoomTransition == nil then
@@ -27879,14 +27879,14 @@ function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes, includeSecretAndS
     if includeUltraSecretRoom == nil then
         includeUltraSecretRoom = false
     end
-    local rooms = ____exports.getRoomsInsideGrid(nil)
+    local roomsInsideGrid = ____exports.getRoomsInsideGrid(nil)
     local matchingRooms
     if onlyCheckRoomTypes == nil then
-        matchingRooms = rooms
+        matchingRooms = roomsInsideGrid
     else
         local roomTypeWhitelist = __TS__New(ReadonlySet, onlyCheckRoomTypes)
         matchingRooms = __TS__ArrayFilter(
-            rooms,
+            roomsInsideGrid,
             function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypeWhitelist:has(roomDescriptor.Data.Type) end
         )
     end
@@ -48156,12 +48156,12 @@ function ____exports.getNewRoomCandidatesForLevel(self, ensureDeadEnd)
     if ensureDeadEnd == nil then
         ensureDeadEnd = true
     end
-    local rooms = getRoomsInsideGrid(nil)
+    local roomsInsideGrid = getRoomsInsideGrid(nil)
     local normalRooms = __TS__ArrayFilter(
-        rooms,
+        roomsInsideGrid,
         function(____, room) return room.Data ~= nil and room.Data.Type == RoomType.DEFAULT and not isMirrorRoom(nil, room.Data) and not isMineShaft(nil, room.Data) end
     )
-    local roomsToLookThrough = ensureDeadEnd and normalRooms or rooms
+    local roomsToLookThrough = ensureDeadEnd and normalRooms or roomsInsideGrid
     local newRoomCandidates = {}
     for ____, room in ipairs(roomsToLookThrough) do
         local newRoomCandidatesBesideRoom = ____exports.getNewRoomCandidatesBesideRoom(nil, room.SafeGridIndex, ensureDeadEnd)
@@ -48279,9 +48279,9 @@ end
 function ____exports.getRoomDescriptorsForType(self, ...)
     local roomTypes = {...}
     local roomTypesSet = __TS__New(Set, roomTypes)
-    local rooms = getRoomsInsideGrid(nil)
+    local roomsInsideGrid = getRoomsInsideGrid(nil)
     return __TS__ArrayFilter(
-        rooms,
+        roomsInsideGrid,
         function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypesSet:has(roomDescriptor.Data.Type) end
     )
 end
@@ -53740,11 +53740,20 @@ end
 return ____exports
  end,
 ["src.functions.level"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local StageID = ____isaac_2Dtypescript_2Ddefinitions.StageID
 local ____cachedEnumValues = require("src.arrays.cachedEnumValues")
 local DOOR_SLOT_VALUES = ____cachedEnumValues.DOOR_SLOT_VALUES
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
+local ____array = require("src.functions.array")
+local filterMap = ____array.filterMap
 local ____levelGrid = require("src.functions.levelGrid")
 local getRoomDescriptorsForType = ____levelGrid.getRoomDescriptorsForType
 local isDoorSlotValidAtGridIndexForRedRoom = ____levelGrid.isDoorSlotValidAtGridIndexForRedRoom
@@ -53768,6 +53777,23 @@ function ____exports.fillLevelWithRedRooms(self)
         end
     until not (numRoomsInGrid ~= getNumRooms(nil))
 end
+function ____exports.getLevelBossIDs(self)
+    local roomsInsideGrid = getRoomsInsideGrid(nil)
+    return filterMap(
+        nil,
+        roomsInsideGrid,
+        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomDescriptor.Data.Type == RoomType.BOSS and roomDescriptor.Data.StageID == StageID.SPECIAL_ROOMS and roomDescriptor.Data.Subtype or nil end
+    )
+end
+function ____exports.levelHasBossID(self, ...)
+    local bossIDs = {...}
+    local levelBossIDs = ____exports.getLevelBossIDs(nil)
+    local levelBossIDsSet = __TS__New(Set, levelBossIDs)
+    return __TS__ArraySome(
+        bossIDs,
+        function(____, bossID) return levelBossIDsSet:has(bossID) end
+    )
+end
 function ____exports.levelHasRoomType(self, ...)
     local roomDescriptors = getRoomDescriptorsForType(nil, ...)
     return #roomDescriptors > 0

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

@@ -1,6 +1,22 @@
-import type { RoomType } from "isaac-typescript-definitions";
-/** Helper function to fill every possible square with a red room. */
+import type { BossID } from "isaac-typescript-definitions";
+import { RoomType } from "isaac-typescript-definitions";
+/** Helper function to fill every possible level grid square with a red room. */
 export declare function fillLevelWithRedRooms(): void;
+/**
+ * Helper function to get the boss IDs of all of the Boss Rooms on this floor. (This is equivalent
+ * to the sub-type of the room data.)
+ *
+ * Note that this will only look at Boss Rooms inside of the grid, so e.g. Reverse Emperor card
+ * rooms will not count.
+ */
+export declare function getLevelBossIDs(): BossID[];
+/**
+ * Helper function to check if the current floor has a Boss Room that matches the boss ID provided.
+ *
+ * This function is variadic, meaning that you can pass as many boss IDs as you want to check for.
+ * It will return true if one or more of the boss IDs are matched.
+ */
+export declare function levelHasBossID(...bossIDs: BossID[]): boolean;
 /**
  * Helper function to check to see if the current floor has one or more of a specific room type in
  * it.

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

@@ -1 +1 @@
-{"version":3,"file":"level.d.ts","sourceRoot":"","sources":["../../../src/functions/level.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAS7D,qEAAqE;AACrE,wBAAgB,qBAAqB,IAAI,IAAI,CAqB5C;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAGlE"}
+{"version":3,"file":"level.d.ts","sourceRoot":"","sources":["../../../src/functions/level.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAW,MAAM,8BAA8B,CAAC;AAUjE,gFAAgF;AAChF,wBAAgB,qBAAqB,IAAI,IAAI,CAqB5C;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,IAAI,MAAM,EAAE,CAU1C;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAK5D;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAGlE"}

package/dist/src/functions/level.lua

@@ -1,15 +1,24 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local StageID = ____isaac_2Dtypescript_2Ddefinitions.StageID
 local ____cachedEnumValues = require("src.arrays.cachedEnumValues")
 local DOOR_SLOT_VALUES = ____cachedEnumValues.DOOR_SLOT_VALUES
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
+local ____array = require("src.functions.array")
+local filterMap = ____array.filterMap
 local ____levelGrid = require("src.functions.levelGrid")
 local getRoomDescriptorsForType = ____levelGrid.getRoomDescriptorsForType
 local isDoorSlotValidAtGridIndexForRedRoom = ____levelGrid.isDoorSlotValidAtGridIndexForRedRoom
 local ____rooms = require("src.functions.rooms")
 local getNumRooms = ____rooms.getNumRooms
 local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
---- Helper function to fill every possible square with a red room.
+--- Helper function to fill every possible level grid square with a red room.
 function ____exports.fillLevelWithRedRooms(self)
     local level = game:GetLevel()
     local numRoomsInGrid
@@ -27,6 +36,32 @@ function ____exports.fillLevelWithRedRooms(self)
         end
     until not (numRoomsInGrid ~= getNumRooms(nil))
 end
+--- Helper function to get the boss IDs of all of the Boss Rooms on this floor. (This is equivalent
+-- to the sub-type of the room data.)
+-- 
+-- Note that this will only look at Boss Rooms inside of the grid, so e.g. Reverse Emperor card
+-- rooms will not count.
+function ____exports.getLevelBossIDs(self)
+    local roomsInsideGrid = getRoomsInsideGrid(nil)
+    return filterMap(
+        nil,
+        roomsInsideGrid,
+        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomDescriptor.Data.Type == RoomType.BOSS and roomDescriptor.Data.StageID == StageID.SPECIAL_ROOMS and roomDescriptor.Data.Subtype or nil end
+    )
+end
+--- Helper function to check if the current floor has a Boss Room that matches the boss ID provided.
+-- 
+-- This function is variadic, meaning that you can pass as many boss IDs as you want to check for.
+-- It will return true if one or more of the boss IDs are matched.
+function ____exports.levelHasBossID(self, ...)
+    local bossIDs = {...}
+    local levelBossIDs = ____exports.getLevelBossIDs(nil)
+    local levelBossIDsSet = __TS__New(Set, levelBossIDs)
+    return __TS__ArraySome(
+        bossIDs,
+        function(____, bossID) return levelBossIDsSet:has(bossID) end
+    )
+end
 --- Helper function to check to see if the current floor has one or more of a specific room type in
 -- it.
 -- 

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

@@ -102,7 +102,7 @@ export declare function getRoomAdjacentGridIndexes(roomGridIndex?: int): Readonl
  * Helper function to get an array of all of the room descriptors for rooms that match the specified
  * room type.
  *
- * This function only searches through rooms in the current dimension.
+ * This function only searches through rooms in the current dimension and rooms inside the grid.
  *
  * This function is variadic, meaning that you can specify N arguments to get the combined room
  * descriptors for N room types.

package/dist/src/functions/levelGrid.lua

@@ -136,12 +136,12 @@ function ____exports.getNewRoomCandidatesForLevel(self, ensureDeadEnd)
     if ensureDeadEnd == nil then
         ensureDeadEnd = true
     end
-    local rooms = getRoomsInsideGrid(nil)
+    local roomsInsideGrid = getRoomsInsideGrid(nil)
     local normalRooms = __TS__ArrayFilter(
-        rooms,
+        roomsInsideGrid,
         function(____, room) return room.Data ~= nil and room.Data.Type == RoomType.DEFAULT and not isMirrorRoom(nil, room.Data) and not isMineShaft(nil, room.Data) end
     )
-    local roomsToLookThrough = ensureDeadEnd and normalRooms or rooms
+    local roomsToLookThrough = ensureDeadEnd and normalRooms or roomsInsideGrid
     local newRoomCandidates = {}
     for ____, room in ipairs(roomsToLookThrough) do
         local newRoomCandidatesBesideRoom = ____exports.getNewRoomCandidatesBesideRoom(nil, room.SafeGridIndex, ensureDeadEnd)
@@ -324,16 +324,16 @@ end
 --- Helper function to get an array of all of the room descriptors for rooms that match the specified
 -- room type.
 -- 
--- This function only searches through rooms in the current dimension.
+-- This function only searches through rooms in the current dimension and rooms inside the grid.
 -- 
 -- This function is variadic, meaning that you can specify N arguments to get the combined room
 -- descriptors for N room types.
 function ____exports.getRoomDescriptorsForType(self, ...)
     local roomTypes = {...}
     local roomTypesSet = __TS__New(Set, roomTypes)
-    local rooms = getRoomsInsideGrid(nil)
+    local roomsInsideGrid = getRoomsInsideGrid(nil)
     return __TS__ArrayFilter(
-        rooms,
+        roomsInsideGrid,
         function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypesSet:has(roomDescriptor.Data.Type) end
     )
 end

package/dist/src/functions/rooms.lua

@@ -259,8 +259,8 @@ end
 --- Helper function to get the number of rooms that are currently on the floor layout. This does not
 -- include off-grid rooms, like the Devil Room.
 function ____exports.getNumRooms(self)
-    local rooms = ____exports.getRoomsInsideGrid(nil)
-    return #rooms
+    local roomsInsideGrid = ____exports.getRoomsInsideGrid(nil)
+    return #roomsInsideGrid
 end
 --- Helper function to get the room data for a specific room type and variant combination. This is
 -- accomplished by using the "goto" console command to load the specified room into the
@@ -507,14 +507,14 @@ function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes, includeSecretAndS
     if includeUltraSecretRoom == nil then
         includeUltraSecretRoom = false
     end
-    local rooms = ____exports.getRoomsInsideGrid(nil)
+    local roomsInsideGrid = ____exports.getRoomsInsideGrid(nil)
     local matchingRooms
     if onlyCheckRoomTypes == nil then
-        matchingRooms = rooms
+        matchingRooms = roomsInsideGrid
     else
         local roomTypeWhitelist = __TS__New(ReadonlySet, onlyCheckRoomTypes)
         matchingRooms = __TS__ArrayFilter(
-            rooms,
+            roomsInsideGrid,
             function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypeWhitelist:has(roomDescriptor.Data.Type) end
         )
     end

package/package.json

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

package/src/functions/level.ts

@@ -1,13 +1,15 @@
-import type { RoomType } from "isaac-typescript-definitions";
+import type { BossID } from "isaac-typescript-definitions";
+import { RoomType, StageID } from "isaac-typescript-definitions";
 import { DOOR_SLOT_VALUES } from "../arrays/cachedEnumValues";
 import { game } from "../core/cachedClasses";
+import { filterMap } from "./array";
 import {
   getRoomDescriptorsForType,
   isDoorSlotValidAtGridIndexForRedRoom,
 } from "./levelGrid";
 import { getNumRooms, getRoomsInsideGrid } from "./rooms";
 
-/** Helper function to fill every possible square with a red room. */
+/** Helper function to fill every possible level grid square with a red room. */
 export function fillLevelWithRedRooms(): void {
   const level = game.GetLevel();
 
@@ -31,6 +33,38 @@ export function fillLevelWithRedRooms(): void {
   } while (numRoomsInGrid !== getNumRooms());
 }
 
+/**
+ * Helper function to get the boss IDs of all of the Boss Rooms on this floor. (This is equivalent
+ * to the sub-type of the room data.)
+ *
+ * Note that this will only look at Boss Rooms inside of the grid, so e.g. Reverse Emperor card
+ * rooms will not count.
+ */
+export function getLevelBossIDs(): BossID[] {
+  const roomsInsideGrid = getRoomsInsideGrid();
+
+  return filterMap(roomsInsideGrid, (roomDescriptor) =>
+    roomDescriptor.Data !== undefined &&
+    roomDescriptor.Data.Type === RoomType.BOSS &&
+    roomDescriptor.Data.StageID === StageID.SPECIAL_ROOMS
+      ? roomDescriptor.Data.Subtype
+      : undefined,
+  );
+}
+
+/**
+ * Helper function to check if the current floor has a Boss Room that matches the boss ID provided.
+ *
+ * This function is variadic, meaning that you can pass as many boss IDs as you want to check for.
+ * It will return true if one or more of the boss IDs are matched.
+ */
+export function levelHasBossID(...bossIDs: BossID[]): boolean {
+  const levelBossIDs = getLevelBossIDs();
+  const levelBossIDsSet = new Set(levelBossIDs);
+
+  return bossIDs.some((bossID) => levelBossIDsSet.has(bossID));
+}
+
 /**
  * Helper function to check to see if the current floor has one or more of a specific room type in
  * it.

package/src/functions/levelGrid.ts

@@ -231,10 +231,10 @@ export function getNewRoomCandidatesForLevel(
   readonly newRoomGridIndex: int;
 }> {
   // We want to iterate over every room on the floor and search for potential new room spots.
-  const rooms = getRoomsInsideGrid();
+  const roomsInsideGrid = getRoomsInsideGrid();
 
   // However, we want to filter out special rooms because they are supposed to be dead ends.
-  const normalRooms = rooms.filter(
+  const normalRooms = roomsInsideGrid.filter(
     (room) =>
       room.Data !== undefined &&
       room.Data.Type === RoomType.DEFAULT &&
@@ -242,7 +242,7 @@ export function getNewRoomCandidatesForLevel(
       !isMineShaft(room.Data), // Mineshaft rooms do not count as special rooms.
   );
 
-  const roomsToLookThrough = ensureDeadEnd ? normalRooms : rooms;
+  const roomsToLookThrough = ensureDeadEnd ? normalRooms : roomsInsideGrid;
 
   const newRoomCandidates: Array<{
     readonly adjacentRoomGridIndex: int;
@@ -301,7 +301,7 @@ export function getRoomAdjacentGridIndexes(
  * Helper function to get an array of all of the room descriptors for rooms that match the specified
  * room type.
  *
- * This function only searches through rooms in the current dimension.
+ * This function only searches through rooms in the current dimension and rooms inside the grid.
  *
  * This function is variadic, meaning that you can specify N arguments to get the combined room
  * descriptors for N room types.
@@ -311,8 +311,8 @@ export function getRoomDescriptorsForType(
 ): RoomDescriptor[] {
   const roomTypesSet = new Set<RoomType>(roomTypes);
 
-  const rooms = getRoomsInsideGrid();
-  return rooms.filter(
+  const roomsInsideGrid = getRoomsInsideGrid();
+  return roomsInsideGrid.filter(
     (roomDescriptor) =>
       roomDescriptor.Data !== undefined &&
       roomTypesSet.has(roomDescriptor.Data.Type),

package/src/functions/rooms.ts

@@ -82,8 +82,8 @@ export function changeRoom(roomGridIndex: int): void {
  * include off-grid rooms, like the Devil Room.
  */
 export function getNumRooms(): int {
-  const rooms = getRoomsInsideGrid();
-  return rooms.length;
+  const roomsInsideGrid = getRoomsInsideGrid();
+  return roomsInsideGrid.length;
 }
 
 /**
@@ -199,7 +199,7 @@ export function getRoomTypeName(roomType: RoomType): string {
 export function getRooms(
   includeExtraDimensionalRooms = false,
 ): RoomDescriptor[] {
-  // The obvious way to get all of the rooms would be to iterate over the `RoomList` from the
+  // The naive way to get all of the rooms would be to iterate over the `RoomList` from the
   // `Level.GetRooms` method. However, this results in read-only data, and we want to return a
   // writable object. Instead, we let the heavy lifting be handled by other functions.
   const roomsInGrid = getRoomsInsideGrid(includeExtraDimensionalRooms);
@@ -497,14 +497,14 @@ export function isAllRoomsClear(
   includeSecretAndSuperSecretRoom = false,
   includeUltraSecretRoom = false,
 ): boolean {
-  const rooms = getRoomsInsideGrid();
+  const roomsInsideGrid = getRoomsInsideGrid();
 
   let matchingRooms: RoomDescriptor[];
   if (onlyCheckRoomTypes === undefined) {
-    matchingRooms = rooms;
+    matchingRooms = roomsInsideGrid;
   } else {
     const roomTypeWhitelist = new ReadonlySet(onlyCheckRoomTypes);
-    matchingRooms = rooms.filter(
+    matchingRooms = roomsInsideGrid.filter(
       (roomDescriptor) =>
         roomDescriptor.Data !== undefined &&
         roomTypeWhitelist.has(roomDescriptor.Data.Type),