isaacscript-common 7.5.0 → 7.5.1

package/dist/interfaces/{CustomStageLua.d.ts → CustomStageTSConfig.d.ts}

@@ -9,7 +9,7 @@
  *
  * The `CustomStageLua` interface extends this, adding room metadata.
  */
-export declare type CustomStageTSConfig = Readonly<{
+export interface CustomStageTSConfig {
     /** Mandatory. The name of the custom stage. */
     name: string;
     /**
@@ -34,8 +34,14 @@ export declare type CustomStageTSConfig = Readonly<{
      * number of the stage that will be warped to and used as a basis for the stage by the level
      * generation algorithm.
      *
-     * (It is not possible to use Basement 1 as a base stage due to conflicts with the `Game.SetStage`
-     * method.)
+     * For example, if you wanted to have a custom stage with a small amount of rooms per floor, then
+     * you should choose 2 as a base. (This would copy the number of rooms that would appear in
+     * Basement 2.) And if you wanted to have a custom stage with the maximum amount of rooms, then
+     * you should choose 13 as a base. (This would copy the number of rooms that would appear on The
+     * Void.)
+     *
+     * It is not possible to use Basement 1 as a base stage due to conflicts with the `Game.SetStage`
+     * method.
      *
      * If not specified, `LevelStage.BASEMENT_2` (2) will be used.
      *
@@ -59,7 +65,7 @@ export declare type CustomStageTSConfig = Readonly<{
      * the graphics for the walls and floor.) If not specified, the graphics for Basement will be
      * used.
      */
-    backdropPNGPaths?: Readonly<{
+    backdropPNGPaths?: {
         /**
          * An array that contains the full paths to the graphic files that are used for the floor in
          * narrow rooms. (The "n" stands for "narrow").
@@ -69,7 +75,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement_nfloor.png".
          */
-        nFloors: readonly string[];
+        nFloors: string[];
         /**
          * An array that contains the full paths to the graphic files that are used for the floor in L
          * rooms.
@@ -79,7 +85,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * For an example of this, see the vanilla file "resources/gfx/backdrop/01_lbasementfloor.png".
          */
-        lFloors: readonly string[];
+        lFloors: string[];
         /**
          * An array that contains the full paths to the graphic files that are used for the walls of the
          * floor.
@@ -91,7 +97,7 @@ export declare type CustomStageTSConfig = Readonly<{
          * the vanilla file, they concatenate all four variations together into one PNG file. However,
          * for the custom stages feature, you must separate each wall variation into a separate file.)
          */
-        walls: readonly string[];
+        walls: string[];
         /**
          * An array that contains the full paths to the graphic files for the stage's corners.
          *
@@ -105,8 +111,8 @@ export declare type CustomStageTSConfig = Readonly<{
          * you must separate each corner variation into a separate file (and put it in a different file
          * from the walls).
          */
-        corners: readonly string[];
-    }>;
+        corners: string[];
+    };
     /**
      * Optional. The full path to the spritesheet that contains the graphics of the decorations for
      * the floor.
@@ -140,7 +146,7 @@ export declare type CustomStageTSConfig = Readonly<{
      * Optional. A collection of paths that contain graphics for the doors of the floor. If not
      * specified, the doors for Basement will be used.
      */
-    doorPNGPaths?: Readonly<{
+    doorPNGPaths?: {
         /**
          * Optional. The full path to the spritesheet that contains the graphics of the normal doors for
          * the floor.
@@ -237,14 +243,14 @@ export declare type CustomStageTSConfig = Readonly<{
          * located at: `resources/gfx/grid/door_02b_chestroomdoor.png`
          */
         chestRoom?: string;
-    }>;
+    };
     /**
      * Optional. An array of shadow objects that describe the graphics for the custom shadows of the
      * floor. (In this context, "shadows" are the outlines from things on the roof. For example, in
      * Basement, a shadow of a sideways V is used, among others.) If not specified, no extra shadows
      * will be drawn.
      */
-    shadows?: Readonly<{
+    shadows?: {
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_1x1` (1), `RoomShape.IH` (2), and `RoomShape.IV` (3).
@@ -253,7 +259,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "1x1"?: readonly CustomStageShadow[];
+        "1x1"?: CustomStageShadow[];
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_1x2` (4) and `RoomShape.IIV` (5).
@@ -262,7 +268,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "1x2"?: readonly CustomStageShadow[];
+        "1x2"?: CustomStageShadow[];
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_2x1` (6) and `RoomShape.IIH` (7).
@@ -271,7 +277,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "2x1"?: readonly CustomStageShadow[];
+        "2x1"?: CustomStageShadow[];
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_2x2` (8), `RoomShape.LTL` (9), `RoomShape.LTR` (10), `RoomShape.LBL` (11),
@@ -281,12 +287,20 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "2x2"?: readonly CustomStageShadow[];
-    }>;
-    /** Optional. An array containing the bosses that should be used for the stage. */
-    bossPool?: readonly CustomStageBossPoolEntry[];
-    /** Optional. A collection of colors used in the boss "versus" screen. */
-    versusScreen?: Readonly<{
+        "2x2"?: CustomStageShadow[];
+    };
+    /**
+     * Optional. An array containing the bosses that should be used for the stage. This can include
+     * both vanilla bosses and modded bosses.
+     */
+    bossPool?: CustomStageBossPoolEntry[];
+    /**
+     * Optional. A collection of colors used for in the boss "versus" screen for all of the bosses.
+     *
+     * Note that these graphics will only be applied if one or more bosses are specified in the
+     * `bossPool` field.
+     */
+    versusScreen?: {
         /**
          * Optional. An object representing the color to use for the background of the boss "versus"
          * screen. If not specified, the color for Basement 1 will be used.
@@ -294,7 +308,7 @@ export declare type CustomStageTSConfig = Readonly<{
          * For a list of the colors that correspond to the vanilla stages, see
          * `versusScreenBackgroundColors.ts`.
          */
-        backgroundColor?: Readonly<{
+        backgroundColor?: {
             /**
              * @minimum 0
              * @maximum 1
@@ -315,7 +329,7 @@ export declare type CustomStageTSConfig = Readonly<{
              * @maximum 1
              */
             a: number;
-        }>;
+        };
         /**
          * Optional. An object representing the color to use for the dirt spots in the boss "versus"
          * screen. (There are two dirt spots; one for the player and one for the boss.) If not
@@ -324,7 +338,7 @@ export declare type CustomStageTSConfig = Readonly<{
          * For a list of the colors that correspond to the vanilla stages, see
          * `versusScreenDirtSpotColors.ts`.
          */
-        dirtSpotColor?: Readonly<{
+        dirtSpotColor?: {
             /**
              * @minimum 0
              * @maximum 1
@@ -345,14 +359,14 @@ export declare type CustomStageTSConfig = Readonly<{
              * @maximum 1
              */
             a: number;
-        }>;
-    }>;
-}>;
+        };
+    };
+}
 /**
  * A description of a custom stage shadow. (In this context, "shadows" are the outlines from things
  * on the roof. For example, in Basement, a shadow of a sideways V is used, among others.)
  */
