isaacscript-common 82.0.2 → 83.1.0

package/dist/functions/bosses.d.ts

@@ -16,8 +16,8 @@ import { BossID, EntityType } from "isaac-typescript-definitions";
  */
 export declare function getAliveBosses(entityType?: EntityType | -1, variant?: number, subType?: number, ignoreFriendly?: boolean): readonly EntityNPC[];
 /**
- * Helper function to get the set of every boss in the game (which is derived from the `BossID`
- * enum).
+ * Helper function to get an array with every boss in the game. This is derived from the `BossID`
+ * enum.
  *
  * This includes:
  * - Ultra Greed
@@ -30,12 +30,15 @@ export declare function getAliveBosses(entityType?: EntityType | -1, variant?: n
  * - sub-bosses of The Beast fight (e.g. Ultra Famine, Ultra Pestilence, Ultra War, Ultra Death)
  * - bosses that do not have any Boss Rooms defined due to being unfinished (e.g. Raglich)
  *
- * Also see the `getBossSet` and `getCombinedBossSet` functions.
- *
- * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives.
- *                           Default is true.
+ * Also see the `getAllNonStoryBosses` function.
+ */
+export declare function getAllBosses(): readonly BossID[];
+/**
+ * Helper function to get an array with every boss in the game. This is derived from the `BossID`
+ * enum. This is the same thing as the `getAllBosses` helper function, but with story bosses
+ * filtered out.
  */
-export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<BossID>;
+export declare function getAllNonStoryBosses(): readonly BossID[];
 /**
  * Helper function to get the boss ID corresponding to the current room. Returns undefined if the
  * current room is not a Boss Room.
@@ -46,17 +49,25 @@ export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlyS
 export declare function getBossID(): BossID | undefined;
 export declare function getBossIDFromEntityTypeVariant(entityType: EntityType, variant: int): BossID | undefined;
 /**
- * Helper function to get the proper English name for a boss. For example, the name for
- * `BossID.WRETCHED` (36) is "The Wretched".
+ * Helper function to get the set of vanilla bosses for a particular stage across all of the stage
+ * types. For example, specifying `LevelStage.BASEMENT_2` will return a set with all of the bosses
+ * for Basement, Cellar, Burning Basement, Downpour, and Dross.
+ *
+ * Also see the `getAllBossesSet` and `getBossIDsForStageID` functions.
  */
-export declare function getBossName(bossID: BossID): string;
+export declare function getBossIDsForStage(stage: LevelStage): ReadonlySet<BossID> | undefined;
 /**
- * Helper function to get the set of vanilla bosses for a particular stage and stage type
- * combination.
+ * Helper function to get the set of vanilla bosses that can randomly appear on a particular stage
+ * ID.
  *
- * Also see the `getAllBossesSet` and `getCombinedBossSet` functions.
+ * Also see the `getAllBossesSet` and `getBossIDsForStage` functions.
  */
-export declare function getBossSet(stageID: StageID): ReadonlySet<BossID> | undefined;
+export declare function getBossIDsForStageID(stageID: StageID): readonly BossID[] | undefined;
+/**
+ * Helper function to get the proper English name for a boss. For example, the name for
+ * `BossID.WRETCHED` (36) is "The Wretched".
+ */
+export declare function getBossName(bossID: BossID): string;
 /** Helper function to get the set of stage IDs that a particular boss naturally appears in. */
 export declare function getBossStageIDs(bossID: BossID): ReadonlySet<StageID>;
 /**
@@ -71,14 +82,6 @@ export declare function getBossStageIDs(bossID: BossID): ReadonlySet<StageID>;
  * @param ignoreFriendly Optional. Default is false.
  */
 export declare function getBosses(entityType?: EntityType, variant?: int, subType?: int, ignoreFriendly?: boolean): readonly EntityNPC[];
