isaacscript-common 50.0.0 → 51.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4722,20 +4722,18 @@ export declare function getAliveNPCs(entityType?: EntityType | -1, variant?: num
4722
4722
  /**
4723
4723
  * Helper function to get the set of every boss in the game.
4724
4724
  *
4725
- * The set contains strings with the entity type and variant, separated by a period.
4726
- *
4727
4725
  * Note that this set does not include:
4728
4726
  * - mini-bosses (e.g. Ultra Pride, Krampus)
4729
4727
  * - bosses that do not appear in Boss Rooms (e.g. Uriel, Gabriel)
4730
- * - the second phase of multi-phase bosses (e.g. Mega Satan 2), with the exception of The Beast
4731
- * (Ultra Famine, Ultra Pestilence, Ultra War, and Ultra Death are included)
4728
+ * - the second phase of multi-phase bosses (e.g. Mega Satan 2, Ultra Famine, Ultra Pestilence,
4729
+ * Ultra War, Ultra Death)
4732
4730
  *
4733
4731
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
4734
4732
  *
4735
- * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!
4733
+ * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives.
4736
4734
  * Default is true.
4737
4735
  */
4738
- export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<string>;
4736
+ export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<BossID>;
4739
4737
 
4740
4738
  /**
4741
4739
  * Helper function to get every legal grid index for the current room.
@@ -4918,11 +4916,9 @@ export declare function getBossRushDoor(): GridEntityDoor | undefined;
4918
4916
  * Helper function to get the set of vanilla bosses for a particular stage and stage type
4919
4917
  * combination.
4920
4918
  *
4921
- * The set contains strings with the entity type and variant, separated by a period.
4922
- *
4923
4919
  * Also see the `getAllBossesSet` and `getCombinedBossSet` functions.
4924
4920
  */
4925
- export declare function getBossSet(stage: int, stageType: StageType): ReadonlySet<string> | undefined;
4921
+ export declare function getBossSet(stage: LevelStage, stageType: StageType): ReadonlySet<BossID> | undefined;
4926
4922
 
4927
4923
  /**
4928
4924
  * Helper function to get a card description from a Card enum value.
@@ -5200,14 +5196,12 @@ export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntit
5200
5196
 
5201
5197
  /**
5202
5198
  * Helper function to get the set of vanilla bosses for a particular stage across all of the stage
5203
- * types. For example, specifying a stage of 2 will return a set with all of the bosses for
5204
- * Basement, Cellar, Burning Basement, Downpour, and Dross.
5205
- *
5206
- * The set contains strings with the entity type and variant, separated by a period.
5199
+ * types. For example, specifying `LevelStage.BASEMENT_2` will return a set with all of the bosses
5200
+ * for Basement, Cellar, Burning Basement, Downpour, and Dross.
5207
5201
  *
5208
5202
  * Also see the `getAllBossesSet` and `getBossSet` functions.
5209
5203
  */
5210
- export declare function getCombinedBossSet(stage: int): ReadonlySet<string> | undefined;
5204
+ export declare function getCombinedBossSet(stage: LevelStage): ReadonlySet<BossID> | undefined;
5211
5205
 
5212
5206
  /** Helper function to get the entity type, variant, and sub-type from an `EntityID`. */
5213
5207
  export declare function getConstituentsFromEntityID(entityID: EntityID): [entityType: EntityType, variant: int, subType: int];
@@ -11147,7 +11141,7 @@ export declare enum ModCallbackCustom {
11147
11141
  * - in the `POST_NEW_ROOM_REORDERED` callback (firing every time a room is entered, even if the
11148
11142
  * entity was previously there on a previous room entry)
11149
11143
  * - in the `POST_UPDATE` callback (if the entity appeared mid-way through the room, like when the
11150
- * trapdoor appears after defeating It Lives!)
11144
+ * trapdoor appears after defeating It Lives)
11151
11145
  *
11152
11146
  * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
11153
11147
  * callback instead.