-export declare type CustomStageShadow = Readonly<{
+export interface CustomStageShadow {
     /**
      * The full path to the shadow overlay PNG file.
      *
@@ -366,7 +380,7 @@ export declare type CustomStageShadow = Readonly<{
      * If not specified, an object of `{ r: 0, g: 0, b: 0, a: 0.25 }` will be used (which corresponds
      * to 75% faded black).
      */
-    color?: Readonly<{
+    color?: {
         /**
          * @minimum 0
          * @maximum 1
@@ -387,45 +401,57 @@ export declare type CustomStageShadow = Readonly<{
          * @maximum 1
          */
         a: number;
-    }>;
-}>;
-/** An object that represents a possible boss for a custom stage. */
+    };
+}
+/**
+ * An object that represents a possible boss for a custom stage. This can be for a vanilla boss or a
+ * custom boss.
+ */
 export interface CustomStageBossPoolEntry {
     /**
-     * The name of the boss. This must correspond to the entry in "entities2.xml".
-     *
-     * Note that since there is no way to determine the corresponding `EntityType` of the boss during
-     * compile-time, you must specify the `EntityType` at run-time when your mod first loads using the
-     * `registerCustomBoss` helper function.
+     * The name of the boss. This should correspond to the entry for the boss in the "entities2.xml"
+     * file.
      */
     name: string;
+    /**
+     * The arbitrary sub-type chosen for this boss, ranging between 1 and 999. You must set the boss
+     * rooms for this boss to this sub-type in Basement Renovator by right-clicking on the room on the
+     * right-hand-side.
+     *
+     * It does not matter if the arbitrary sub-type overlaps with any of the vanilla `BossID` values
+     * (e.g. vanilla Boss Room sub-types in "00.special_rooms.stb"). It also does not matter if this
+     * value overlaps with the values from other mods.
+     *
+     * If you are creating an entry for a vanilla boss, it is recommended that you match the sub-type
+     * with the corresponding vanilla `BossID` value. This will make things a bit easier to understand
+     * for people working on your mod, but is not a hard requirement.
+     *
+     * @minimum 1
+     * @maximum 999
+     */
+    subType: number;
     /**
      * The weight of the boss. This is used when randomly selecting which boss to use for the floor.
      * For example, use a value of 1 if you want this boss to be equally likely as any other boss, 0.5
      * if you want it to be half as likely, 2 if you want it to be twice as likely, and so on.
      */
     weight: number;
+    /** Optional. A collection of sprites used for the boss on the "versus" screen. */
+    versusScreen?: {
+        /**
+         * Mandatory. The full path to the spritesheet that contains the graphics of the name of the
+         * boss that will be displayed on the top of the boss "versus" screen.
+         *
+         * If not specified, a sprite showing "???" will be used.
+         */
+        namePNGPath: string;
+        /**
+         * Mandatory. The full path to the spritesheet that contains the portrait of the boss that will
+         * be displayed on the right side of the boss "versus" screen.
+         *
+         * If not specified, a sprite showing "???" will be used.
+         */
+        portraitPNGPath: string;
+    };
 }
