isaacscript-common 6.4.0 → 6.5.0

package/interfaces/CustomStageLua.d.ts

@@ -9,119 +9,264 @@
  *
  * The `CustomStageLua` interface extends this, adding room metadata.
  */
-export interface CustomStageTSConfig {
+export declare type CustomStageTSConfig = Readonly<{
     /** The name of the custom stage. Mandatory. */
-    readonly name: string;
+    name: string;
     /**
      * Path to the XML file that contains the rooms for the custom stage (created with Basement
      * Renovator). Mandatory.
      */
-    readonly xmlPath: string;
+    xmlPath: string;
     /** An arbitrarily chosen prefix in the range of 101-999. Mandatory. */
-    readonly roomVariantPrefix: number;
+    roomVariantPrefix: number;
     /**
      * An integer between 2 and 13, corresponding to the `LevelStage` enum. This is the number of the
      * stage that will be warped to and used as a basis for the stage by the level generation
      * algorithm. Mandatory.
      *
-     * (It is not possible to use Basement 1 as a base due to conflicts with the `Game.SetStage`
+     * (It is not possible to use Basement 1 as a base stage due to conflicts with the `Game.SetStage`
      * method.)
      */
-    readonly baseStage: number;
+    baseStage: number;
     /**
      * An integer between 0 and 5, corresponding to the `StageType` enum. This is the number of the
      * stage type that will be warped to and used as a basis for the stage by the level generation
      * algorithm. Mandatory.
      */
-    readonly baseStageType: number;
+    baseStageType: number;
     /**
-     * An object containing the paths to the backdrop for the stage. (A backdrop is the graphics for
-     * the walls and floor.) Mandatory.
+     * Optional. An object containing the paths to the backdrop graphics for the stage. (A backdrop is
+     * the graphics for the walls and floor.) If not specified, the graphics for Basement will be
+     * used.
      */
-    readonly backdrop: CustomStageBackdrop;
+    backdrop?: Readonly<{
+        /**
+         * The beginning of the path that leads to the backdrop graphics. For example:
+         *
+         * ```sh
+         * gfx/backdrop/revelations/revelations_
+         * ```
+         */
+        prefix: string;
+        /**
+         * The end of the path that leads to the backdrop graphics. In most cases, this will be ".png".
+         */
+        suffix: string;
+        /**
+         * An array of strings that represent the graphic files that are used for the floors in narrow
+         * rooms. (The "n" stands for "narrow").
+         *
+         * You must have at least one string in this array, but you can specify more than one to
+         * randomly add extra variety (like the vanilla stages do).
+         *
+         * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement_nfloor.png".
+         */
+        nFloors: readonly string[];
+        /**
+         * An array of strings that represent the graphic files that are used for the floors in L rooms.
+         *
+         * You must have at least one string in this array, but you can specify more than one to
+         * randomly add extra variety (like the vanilla stages do).
+         *
+         * For an example of this, see the vanilla file "resources/gfx/backdrop/01_lbasementfloor.png".
+         */
+        lFloors: readonly string[];
+        /**
+         * An array of strings that represent the graphic files for the stage's walls.
+         *
+         * You must have at least one string in this array, but you can specify more than one to
+         * randomly add extra variety (like the vanilla stages do).
+         *
+         * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement.png". (In
+         * 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[];
+        /**
+         * An array of strings that represent the graphic files for the stage's corners. You must have
+         * at least one string in this array, but you can specify more than one to randomly add extra
+         * variety (like the vanilla stages do).
+         *
+         * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement.png". (In
+         * the vanilla file, they concatenate both variations together into one PNG file and put it in
+         * the top right hand corner. The corners are shown in the top right hand corner of the file,
+         * with two different variations concatenated together. However, for the custom stages feature,
+         * you must separate each corner variation into a separate file (and put it in a different file
+         * from the walls).
+         */
+        corners: readonly string[];
+    }>;
     /**
-     * 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.
+     * Optional. The path to the spritesheet that contains the graphics of the decorations for the
+     * floor.
      *
-     * For a list of the colors that correspond to the vanilla stages, see
-     * `versusScreenBackgroundColors.ts`.
+     * If not specified, the vanilla Basement decorations spritesheet will be used. For reference,
+     * this is located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+     * Rebirth\resources\gfx\grid\props_01_basement.png`
      */
-    readonly versusScreenBackgroundColor?: {
-        r: number;
-        g: number;
-        b: number;
-    };
+    decorationsPNGPath?: string;
     /**
-     * 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 specified,
-     * the color for Basement 1 will be used.
+     * Optional. The path to the spritesheet that contains the graphics of the rocks/blocks/urns for
+     * the floor.
      *
-     * For a list of the colors that correspond to the vanilla stages, see
-     * `versusScreenDirtSpotColors.ts`.
-     */
-    readonly versusScreenDirtSpotColor?: {
-        r: number;
-        g: number;
-        b: number;
-    };
-}
-interface CustomStageBackdrop {
-    /**
-     * The beginning of the path that leads to the backdrop graphics. For example:
-     *
-     * ```sh
-     * gfx/backdrop/revelations/revelations_
-     * ```
-     */
-    prefix: string;
-    /**
-     * The end of the path that leads to the backdrop graphics. In most cases, this will be ".png".
-     */
-    suffix: string;
-    /**
-     * An array of strings that represent the graphic files that are used for the floors in narrow
-     * rooms. (The "n" stands for "narrow").
+     * If specified, it is assumed that you have your own custom rock alt type, and all vanilla
+     * rewards/enemies that spawn from urns will be automatically removed. Use the
+     * `POST_GRID_ENTITY_BROKEN` callback to make your own custom rewards. Or, if you want to emulate
+     * a vanilla urn/mushroom/skull/polyp/bucket, use the `spawnRockAltReward` helper function.
      *
-     * You must have at least one string in this array, but you can specify more than one to randomly
-     * add extra variety (like the vanilla stages do).
-     *
-     * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement_nfloor.png".
+     * If not specified, the vanilla Basement rocks spritesheet will be used. For reference, this is
+     * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+     * Rebirth\resources-dlc3\gfx\grid\rocks_basement.png`
      */
-    nFloors: string[];
+    rocksPNGPath?: string;
     /**
-     * An array of strings that represent the graphic files that are used for the floors in L rooms.
-     *
-     * You must have at least one string in this array, but you can specify more than one to randomly
-     * add extra variety (like the vanilla stages do).
+     * Optional. The path to the spritesheet that contains the graphics of the pits for the floor.
      *
-     * For an example of this, see the vanilla file "resources/gfx/backdrop/01_lbasementfloor.png".
+     * If not specified, the vanilla Basement pits spritesheet will be used. For reference, this is
+     * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+     * Rebirth\resources\gfx\grid\grid_pit.png`
      */
-    lFloors: string[];
-    /**
-     * An array of strings that represent the graphic files for the stage's walls.
-     *
-     * You must have at least one string in this array, but you can specify more than one to randomly
-     * add extra variety (like the vanilla stages do).
-     *
-     * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement.png". (In 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: string[];
-    /**
-     * An array of strings that represent the graphic files for the stage's corners. You must have at
-     * least one string in this array, but you can specify more than one to randomly add extra variety
-     * (like the vanilla stages do).
-     *
-     * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement.png". (In the
-     * vanilla file, they concatenate both variations together into one PNG file and put it in the top
-     * right hand corner. The corners are shown in the top right hand corner of the file, with two
-     * different variations concatenated together. However, for the custom stages feature, you must
-     * separate each corner variation into a separate file (and put it in a different file from the
-     * walls).
-     */
-    corners: string[];
-}
+    pitsPNGPath?: string;
+    /** Optional. A collection of paths that contain graphics for the doors of the floor. */
+    doorPNGPaths?: Readonly<{
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the normal doors for the
+         * floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_01_normaldoor.png`
+         */
+        normal?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Treasure Room doors
+         * for the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_02_treasureroomdoor.png`
+         */
+        treasureRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Boss Room doors for
+         * the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_10_bossroomdoor.png`
+         */
+        bossRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Secret Room and Super
+         * Secret Room doors for the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_08_holeinwall.png`
+         */
+        secretRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the arcade doors for the
+         * floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_05_arcaderoomdoor.png`
+         */
+        arcade?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Curse Room doors for
+         * the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_04_selfsacrificeroomdoor.png`
+         */
+        curseRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the normal Challenge Room
+         * doors for the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_03_ambushroomdoor.png`
+         */
+        normalChallengeRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Boss Challenge Room
+         * doors for the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_09_bossambushroomdoor.png`
+         */
+        bossChallengeRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Devil Room doors for
+         * the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_07_devilroomdoor.png`
+         */
+        devilRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Angel Room doors for
+         * the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_07_holyroomdoor.png`
+         */
+        angelRoom?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Boss Rush doors for
+         * the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_15_bossrushdoor.png`
+         */
+        bossRush?: string;
+        /**
+         * Optional. The path to the spritesheet that contains the graphics of the Chest Room doors for
+         * the floor.
+         *
+         * If not specified, the vanilla Basement door spritesheet will be used. For reference, this is
+         * located at: `C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac
+         * Rebirth\resources\gfx\grid\door_02b_chestroomdoor.png`
+         */
+        chestRoom?: string;
+    }>;
+    /** Optional. A collection of colors used in the boss "versus" screen. */
+    versusScreen?: Readonly<{
+        /**
+         * 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.
+         *
+         * For a list of the colors that correspond to the vanilla stages, see
+         * `versusScreenBackgroundColors.ts`.
+         */
+        backgroundColor?: Readonly<{
+            r: number;
+            g: number;
+            b: 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
+         * specified, the color for Basement 1 will be used.
+         *
+         * For a list of the colors that correspond to the vanilla stages, see
+         * `versusScreenDirtSpotColors.ts`.
+         */
+        dirtSpotColor?: Readonly<{
+            r: number;
+            g: number;
+            b: number;
+        }>;
+    }>;
+}>;
 /**
  * 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
@@ -136,12 +281,11 @@ export interface CustomStageLua extends CustomStageTSConfig {
  * Metadata about a custom stage room. Each custom stage object contains an array with metadata for
  * each room.
  */
-export interface CustomStageRoomMetadata {
-    readonly type: number;
-    readonly variant: number;
-    readonly subType: number;
-    readonly shape: number;
-    readonly doorSlotFlags: number;
-    readonly weight: number;
-}
-export {};
+export declare type CustomStageRoomMetadata = Readonly<{
+    type: number;
+    variant: number;
+    subType: number;
+    shape: number;
+    doorSlotFlags: number;
+    weight: number;
+}>;

package/objects/backdropTypeToRockAltType.d.ts

@@ -0,0 +1,6 @@
+import { BackdropType } from "isaac-typescript-definitions";
+import { RockAltType } from "../enums/RockAltType";
+/** Used by the `getRockAltType` function. */
+export declare const BACKDROP_TYPE_TO_ROCK_ALT_TYPE: {
+    readonly [key in BackdropType]: RockAltType;
+};

package/objects/backdropTypeToRockAltType.lua

@@ -0,0 +1,69 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BackdropType = ____isaac_2Dtypescript_2Ddefinitions.BackdropType
+local ____RockAltType = require("enums.RockAltType")
+local RockAltType = ____RockAltType.RockAltType
+--- Used by the `getRockAltType` function.
+____exports.BACKDROP_TYPE_TO_ROCK_ALT_TYPE = {
+    [BackdropType.BASEMENT] = RockAltType.URN,
+    [BackdropType.CELLAR] = RockAltType.URN,
+    [BackdropType.BURNT_BASEMENT] = RockAltType.URN,
+    [BackdropType.CAVES] = RockAltType.MUSHROOM,
+    [BackdropType.CATACOMBS] = RockAltType.MUSHROOM,
+    [BackdropType.FLOODED_CAVES] = RockAltType.MUSHROOM,
+    [BackdropType.DEPTHS] = RockAltType.SKULL,
+    [BackdropType.NECROPOLIS] = RockAltType.SKULL,
+    [BackdropType.DANK_DEPTHS] = RockAltType.SKULL,
+    [BackdropType.WOMB] = RockAltType.POLYP,
+    [BackdropType.UTERO] = RockAltType.POLYP,
+    [BackdropType.SCARRED_WOMB] = RockAltType.POLYP,
+    [BackdropType.BLUE_WOMB] = RockAltType.POLYP,
+    [BackdropType.SHEOL] = RockAltType.SKULL,
+    [BackdropType.CATHEDRAL] = RockAltType.URN,
+    [BackdropType.DARK_ROOM] = RockAltType.SKULL,
+    [BackdropType.CHEST] = RockAltType.URN,
+    [BackdropType.MEGA_SATAN] = RockAltType.URN,
+    [BackdropType.LIBRARY] = RockAltType.URN,
+    [BackdropType.SHOP] = RockAltType.URN,
+    [BackdropType.CLEAN_BEDROOM] = RockAltType.URN,
+    [BackdropType.DIRTY_BEDROOM] = RockAltType.URN,
+    [BackdropType.SECRET] = RockAltType.MUSHROOM,
+    [BackdropType.DICE] = RockAltType.URN,
+    [BackdropType.ARCADE] = RockAltType.URN,
+    [BackdropType.ERROR_ROOM] = RockAltType.URN,
+    [BackdropType.BLUE_WOMB_PASS] = RockAltType.POLYP,
+    [BackdropType.GREED_SHOP] = RockAltType.URN,
+    [BackdropType.DUNGEON] = RockAltType.URN,
+    [BackdropType.SACRIFICE] = RockAltType.SKULL,
+    [BackdropType.DOWNPOUR] = RockAltType.BUCKET,
+    [BackdropType.MINES] = RockAltType.MUSHROOM,
+    [BackdropType.MAUSOLEUM] = RockAltType.SKULL,
+    [BackdropType.CORPSE] = RockAltType.POLYP,
+    [BackdropType.PLANETARIUM] = RockAltType.URN,
+    [BackdropType.DOWNPOUR_ENTRANCE] = RockAltType.BUCKET,
+    [BackdropType.MINES_ENTRANCE] = RockAltType.MUSHROOM,
+    [BackdropType.MAUSOLEUM_ENTRANCE] = RockAltType.SKULL,
+    [BackdropType.CORPSE_ENTRANCE] = RockAltType.SKULL,
+    [BackdropType.MAUSOLEUM_2] = RockAltType.SKULL,
+    [BackdropType.MAUSOLEUM_3] = RockAltType.SKULL,
+    [BackdropType.MAUSOLEUM_4] = RockAltType.SKULL,
+    [BackdropType.CORPSE_2] = RockAltType.POLYP,
+    [BackdropType.CORPSE_3] = RockAltType.POLYP,
+    [BackdropType.DROSS] = RockAltType.BUCKET,
+    [BackdropType.ASHPIT] = RockAltType.MUSHROOM,
+    [BackdropType.GEHENNA] = RockAltType.SKULL,
+    [BackdropType.MORTIS] = RockAltType.POLYP,
+    [BackdropType.ISAACS_BEDROOM] = RockAltType.URN,
+    [BackdropType.HALLWAY] = RockAltType.URN,
+    [BackdropType.MOMS_BEDROOM] = RockAltType.URN,
+    [BackdropType.CLOSET] = RockAltType.URN,
+    [BackdropType.CLOSET_B] = RockAltType.URN,
+    [BackdropType.DOGMA] = RockAltType.URN,
+    [BackdropType.DUNGEON_GIDEON] = RockAltType.URN,
+    [BackdropType.DUNGEON_ROTGUT] = RockAltType.URN,
+    [BackdropType.DUNGEON_BEAST] = RockAltType.URN,
+    [BackdropType.MINES_SHAFT] = RockAltType.MUSHROOM,
+    [BackdropType.ASHPIT_SHAFT] = RockAltType.MUSHROOM,
+    [BackdropType.DARK_CLOSET] = RockAltType.SKULL
+}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.4.0",
+  "version": "6.5.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.22"
+    "isaac-typescript-definitions": "^3.0.24"
   }
 }