-/**
- * Helper function to get the set of vanilla bosses for a particular stage across all of the stage
- * types. For example, specifying `LevelStage.BASEMENT_2` will return a set with all of the bosses
- * for Basement, Cellar, Burning Basement, Downpour, and Dross.
- *
- * Also see the `getAllBossesSet` and `getBossSet` functions.
- */
-export declare function getCombinedBossSet(stage: LevelStage): ReadonlySet<BossID> | undefined;
 export declare function getEntityTypeVariantFromBossID(bossID: BossID): readonly [EntityType, int];
 /**
  * Helper function to check if a boss is only found on a Repentance floor such as Dross, Mines, and

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

@@ -1 +1 @@
-{"version":3,"file":"bosses.d.ts","sourceRoot":"","sources":["../../src/functions/bosses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACL,MAAM,EACN,UAAU,EAGX,MAAM,8BAA8B,CAAC;AAiCtC;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,UAAU,GAAE,UAAU,GAAG,CAAC,CAAM,EAChC,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,SAAS,EAAE,CAGtB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAC7B,kBAAkB,UAAO,GACxB,WAAW,CAAC,MAAM,CAAC,CAIrB;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,IAAI,MAAM,GAAG,SAAS,CA0B9C;AAED,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,GACX,MAAM,GAAG,SAAS,CAGpB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAE5E;AAED,+FAA+F;AAC/F,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAEpE;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,SAAS,EAAE,CAGtB;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,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACL,MAAM,EACN,UAAU,EAGX,MAAM,8BAA8B,CAAC;AAiCtC;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,UAAU,GAAE,UAAU,GAAG,CAAC,CAAM,EAChC,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,SAAS,EAAE,CAGtB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,IAAI,SAAS,MAAM,EAAE,CAEhD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,SAAS,MAAM,EAAE,CAExD;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,IAAI,MAAM,GAAG,SAAS,CA0B9C;AAED,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,GACX,MAAM,GAAG,SAAS,CAGpB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,UAAU,GAChB,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAEjC;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,OAAO,GACf,SAAS,MAAM,EAAE,GAAG,SAAS,CAE/B;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED,+FAA+F;AAC/F,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAEpE;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,SAAS,EAAE,CAGtB;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"}

package/dist/functions/bosses.lua

@@ -19,10 +19,10 @@ local ____bossNames = require("objects.bossNames")
 local BOSS_NAMES = ____bossNames.BOSS_NAMES
 local DEFAULT_BOSS_NAME = ____bossNames.DEFAULT_BOSS_NAME
 local ____bossSets = require("sets.bossSets")
-local ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET = ____bossSets.ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET
-local ALL_BOSSES_SET = ____bossSets.ALL_BOSSES_SET
+local ALL_BOSSES = ____bossSets.ALL_BOSSES
 local BOSS_ID_TO_STAGE_IDS = ____bossSets.BOSS_ID_TO_STAGE_IDS
-local STAGE_ID_TO_BOSS_SET_MAP = ____bossSets.STAGE_ID_TO_BOSS_SET_MAP
+local NON_STORY_BOSSES = ____bossSets.NON_STORY_BOSSES
+local STAGE_ID_TO_BOSS_IDS = ____bossSets.STAGE_ID_TO_BOSS_IDS
 local STAGE_TO_COMBINED_BOSS_SET_MAP = ____bossSets.STAGE_TO_COMBINED_BOSS_SET_MAP
 local ____repentanceBossIDsSet = require("sets.repentanceBossIDsSet")
 local REPENTANCE_ONLY_BOSS_IDS_SET = ____repentanceBossIDsSet.REPENTANCE_ONLY_BOSS_IDS_SET
@@ -89,8 +89,8 @@ function ____exports.getAliveBosses(self, entityType, variant, subType, ignoreFr
         function(____, aliveNPC) return aliveNPC:IsBoss() end
     )
 end
---- Helper function to get the set of every boss in the game (which is derived from the `BossID`
--- enum).
+--- Helper function to get an array with every boss in the game. This is derived from the `BossID`
+-- enum.
 -- 
 -- This includes:
 -- - Ultra Greed
@@ -103,15 +103,15 @@ end
 -- - sub-bosses of The Beast fight (e.g. Ultra Famine, Ultra Pestilence, Ultra War, Ultra Death)
 -- - bosses that do not have any Boss Rooms defined due to being unfinished (e.g. Raglich)
 -- 
--- Also see the `getBossSet` and `getCombinedBossSet` functions.
--- 
--- @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives.
--- Default is true.
-function ____exports.getAllBossesSet(self, includeStoryBosses)
-    if includeStoryBosses == nil then
-        includeStoryBosses = true
-    end
-    return includeStoryBosses and ALL_BOSSES_SET or ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET
+-- Also see the `getAllNonStoryBosses` function.
+function ____exports.getAllBosses(self)
+    return ALL_BOSSES
+end
+--- Helper function to get an array with every boss in the game. This is derived from the `BossID`
+-- enum. This is the same thing as the `getAllBosses` helper function, but with story bosses
+-- filtered out.
+function ____exports.getAllNonStoryBosses(self)
+    return NON_STORY_BOSSES
 end
 --- Helper function to get the boss ID corresponding to the current room. Returns undefined if the
 -- current room is not a Boss Room.
@@ -139,18 +139,26 @@ function ____exports.getBossIDFromEntityTypeVariant(self, entityType, variant)
     local entityTypeVariant = (tostring(entityType) .. ".") .. tostring(variant)
     return ENTITY_TYPE_VARIANT_TO_BOSS_ID_MAP:get(entityTypeVariant)
 end
+--- Helper function to get the set of vanilla bosses for a particular stage across all of the stage
+-- types. For example, specifying `LevelStage.BASEMENT_2` will return a set with all of the bosses
+-- for Basement, Cellar, Burning Basement, Downpour, and Dross.
+-- 
+-- Also see the `getAllBossesSet` and `getBossIDsForStageID` functions.
+function ____exports.getBossIDsForStage(self, stage)
+    return STAGE_TO_COMBINED_BOSS_SET_MAP:get(stage)
+end
+--- Helper function to get the set of vanilla bosses that can randomly appear on a particular stage
+-- ID.
+-- 
+-- Also see the `getAllBossesSet` and `getBossIDsForStage` functions.
+function ____exports.getBossIDsForStageID(self, stageID)
+    return STAGE_ID_TO_BOSS_IDS:get(stageID)
+end
 --- Helper function to get the proper English name for a boss. For example, the name for
 -- `BossID.WRETCHED` (36) is "The Wretched".
 function ____exports.getBossName(self, bossID)
     return BOSS_NAMES[bossID] or DEFAULT_BOSS_NAME
 end
---- Helper function to get the set of vanilla bosses for a particular stage and stage type
--- combination.
--- 
--- Also see the `getAllBossesSet` and `getCombinedBossSet` functions.
-function ____exports.getBossSet(self, stageID)
-    return STAGE_ID_TO_BOSS_SET_MAP:get(stageID)
-end
 --- Helper function to get the set of stage IDs that a particular boss naturally appears in.
 function ____exports.getBossStageIDs(self, bossID)
     return BOSS_ID_TO_STAGE_IDS[bossID]
@@ -180,14 +188,6 @@ function ____exports.getBosses(self, entityType, variant, subType, ignoreFriendl
         function(____, npc) return npc:IsBoss() end
     )
 end
---- Helper function to get the set of vanilla bosses for a particular stage across all of the stage
--- types. For example, specifying `LevelStage.BASEMENT_2` will return a set with all of the bosses
--- for Basement, Cellar, Burning Basement, Downpour, and Dross.
--- 
--- Also see the `getAllBossesSet` and `getBossSet` functions.
-function ____exports.getCombinedBossSet(self, stage)
-    return STAGE_TO_COMBINED_BOSS_SET_MAP:get(stage)
-end
 function ____exports.getEntityTypeVariantFromBossID(self, bossID)
     return BOSS_ID_TO_ENTITY_TYPE_VARIANT[bossID]
 end
@@ -208,21 +208,21 @@ local function getNumBossSegments(self, entityType, variant, numSegments)
         return numSegments
     end
     repeat
-        local ____switch22 = entityType
-        local ____cond22 = ____switch22 == EntityType.CHUB
-        if ____cond22 then
+        local ____switch23 = entityType
+        local ____cond23 = ____switch23 == EntityType.CHUB
+        if ____cond23 then
             do
                 return 3
             end
         end
-        ____cond22 = ____cond22 or ____switch22 == EntityType.LOKI
-        if ____cond22 then
+        ____cond23 = ____cond23 or ____switch23 == EntityType.LOKI
+        if ____cond23 then
             do
                 return variant == LokiVariant.LOKII and 2 or 1
             end
         end
-        ____cond22 = ____cond22 or ____switch22 == EntityType.GURGLING
-        if ____cond22 then
+        ____cond23 = ____cond23 or ____switch23 == EntityType.GURGLING
+        if ____cond23 then
             do
                 return 2
             end

package/dist/functions/stage.d.ts

@@ -1,5 +1,4 @@
-import type { StageID } from "isaac-typescript-definitions";
-import { LevelStage, RoomType, StageType } from "isaac-typescript-definitions";
+import { LevelStage, RoomType, StageID, StageType } from "isaac-typescript-definitions";
 /**
  * Helper function that calculates what the stage type should be for the provided stage. This
  * emulates what the game's internal code does.
@@ -42,9 +41,13 @@ export declare function getLevelName(stage?: LevelStage, stageType?: StageType):
 /** Alias for the `Level.GetStage` method. */
 export declare function getStage(): LevelStage;
 /**
- * Helper function to get the stage ID that corresponds to a particular floor. It does this by
- * manually converting `LevelStage` and `StageType` into `StageID`. This is useful because
- * `getRoomStageID` will not correctly return the `StageID` if the player is in a special room.
+ * Helper function to get the stage ID that corresponds to a particular stage and stage type.
+ *
+ * This is useful because `getRoomStageID` will not correctly return the `StageID` if the player is
+ * in a special room.
+ *
+ * This correctly handles the case of Greed Mode. In Greed Mode, if an undefined stage and stage
+ * type combination are passed, `StageID.SPECIAL_ROOMS` (0) will be returned.
  *
  * @param stage Optional. If not specified, the stage corresponding to the current floor will be
  *              used.
@@ -52,6 +55,15 @@ export declare function getStage(): LevelStage;
  *                  will be used.
  */
 export declare function getStageID(stage?: LevelStage, stageType?: StageType): StageID;