-/**
- * An object that represents a custom stage. The "metadata.lua" file contains an array of these
- * objects. Besides the room metadata, the data is the same as what is specified inside the
- * "tsconfig.json" file.
- *
- * The `CustomStage` interface extends this, adding more data.
- */
-export interface CustomStageLua extends CustomStageTSConfig {
-    readonly roomsMetadata: readonly CustomStageRoomMetadata[];
-}
-/**
- * Metadata about a custom stage room. Each custom stage object contains an array with metadata for
- * each room.
- */
-export declare type CustomStageRoomMetadata = Readonly<{
-    type: number;
-    variant: number;
-    subType: number;
-    shape: number;
-    doorSlotFlags: number;
-    weight: number;
-}>;
-//# sourceMappingURL=CustomStageLua.d.ts.map
+//# sourceMappingURL=CustomStageTSConfig.d.ts.map

package/dist/interfaces/CustomStageTSConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomStageTSConfig.d.ts","sourceRoot":"","sources":["../../src/interfaces/CustomStageTSConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAKH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QACjB;;;;;;;;WAQG;QACH,OAAO,EAAE,MAAM,EAAE,CAAC;QAElB;;;;;;;;WAQG;QACH,OAAO,EAAE,MAAM,EAAE,CAAC;QAElB;;;;;;;;;;WAUG;QACH,KAAK,EAAE,MAAM,EAAE,CAAC;QAEhB;;;;;;;;;;;;WAYG;QACH,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IAEF;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE;QACb;;;;;;WAMG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;;;;WAMG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;;;WAMG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;;;;WAMG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF;;;;;OAKG;IACH,OAAO,CAAC,EAAE;QACR;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAE5B;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAE5B;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAE5B;;;;;;;;WAQG;QACH,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;KAC7B,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAEtC;;;;;OAKG;IACH,YAAY,CAAC,EAAE;QACb;;;;;;WAMG;QACH,eAAe,CAAC,EAAE;YAChB;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;YAEV;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;YAEV;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;YAEV;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;SACX,CAAC;QAEF;;;;;;;WAOG;QACH,aAAa,CAAC,EAAE;YACd;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;YAEV;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;YAEV;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;YAEV;;;eAGG;YACH,CAAC,EAAE,MAAM,CAAC;SACX,CAAC;KACH,CAAC;CACH;AAED;;;GAGG;AAEH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,KAAK,CAAC,EAAE;QACN;;;WAGG;QACH,CAAC,EAAE,MAAM,CAAC;QAEV;;;WAGG;QACH,CAAC,EAAE,MAAM,CAAC;QAEV;;;WAGG;QACH,CAAC,EAAE,MAAM,CAAC;QAEV;;;WAGG;QACH,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;CACH;AAED;;;GAGG;AAEH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;;OAeG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,kFAAkF;IAClF,YAAY,CAAC,EAAE;QAEb;;;;;WAKG;QACH,WAAW,EAAE,MAAM,CAAC;QAGpB;;;;;WAKG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH"}

