isaacscript-common 50.0.0 → 51.1.0

package/dist/index.rollup.d.ts

@@ -4722,20 +4722,18 @@ export declare function getAliveNPCs(entityType?: EntityType | -1, variant?: num
 /**
  * Helper function to get the set of every boss in the game.
  *
- * The set contains strings with the entity type and variant, separated by a period.
- *
  * Note that this set does not include:
  * - mini-bosses (e.g. Ultra Pride, Krampus)
  * - bosses that do not appear in Boss Rooms (e.g. Uriel, Gabriel)
- * - the second phase of multi-phase bosses (e.g. Mega Satan 2), with the exception of The Beast
- *   (Ultra Famine, Ultra Pestilence, Ultra War, and Ultra Death are included)
+ * - the second phase of multi-phase bosses (e.g. Mega Satan 2, Ultra Famine, Ultra Pestilence,
+ *   Ultra War, Ultra Death)
  *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
  *
- * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!
+ * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives.
  *                           Default is true.
  */
-export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<string>;
+export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<BossID>;
 
 /**
  * Helper function to get every legal grid index for the current room.
@@ -4918,11 +4916,9 @@ export declare function getBossRushDoor(): GridEntityDoor | undefined;
  * Helper function to get the set of vanilla bosses for a particular stage and stage type
  * combination.
  *
- * The set contains strings with the entity type and variant, separated by a period.
- *
  * Also see the `getAllBossesSet` and `getCombinedBossSet` functions.
  */
-export declare function getBossSet(stage: int, stageType: StageType): ReadonlySet<string> | undefined;
+export declare function getBossSet(stage: LevelStage, stageType: StageType): ReadonlySet<BossID> | undefined;
 
 /**
  * Helper function to get a card description from a Card enum value.
@@ -4975,6 +4971,14 @@ export declare function getCharacterName(character: PlayerType): string;
 /** Helper function to get an array containing the characters of all of the current players. */
 export declare function getCharacters(): PlayerType[];
 
+/**
+ * Helper function to get the path to the sprite for a particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is
+ * "characters/costumes/character_001_isaac.png".
+ */
+export declare function getCharacterSpritePNGFilePath(character: PlayerType): string;
+
 /**
  * Helper function to get the collectibles that are granted to a particular character at the
  * beginning of a run.
@@ -5200,14 +5204,12 @@ export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntit
 
 /**
  * Helper function to get the set of vanilla bosses for a particular stage across all of the stage
- * types. For example, specifying a stage of 2 will return a set with all of the bosses for
- * Basement, Cellar, Burning Basement, Downpour, and Dross.
- *
- * The set contains strings with the entity type and variant, separated by a period.
+ * 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: int): ReadonlySet<string> | undefined;
+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];
@@ -11147,7 +11149,7 @@ export declare enum ModCallbackCustom {
      * - in the `POST_NEW_ROOM_REORDERED` callback (firing every time a room is entered, even if the
      *   entity was previously there on a previous room entry)
      * - in the `POST_UPDATE` callback (if the entity appeared mid-way through the room, like when the
-     *   trapdoor appears after defeating It Lives!)
+     *   trapdoor appears after defeating It Lives)
      *
      * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
      * callback instead.