+/**
+ * Helper function to get the English name corresponding to a stage ID. For example, "Caves".
+ *
+ * This is derived from the data in the "stages.xml" file.
+ *
+ * Note that unlike "stages.xml", Blue Womb is specified with a name of "Blue Womb" instead of
+ * "???".
+ */
+export declare function getStageIDName(stageID: StageID): string;
 /** Alias for the `Level.GetStageType` method. */
 export declare function getStageType(): StageType;
 /**

package/dist/functions/stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAa7E;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE/D;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAO7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,cAAc,EAAE,UAAU,GACzB,OAAO,CAKT;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE3E;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE1E;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE/D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,eAAe,EAAE,SAAS,UAAU,EAAE,GACxC,OAAO,CAGT;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAMtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,SAAS,UAAU,EAAE,GAAG,OAAO,CAIjE;AAED,gGAAgG;AAChG,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAI1D;AAED,gGAAgG;AAChG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,CAIxE;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAGrD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAM1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAMtD;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,OAAO,CAMpD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAYN"}
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAuCR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAsB7E;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEvD;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE/D;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAO7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,cAAc,EAAE,UAAU,GACzB,OAAO,CAKT;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE3E;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE1E;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE/D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,eAAe,EAAE,SAAS,UAAU,EAAE,GACxC,OAAO,CAGT;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAMtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,SAAS,UAAU,EAAE,GAAG,OAAO,CAIjE;AAED,gGAAgG;AAChG,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAI1D;AAED,gGAAgG;AAChG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,CAIxE;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAGrD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAM1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAMtD;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,OAAO,CAMpD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAYN"}

package/dist/functions/stage.lua

@@ -5,15 +5,17 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local GameStateFlag = ____isaac_2Dtypescript_2Ddefinitions.GameStateFlag
 local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local StageID = ____isaac_2Dtypescript_2Ddefinitions.StageID
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 local ____cachedClasses = require("core.cachedClasses")
 local game = ____cachedClasses.game
-local ____levelNames = require("objects.levelNames")
-local LEVEL_NAMES = ____levelNames.LEVEL_NAMES
 local ____roomTypeSpecialGotoPrefixes = require("objects.roomTypeSpecialGotoPrefixes")
 local ROOM_TYPE_SPECIAL_GOTO_PREFIXES = ____roomTypeSpecialGotoPrefixes.ROOM_TYPE_SPECIAL_GOTO_PREFIXES
+local ____stageIDNames = require("objects.stageIDNames")
+local STAGE_ID_NAMES = ____stageIDNames.STAGE_ID_NAMES
 local ____stageToStageID = require("objects.stageToStageID")
 local STAGE_TO_STAGE_ID = ____stageToStageID.STAGE_TO_STAGE_ID
+local STAGE_TO_STAGE_ID_GREED_MODE = ____stageToStageID.STAGE_TO_STAGE_ID_GREED_MODE
 local ____stageTypeSuffixes = require("objects.stageTypeSuffixes")
 local STAGE_TYPE_SUFFIXES = ____stageTypeSuffixes.STAGE_TYPE_SUFFIXES
 local ____log = require("functions.log")
@@ -22,6 +24,45 @@ local ____types = require("functions.types")
 local asLevelStage = ____types.asLevelStage
 local ____utils = require("functions.utils")
 local inRange = ____utils.inRange
+--- Helper function to get the stage ID that corresponds to a particular stage and stage type.
+-- 
+-- This is useful because `getRoomStageID` will not correctly return the `StageID` if the player is
+-- in a special room.
+-- 
+-- This correctly handles the case of Greed Mode. In Greed Mode, if an undefined stage and stage
+-- type combination are passed, `StageID.SPECIAL_ROOMS` (0) will be returned.
+-- 
+-- @param stage Optional. If not specified, the stage corresponding to the current floor will be
+-- used.
+-- @param stageType Optional. If not specified, the stage type corresponding to the current floor
+-- will be used.
+function ____exports.getStageID(self, stage, stageType)
+    local level = game:GetLevel()
+    if stage == nil then
+        stage = level:GetStage()
+    end
+    if stageType == nil then
+        stageType = level:GetStageType()
+    end
+    if game:IsGreedMode() then
+        local stageTypeToStageID = STAGE_TO_STAGE_ID_GREED_MODE:get(stage)
+        if stageTypeToStageID == nil then
+            return StageID.SPECIAL_ROOMS
+        end
+        return stageTypeToStageID[stageType]
+    end
+    local stageTypeToStageID = STAGE_TO_STAGE_ID[stage]
+    return stageTypeToStageID[stageType]
+end
+--- Helper function to get the English name corresponding to a stage ID. For example, "Caves".
+-- 
+-- This is derived from the data in the "stages.xml" file.
+-- 
+-- Note that unlike "stages.xml", Blue Womb is specified with a name of "Blue Womb" instead of
+-- "???".
+function ____exports.getStageIDName(self, stageID)
+    return STAGE_ID_NAMES[stageID]
+end
 --- Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
 -- `StageType.REPENTANCE_B`.
 function ____exports.isRepentanceStage(self, stageType)
@@ -114,33 +155,39 @@ function ____exports.getLevelName(self, stage, stageType)
     if stageType == nil then
         stageType = level:GetStageType()
     end
-    local stageNames = LEVEL_NAMES[stage]
-    return stageNames[stageType]
+    local stageID = ____exports.getStageID(nil, stage, stageType)
+    local stageIDName = ____exports.getStageIDName(nil, stageID)
+    local suffix
+    repeat
+        local ____switch14 = stage
+        local ____cond14 = ____switch14 == LevelStage.BASEMENT_1 or ____switch14 == LevelStage.CAVES_1 or ____switch14 == LevelStage.DEPTHS_1 or ____switch14 == LevelStage.WOMB_1
+        if ____cond14 then
+            do
+                suffix = " 1"
+                break
+            end
+        end
+        ____cond14 = ____cond14 or (____switch14 == LevelStage.BASEMENT_2 or ____switch14 == LevelStage.CAVES_2 or ____switch14 == LevelStage.DEPTHS_2 or ____switch14 == LevelStage.WOMB_2)
+        if ____cond14 then
+            do
+                suffix = " 2"
+                break
+            end
+        end
+        do
+            do
+                suffix = ""
+                break
+            end
+        end
+    until true
+    return stageIDName .. suffix
 end
 --- Alias for the `Level.GetStage` method.
 function ____exports.getStage(self)
     local level = game:GetLevel()
     return level:GetStage()
 end
---- Helper function to get the stage ID that corresponds to a particular floor. It does this by
--- manually converting `LevelStage` and `StageType` into `StageID`. This is useful because
--- `getRoomStageID` will not correctly return the `StageID` if the player is in a special room.
--- 
--- @param stage Optional. If not specified, the stage corresponding to the current floor will be
--- used.
--- @param stageType Optional. If not specified, the stage type corresponding to the current floor
--- will be used.
-function ____exports.getStageID(self, stage, stageType)
-    local level = game:GetLevel()
-    if stage == nil then
-        stage = level:GetStage()
-    end
-    if stageType == nil then
-        stageType = level:GetStageType()
-    end
-    local stageTypeToStageID = STAGE_TO_STAGE_ID[stage]
-    return stageTypeToStageID[stageType]
-end
 --- Alias for the `Level.GetStageType` method.
 function ____exports.getStageType(self)
     local level = game:GetLevel()

package/dist/index.rollup.d.ts

@@ -76,7 +76,7 @@ import { RoomType } from 'isaac-typescript-definitions';
 import type { SackSubType } from 'isaac-typescript-definitions';
 import { SeedEffect } from 'isaac-typescript-definitions';
 import { SlotVariant } from 'isaac-typescript-definitions';
-import type { StageID } from 'isaac-typescript-definitions';
+import { StageID } from 'isaac-typescript-definitions';
 import { StageType } from 'isaac-typescript-definitions';
 import { TearFlag } from 'isaac-typescript-definitions';
 import type { TearVariant } from 'isaac-typescript-definitions';
@@ -4912,8 +4912,8 @@ export declare function getAliveBosses(entityType?: EntityType | -1, variant?: n
 export declare function getAliveNPCs(entityType?: EntityType | -1, variant?: number, subType?: number, ignoreFriendly?: boolean): readonly EntityNPC[];
 
 /**
- * Helper function to get the set of every boss in the game (which is derived from the `BossID`
- * enum).
+ * Helper function to get an array with every boss in the game. This is derived from the `BossID`
+ * enum.
  *
  * This includes:
  * - Ultra Greed
@@ -4926,12 +4926,9 @@ export declare function getAliveNPCs(entityType?: EntityType | -1, variant?: num
  * - sub-bosses of The Beast fight (e.g. Ultra Famine, Ultra Pestilence, Ultra War, Ultra Death)
  * - bosses that do not have any Boss Rooms defined due to being unfinished (e.g. Raglich)
  *
- * Also see the `getBossSet` and `getCombinedBossSet` functions.
- *
- * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives.
- *                           Default is true.
+ * Also see the `getAllNonStoryBosses` function.
  */
