isaacscript-common 51.6.0 → 51.8.0

package/dist/index.rollup.d.ts

@@ -7,7 +7,7 @@ import type { BackdropType } from 'isaac-typescript-definitions';
 import type { BatterySubType } from 'isaac-typescript-definitions';
 import type { BombSubType } from 'isaac-typescript-definitions';
 import type { BombVariant } from 'isaac-typescript-definitions';
-import type { BossID } from 'isaac-typescript-definitions';
+import { BossID } from 'isaac-typescript-definitions';
 import { ButtonAction } from 'isaac-typescript-definitions';
 import { CacheFlag } from 'isaac-typescript-definitions';
 import { CallbackPriority } from 'isaac-typescript-definitions/dist/src/enums/CallbackPriority';
@@ -1687,6 +1687,40 @@ export declare function combineArrays<T>(...arrays: Array<T[] | readonly T[]>):
  */
 export declare function combineSets<T>(...sets: Array<Set<T> | ReadonlySet<T>>): Set<T>;
 
+/**
+ * Helper type to validate that a union of interfaces with a field of `type` that is based on an
+ * enum is complete.
+ *
+ * For example:
+ *
+ * ```ts
+ * enum ObjectiveType {
+ *   FOO,
+ *   BAR,
+ *   BAZ,
+ * }
+ *
+ * interface FooObjective {
+ *   type: ObjectiveType.FOO;
+ *   fooThing: number;
+ * }
+ *
+ * interface BarObjective {
+ *   type: ObjectiveType.BAR;
+ *   barThing: string;
+ * }
+ *
+ * type Objective = FooObjective | BarObjective;
+ * type _Test = CompositionTypeSatisfiesEnum<Objective, ObjectiveType>;
+ * ```
+ *
+ * In this example, `Test` would be flagged by TypeScript because `Objective` does not contain an
+ * entry for `BazObjective`.
+ */
+export declare type CompositionTypeSatisfiesEnum<T extends {
+    type: unknown;
+}, _Enum extends T["type"]> = unknown;
+
 /**
  * Helper function to get the enum name for the specified `Controller` value. Note that this will
  * trim off the "BUTTON_" prefix.
@@ -4909,6 +4943,15 @@ export declare function getBooleansFromTable(luaMap: LuaMap<string, unknown>, ob
  */
 export declare function getBosses(entityType?: EntityType, variant?: int, subType?: int, ignoreFriendly?: boolean): EntityNPC[];
 
+/**
+ * Helper function to get the boss ID corresponding to the current room. Returns 0 if the current
+ * room is not a Boss Room.
+ *
+ * Use this instead of the vanilla `Room.GetBossID` method since it correctly handles Dogma and The
+ * Beast.
+ */
+export declare function getBossID(): BossID | 0;
+
 export declare function getBossIDFromEntityTypeVariant(entityType: EntityType, variant: int): BossID | undefined;
 
 /**
@@ -8088,18 +8131,27 @@ declare type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
  */
 export declare function in2x1Room(): boolean;
 
+/**
+ * Helper function to check to see if the current room is an angel shop.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+ * being equal to `AngelRoomSubType.SHOP` (1).
+ */
 export declare function inAngelShop(): boolean;
 
 /**
- * Helper function to check to see if the current room is a boss room for The Beast.
+ * Helper function to check to see if the current room is the Boss Room for The Beast.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
  *
- * Under the hood, this checks the room type and sub-type.
+ * Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+ * being equal to `DungeonSubType.BEAST_ROOM` (4).
  */
 export declare function inBeastRoom(): boolean;
 
 /**
- * Helper function to check if the current room is a boss room for a particular boss. This will only
- * work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
+ * Helper function to check if the current room is the Boss Room for a particular boss. This will
+ * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
  */
 export declare function inBossRoomOf(bossID: BossID): boolean;
 
@@ -8148,6 +8200,21 @@ export declare function inDevilsCrownTreasureRoom(): boolean;
 
 export declare function inDimension(dimension: Dimension): boolean;
 
+/**
+ * Helper function to check to see if the current room is the Boss Room for Dogma.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+ *
+ * Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+ * Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+ *
+ * Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+ * being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+ * Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+ * `HomeRoomSubType.LIVING_ROOM` (3).
+ */
+export declare function inDogmaRoom(): boolean;
+
 /**
  * Helper function to detect if the current room is a Double Trouble Boss Room.
  *
@@ -8437,6 +8504,12 @@ export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[] | readon
 
 export declare function isAngelRoomDoor(door: GridEntityDoor): boolean;
 
+/**
+ * Helper function to check to see if the current room is an angel shop.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+ * being equal to `AngelRoomSubType.SHOP` (1).
+ */
 export declare function isAngelShop(roomData: RoomConfig): boolean;
 
 /**
@@ -8466,9 +8539,12 @@ export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], pare
 export declare function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery;
 
 /**
- * Helper function to check to see if the provided room is a boss room for The Beast.
+ * Helper function to check to see if the provided room is the Boss Room for The Beast.
  *
- * Under the hood, this checks the room type and sub-type.
+ * This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+ * being equal to `DungeonSubType.BEAST_ROOM` (4).
  */
 export declare function isBeastRoom(roomData: RoomConfig): boolean;
 
