isaacscript-common 7.1.1 → 7.2.0

package/dist/interfaces/CustomStageLua.d.ts

@@ -24,6 +24,9 @@ export declare type CustomStageTSConfig = Readonly<{
      * Make sure the chosen prefix does not conflict with any other mods. You can find a list of
      * registered room variant prefixes on the IsaacScript website:
      * https://isaacscript.github.io/main/custom-stages
+     *
+     * @minimum 101
+     * @maximum 109
      */
     roomVariantPrefix: number;
     /**
@@ -35,6 +38,9 @@ export declare type CustomStageTSConfig = Readonly<{
      * method.)
      *
      * If not specified, `LevelStage.BASEMENT_2` (2) will be used.
+     *
+     * @minimum 2
+     * @maximum 13
      */
     baseStage?: number;
     /**
@@ -43,6 +49,9 @@ export declare type CustomStageTSConfig = Readonly<{
      * generation algorithm.
      *
      * If not specified, `StageType.ORIGINAL` (0) will be used.
+     *
+     * @minimum 0
+     * @maximum 5
      */
     baseStageType?: number;
     /**
@@ -301,9 +310,25 @@ export declare type CustomStageTSConfig = Readonly<{
          * `versusScreenBackgroundColors.ts`.
          */
         backgroundColor?: Readonly<{
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             r: number;
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             g: number;
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             b: number;
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             a: number;
         }>;
         /**
@@ -315,9 +340,25 @@ export declare type CustomStageTSConfig = Readonly<{
          * `versusScreenDirtSpotColors.ts`.
          */
         dirtSpotColor?: Readonly<{
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             r: number;
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             g: number;
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             b: number;
+            /**
+             * @minimum 0
+             * @maximum 1
+             */
             a: number;
         }>;
     }>;
@@ -342,9 +383,25 @@ export declare type CustomStageShadow = Readonly<{
      * to 75% faded black).
      */
     color?: Readonly<{
+        /**
+         * @minimum 0
+         * @maximum 1
+         */
         r: number;
+        /**
+         * @minimum 0
+         * @maximum 1
+         */
         g: number;
+        /**
+         * @minimum 0
+         * @maximum 1
+         */
         b: number;
+        /**
+         * @minimum 0
+         * @maximum 1
+         */
         a: number;
     }>;
 }>;

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

