isaacscript-common 6.1.1 → 6.3.0

package/initFeatures.lua

@@ -21,6 +21,8 @@ local ____fastReset = require("features.fastReset")
 local fastResetInit = ____fastReset.fastResetInit
 local ____forgottenSwitch = require("features.forgottenSwitch")
 local forgottenSwitchInit = ____forgottenSwitch.forgottenSwitchInit
+local ____pause = require("features.pause")
+local pauseInit = ____pause.pauseInit
 local ____persistentEntities = require("features.persistentEntities")
 local persistentEntitiesInit = ____persistentEntities.persistentEntitiesInit
 local ____playerInventory = require("features.playerInventory")
@@ -35,6 +37,8 @@ local ____roomClearFrame = require("features.roomClearFrame")
 local roomClearFrameInit = ____roomClearFrame.roomClearFrameInit
 local ____runInNFrames = require("features.runInNFrames")
 local runInNFramesInit = ____runInNFrames.runInNFramesInit
+local ____runNextRoom = require("features.runNextRoom")
+local runNextRoomInit = ____runNextRoom.runNextRoomInit
 local ____sirenHelpers = require("features.sirenHelpers")
 local sirenHelpersInit = ____sirenHelpers.sirenHelpersInit
 local ____stageHistory = require("features.stageHistory")
@@ -42,7 +46,7 @@ local stageHistoryInit = ____stageHistory.stageHistoryInit
 local ____taintedLazarusPlayers = require("features.taintedLazarusPlayers")
 local taintedLazarusPlayersInit = ____taintedLazarusPlayers.taintedLazarusPlayersInit
 function ____exports.initFeaturesMajor(self, mod)
-    customStageInit(nil)
+    customStageInit(nil, mod)
     deployJSONRoomInit(nil, mod)
     runInNFramesInit(nil, mod)
     characterStatsInit(nil, mod)
@@ -56,12 +60,14 @@ function ____exports.initFeaturesMinor(self, mod)
     fastResetInit(nil, mod)
     forgottenSwitchInit(nil, mod)
     collectibleItemPoolTypeInit(nil, mod)
+    pauseInit(nil, mod)
     persistentEntitiesInit(nil, mod)
     playerInventoryInit(nil, mod)
     ponyDetectionInit(nil, mod)
     preventCollectibleRotationInit(nil, mod)
     registerHotkeyInit(nil, mod)
     roomClearFrameInit(nil, mod)
+    runNextRoomInit(nil, mod)
     sirenHelpersInit(nil, mod)
     stageHistoryInit(nil, mod)
     taintedLazarusPlayersInit(nil, mod)

package/interfaces/Corner.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="isaac-typescript-definitions" />
+import { CornerType } from "../enums/CornerType";
+export interface Corner {
+    readonly type: CornerType;
+    readonly position: Readonly<Vector>;
+}

package/interfaces/Corner.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/interfaces/CustomStage.d.ts

