isaacscript-common 82.0.1 → 83.0.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/index.rollup.d.ts

@@ -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];