@@ -1 +1 @@
-{"version":3,"file":"CustomStageLua.d.ts","sourceRoot":"","sources":["../../src/interfaces/CustomStageLua.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,oBAAY,mBAAmB,GAAG,QAAQ,CAAC;IACzC,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,QAAQ,CAAC;QAC1B;;;;;;;;WAQG;QACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;QAE3B;;;;;;;;WAQG;QACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;QAE3B;;;;;;;;;;WAUG;QACH,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;QAEzB;;;;;;;;;;;;WAYG;QACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;KAC5B,CAAC,CAAC;IAEH;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;QACtB;;;;;;;WAOG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;;;;;WAOG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;;;;WAOG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;;;;;WAOG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;WAOG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;;;;;WAOG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;WAOG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;IAEH;;;;;OAKG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC;QACjB;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;QAErC;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;QAErC;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;QAErC;;;;;;;;WAQG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;KACtC,CAAC,CAAC;IAEH,kFAAkF;IAClF,QAAQ,CAAC,EAAE,SAAS,wBAAwB,EAAE,CAAC;IAE/C,yEAAyE;IACzE,YAAY,CAAC,EAAE,QAAQ,CAAC;QACtB;;;;;;WAMG;QACH,eAAe,CAAC,EAAE,QAAQ,CAAC;YACzB,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;SACX,CAAC,CAAC;QAEH;;;;;;;WAOG;QACH,aAAa,CAAC,EAAE,QAAQ,CAAC;YACvB,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;YACV,CAAC,EAAE,MAAM,CAAC;SACX,CAAC,CAAC;KACJ,CAAC,CAAC;CACJ,CAAC,CAAC;AAEH;;;GAGG;AAEH,oBAAY,iBAAiB,GAAG,QAAQ,CAAC;IACvC;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC;QACf,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC,CAAC;CACJ,CAAC,CAAC;AAEH,oEAAoE;AAEpE,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,QAAQ,CAAC,aAAa,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC5D;AAED;;;GAGG;AACH,oBAAY,uBAAuB,GAAG,QAAQ,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC"}
+{"version":3,"file":"CustomStageLua.d.ts","sourceRoot":"","sources":["../../src/interfaces/CustomStageLua.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,oBAAY,mBAAmB,GAAG,QAAQ,CAAC;IACzC,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,QAAQ,CAAC;QAC1B;;;;;;;;WAQG;QACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;QAE3B;;;;;;;;WAQG;QACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;QAE3B;;;;;;;;;;WAUG;QACH,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;QAEzB;;;;;;;;;;;;WAYG;QACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;KAC5B,CAAC,CAAC;IAEH;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;QACtB;;;;;;;WAOG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;;;;;WAOG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;;;;WAOG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;;;;;WAOG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;WAOG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;;;;;WAOG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;;WAOG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;IAEH;;;;;OAKG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC;QACjB;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;QAErC;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;QAErC;;;;;;;WAOG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;QAErC;;;;;;;;WAQG;QACH,KAAK,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;KACtC,CAAC,CAAC;IAEH,kFAAkF;IAClF,QAAQ,CAAC,EAAE,SAAS,wBAAwB,EAAE,CAAC;IAE/C,yEAAyE;IACzE,YAAY,CAAC,EAAE,QAAQ,CAAC;QACtB;;;;;;WAMG;QACH,eAAe,CAAC,EAAE,QAAQ,CAAC;YACzB;;;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,CAAC;QAEH;;;;;;;WAOG;QACH,aAAa,CAAC,EAAE,QAAQ,CAAC;YACvB;;;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,CAAC;KACJ,CAAC,CAAC;CACJ,CAAC,CAAC;AAEH;;;GAGG;AAEH,oBAAY,iBAAiB,GAAG,QAAQ,CAAC;IACvC;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC;QACf;;;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,CAAC;CACJ,CAAC,CAAC;AAEH,oEAAoE;AAEpE,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,QAAQ,CAAC,aAAa,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC5D;AAED;;;GAGG;AACH,oBAAY,uBAAuB,GAAG,QAAQ,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC"}

package/dist/interfaces/GridEntityCustomData.d.ts

@@ -1,4 +1,10 @@
 import { GridCollisionClass, GridEntityType } from "isaac-typescript-definitions";
+/**
+ * This is meta-data that describes a custom grid entity.
+ *
+ * (One of the extra features that the standard library offers is the ability to spawn custom grid
+ * entities with the `spawnCustomGridEntity` helper function.)
+ */
 export interface GridEntityCustomData {
     /**
      * This is not a real `GridEntityType`; rather it is an arbitrary integer selected by end-user

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

@@ -1 +1 @@
-{"version":3,"file":"GridEntityCustomData.d.ts","sourceRoot":"","sources":["../../src/interfaces/GridEntityCustomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,cAAc,EACf,MAAM,8BAA8B,CAAC;AAEtC,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,oBAAoB,EAAE,cAAc,CAAC;IAErC,aAAa,EAAE,GAAG,CAAC;IACnB,SAAS,EAAE,GAAG,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,kBAAkB,CAAC;CACxC"}
+{"version":3,"file":"GridEntityCustomData.d.ts","sourceRoot":"","sources":["../../src/interfaces/GridEntityCustomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,cAAc,EACf,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,oBAAoB,EAAE,cAAc,CAAC;IAErC,aAAa,EAAE,GAAG,CAAC;IACnB,SAAS,EAAE,GAAG,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,kBAAkB,CAAC;CACxC"}

package/dist/interfaces/JSONRoomsFile.d.ts

@@ -1,13 +1,17 @@
 /**
- * Custom rooms are created with the Basement Renovator program, which outputs XML files and STB
- * files. A `JSONRoomsFile` object is simply an XML file converted to JSON. (It is useful to have
- * the room data in JSON format so that it can be directly consumed by TypeScript programs.)
+ * 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.)
  *
  * You can convert your XML files using the following command:
  *
  * ```sh
  * npx convert-xml-to-json foo.xml foo.json
  * ```
+ *
+ * Note that the custom stages feature of the standard library uses real XML/STB files, not JSON
+ * rooms, so you would only need to do this if you are using the `deployJSONRoom` command
+ * specifically.
  */
 export interface JSONRoomsFile {
     rooms: JSONRooms;

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

@@ -1 +1 @@
-{"version":3,"file":"JSONRoomsFile.d.ts","sourceRoot":"","sources":["../../src/interfaces/JSONRoomsFile.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;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,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"}

package/dist/interfaces/PlayerHealth.d.ts

@@ -1,5 +1,5 @@
 import { HeartSubType } from "isaac-typescript-definitions";
-/** Used by the `getPlayerHealth` and `setPlayerHealth` helper functions. */
+/** This is used by the `getPlayerHealth` and `setPlayerHealth` helper functions. */
 export interface PlayerHealth {
     maxHearts: int;
     hearts: int;

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

@@ -1 +1 @@
-{"version":3,"file":"PlayerHealth.d.ts","sourceRoot":"","sources":["../../src/interfaces/PlayerHealth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,4EAA4E;AAC5E,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,GAAG,CAAC;IACf,MAAM,EAAE,GAAG,CAAC;IACZ,aAAa,EAAE,GAAG,CAAC;IAEnB,8FAA8F;IAC9F,UAAU,EAAE,GAAG,CAAC;IAEhB,8FAA8F;IAC9F,UAAU,EAAE,GAAG,CAAC;IAEhB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,GAAG,CAAC;IACjB,YAAY,EAAE,GAAG,CAAC;IAElB,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED,oBAAY,aAAa,GACrB,YAAY,CAAC,IAAI,GACjB,YAAY,CAAC,KAAK,GAClB,YAAY,CAAC,IAAI,CAAC"}
+{"version":3,"file":"PlayerHealth.d.ts","sourceRoot":"","sources":["../../src/interfaces/PlayerHealth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,oFAAoF;AACpF,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,GAAG,CAAC;IACf,MAAM,EAAE,GAAG,CAAC;IACZ,aAAa,EAAE,GAAG,CAAC;IAEnB,8FAA8F;IAC9F,UAAU,EAAE,GAAG,CAAC;IAEhB,8FAA8F;IAC9F,UAAU,EAAE,GAAG,CAAC;IAEhB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,GAAG,CAAC;IACjB,YAAY,EAAE,GAAG,CAAC;IAElB,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED,oBAAY,aAAa,GACrB,YAAY,CAAC,IAAI,GACjB,YAAY,CAAC,KAAK,GAClB,YAAY,CAAC,IAAI,CAAC"}

package/dist/interfaces/PocketItemDescription.d.ts

@@ -1,6 +1,6 @@
 import { PocketItemSlot } from "isaac-typescript-definitions";
 import { PocketItemType } from "../enums/PocketItemType";
-/** Used by the `getPocketItems` and related helper functions. */
+/** This is used by the `getPocketItems` and related helper functions. */
 export interface PocketItemDescription {
     slot: PocketItemSlot;
     type: PocketItemType;

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

@@ -1 +1 @@
-{"version":3,"file":"PocketItemDescription.d.ts","sourceRoot":"","sources":["../../src/interfaces/PocketItemDescription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,iEAAiE;AACjE,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,GAAG,CAAC;CACd"}
+{"version":3,"file":"PocketItemDescription.d.ts","sourceRoot":"","sources":["../../src/interfaces/PocketItemDescription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,yEAAyE;AACzE,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,GAAG,CAAC;CACd"}

package/dist/interfaces/RoomDescription.d.ts

@@ -1,5 +1,5 @@
 import { LevelStage, RoomType, StageID, StageType } from "isaac-typescript-definitions";
-/** Used by the room history feature. */
+/** This is used by the room history feature of the standard library. */
 export interface RoomDescription {
     stage: LevelStage;
     stageType: StageType;

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

@@ -1 +1 @@
-{"version":3,"file":"RoomDescription.d.ts","sourceRoot":"","sources":["../../src/interfaces/RoomDescription.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACV,MAAM,8BAA8B,CAAC;AAEtC,wCAAwC;AACxC,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,UAAU,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,GAAG,CAAC;IACjB,WAAW,EAAE,GAAG,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,GAAG,CAAC;IACnB,aAAa,EAAE,GAAG,CAAC;IACnB,gBAAgB,EAAE,GAAG,CAAC;CACvB"}
+{"version":3,"file":"RoomDescription.d.ts","sourceRoot":"","sources":["../../src/interfaces/RoomDescription.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACV,MAAM,8BAA8B,CAAC;AAEtC,wEAAwE;AACxE,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,UAAU,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,GAAG,CAAC;IACjB,WAAW,EAAE,GAAG,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,GAAG,CAAC;IACnB,aAAa,EAAE,GAAG,CAAC;IACnB,gBAAgB,EAAE,GAAG,CAAC;CACvB"}

package/dist/interfaces/StatTypeType.d.ts

@@ -1,5 +1,9 @@
 import { TearFlag } from "isaac-typescript-definitions";
 import { StatType } from "../enums/StatType";
+/**
+ * This is an interface mapping a stat type to the data type. For example, `StatType.DAMAGE` is a
+ * `float` type.
+ */
 export interface StatTypeType {
     [StatType.DAMAGE]: float;
     [StatType.FIRE_DELAY]: float;

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

@@ -1 +1 @@
-{"version":3,"file":"StatTypeType.d.ts","sourceRoot":"","sources":["../../src/interfaces/StatTypeType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,MAAM,WAAW,YAAY;IAC3B,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IACzB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC;IAC9B,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,KAAK,CAAC;IAC5C,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC;IACrC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC3B,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;CACxB"}
+{"version":3,"file":"StatTypeType.d.ts","sourceRoot":"","sources":["../../src/interfaces/StatTypeType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IACzB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC;IAC9B,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,KAAK,CAAC;IAC5C,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC;IACrC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC;IAC7B,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC3B,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;CACxB"}

package/dist/interfaces/TrinketSituation.d.ts

@@ -1,5 +1,5 @@
 import { TrinketType } from "isaac-typescript-definitions";
-/** Used by the `temporarilyRemoveTrinkets` and related helper functions. */
+/** This is used by the `temporarilyRemoveTrinkets` and related helper functions. */
 export interface TrinketSituation {
     trinketTypeRemoved: TrinketType;
     trinketType1: TrinketType;

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

@@ -1 +1 @@
-{"version":3,"file":"TrinketSituation.d.ts","sourceRoot":"","sources":["../../src/interfaces/TrinketSituation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,4EAA4E;AAC5E,MAAM,WAAW,gBAAgB;IAC/B,kBAAkB,EAAE,WAAW,CAAC;IAChC,YAAY,EAAE,WAAW,CAAC;IAC1B,YAAY,EAAE,WAAW,CAAC;IAC1B,kBAAkB,EAAE,GAAG,CAAC;CACzB"}
+{"version":3,"file":"TrinketSituation.d.ts","sourceRoot":"","sources":["../../src/interfaces/TrinketSituation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,oFAAoF;AACpF,MAAM,WAAW,gBAAgB;IAC/B,kBAAkB,EAAE,WAAW,CAAC;IAChC,YAAY,EAAE,WAAW,CAAC;IAC1B,YAAY,EAAE,WAAW,CAAC;IAC1B,kBAAkB,EAAE,GAAG,CAAC;CACzB"}

package/dist/maps/keyboardToString.d.ts

@@ -0,0 +1,4 @@
+import { Keyboard } from "isaac-typescript-definitions";
+/** Maps each keyboard enum member to its corresponding lowercase and uppercase characters. */
+export declare const KEYBOARD_TO_STRING: ReadonlyMap<Keyboard, readonly [lowercaseCharacter: string, uppercaseCharacter: string]>;
+//# sourceMappingURL=keyboardToString.d.ts.map

package/dist/maps/keyboardToString.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboardToString.d.ts","sourceRoot":"","sources":["../../src/maps/keyboardToString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD,8FAA8F;AAC9F,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAC1C,QAAQ,EACR,SAAS,CAAC,kBAAkB,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAuEjE,CAAC"}

package/dist/maps/keyboardToString.lua

@@ -0,0 +1,73 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Keyboard = ____isaac_2Dtypescript_2Ddefinitions.Keyboard
+--- Maps each keyboard enum member to its corresponding lowercase and uppercase characters.
+____exports.KEYBOARD_TO_STRING = __TS__New(Map, {
+    {Keyboard.SPACE, {" ", " "}},
+    {Keyboard.APOSTROPHE, {"'", "\""}},
+    {Keyboard.COMMA, {",", "<"}},
+    {Keyboard.MINUS, {"-", "_"}},
+    {Keyboard.PERIOD, {".", ">"}},
+    {Keyboard.SLASH, {"/", "?"}},
+    {Keyboard.ZERO, {"0", ")"}},
+    {Keyboard.ONE, {"1", "!"}},
+    {Keyboard.TWO, {"2", "@"}},
+    {Keyboard.THREE, {"3", "#"}},
+    {Keyboard.FOUR, {"4", "$"}},
+    {Keyboard.FIVE, {"5", "%"}},
+    {Keyboard.SIX, {"6", "^"}},
+    {Keyboard.SEVEN, {"7", "&"}},
+    {Keyboard.EIGHT, {"8", "*"}},
+    {Keyboard.NINE, {"9", "("}},
+    {Keyboard.SEMICOLON, {";", ":"}},
+    {Keyboard.EQUAL, {"=", "+"}},
+    {Keyboard.A, {"a", "A"}},
+    {Keyboard.B, {"b", "B"}},
+    {Keyboard.C, {"c", "C"}},
+    {Keyboard.D, {"d", "D"}},
+    {Keyboard.E, {"e", "E"}},
+    {Keyboard.F, {"f", "F"}},
+    {Keyboard.G, {"g", "G"}},
+    {Keyboard.H, {"h", "H"}},
+    {Keyboard.I, {"i", "I"}},
+    {Keyboard.J, {"j", "J"}},
+    {Keyboard.K, {"k", "K"}},
+    {Keyboard.L, {"l", "L"}},
+    {Keyboard.M, {"m", "M"}},
+    {Keyboard.N, {"n", "N"}},
+    {Keyboard.O, {"o", "O"}},
+    {Keyboard.P, {"p", "P"}},
+    {Keyboard.Q, {"q", "Q"}},
+    {Keyboard.R, {"r", "R"}},
+    {Keyboard.S, {"s", "S"}},
+    {Keyboard.T, {"t", "T"}},
+    {Keyboard.U, {"u", "U"}},
+    {Keyboard.V, {"v", "V"}},
+    {Keyboard.W, {"w", "W"}},
+    {Keyboard.X, {"x", "X"}},
+    {Keyboard.Y, {"y", "Y"}},
+    {Keyboard.Z, {"z", "Z"}},
+    {Keyboard.KP_0, {"0", "0"}},
+    {Keyboard.KP_1, {"1", "1"}},
+    {Keyboard.KP_2, {"2", "2"}},
+    {Keyboard.KP_3, {"3", "3"}},
+    {Keyboard.KP_4, {"4", "4"}},
+    {Keyboard.KP_5, {"5", "5"}},
+    {Keyboard.KP_6, {"6", "6"}},
+    {Keyboard.KP_7, {"7", "7"}},
+    {Keyboard.KP_8, {"8", "8"}},
+    {Keyboard.KP_9, {"9", "9"}},
+    {Keyboard.KP_DECIMAL, {".", "."}},
+    {Keyboard.KP_DIVIDE, {"/", "/"}},
+    {Keyboard.KP_MULTIPLY, {"*", "*"}},
+    {Keyboard.KP_SUBTRACT, {"-", "-"}},
+    {Keyboard.KP_ADD, {"+", "+"}},
+    {Keyboard.LEFT_BRACKET, {"[", "{"}},
+    {Keyboard.BACKSLASH, {"\\", "|"}},
+    {Keyboard.RIGHT_BRACKET, {"]", "}"}},
+    {Keyboard.GRAVE_ACCENT, {"`", "~"}}
+})
+return ____exports

package/dist/types/AnyEntity.d.ts

@@ -9,5 +9,10 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
+/**
+ * A type union that matches `Entity`, `EntityBomb`, `EntityEffect`, and so on.
+ *
+ * This is useful for building generic functions that should accept any kind of entity.
+ */
 export declare type AnyEntity = Entity | EntityBomb | EntityEffect | EntityFamiliar | EntityKnife | EntityLaser | EntityNPC | EntityPickup | EntityPlayer | EntityProjectile | EntityTear;
 //# sourceMappingURL=AnyEntity.d.ts.map

package/dist/types/AnyEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnyEntity.d.ts","sourceRoot":"","sources":["../../src/types/AnyEntity.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,oBAAY,SAAS,GACjB,MAAM,GACN,UAAU,GACV,YAAY,GACZ,cAAc,GACd,WAAW,GACX,WAAW,GACX,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,UAAU,CAAC"}
+{"version":3,"file":"AnyEntity.d.ts","sourceRoot":"","sources":["../../src/types/AnyEntity.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA;;;;GAIG;AACH,oBAAY,SAAS,GACjB,MAAM,GACN,UAAU,GACV,YAAY,GACZ,cAAc,GACd,WAAW,GACX,WAAW,GACX,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,UAAU,CAAC"}

package/dist/types/AnyGridEntity.d.ts

@@ -6,5 +6,10 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
+/**
+ * A type union that matches `GridEntity`, `GridEntityDoor`, `GridEntityPit`, and so on.
+ *
+ * This is useful for building generic functions that should accept any kind of grid entity.
+ */
 export declare type AnyGridEntity = GridEntity | GridEntityDoor | GridEntityPit | GridEntityPoop | GridEntityPressurePlate | GridEntityRock | GridEntitySpikes | GridEntityTNT;
 //# sourceMappingURL=AnyGridEntity.d.ts.map

package/dist/types/AnyGridEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnyGridEntity.d.ts","sourceRoot":"","sources":["../../src/types/AnyGridEntity.ts"],"names":[],"mappings":";;;;;;;;AAAA,oBAAY,aAAa,GACrB,UAAU,GACV,cAAc,GACd,aAAa,GACb,cAAc,GACd,uBAAuB,GACvB,cAAc,GACd,gBAAgB,GAChB,aAAa,CAAC"}
+{"version":3,"file":"AnyGridEntity.d.ts","sourceRoot":"","sources":["../../src/types/AnyGridEntity.ts"],"names":[],"mappings":";;;;;;;;AAAA;;;;GAIG;AACH,oBAAY,aAAa,GACrB,UAAU,GACV,cAAc,GACd,aAAa,GACb,cAAc,GACd,uBAAuB,GACvB,cAAc,GACd,gBAAgB,GAChB,aAAa,CAAC"}

package/dist/types/CollectibleIndex.d.ts

@@ -1,7 +1,8 @@
 /**
- * `CollectibleIndex` is a specific type of string; see the documentation for the
- * `getCollectibleIndex` function. Mods can signify that data structures handle collectibles by
- * using this type.
+ * `CollectibleIndex` is a specific type of string that represents a unique identifier for a
+ * collectible. Mods can signify that data structures handle collectibles by using this type.
+ *
+ * For more information, see the documentation for the `getCollectibleIndex` function.
  *
  * For example:
  *

package/dist/types/CollectibleIndex.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CollectibleIndex.d.ts","sourceRoot":"","sources":["../../src/types/CollectibleIndex.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,oBAAY,gBAAgB,GAAG,MAAM,GAAG;IACtC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC1C,CAAC"}
+{"version":3,"file":"CollectibleIndex.d.ts","sourceRoot":"","sources":["../../src/types/CollectibleIndex.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,oBAAY,gBAAgB,GAAG,MAAM,GAAG;IACtC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC1C,CAAC"}

package/dist/types/Immutable.d.ts

@@ -1,5 +1,7 @@
 /**
- * Immutable is a type that will make the given array/map/set/object recursively read-only.
+ * Immutable is a utility type that will make the given array/map/set/object recursively read-only.
+ *
+ * You can use this type to easily build safe data structures.
  *
  * From: https://stackoverflow.com/questions/41879327/deepreadonly-object-typescript
  */

package/dist/types/Immutable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Immutable.d.ts","sourceRoot":"","sources":["../../src/types/Immutable.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,kBAAkB,GACnD,CAAC,GACD,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACxB,cAAc,CAAC,CAAC,CAAC,GACjB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAC/B,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAClB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GACtB,YAAY,CAAC,CAAC,CAAC,GACf,eAAe,CAAC,CAAC,CAAC,CAAC;AAEvB,aAAK,kBAAkB,GACnB,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,CAAC;AACb,aAAK,cAAc,CAAC,CAAC,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,aAAK,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,aAAK,YAAY,CAAC,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACjD,aAAK,eAAe,CAAC,CAAC,IAAI;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC"}
+{"version":3,"file":"Immutable.d.ts","sourceRoot":"","sources":["../../src/types/Immutable.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oBAAY,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,kBAAkB,GACnD,CAAC,GACD,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACxB,cAAc,CAAC,CAAC,CAAC,GACjB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAC/B,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAClB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GACtB,YAAY,CAAC,CAAC,CAAC,GACf,eAAe,CAAC,CAAC,CAAC,CAAC;AAEvB,aAAK,kBAAkB,GACnB,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,CAAC;AACb,aAAK,cAAc,CAAC,CAAC,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,aAAK,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,aAAK,YAAY,CAAC,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACjD,aAAK,eAAe,CAAC,CAAC,IAAI;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC"}

package/dist/types/PickupIndex.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * `PickupIndex` is a specific type of string; see the documentation for the `getPickupIndex`
- * function. Mods can signify that data structures handle collectibles by using this type.
+ * `PickupIndex` is a specific type of number that represents a unique identifier for a pickup. Mods
+ * can signify that data structures handle collectibles by using this type.
+ *
+ * For more information, see the documentation for the `getPickupIndex` function.
  *
  * For example:
  *

package/dist/types/PickupIndex.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PickupIndex.d.ts","sourceRoot":"","sources":["../../src/types/PickupIndex.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;AACH,oBAAY,WAAW,GAAG,GAAG,GAAG;IAC9B,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;CACrC,CAAC"}
+{"version":3,"file":"PickupIndex.d.ts","sourceRoot":"","sources":["../../src/types/PickupIndex.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;AACH,oBAAY,WAAW,GAAG,GAAG,GAAG;IAC9B,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;CACrC,CAAC"}

package/dist/types/PlayerIndex.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * `PlayerIndex` is a specific type of number that represents a unique identifier for a player. Mods
- * can signify that data structures handle `EntityPlayer` by using this type. For more information,
- * see the documentation for the `getPlayerIndex` function.
+ * can signify that data structures handle `EntityPlayer` by using this type.
+ *
+ * For more information, see the documentation for the `getPlayerIndex` function.
  *
  * For example:
  *

package/dist/types/PlayerIndex.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlayerIndex.d.ts","sourceRoot":"","sources":["../../src/types/PlayerIndex.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;AACH,oBAAY,WAAW,GAAG,GAAG,GAAG;IAAE,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"PlayerIndex.d.ts","sourceRoot":"","sources":["../../src/types/PlayerIndex.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;AACH,oBAAY,WAAW,GAAG,GAAG,GAAG;IAAE,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/types/SerializedIsaacAPIClass.d.ts

@@ -1,4 +1,10 @@
 /// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * This is a type representing an Isaac API class like `Color` or `RNG` that has been written to the
+ * "save#.dat" file. It is used by the save data manager when reading and writing to that file.
+ *
+ * For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+ */
 export declare type SerializedIsaacAPIClass = LuaMap<string, unknown> & {
     readonly __serializedIsaacAPIClassBrand: symbol;
 };

package/dist/types/SerializedIsaacAPIClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SerializedIsaacAPIClass.d.ts","sourceRoot":"","sources":["../../src/types/SerializedIsaacAPIClass.ts"],"names":[],"mappings":";AAAA,oBAAY,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC9D,QAAQ,CAAC,8BAA8B,EAAE,MAAM,CAAC;CACjD,CAAC"}
+{"version":3,"file":"SerializedIsaacAPIClass.d.ts","sourceRoot":"","sources":["../../src/types/SerializedIsaacAPIClass.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,oBAAY,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC9D,QAAQ,CAAC,8BAA8B,EAAE,MAAM,CAAC;CACjD,CAAC"}

package/dist/types/TSTLClass.d.ts

@@ -1,4 +1,9 @@
 /// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * This is a type representing a user-created class from TypeScript code.
+ *
+ * This type is used by the save data manager to when copying, serializing, and deserializing.
+ */
 export declare type TSTLClass = LuaMap<AnyNotNil, unknown> & {
     readonly __tstlClassBrand: symbol;
 };

package/dist/types/TSTLClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../src/types/TSTLClass.ts"],"names":[],"mappings":";AAAA,oBAAY,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}
+{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../src/types/TSTLClass.ts"],"names":[],"mappings":";AAAA;;;;GAIG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}

package/dist/types/TrapdoorDestination.d.ts

@@ -1,3 +1,6 @@
 import { LevelStage, StageType } from "isaac-typescript-definitions";
+/**
+ * This is the type that you need to specify when using the `spawnCustomTrapdoor` helper function.
+ */
 export declare type TrapdoorDestination = [stage: LevelStage, stageType: StageType] | [customStageName: string, floorNum: int];
 //# sourceMappingURL=TrapdoorDestination.d.ts.map

package/dist/types/TrapdoorDestination.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TrapdoorDestination.d.ts","sourceRoot":"","sources":["../../src/types/TrapdoorDestination.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAErE,oBAAY,mBAAmB,GAC3B,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,GACzC,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC"}
+{"version":3,"file":"TrapdoorDestination.d.ts","sourceRoot":"","sources":["../../src/types/TrapdoorDestination.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAErE;;GAEG;AACH,oBAAY,mBAAmB,GAC3B,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,GACzC,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "7.1.1",
+  "version": "7.2.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/index",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.2.3"
+    "isaac-typescript-definitions": "^3.2.4"
   }
 }

package/src/classes/DefaultMap.ts

@@ -1,12 +1,5 @@
 import { isFunction, isPrimitive } from "../functions/types";
 
-// eslint-disable-next-line isaacscript/complete-sentences-jsdoc
-/**
- * A function that creates the default value for your `DefaultMap`. For example, if it was a
- * `DefaultMap` containing maps, the factory function would be: `() => new Map()`
- */
-export type FactoryFunction<V, Args extends unknown[]> = (...args: Args) => V;
-
 /**
  * `DefaultMap` is a data structure that makes working with default values easier.
  *
@@ -169,6 +162,13 @@ export class DefaultMap<Key, Value, Args extends unknown[] = []> extends Map<
   }
 }
 
+// eslint-disable-next-line isaacscript/complete-sentences-jsdoc
+/**
+ * A function that creates the default value for your `DefaultMap`. For example, if it was a
+ * `DefaultMap` containing maps, the factory function would be: `() => new Map()`
+ */
+export type FactoryFunction<V, Args extends unknown[]> = (...args: Args) => V;
+
 /* eslint-disable @typescript-eslint/no-unused-vars */
 function test() {
   // Boolean

package/src/enums/AmbushType.ts

@@ -1,3 +1,4 @@
+/** This is used by the `POST_AMBUSH_STARTED` and `POST_AMBUSH_FINISHED` custom callbacks. */
 export enum AmbushType {
   CHALLENGE_ROOM,
   BOSS_RUSH,

package/src/enums/CornerType.ts

@@ -1,3 +1,4 @@
+/** This is used by the `getRoomShapeCorners` helper function. */
 export enum CornerType {
   TOP_LEFT,
   TOP_RIGHT,

package/src/enums/PocketItemType.ts

@@ -1,3 +1,4 @@
+/** This is used in the various pocket item helper functions. */
 export enum PocketItemType {
   EMPTY,
   CARD,

package/src/enums/RockAltType.ts

@@ -1,3 +1,4 @@
+/** This is used in the various rock alt type helper functions. */
 export enum RockAltType {
   URN,
   MUSHROOM,

package/src/enums/SerializationType.ts

@@ -1,3 +1,4 @@
+/** This is used with the `deepCopy` and `merge` functions. */
 export enum SerializationType {
   NONE,
   SERIALIZE,

package/src/enums/SlotDestructionType.ts

@@ -1,3 +1,4 @@
+/** This is used in the `POST_SLOT_DESTROYED` custom callback. */
 export enum SlotDestructionType {
   NORMAL,
   COLLECTIBLE_PAYOUT,

package/src/features/customStage/backdrop.ts

@@ -91,7 +91,7 @@ const BACKDROP_ROOM_TYPE_SET: ReadonlySet<RoomType> = new Set([
   RoomType.MINI_BOSS,
 ]);
 
-export function setBackdrop(customStage: CustomStage): void {
+export function setCustomStageBackdrop(customStage: CustomStage): void {
   const room = game.GetRoom();
   const roomType = room.GetType();
   const decorationSeed = room.GetDecorationSeed();

package/src/features/customStage/init.ts

@@ -16,7 +16,7 @@ import {
 } from "../../interfaces/CustomStageLua";
 import { CustomStage, RoomTypeMap } from "../../interfaces/private/CustomStage";
 import { saveDataManager } from "../saveDataManager/exports";
-import { setBackdrop } from "./backdrop";
+import { setCustomStageBackdrop } from "./backdrop";
 import {
   convertVanillaTrapdoors,
   removeUrnRewards,
@@ -196,7 +196,7 @@ function postNewRoomReordered() {
     return;
   }
 
-  setBackdrop(customStage);
+  setCustomStageBackdrop(customStage);
   setShadows(customStage);
   playVersusScreenAnimation(customStage);
 }

package/src/features/fastReset.ts

@@ -34,7 +34,7 @@ function checkResetInput() {
     return;
   }
 
-  // Disable the fast-reset feature if the custom console is open.
+  // Disable the fast-reset feature if any custom consoles are open.
   if (AwaitingTextInput) {
     return;
   }

package/src/features/indexTypeDoc.ts

@@ -9,7 +9,8 @@ export * as DebugDisplay from "./debugDisplay/exports";
 export * as DeployJSONRoom from "./deployJSONRoom";
 export * as DisableAllSound from "./disableAllSound";
 export * as DisableInputs from "./disableInputs";
-export * as ExtraConsoleCommands from "./extraConsoleCommands/exports";
+export * as ExtraConsoleCommandsInit from "./extraConsoleCommands/exports";
+export * as ExtraConsoleCommandsList from "./extraConsoleCommands/listCommands";
 export * as FadeInRemover from "./fadeInRemover";
 export * as FastReset from "./fastReset";
 export * as ForgottenSwitch from "./forgottenSwitch";