@@ -8506,7 +8582,7 @@ export declare function isBombPickup(pickup: EntityPickup): pickup is EntityPick
 export declare function isBoolean(variable: unknown): variable is boolean;
 
 /**
- * Helper function to check if the provided room is a boss room for a particular boss. This will
+ * Helper function to check if the provided room is the Boss Room for a particular boss. This will
  * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
  */
 export declare function isBossRoomOf(roomData: RoomConfig, bossID: BossID): boolean;
@@ -8785,6 +8861,21 @@ export declare function isDevilRoomDoor(door: GridEntityDoor): boolean;
  */
 export declare function isDevilsCrownTreasureRoom(roomDescriptor: RoomDescriptor): boolean;
 
+/**
+ * Helper function to check to see if the provided room is the Boss Room for Dogma.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+ *
+ * Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+ * Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+ *
+ * Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+ * being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+ * Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+ * `HomeRoomSubType.LIVING_ROOM` (3).
+ */
+export declare function isDogmaRoom(roomData: RoomConfig): boolean;
+
 /** Helper function to detect if a variable is of type `GridEntityDoor`. */
 export declare function isDoor(variable: unknown): variable is GridEntityDoor;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 51.6.0
+isaacscript-common 51.8.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -28010,6 +28010,9 @@ end
 function ____exports.isDevilsCrownTreasureRoom(self, roomDescriptor)
     return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE)
 end
+function ____exports.isDogmaRoom(self, roomData)
+    return roomData.StageID == StageID.HOME and roomData.Type == RoomType.DEFAULT and roomData.Variant == 1000 and roomData.Subtype == asNumber(nil, HomeRoomSubType.LIVING_ROOM)
+end
 function ____exports.isDoubleTrouble(self, roomData)
     return roomData.Type == RoomType.BOSS and __TS__StringIncludes(roomData.Name, "Double Trouble")
 end
@@ -28146,6 +28149,10 @@ function ____exports.inDevilsCrownTreasureRoom(self)
     local roomDescriptor = getRoomDescriptorReadOnly(nil)
     return ____exports.isDevilsCrownTreasureRoom(nil, roomDescriptor)
 end
+function ____exports.inDogmaRoom(self)
+    local roomData = getRoomData(nil)
+    return ____exports.isDogmaRoom(nil, roomData)
+end
 function ____exports.inDoubleTrouble(self)
     local roomData = getRoomData(nil)
     return ____exports.isDoubleTrouble(nil, roomData)
@@ -28261,12 +28268,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue80
+                goto __continue82
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue80::
+        ::__continue82::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)
@@ -44558,8 +44565,11 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local LokiVariant = ____isaac_2Dtypescript_2Ddefinitions.LokiVariant
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
 local ____constants = require("src.core.constants")
 local VectorZero = ____constants.VectorZero
 local ____entityTypeVariantToBossIDMap = require("src.maps.entityTypeVariantToBossIDMap")
@@ -44584,6 +44594,9 @@ local ____npcs = require("src.functions.npcs")
 local getAliveNPCs = ____npcs.getAliveNPCs
 local ____rng = require("src.functions.rng")
 local isRNG = ____rng.isRNG
+local ____rooms = require("src.functions.rooms")
+local inBeastRoom = ____rooms.inBeastRoom
+local inDogmaRoom = ____rooms.inDogmaRoom
 local ____types = require("src.functions.types")
 local asNumber = ____types.asNumber
 local ____utils = require("src.functions.utils")
@@ -44627,6 +44640,16 @@ function ____exports.getAllBossesSet(self, includeStoryBosses)
     end
     return includeStoryBosses and ALL_BOSSES_SET or ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET
 end
+function ____exports.getBossID(self)
+    if inDogmaRoom(nil) then
+        return BossID.DOGMA
+    end
+    if inBeastRoom(nil) then
+        return BossID.BEAST
+    end
+    local room = game:GetRoom()
+    return room:GetBossID()
+end
 function ____exports.getBossIDFromEntityTypeVariant(self, entityType, variant)
     local entityTypeVariant = (tostring(entityType) .. ".") .. tostring(variant)
     return ENTITY_TYPE_VARIANT_TO_BOSS_ID_MAP:get(entityTypeVariant)
@@ -44663,29 +44686,26 @@ end
 function ____exports.isRepentanceBoss(self, bossID)
     return REPENTANCE_ONLY_BOSS_IDS_SET:has(bossID)
 end
-function ____exports.isSin(self, npc)
-    return SIN_ENTITY_TYPES_SET:has(npc.Type)
-end
 local function getNumBossSegments(self, entityType, variant, numSegments)
     if numSegments ~= nil then
         return numSegments
     end
     repeat
-        local ____switch16 = entityType
-        local ____cond16 = ____switch16 == EntityType.CHUB
-        if ____cond16 then
+        local ____switch18 = entityType
+        local ____cond18 = ____switch18 == EntityType.CHUB
+        if ____cond18 then
             do
                 return 3
             end
         end
-        ____cond16 = ____cond16 or ____switch16 == EntityType.LOKI
-        if ____cond16 then
+        ____cond18 = ____cond18 or ____switch18 == EntityType.LOKI
+        if ____cond18 then
             do
                 return variant == asNumber(nil, LokiVariant.LOKII) and 2 or 1
             end
         end