-export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<BossID>;
+export declare function getAllBosses(): readonly BossID[];
 
 /**
  * Helper function to get every legal grid index for the current room.
@@ -4940,6 +4937,13 @@ export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlyS
  */
 export declare function getAllGridIndexes(): readonly int[];
 
+/**
+ * Helper function to get an array with every boss in the game. This is derived from the `BossID`
+ * enum. This is the same thing as the `getAllBosses` helper function, but with story bosses
+ * filtered out.
+ */
+export declare function getAllNonStoryBosses(): readonly BossID[];
+
 /**
  * Helper function to get an array with every non-null pill color. This includes all gold colors and
  * all horse colors.
@@ -5118,6 +5122,23 @@ export declare function getBossID(): BossID | undefined;
 
 export declare function getBossIDFromEntityTypeVariant(entityType: EntityType, variant: int): BossID | undefined;
 
+/**
+ * Helper function to get the set of vanilla bosses for a particular stage across all of the stage
+ * types. For example, specifying `LevelStage.BASEMENT_2` will return a set with all of the bosses
+ * for Basement, Cellar, Burning Basement, Downpour, and Dross.
+ *
+ * Also see the `getAllBossesSet` and `getBossIDsForStageID` functions.
+ */
+export declare function getBossIDsForStage(stage: LevelStage): ReadonlySet<BossID> | undefined;
+
+/**
+ * Helper function to get the set of vanilla bosses that can randomly appear on a particular stage
+ * ID.
+ *
+ * Also see the `getAllBossesSet` and `getBossIDsForStage` functions.
+ */
+export declare function getBossIDsForStageID(stageID: StageID): readonly BossID[] | undefined;
+
 /**
  * Helper function to get the proper English name for a boss. For example, the name for
  * `BossID.WRETCHED` (36) is "The Wretched".
@@ -5148,14 +5169,6 @@ export declare function getBossPortraitPNGFilePath(bossID: BossID): string;
  */
 export declare function getBossRushDoor(): GridEntityDoor | undefined;
 