package/dist/interfaces/JSONRoomsFile.d.ts

@@ -1,7 +1,7 @@
 /**
  * The standard library has the feature to deploy a new room on-the-fly with the `deployJSONRoom`
  * helper function. It requires a `JSONRoomsFile` as an argument, which is simply an XML file
- * converted to JSON. (You create XML room files using the Basement Renovator program.)
+ * converted to JSON. (You can create XML room files using the Basement Renovator program.)
  *
  * You can convert your XML files using the following command:
  *
@@ -16,10 +16,11 @@
 export interface JSONRoomsFile {
     rooms: JSONRooms;
 }
+/** Part of `JSONRoomsFile`. */
 export interface JSONRooms {
     room: JSONRoom[];
 }
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export interface JSONRoom {
     $: {
         /** Needs to be converted to an `int`. */
@@ -43,7 +44,7 @@ export interface JSONRoom {
     door: JSONDoor[];
     spawn: JSONSpawn[];
 }
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export interface JSONDoor {
     $: {
         /** Equal to "True" or "False". Needs to be converted to an `boolean`. */
@@ -54,7 +55,7 @@ export interface JSONDoor {
         y: string;
     };
 }
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export interface JSONSpawn {
     $: {
         /** Needs to be converted to an `int`. */
@@ -64,7 +65,7 @@ export interface JSONSpawn {
     };
     entity: JSONEntity[];
 }
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export interface JSONEntity {
     $: {
         /** Needs to be converted to an `int`. */

package/dist/interfaces/JSONRoomsFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"JSONRoomsFile.d.ts","sourceRoot":"","sources":["../../src/interfaces/JSONRoomsFile.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,QAAQ,EAAE,CAAC;CAClB;AAED,2BAA2B;AAC3B,MAAM,WAAW,QAAQ;IACvB,CAAC,EAAE;QACD,yCAAyC;QACzC,UAAU,EAAE,MAAM,CAAC;QAEnB,yCAAyC;QACzC,MAAM,EAAE,MAAM,CAAC;QAEf,IAAI,EAAE,MAAM,CAAC;QAEb,yCAAyC;QACzC,KAAK,EAAE,MAAM,CAAC;QAEd,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,yCAAyC;QACzC,IAAI,EAAE,MAAM,CAAC;QAEb,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,0CAA0C;QAC1C,MAAM,EAAE,MAAM,CAAC;QAEf,yCAAyC;QACzC,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,2BAA2B;AAC3B,MAAM,WAAW,QAAQ;IACvB,CAAC,EAAE;QACD,yEAAyE;QACzE,MAAM,EAAE,MAAM,CAAC;QAEf,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;QAEV,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;CACH;AAED,2BAA2B;AAC3B,MAAM,WAAW,SAAS;IACxB,CAAC,EAAE;QACD,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;QAEV,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IAEF,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,2BAA2B;AAC3B,MAAM,WAAW,UAAU;IACzB,CAAC,EAAE;QACD,yCAAyC;QACzC,IAAI,EAAE,MAAM,CAAC;QAEb,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,0CAA0C;QAC1C,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH"}
+{"version":3,"file":"JSONRoomsFile.d.ts","sourceRoot":"","sources":["../../src/interfaces/JSONRoomsFile.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,+BAA+B;AAC/B,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,QAAQ,EAAE,CAAC;CAClB;AAED,+BAA+B;AAC/B,MAAM,WAAW,QAAQ;IACvB,CAAC,EAAE;QACD,yCAAyC;QACzC,UAAU,EAAE,MAAM,CAAC;QAEnB,yCAAyC;QACzC,MAAM,EAAE,MAAM,CAAC;QAEf,IAAI,EAAE,MAAM,CAAC;QAEb,yCAAyC;QACzC,KAAK,EAAE,MAAM,CAAC;QAEd,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,yCAAyC;QACzC,IAAI,EAAE,MAAM,CAAC;QAEb,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,0CAA0C;QAC1C,MAAM,EAAE,MAAM,CAAC;QAEf,yCAAyC;QACzC,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,+BAA+B;AAC/B,MAAM,WAAW,QAAQ;IACvB,CAAC,EAAE;QACD,yEAAyE;QACzE,MAAM,EAAE,MAAM,CAAC;QAEf,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;QAEV,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;CACH;AAED,+BAA+B;AAC/B,MAAM,WAAW,SAAS;IACxB,CAAC,EAAE;QACD,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;QAEV,yCAAyC;QACzC,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IAEF,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,WAAW,UAAU;IACzB,CAAC,EAAE;QACD,yCAAyC;QACzC,IAAI,EAAE,MAAM,CAAC;QAEb,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,yCAAyC;QACzC,OAAO,EAAE,MAAM,CAAC;QAEhB,0CAA0C;QAC1C,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH"}

package/dist/interfaces/private/CustomStage.d.ts

@@ -1,5 +1,5 @@
 import { DoorSlotFlag, RoomShape, RoomType } from "isaac-typescript-definitions";
-import { CustomStageLua, CustomStageRoomMetadata } from "../CustomStageLua";
+import { CustomStageLua, CustomStageRoomMetadata } from "../CustomStageTSConfig";
 export interface CustomStage extends CustomStageLua {
     /** A map that makes it easier to select certain room type/shape/door combinations. */
     readonly roomTypeMap: RoomTypeMap;

package/dist/interfaces/private/CustomStage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomStage.d.ts","sourceRoot":"","sources":["../../../src/interfaces/private/CustomStage.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,SAAS,EACT,QAAQ,EACT,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5E,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,sFAAsF;IACtF,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED,oBAAY,WAAW,GAAG,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC9D,aAAK,YAAY,GAAG,WAAW,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;AAC5D,aAAK,eAAe,GAAG,WAAW,CAAC,YAAY,EAAE,uBAAuB,EAAE,CAAC,CAAC"}
+{"version":3,"file":"CustomStage.d.ts","sourceRoot":"","sources":["../../../src/interfaces/private/CustomStage.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,SAAS,EACT,QAAQ,EACT,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,cAAc,EACd,uBAAuB,EACxB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,sFAAsF;IACtF,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED,oBAAY,WAAW,GAAG,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC9D,aAAK,YAAY,GAAG,WAAW,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;AAC5D,aAAK,eAAe,GAAG,WAAW,CAAC,YAAY,EAAE,uBAAuB,EAAE,CAAC,CAAC"}

package/package.json

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

package/src/classes/DefaultMap.ts

@@ -1,7 +1,8 @@
 import { isFunction, isPrimitive } from "../functions/types";
 
 /**
- * `DefaultMap` is a data structure that makes working with default values easier.
+ * `DefaultMap` is a data structure that makes working with default values easier. It extends a
+ * `Map` and adds additional methods.
  *
  * It is a common pattern to look up a value in a `Map`, and then, if the value does not exist, set
  * a default value for the key, and then return the default value. `DefaultMap` abstracts this
@@ -89,7 +90,7 @@ export class DefaultMap<Key, Value, Args extends unknown[] = []> extends Map<
 
   /**
    * See the main `DefaultMap` documentation:
-   * https://isaacscript.github.io/isaacscript-common/classes/classes_DefaultMap.DefaultMap
+   * https://isaacscript.github.io/isaacscript-common/other/classes/DefaultMap
    */
   constructor(
     defaultValueOrFactoryFunction: Value | FactoryFunction<Value, Args>,

package/src/features/customStage/customStageUtils.ts

@@ -2,7 +2,10 @@ import { sumArray } from "../../functions/array";
 import { log } from "../../functions/log";
 import { getRandomFloat } from "../../functions/random";
 import { getRandomSeed } from "../../functions/rng";
-import { CustomStageRoomMetadata } from "../../interfaces/CustomStageLua";
+import {
+  CustomStageBossPoolEntry,
+  CustomStageRoomMetadata,
+} from "../../interfaces/CustomStageTSConfig";
 
 /**
  * Helper function to get a random custom stage room from an array of custom stage rooms.
@@ -52,3 +55,51 @@ function getCustomStageRoomWithChosenWeight(
     `Failed to get a custom stage room with chosen weight: ${chosenWeight}`,
   );
 }
+
+export function getRandomBossRoomFromPool(
+  roomsMetadata: readonly CustomStageRoomMetadata[],
+  bossPool: readonly CustomStageBossPoolEntry[],
+  seedOrRNG: Seed | RNG = getRandomSeed(),
+  verbose = false,
+): CustomStageRoomMetadata {
+  const totalWeight = getTotalWeightOfBossPool(bossPool);
+  if (verbose) {
+    log(`Total weight of the custom stage boss pool provided: ${totalWeight}`);
+  }
+
+  const chosenWeight = getRandomFloat(0, totalWeight, seedOrRNG);
+  if (verbose) {
+    log(`Randomly chose weight for custom stage boss pool: ${chosenWeight}`);
+  }
+
+  const bossEntry = getBossEntryWithChosenWeight(bossPool, chosenWeight);
+
+  const roomsMetadataForBoss = roomsMetadata.filter(
+    (roomMetadata) => roomMetadata.subType === bossEntry.subType,
+  );
+  return getRandomCustomStageRoom(roomsMetadataForBoss, seedOrRNG, verbose);
+}
+
+function getTotalWeightOfBossPool(
+  bossPool: readonly CustomStageBossPoolEntry[],
+): float {
+  const weights = bossPool.map((bossEntry) => bossEntry.weight);
+  return sumArray(weights);
+}
+
+function getBossEntryWithChosenWeight(
+  bossPool: readonly CustomStageBossPoolEntry[],
+  chosenWeight: float,
+): CustomStageBossPoolEntry {
+  for (const bossEntry of bossPool) {
+    if (chosenWeight < bossEntry.weight) {
+      return bossEntry;
+    }
+
+    chosenWeight -= bossEntry.weight;
+  }
+
+  error(
+    `Failed to get a custom stage boss entry with chosen weight: ${chosenWeight}`,
+  );
+}

package/src/features/customStage/exports.ts

@@ -8,7 +8,7 @@
  */
 
 import {
-  EntityType,
+  DoorSlot,
   LevelStage,
   RoomShape,
   RoomType,
@@ -16,7 +16,7 @@ import {
 } from "isaac-typescript-definitions";
 import { reorderedCallbacksSetStageInternal } from "../../callbacks/reorderedCallbacks";
 import { game } from "../../core/cachedClasses";
-import { getEntityIDFromConstituents } from "../../functions/entities";
+import { doorSlotFlagsToDoorSlots } from "../../functions/doors";
 import { logError } from "../../functions/log";
 import { newRNG } from "../../functions/rng";
 import {
@@ -25,13 +25,13 @@ import {
 } from "../../functions/rooms";
 import { setStage } from "../../functions/stage";
 import { asNumber } from "../../functions/types";
+import { CustomStageRoomMetadata } from "../../interfaces/CustomStageTSConfig";
 import { CustomStage } from "../../interfaces/private/CustomStage";
-import { getRandomCustomStageRoom } from "./customStageUtils";
-import v, {
-  customBossPNGPaths,
-  customStageCachedRoomData,
-  customStagesMap,
-} from "./v";
+import {
+  getRandomBossRoomFromPool,
+  getRandomCustomStageRoom,
+} from "./customStageUtils";
+import v, { customStageCachedRoomData, customStagesMap } from "./v";
 
 export const DEFAULT_BASE_STAGE = LevelStage.BASEMENT_2;
 export const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
@@ -135,8 +135,8 @@ function setStageRoomsData(
     const roomType = room.Data.Type;
     const roomShapeMap = customStage.roomTypeMap.get(roomType);
     if (roomShapeMap === undefined) {
-      // Only show errors for non-default room types. (By default, we won't replace shops and other
-      // special rooms.)
+      // Only show errors for non-default room types. (We do not require that end-users provide
+      // custom rooms for shops and other special rooms inside of their XML file.)
       if (roomType === RoomType.DEFAULT) {
         logError(
           `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) for custom stage: ${customStage.name}`,
@@ -160,10 +160,32 @@ function setStageRoomsData(
       logError(
         `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) + RoomShape.${RoomShape[roomShape]} (${roomShape}) + DoorSlotFlags ${doorSlotFlags} for custom stage: ${customStage.name}`,
       );
+
+      const header = `For reference, a DoorSlotFlags of ${doorSlotFlags} is equal to the following doors being enabled:\n`;
+      const doorSlots = doorSlotFlagsToDoorSlots(doorSlotFlags);
+      const doorSlotLines = doorSlots.map(
+        (doorSlot) => `- DoorSlot.${DoorSlot[doorSlot]} (${doorSlot})`,
+      );
+      const explanation = header + doorSlotLines.join("\n");
+      logError(explanation);
       continue;
     }
 
-    const randomRoom = getRandomCustomStageRoom(roomsMetadata, rng, verbose);
+    let randomRoom: CustomStageRoomMetadata;
+    if (roomType === RoomType.BOSS) {
+      if (customStage.bossPool === undefined) {
+        continue;
+      }
+
+      randomRoom = getRandomBossRoomFromPool(
+        roomsMetadata,
+        customStage.bossPool,
+        rng,
+        verbose,
+      );
+    } else {
+      randomRoom = getRandomCustomStageRoom(roomsMetadata, rng, verbose);
+    }
 
     let newRoomData = customStageCachedRoomData.get(randomRoom.variant);
     if (newRoomData === undefined) {
@@ -187,40 +209,6 @@ function setStageRoomsData(
   }
 }
 
-/**
- * By default, unknown bosses will be drawn on the boss "versus" screen as "???". If your custom
- * stage has custom bosses, you can use this function to register the corresponding graphic file
- * files for them.
- *
- * For reference:
- * - The vanilla name sprite for Monstro is located at:
- *   `resources/gfx/ui/boss/bossname_20.0_monstro.png`
- * - The vanilla portrait sprite for Monstro is located at:
- *   `resources/gfx/ui/boss/portrait_20.0_monstro.png`
- *
- * (Note that boss metadata like this cannot be specified with the rest of the custom stage metadata
- * in the "tsconfig.json" file because there is not a way to retrieve the name of an entity at
- * run-time.)
- *
- * @param entityType The entity type of the custom boss.
- * @param variant The variant of the custom boss.
- * @param subType The sub-type of the custom boss.
- * @param namePNGPath The full path to the PNG file that contains the name of the boss that will be
- *                    displayed on the top of the boss "versus" screen.
- * @param portraitPNGPath The full path to the PNG file that contains the portrait of the boss that
- *                        will be displayed on the right side of the boss "versus" screen.
- */
-export function registerCustomBoss(
-  entityType: EntityType,
-  variant: int,
-  subType: int,
-  namePNGPath: string,
-  portraitPNGPath: string,
-): void {
-  const entityID = getEntityIDFromConstituents(entityType, variant, subType);
-  customBossPNGPaths.set(entityID, [namePNGPath, portraitPNGPath]);
-}
-
 /**
  * Helper function to disable the custom stage. This is typically called before taking the player to
  * a vanilla floor.

package/src/features/customStage/init.ts

@@ -13,7 +13,7 @@ import { hasFlag, removeFlag } from "../../functions/flag";
 import {
   CustomStageLua,
   CustomStageRoomMetadata,
-} from "../../interfaces/CustomStageLua";
+} from "../../interfaces/CustomStageTSConfig";
 import { CustomStage, RoomTypeMap } from "../../interfaces/private/CustomStage";
 import { saveDataManager } from "../saveDataManager/exports";
 import { setCustomStageBackdrop } from "./backdrop";

package/src/features/customStage/v.ts

@@ -40,9 +40,3 @@ export const customStagesMap = new Map<string, CustomStage>();
 
 /** Indexed by room variant. */
 export const customStageCachedRoomData = new Map<int, Readonly<RoomConfig>>();
-
-/** Indexed by entity ID. */
-export const customBossPNGPaths = new Map<
-  string,
-  [namePNGPath: string, portraitPNGPath: string]
->();