-        ____cond16 = ____cond16 or ____switch16 == EntityType.GURGLING
-        if ____cond16 then
+        ____cond18 = ____cond18 or ____switch18 == EntityType.GURGLING
+        if ____cond18 then
             do
                 return 2
             end
@@ -44697,6 +44717,9 @@ local function getNumBossSegments(self, entityType, variant, numSegments)
         end
     until true
 end
+function ____exports.isSin(self, npc)
+    return SIN_ENTITY_TYPES_SET:has(npc.Type)
+end
 function ____exports.spawnBoss(self, entityType, variant, subType, positionOrGridIndex, velocity, spawner, seedOrRNG, numSegments)
     if velocity == nil then
         velocity = VectorZero
@@ -54947,6 +54970,17 @@ return ____exports
  end,
 ["src.types.AllButLast"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.CompositionTypeSatisfiesEnum"] = function(...) 
+local ____exports = {}
+local ObjectiveType = {}
+ObjectiveType.FOO = 0
+ObjectiveType[ObjectiveType.FOO] = "FOO"
+ObjectiveType.BAR = 1
+ObjectiveType[ObjectiveType.BAR] = "BAR"
+ObjectiveType.BAZ = 2
+ObjectiveType[ObjectiveType.BAZ] = "BAZ"
 return ____exports
  end,
 ["src.types.Decrement"] = function(...) 

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

@@ -1,5 +1,5 @@
-import type { BossID, LevelStage, StageType } from "isaac-typescript-definitions";
-import { EntityType } from "isaac-typescript-definitions";
+import type { LevelStage, StageType } from "isaac-typescript-definitions";
+import { BossID, EntityType } from "isaac-typescript-definitions";
 /**
  * Helper function to get all of the non-dead bosses in the room.
  *
@@ -35,6 +35,14 @@ export declare function getAliveBosses(entityType?: EntityType | -1, variant?: n
  *                           Default is true.
  */
 export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<BossID>;
+/**
+ * Helper function to get the boss ID corresponding to the current room. Returns 0 if the current
+ * room is not a Boss Room.
+ *
+ * Use this instead of the vanilla `Room.GetBossID` method since it correctly handles Dogma and The
+ * Beast.
+ */
+export declare function getBossID(): BossID | 0;
 export declare function getBossIDFromEntityTypeVariant(entityType: EntityType, variant: int): BossID | undefined;
 /**
  * Helper function to get the set of vanilla bosses for a particular stage and stage type

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

@@ -1 +1 @@
-{"version":3,"file":"bosses.d.ts","sourceRoot":"","sources":["../../../src/functions/bosses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EACN,UAAU,EACV,SAAS,EACV,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAe,MAAM,8BAA8B,CAAC;AA6BvE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,UAAU,GAAE,UAAU,GAAG,CAAC,CAAM,EAChC,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAC7B,kBAAkB,UAAO,GACxB,WAAW,CAAC,MAAM,CAAC,CAIrB;AAED,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,GACX,MAAM,GAAG,SAAS,CAGpB;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAOjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACvB,UAAU,CAAC,EAAE,UAAU,EACvB,OAAO,CAAC,EAAE,GAAG,EACb,OAAO,CAAC,EAAE,GAAG,EACb,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,UAAU,GAChB,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAEjC;AAED,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,MAAM,GACb,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,CAE5B;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,6FAA6F;AAC7F,wBAAgB,KAAK,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAE7C;AAmCD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,EAC7C,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAiCX;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAYX"}
+{"version":3,"file":"bosses.d.ts","sourceRoot":"","sources":["../../../src/functions/bosses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,UAAU,EAAe,MAAM,8BAA8B,CAAC;AA+B/E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,UAAU,GAAE,UAAU,GAAG,CAAC,CAAM,EAChC,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAC7B,kBAAkB,UAAO,GACxB,WAAW,CAAC,MAAM,CAAC,CAIrB;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,IAAI,MAAM,GAAG,CAAC,CAWtC;AAED,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,GACX,MAAM,GAAG,SAAS,CAGpB;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAOjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACvB,UAAU,CAAC,EAAE,UAAU,EACvB,OAAO,CAAC,EAAE,GAAG,EACb,OAAO,CAAC,EAAE,GAAG,EACb,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,UAAU,GAChB,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAEjC;AAED,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,MAAM,GACb,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,CAE5B;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAExD;AAmCD,6FAA6F;AAC7F,wBAAgB,KAAK,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAE7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,EAC7C,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAiCX;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,WAAW,CAAC,EAAE,GAAG,GAChB,SAAS,CAYX"}

package/dist/src/functions/bosses.lua

@@ -3,8 +3,11 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local LokiVariant = ____isaac_2Dtypescript_2Ddefinitions.LokiVariant
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
 local ____constants = require("src.core.constants")
 local VectorZero = ____constants.VectorZero
 local ____entityTypeVariantToBossIDMap = require("src.maps.entityTypeVariantToBossIDMap")
@@ -29,6 +32,9 @@ local ____npcs = require("src.functions.npcs")
 local getAliveNPCs = ____npcs.getAliveNPCs
 local ____rng = require("src.functions.rng")
 local isRNG = ____rng.isRNG
+local ____rooms = require("src.functions.rooms")
+local inBeastRoom = ____rooms.inBeastRoom
+local inDogmaRoom = ____rooms.inDogmaRoom
 local ____types = require("src.functions.types")
 local asNumber = ____types.asNumber
 local ____utils = require("src.functions.utils")
@@ -101,6 +107,21 @@ function ____exports.getAllBossesSet(self, includeStoryBosses)
     end
     return includeStoryBosses and ALL_BOSSES_SET or ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET
 end
+--- Helper function to get the boss ID corresponding to the current room. Returns 0 if the current
+-- room is not a Boss Room.
+-- 
+-- Use this instead of the vanilla `Room.GetBossID` method since it correctly handles Dogma and The
+-- Beast.
+function ____exports.getBossID(self)
+    if inDogmaRoom(nil) then
+        return BossID.DOGMA
+    end
+    if inBeastRoom(nil) then
+        return BossID.BEAST
+    end
+    local room = game:GetRoom()
+    return room:GetBossID()
+end
 function ____exports.getBossIDFromEntityTypeVariant(self, entityType, variant)
     local entityTypeVariant = (tostring(entityType) .. ".") .. tostring(variant)
     return ENTITY_TYPE_VARIANT_TO_BOSS_ID_MAP:get(entityTypeVariant)
@@ -160,30 +181,26 @@ end
 function ____exports.isRepentanceBoss(self, bossID)
     return REPENTANCE_ONLY_BOSS_IDS_SET:has(bossID)
 end
---- Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust.
-function ____exports.isSin(self, npc)
-    return SIN_ENTITY_TYPES_SET:has(npc.Type)
-end
 local function getNumBossSegments(self, entityType, variant, numSegments)
     if numSegments ~= nil then
         return numSegments
     end
     repeat
-        local ____switch16 = entityType
-        local ____cond16 = ____switch16 == EntityType.CHUB
-        if ____cond16 then
+        local ____switch18 = entityType
+        local ____cond18 = ____switch18 == EntityType.CHUB
+        if ____cond18 then
             do
                 return 3
             end
         end
-        ____cond16 = ____cond16 or ____switch16 == EntityType.LOKI
-        if ____cond16 then
+        ____cond18 = ____cond18 or ____switch18 == EntityType.LOKI
+        if ____cond18 then
             do
                 return variant == asNumber(nil, LokiVariant.LOKII) and 2 or 1
             end
         end
-        ____cond16 = ____cond16 or ____switch16 == EntityType.GURGLING
-        if ____cond16 then
+        ____cond18 = ____cond18 or ____switch18 == EntityType.GURGLING
+        if ____cond18 then
             do
                 return 2
             end
@@ -195,6 +212,10 @@ local function getNumBossSegments(self, entityType, variant, numSegments)
         end
     until true
 end
+--- Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust.
+function ____exports.isSin(self, npc)
+    return SIN_ENTITY_TYPES_SET:has(npc.Type)
+end
 --- Helper function to spawn a boss.
 -- 
 -- Use this function instead of `spawnNPC` since it handles automatically spawning multiple segments

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

@@ -103,16 +103,25 @@ export declare function getRoomsOutsideGrid(): RoomDescriptor[];
  * `RoomShape.2x1`.
  */
 export declare function in2x1Room(): boolean;
+/**
+ * Helper function to check to see if the current room is an angel shop.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+ * being equal to `AngelRoomSubType.SHOP` (1).
+ */
 export declare function inAngelShop(): boolean;
 /**
- * Helper function to check to see if the current room is a boss room for The Beast.
+ * Helper function to check to see if the current room is the Boss Room for The Beast.
  *
- * Under the hood, this checks the room type and sub-type.
+ * This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+ * being equal to `DungeonSubType.BEAST_ROOM` (4).
  */
 export declare function inBeastRoom(): boolean;
 /**
- * Helper function to check if the current room is a boss room for a particular boss. This will only
- * work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
+ * Helper function to check if the current room is the Boss Room for a particular boss. This will
+ * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
  */
 export declare function inBossRoomOf(bossID: BossID): boolean;
 /**
@@ -137,6 +146,20 @@ export declare function inDeathCertificateArea(): boolean;
  * Under the hood, this checks for `RoomDescriptorFlag.DEVIL_TREASURE`.
  */
 export declare function inDevilsCrownTreasureRoom(): boolean;
+/**
+ * Helper function to check to see if the current room is the Boss Room for Dogma.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+ *
+ * Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+ * Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+ *
+ * Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+ * being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+ * Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+ * `HomeRoomSubType.LIVING_ROOM` (3).
+ */
+export declare function inDogmaRoom(): boolean;
 /**
  * Helper function to detect if the current room is a Double Trouble Boss Room.
  *
@@ -228,15 +251,24 @@ export declare function is2x1Room(roomData: RoomConfig): boolean;
  * @allowEmptyVariadic
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[] | readonly RoomType[], includeSecretAndSuperSecretRoom?: boolean, includeUltraSecretRoom?: boolean): boolean;
+/**
+ * Helper function to check to see if the current room is an angel shop.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+ * being equal to `AngelRoomSubType.SHOP` (1).
+ */
 export declare function isAngelShop(roomData: RoomConfig): boolean;
 /**
- * Helper function to check to see if the provided room is a boss room for The Beast.
+ * Helper function to check to see if the provided room is the Boss Room for The Beast.
  *
- * Under the hood, this checks the room type and sub-type.
+ * This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+ * being equal to `DungeonSubType.BEAST_ROOM` (4).
  */
 export declare function isBeastRoom(roomData: RoomConfig): boolean;
 /**
- * Helper function to check if the provided room is a boss room for a particular boss. This will
+ * Helper function to check if the provided room is the Boss Room for a particular boss. This will
  * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
  */
 export declare function isBossRoomOf(roomData: RoomConfig, bossID: BossID): boolean;
@@ -262,6 +294,20 @@ export declare function isDeathCertificateArea(roomData: RoomConfig): boolean;
  * Under the hood, this checks for `RoomDescriptorFlag.DEVIL_TREASURE`.
  */
 export declare function isDevilsCrownTreasureRoom(roomDescriptor: RoomDescriptor): boolean;
+/**
+ * Helper function to check to see if the provided room is the Boss Room for Dogma.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+ *
+ * Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+ * Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+ *
+ * Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+ * being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+ * Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+ * `HomeRoomSubType.LIVING_ROOM` (3).
+ */
+export declare function isDogmaRoom(roomData: RoomConfig): boolean;
 /**
  * Helper function to detect if the provided room is a Double Trouble Boss Room.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,UAAU,EACX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,SAAS,EAQT,SAAS,EACT,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAuCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAcnD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,IAAI,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAiBlE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,oBAAoB,UAAO,EAC3B,iCAAiC,UAAQ,GACxC,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,CAclC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAOlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAqBlB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAe1E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,cAAc,EAAE,CAWtD;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAGnC;AAED,wBAAgB,WAAW,IAAI,OAAO,CAGrC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAGrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;GAGG;AACH,wBAAgB,mCAAmC,IAAI,OAAO,CAG7D;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAGhD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAGzC;AAED,6FAA6F;AAC7F,wBAAgB,aAAa,IAAI,OAAO,CAGvC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAGjC;AAED,gGAAgG;AAChG,wBAAgB,eAAe,IAAI,OAAO,CAGzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAGrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAGhE;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAG/D;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAG5D;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAKvD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EACrD,+BAA+B,UAAQ,EACvC,sBAAsB,UAAQ,GAC7B,OAAO,CAiCT;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAKzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAM1E;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,UAAU,GACnB,OAAO,CAIT;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,cAAc,EAAE,cAAc,GAC7B,OAAO,CAET;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAI7D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAM1D;AAED,0FAA0F;AAC1F,wBAAgB,OAAO,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAErD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAEvE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAOzD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,UAAU,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAMT;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAO1D;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,UAAU,EACpB,GAAG,UAAU,EAAE,SAAS,EAAE,GACzB,OAAO,CAET;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,UAAU,EACpB,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAEpE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAE5D;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAEpE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED,iFAAiF;AACjF,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC"}
+{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,UAAU,EACX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,SAAS,EAQT,SAAS,EACT,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAuCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAcnD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,IAAI,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAiBlE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,oBAAoB,UAAO,EAC3B,iCAAiC,UAAQ,GACxC,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,CAclC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAOlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAqBlB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAe1E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,cAAc,EAAE,CAWtD;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAGnC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAGrC;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAGrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;GAGG;AACH,wBAAgB,mCAAmC,IAAI,OAAO,CAG7D;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAGhD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAGrC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAGzC;AAED,6FAA6F;AAC7F,wBAAgB,aAAa,IAAI,OAAO,CAGvC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAGjC;AAED,gGAAgG;AAChG,wBAAgB,eAAe,IAAI,OAAO,CAGzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAGrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAGhE;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAG/D;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAG5D;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAKvD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EACrD,+BAA+B,UAAQ,EACvC,sBAAsB,UAAQ,GAC7B,OAAO,CAiCT;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAKzD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAM1E;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,UAAU,GACnB,OAAO,CAIT;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,cAAc,EAAE,cAAc,GAC7B,OAAO,CAET;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAOzD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAI7D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAM1D;AAED,0FAA0F;AAC1F,wBAAgB,OAAO,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAErD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAEvE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAOzD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,UAAU,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAMT;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO,CAO1D;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,UAAU,EACpB,GAAG,UAAU,EAAE,SAAS,EAAE,GACzB,OAAO,CAET;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,UAAU,EACpB,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAEpE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAE5D;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAEpE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED,iFAAiF;AACjF,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC"}

package/dist/src/functions/rooms.lua

@@ -140,16 +140,23 @@ end
 function ____exports.is2x1Room(self, roomData)
     return roomData.Shape == RoomShape.SHAPE_1x2 or roomData.Shape == RoomShape.SHAPE_2x1
 end
+--- Helper function to check to see if the current room is an angel shop.
+-- 
+-- Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+-- being equal to `AngelRoomSubType.SHOP` (1).
 function ____exports.isAngelShop(self, roomData)
     return roomData.Type == RoomType.ANGEL and roomData.Subtype == asNumber(nil, AngelRoomSubType.SHOP)
 end
---- Helper function to check to see if the provided room is a boss room for The Beast.
+--- Helper function to check to see if the provided room is the Boss Room for The Beast.
+-- 
+-- This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
 -- 
--- Under the hood, this checks the room type and sub-type.
+-- Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+-- being equal to `DungeonSubType.BEAST_ROOM` (4).
 function ____exports.isBeastRoom(self, roomData)
     return roomData.Type == RoomType.DUNGEON and roomData.Subtype == asNumber(nil, DungeonSubType.BEAST_ROOM)
 end
---- Helper function to check if the provided room is a boss room for a particular boss. This will
+--- Helper function to check if the provided room is the Boss Room for a particular boss. This will
 -- only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
 function ____exports.isBossRoomOf(self, roomData, bossID)
     return roomData.Type == RoomType.BOSS and roomData.StageID == StageID.SPECIAL_ROOMS and roomData.Subtype == asNumber(nil, bossID)
@@ -176,6 +183,20 @@ end
 function ____exports.isDevilsCrownTreasureRoom(self, roomDescriptor)
     return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE)
 end
+--- Helper function to check to see if the provided room is the Boss Room for Dogma.
+-- 
+-- This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+-- 
+-- Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+-- Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+-- 
+-- Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+-- being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+-- Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+-- `HomeRoomSubType.LIVING_ROOM` (3).
+function ____exports.isDogmaRoom(self, roomData)
+    return roomData.StageID == StageID.HOME and roomData.Type == RoomType.DEFAULT and roomData.Variant == 1000 and roomData.Subtype == asNumber(nil, HomeRoomSubType.LIVING_ROOM)
+end
 --- Helper function to detect if the provided room is a Double Trouble Boss Room.
 -- 
 -- This is performed by checking for the string "Double Trouble" inside of the room name. The
@@ -370,19 +391,26 @@ function ____exports.in2x1Room(self)
     local roomData = getRoomData(nil)
     return ____exports.is2x1Room(nil, roomData)
 end
+--- Helper function to check to see if the current room is an angel shop.
+-- 
+-- Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+-- being equal to `AngelRoomSubType.SHOP` (1).
 function ____exports.inAngelShop(self)
     local roomData = getRoomData(nil)
     return ____exports.isAngelShop(nil, roomData)
 end
---- Helper function to check to see if the current room is a boss room for The Beast.
+--- Helper function to check to see if the current room is the Boss Room for The Beast.
 -- 
--- Under the hood, this checks the room type and sub-type.
+-- This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
+-- 
+-- Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+-- being equal to `DungeonSubType.BEAST_ROOM` (4).
 function ____exports.inBeastRoom(self)
     local roomData = getRoomData(nil)
     return ____exports.isBeastRoom(nil, roomData)
 end
---- Helper function to check if the current room is a boss room for a particular boss. This will only
--- work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
+--- Helper function to check if the current room is the Boss Room for a particular boss. This will
+-- only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
 function ____exports.inBossRoomOf(self, bossID)
     local roomData = getRoomData(nil)
     return ____exports.isBossRoomOf(nil, roomData, bossID)
@@ -413,6 +441,21 @@ function ____exports.inDevilsCrownTreasureRoom(self)
     local roomDescriptor = getRoomDescriptorReadOnly(nil)
     return ____exports.isDevilsCrownTreasureRoom(nil, roomDescriptor)
 end
+--- Helper function to check to see if the current room is the Boss Room for Dogma.
+-- 
+-- This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+-- 
+-- Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+-- Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+-- 
+-- Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+-- being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+-- Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+-- `HomeRoomSubType.LIVING_ROOM` (3).
+function ____exports.inDogmaRoom(self)
+    local roomData = getRoomData(nil)
+    return ____exports.isDogmaRoom(nil, roomData)
+end
 --- Helper function to detect if the current room is a Double Trouble Boss Room.
 -- 
 -- This is performed by checking for the string "Double Trouble" inside of the room name. The
@@ -589,12 +632,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue80
+                goto __continue82
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue80::
+        ::__continue82::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/src/index.d.ts

@@ -161,6 +161,7 @@ export * from "./types/AnyClass";
 export * from "./types/AnyEntity";
 export * from "./types/AnyFunction";
 export * from "./types/AnyGridEntity";
+export * from "./types/CompositionTypeSatisfiesEnum";
 export * from "./types/ConversionHeartSubType";
 export * from "./types/Decrement";
 export * from "./types/ERange";

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0CAA0C,CAAC;AACzD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yCAAyC,CAAC;AACxD,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0CAA0C,CAAC;AACzD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yCAAyC,CAAC;AACxD,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC"}

package/dist/src/types/CompositionTypeSatisfiesEnum.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Helper type to validate that a union of interfaces with a field of `type` that is based on an
+ * enum is complete.
+ *
+ * For example:
+ *
+ * ```ts
+ * enum ObjectiveType {
+ *   FOO,
+ *   BAR,
+ *   BAZ,
+ * }
+ *
+ * interface FooObjective {
+ *   type: ObjectiveType.FOO;
+ *   fooThing: number;
+ * }
+ *
+ * interface BarObjective {
+ *   type: ObjectiveType.BAR;
+ *   barThing: string;
+ * }
+ *
+ * type Objective = FooObjective | BarObjective;
+ * type _Test = CompositionTypeSatisfiesEnum<Objective, ObjectiveType>;
+ * ```
+ *
+ * In this example, `Test` would be flagged by TypeScript because `Objective` does not contain an
+ * entry for `BazObjective`.
+ */
+export type CompositionTypeSatisfiesEnum<T extends {
+    type: unknown;
+}, _Enum extends T["type"]> = unknown;
+//# sourceMappingURL=CompositionTypeSatisfiesEnum.d.ts.map

package/dist/src/types/CompositionTypeSatisfiesEnum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompositionTypeSatisfiesEnum.d.ts","sourceRoot":"","sources":["../../../src/types/CompositionTypeSatisfiesEnum.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,MAAM,4BAA4B,CACtC,CAAC,SAAS;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,EAC3B,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC,IACrB,OAAO,CAAC"}

package/dist/src/types/CompositionTypeSatisfiesEnum.lua

@@ -0,0 +1,9 @@
+local ____exports = {}
+local ObjectiveType = {}
+ObjectiveType.FOO = 0
+ObjectiveType[ObjectiveType.FOO] = "FOO"
+ObjectiveType.BAR = 1
+ObjectiveType[ObjectiveType.BAR] = "BAR"
+ObjectiveType.BAZ = 2
+ObjectiveType[ObjectiveType.BAZ] = "BAZ"
+return ____exports

package/package.json

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

package/src/functions/bosses.ts

@@ -1,9 +1,6 @@
-import type {
-  BossID,
-  LevelStage,
-  StageType,
-} from "isaac-typescript-definitions";
-import { EntityType, LokiVariant } from "isaac-typescript-definitions";
+import type { LevelStage, StageType } from "isaac-typescript-definitions";
+import { BossID, EntityType, LokiVariant } from "isaac-typescript-definitions";
+import { game } from "../core/cachedClasses";
 import { VectorZero } from "../core/constants";
 import { ENTITY_TYPE_VARIANT_TO_BOSS_ID_MAP } from "../maps/entityTypeVariantToBossIDMap";
 import { BOSS_ID_TO_ENTITY_TYPE_VARIANT } from "../objects/bossIDToEntityTypeVariant";
@@ -19,6 +16,7 @@ import { ReadonlySet } from "../types/ReadonlySet";
 import { getNPCs, spawnNPC } from "./entitiesSpecific";
 import { getAliveNPCs } from "./npcs";
 import { isRNG } from "./rng";
+import { inBeastRoom, inDogmaRoom } from "./rooms";
 import { asNumber } from "./types";
 import { repeat } from "./utils";
 
@@ -83,6 +81,26 @@ export function getAllBossesSet(
     : ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET;
 }
 
+/**
+ * Helper function to get the boss ID corresponding to the current room. Returns 0 if the current
+ * room is not a Boss Room.
+ *
+ * Use this instead of the vanilla `Room.GetBossID` method since it correctly handles Dogma and The
+ * Beast.
+ */
+export function getBossID(): BossID | 0 {
+  if (inDogmaRoom()) {
+    return BossID.DOGMA;
+  }
+
+  if (inBeastRoom()) {
+    return BossID.BEAST;
+  }
+
+  const room = game.GetRoom();
+  return room.GetBossID();
+}
+
 export function getBossIDFromEntityTypeVariant(
   entityType: EntityType,
   variant: int,
@@ -160,11 +178,6 @@ export function isRepentanceBoss(bossID: BossID): boolean {
   return REPENTANCE_ONLY_BOSS_IDS_SET.has(bossID);
 }
 
-/** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */
-export function isSin(npc: EntityNPC): boolean {
-  return SIN_ENTITY_TYPES_SET.has(npc.Type);
-}
-
 function getNumBossSegments(
   entityType: EntityType,
   variant: int,
@@ -198,6 +211,11 @@ function getNumBossSegments(
   }
 }
 
+/** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */
+export function isSin(npc: EntityNPC): boolean {
+  return SIN_ENTITY_TYPES_SET.has(npc.Type);
+}
+
 /**
  * Helper function to spawn a boss.
  *

package/src/functions/rooms.ts

@@ -294,15 +294,24 @@ export function in2x1Room(): boolean {
   return is2x1Room(roomData);
 }
 
+/**
+ * Helper function to check to see if the current room is an angel shop.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+ * being equal to `AngelRoomSubType.SHOP` (1).
+ */
 export function inAngelShop(): boolean {
   const roomData = getRoomData();
   return isAngelShop(roomData);
 }
 
 /**
- * Helper function to check to see if the current room is a boss room for The Beast.
+ * Helper function to check to see if the current room is the Boss Room for The Beast.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
  *
- * Under the hood, this checks the room type and sub-type.
+ * Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+ * being equal to `DungeonSubType.BEAST_ROOM` (4).
  */
 export function inBeastRoom(): boolean {
   const roomData = getRoomData();
@@ -310,8 +319,8 @@ export function inBeastRoom(): boolean {
 }
 
 /**
- * Helper function to check if the current room is a boss room for a particular boss. This will only
- * work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
+ * Helper function to check if the current room is the Boss Room for a particular boss. This will
+ * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
  */
 export function inBossRoomOf(bossID: BossID): boolean {
   const roomData = getRoomData();
@@ -356,6 +365,24 @@ export function inDevilsCrownTreasureRoom(): boolean {
   return isDevilsCrownTreasureRoom(roomDescriptor);
 }
 
+/**
+ * Helper function to check to see if the current room is the Boss Room for Dogma.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+ *
+ * Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+ * Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+ *
+ * Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+ * being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+ * Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+ * `HomeRoomSubType.LIVING_ROOM` (3).
+ */
+export function inDogmaRoom(): boolean {
+  const roomData = getRoomData();
+  return isDogmaRoom(roomData);
+}
+
 /**
  * Helper function to detect if the current room is a Double Trouble Boss Room.
  *
@@ -546,6 +573,12 @@ export function isAllRoomsClear(
   return matchingRooms.every((roomDescriptor) => roomDescriptor.Clear);
 }
 
+/**
+ * Helper function to check to see if the current room is an angel shop.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.ANGEL` (15) and the sub-type
+ * being equal to `AngelRoomSubType.SHOP` (1).
+ */
 export function isAngelShop(roomData: RoomConfig): boolean {
   return (
     roomData.Type === RoomType.ANGEL &&
@@ -554,9 +587,12 @@ export function isAngelShop(roomData: RoomConfig): boolean {
 }
 
 /**
- * Helper function to check to see if the provided room is a boss room for The Beast.
+ * Helper function to check to see if the provided room is the Boss Room for The Beast.
  *
- * Under the hood, this checks the room type and sub-type.
+ * This function is useful because the `Room.GetBossID` method returns 0 for The Beast room.
+ *
+ * Under the hood, this checks the room type being equal to `RoomType.DUNGEON` (16) and the sub-type
+ * being equal to `DungeonSubType.BEAST_ROOM` (4).
  */
 export function isBeastRoom(roomData: RoomConfig): boolean {
   return (
@@ -566,7 +602,7 @@ export function isBeastRoom(roomData: RoomConfig): boolean {
 }
 
 /**
- * Helper function to check if the provided room is a boss room for a particular boss. This will
+ * Helper function to check if the provided room is the Boss Room for a particular boss. This will
  * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
  */
 export function isBossRoomOf(roomData: RoomConfig, bossID: BossID): boolean {
@@ -625,6 +661,28 @@ export function isDevilsCrownTreasureRoom(
   return hasFlag(roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE);
 }
 
+/**
+ * Helper function to check to see if the provided room is the Boss Room for Dogma.
+ *
+ * This function is useful because the `Room.GetBossID` method returns 0 for the Dogma room.
+ *
+ * Note that the "living room" on the Home floor with the TV at the top of the room is not the Dogma
+ * Boss Room, as the player is teleported to a different room after watching the TV cutscene.
+ *
+ * Under the hood, this checks the stage ID being equal to `StageID.HOME` (35) and the room type
+ * being equal to `RoomType.DEFAULT` (1) and the variant being equal to 1000 (which is the only
+ * Dogma Boss Room that exists in vanilla) and the sub-type being equal to
+ * `HomeRoomSubType.LIVING_ROOM` (3).
+ */
+export function isDogmaRoom(roomData: RoomConfig): boolean {
+  return (
+    roomData.StageID === StageID.HOME &&
+    roomData.Type === RoomType.DEFAULT &&
+    roomData.Variant === 1000 &&
+    roomData.Subtype === asNumber(HomeRoomSubType.LIVING_ROOM)
+  );
+}
+
 /**
  * Helper function to detect if the provided room is a Double Trouble Boss Room.
  *

package/src/index.ts

@@ -161,6 +161,7 @@ export * from "./types/AnyClass";
 export * from "./types/AnyEntity";
 export * from "./types/AnyFunction";
 export * from "./types/AnyGridEntity";
+export * from "./types/CompositionTypeSatisfiesEnum";
 export * from "./types/ConversionHeartSubType";
 export * from "./types/Decrement";
 export * from "./types/ERange";

package/src/types/CompositionTypeSatisfiesEnum.ts

@@ -0,0 +1,66 @@
+/**
+ * Helper type to validate that a union of interfaces with a field of `type` that is based on an
+ * enum is complete.
+ *
+ * For example:
+ *
+ * ```ts
+ * enum ObjectiveType {
+ *   FOO,
+ *   BAR,
+ *   BAZ,
+ * }
+ *
+ * interface FooObjective {
+ *   type: ObjectiveType.FOO;
+ *   fooThing: number;
+ * }
+ *
+ * interface BarObjective {
+ *   type: ObjectiveType.BAR;
+ *   barThing: string;
+ * }
+ *
+ * type Objective = FooObjective | BarObjective;
+ * type _Test = CompositionTypeSatisfiesEnum<Objective, ObjectiveType>;
+ * ```
+ *
+ * In this example, `Test` would be flagged by TypeScript because `Objective` does not contain an
+ * entry for `BazObjective`.
+ */
+export type CompositionTypeSatisfiesEnum<
+  T extends { type: unknown },
+  _Enum extends T["type"],
+> = unknown;
+
+// -----
+// Tests
+// -----
+
+enum ObjectiveType {
+  FOO,
+  BAR,
+  BAZ,
+}
+
+interface FooObjective {
+  type: ObjectiveType.FOO;
+  fooThing: number;
+}
+
+interface BarObjective {
+  type: ObjectiveType.BAR;
+  barThing: string;
+}
+
+interface BazObjective {
+  type: ObjectiveType.BAZ;
+  bazThing: string;
+}
+
+type Objective1 = FooObjective | BarObjective | BazObjective;
+type _Test1 = CompositionTypeSatisfiesEnum<Objective1, ObjectiveType>;
+
+type Objective2 = FooObjective | BarObjective;
+// @ts-expect-error Missing "Baz".
+type _Test2 = CompositionTypeSatisfiesEnum<Objective2, ObjectiveType>;