-/**
- * Helper function to get the set of vanilla bosses for a particular stage and stage type
- * combination.
- *
- * Also see the `getAllBossesSet` and `getCombinedBossSet` functions.
- */
-export declare function getBossSet(stageID: StageID): ReadonlySet<BossID> | undefined;
-
 /** Helper function to get the set of stage IDs that a particular boss naturally appears in. */
 export declare function getBossStageIDs(bossID: BossID): ReadonlySet<StageID>;
 
@@ -5520,15 +5533,6 @@ export declare function getCollectibleTags(collectibleOrCollectibleType: EntityP
  */
 export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntity): readonly Entity[];
 
-/**
- * Helper function to get the set of vanilla bosses for a particular stage across all of the stage
- * types. For example, specifying `LevelStage.BASEMENT_2` will return a set with all of the bosses
- * for Basement, Cellar, Burning Basement, Downpour, and Dross.
- *
- * Also see the `getAllBossesSet` and `getBossSet` functions.
- */
-export declare function getCombinedBossSet(stage: LevelStage): ReadonlySet<BossID> | undefined;
-
 /** Helper function to get the entity type, variant, and sub-type from an `EntityID`. */
 export declare function getConstituentsFromEntityID(entityID: EntityID): [entityType: EntityType, variant: int, subType: int];
 