@@ -1,51 +1,10 @@
-/**
- * This is the format of a custom stage in the "isaacscript" section of the "tsconfig.json" file.
- *
- * The contents of this interface are used to create a "tsconfig-isaacscript-section-schema.json"
- * schema with the "ts-json-schema-generator" library.
- *
- * The contents of this interface are validated at run-time against the schema using the Ajv
- * library.
- *
- * The `CustomStage` interface extends this, adding room metadata.
- */
-export interface CustomStageTSConfig {
-    /** The name of the custom stage. */
-    name: string;
-    /**
-     * Path to the XML file that contains the rooms for the custom stage (created with Basement
-     * Renovator).
-     */
-    xmlPath: string;
-    /** An arbitrarily chosen prefix in the range of 101-999. */
-    roomVariantPrefix: number;
-    /**
-     * An integer between 1 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.
-     */
-    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.
-     */
-    baseStageType: 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
- * "tsconfig.json" file.
- */
-export interface CustomStage extends CustomStageTSConfig {
-    roomsMetadata: CustomStageRoomMetadata[];
-}
-/**
- * Metadata about a custom stage room. Each custom stage object contains an array with metadata for
- * each room.
- */
-export interface CustomStageRoomMetadata {
-    variant: number;
-    shape: number;
-    weight: number;
+import { DoorSlotFlag, RoomShape, RoomType } from "isaac-typescript-definitions";
+import { CustomStageLua, CustomStageRoomMetadata } from "./CustomStageLua";
+export interface CustomStage extends CustomStageLua {
+    /** A map that makes it easier to select certain room type/shape/door combinations. */
+    readonly roomTypeMap: RoomTypeMap;
 }
+export declare type RoomTypeMap = ReadonlyMap<RoomType, RoomShapeMap>;
+declare type RoomShapeMap = ReadonlyMap<RoomShape, RoomDoorSlotMap>;
+declare type RoomDoorSlotMap = ReadonlyMap<DoorSlotFlag, CustomStageRoomMetadata[]>;
+export {};

package/interfaces/CustomStageLua.d.ts

@@ -0,0 +1,122 @@
+/**
+ * This is the format of a custom stage in the "isaacscript" section of the "tsconfig.json" file.
+ *
+ * The contents of this interface are used to create a "tsconfig-isaacscript-section-schema.json"
+ * schema with the "ts-json-schema-generator" library.
+ *
+ * The contents of this interface are validated at run-time against the schema using the Ajv
+ * library.
+ *
+ * The `CustomStageLua` interface extends this, adding room metadata.
+ */
+export interface CustomStageTSConfig {
+    /** The name of the custom stage. Mandatory. */
+    readonly name: string;
+    /**
+     * Path to the XML file that contains the rooms for the custom stage (created with Basement
+     * Renovator). Mandatory.
+     */
+    readonly xmlPath: string;
+    /** An arbitrarily chosen prefix in the range of 101-999. Mandatory. */
+    readonly 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`
+     * method.)
+     */
+    readonly 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;
+    /**
+     * An object containing the paths to the backdrop for the stage. (A backdrop is the graphics for
+     * the walls and floor.) Mandatory.
+     */
+    readonly backdrop: CustomStageBackdrop;
+}
+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").
+     *
+     * 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: 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: 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[];
+}
+/**
+ * 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 interface CustomStageRoomMetadata {
+    readonly type: number;
+    readonly variant: number;
+    readonly subType: number;
+    readonly shape: number;
+    readonly doorSlotFlags: number;
+    readonly weight: number;
+}
+export {};

package/interfaces/CustomStageLua.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/objects/roomShapeCorners.d.ts

@@ -0,0 +1,6 @@
+import { RoomShape } from "isaac-typescript-definitions";
+import { Corner } from "../interfaces/Corner";
+/** The locations of the corners for each room shape. */
+export declare const ROOM_SHAPE_CORNERS: {
+    readonly [key in RoomShape]: readonly Corner[];
+};

package/objects/roomShapeCorners.lua

@@ -0,0 +1,259 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local ____CornerType = require("enums.CornerType")
+local CornerType = ____CornerType.CornerType
+local TWO_BY_TWO_CENTER_X = 580
+local TWO_BY_TWO_CENTER_Y = 420
+--- The locations of the corners for each room shape.
+____exports.ROOM_SHAPE_CORNERS = {
+    [RoomShape.SHAPE_1x1] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(580, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 420)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(580, 420)
+        }
+    },
+    [RoomShape.IH] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 220)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(580, 220)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 340)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(580, 340)
+        }
+    },
+    [RoomShape.IV] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(220, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(420, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(220, 420)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(420, 420)
+        }
+    },
+    [RoomShape.SHAPE_1x2] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(580, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 700)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(580, 700)
+        }
+    },
+    [RoomShape.IIV] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(220, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(420, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(220, 700)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(420, 700)
+        }
+    },
+    [RoomShape.SHAPE_2x1] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(1100, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 420)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(1100, 420)
+        }
+    },
+    [RoomShape.IIH] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 220)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(1100, 220)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 340)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(1100, 340)
+        }
+    },
+    [RoomShape.SHAPE_2x2] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(1100, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 700)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(1100, 700)
+        }
+    },
+    [RoomShape.LTL] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(TWO_BY_TWO_CENTER_X, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(1100, 140)
+        },
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, TWO_BY_TWO_CENTER_Y)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 700)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(1100, 700)
+        }
+    },
+    [RoomShape.LTR] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(TWO_BY_TWO_CENTER_X, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(1100, TWO_BY_TWO_CENTER_Y)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 700)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(1100, 700)
+        }
+    },
+    [RoomShape.LBL] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(1100, 140)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(TWO_BY_TWO_CENTER_X, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(TWO_BY_TWO_CENTER_X, 700)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(1100, 700)
+        }
+    },
+    [RoomShape.LBR] = {
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(60, 140)
+        },
+        {
+            type = CornerType.TOP_RIGHT,
+            position = Vector(1100, 140)
+        },
+        {
+            type = CornerType.TOP_LEFT,
+            position = Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(1100, TWO_BY_TWO_CENTER_Y)
+        },
+        {
+            type = CornerType.BOTTOM_LEFT,
+            position = Vector(60, 700)
+        },
+        {
+            type = CornerType.BOTTOM_RIGHT,
+            position = Vector(TWO_BY_TWO_CENTER_X, 700)
+        }
+    }
+}
+return ____exports

package/objects/roomShapeToBottomRightPosition.d.ts

@@ -4,5 +4,5 @@ import { RoomShape } from "isaac-typescript-definitions";
  * wall would be at "Vector(-1, -1)".)
  */
 export declare const ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION: {
-    readonly [key in RoomShape]: Vector;
+    readonly [key in RoomShape]: Readonly<Vector>;
 };

package/objects/roomShapeToTopLeftPosition.d.ts

@@ -4,5 +4,5 @@ import { RoomShape } from "isaac-typescript-definitions";
  * wall would be at "Vector(-1, -1)".)
  */
 export declare const ROOM_SHAPE_TO_TOP_LEFT_POSITION: {
-    readonly [key in RoomShape]: Vector;
+    readonly [key in RoomShape]: Readonly<Vector>;
 };

package/objects/roomTypeGotoPrefixes.lua

@@ -2,34 +2,34 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 ____exports.ROOM_TYPE_GOTO_PREFIXES = {
-    [RoomType.DEFAULT] = "d.",
-    [RoomType.SHOP] = "s.shop.",
-    [RoomType.ERROR] = "s.error.",
-    [RoomType.TREASURE] = "s.treasure.",
-    [RoomType.BOSS] = "s.boss.",
-    [RoomType.MINI_BOSS] = "s.miniboss.",
-    [RoomType.SECRET] = "s.secret.",
-    [RoomType.SUPER_SECRET] = "s.supersecret.",
-    [RoomType.ARCADE] = "s.arcade.",
-    [RoomType.CURSE] = "s.curse.",
-    [RoomType.CHALLENGE] = "s.challenge.",
-    [RoomType.LIBRARY] = "s.library.",
-    [RoomType.SACRIFICE] = "s.sacrifice.",
-    [RoomType.DEVIL] = "s.devil.",
-    [RoomType.ANGEL] = "s.angel.",
-    [RoomType.DUNGEON] = "s.itemdungeon.",
-    [RoomType.BOSS_RUSH] = "s.bossrush.",
-    [RoomType.CLEAN_BEDROOM] = "s.isaacs.",
-    [RoomType.DIRTY_BEDROOM] = "s.barren.",
-    [RoomType.CHEST] = "s.chest.",
-    [RoomType.DICE] = "s.dice.",
-    [RoomType.BLACK_MARKET] = "s.blackmarket.",
-    [RoomType.GREED_EXIT] = "s.greedexit.",
-    [RoomType.PLANETARIUM] = "s.planetarium.",
-    [RoomType.TELEPORTER] = "s.teleporter.",
-    [RoomType.TELEPORTER_EXIT] = "s.teleporterexit.",
-    [RoomType.SECRET_EXIT] = "s.secretexit.",
-    [RoomType.BLUE] = "s.blue.",
-    [RoomType.ULTRA_SECRET] = "s.ultrasecret."
+    [RoomType.DEFAULT] = "s.default",
+    [RoomType.SHOP] = "s.shop",
+    [RoomType.ERROR] = "s.error",
+    [RoomType.TREASURE] = "s.treasure",
+    [RoomType.BOSS] = "s.boss",
+    [RoomType.MINI_BOSS] = "s.miniboss",
+    [RoomType.SECRET] = "s.secret",
+    [RoomType.SUPER_SECRET] = "s.supersecret",
+    [RoomType.ARCADE] = "s.arcade",
+    [RoomType.CURSE] = "s.curse",
+    [RoomType.CHALLENGE] = "s.challenge",
+    [RoomType.LIBRARY] = "s.library",
+    [RoomType.SACRIFICE] = "s.sacrifice",
+    [RoomType.DEVIL] = "s.devil",
+    [RoomType.ANGEL] = "s.angel",
+    [RoomType.DUNGEON] = "s.itemdungeon",
+    [RoomType.BOSS_RUSH] = "s.bossrush",
+    [RoomType.CLEAN_BEDROOM] = "s.isaacs",
+    [RoomType.DIRTY_BEDROOM] = "s.barren",
+    [RoomType.CHEST] = "s.chest",
+    [RoomType.DICE] = "s.dice",
+    [RoomType.BLACK_MARKET] = "s.blackmarket",
+    [RoomType.GREED_EXIT] = "s.greedexit",
+    [RoomType.PLANETARIUM] = "s.planetarium",
+    [RoomType.TELEPORTER] = "s.teleporter",
+    [RoomType.TELEPORTER_EXIT] = "s.teleporterexit",
+    [RoomType.SECRET_EXIT] = "s.secretexit",
+    [RoomType.BLUE] = "s.blue",
+    [RoomType.ULTRA_SECRET] = "s.ultrasecret"
 }
 return ____exports

package/package.json

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

package/sets/narrowRoomShapesSet.d.ts

@@ -0,0 +1,2 @@
+import { RoomShape } from "isaac-typescript-definitions";
+export declare const NARROW_ROOM_SHAPES_SET: ReadonlySet<RoomShape>;

package/sets/narrowRoomShapesSet.lua

@@ -0,0 +1,8 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+____exports.NARROW_ROOM_SHAPES_SET = __TS__New(Set, {RoomShape.IH, RoomShape.IV, RoomShape.IIV, RoomShape.IIH})
+return ____exports