@@ -7889,9 +7893,13 @@ export declare function getSpikes(variant?: number): readonly GridEntitySpikes[]
 export declare function getStage(): LevelStage;
 
 /**
- * Helper function to get the stage ID that corresponds to a particular floor. It does this by
- * manually converting `LevelStage` and `StageType` into `StageID`. This is useful because
- * `getRoomStageID` will not correctly return the `StageID` if the player is in a special room.
+ * Helper function to get the stage ID that corresponds to a particular stage and stage type.
+ *
+ * This is useful because `getRoomStageID` will not correctly return the `StageID` if the player is
+ * in a special room.
+ *
+ * This correctly handles the case of Greed Mode. In Greed Mode, if an undefined stage and stage
+ * type combination are passed, `StageID.SPECIAL_ROOMS` (0) will be returned.
  *
  * @param stage Optional. If not specified, the stage corresponding to the current floor will be
  *              used.
@@ -7900,6 +7908,16 @@ export declare function getStage(): LevelStage;
  */
 export declare function getStageID(stage?: LevelStage, stageType?: StageType): StageID;
 
+/**
+ * Helper function to get the English name corresponding to a stage ID. For example, "Caves".
+ *
+ * This is derived from the data in the "stages.xml" file.
+ *
+ * Note that unlike "stages.xml", Blue Womb is specified with a name of "Blue Womb" instead of
+ * "???".
+ */
+export declare function getStageIDName(stageID: StageID): string;
+
 /** Alias for the `Level.GetStageType` method. */
 export declare function getStageType(): StageType;