isaacscript-common 7.0.0 → 7.2.0

package/src/functions/tears.ts

@@ -1,6 +1,7 @@
 /**
- * - Converts the specified amount of tears stat into MaxFireDelay and adds it to the player.
- * - This function should only be used inside the EvaluateCache callback.
+ * - Converts the specified amount of tears stat into the format of `EntityPlayer.MaxFireDelay` and
+ *   adds it to the player.
+ * - This function should only be used inside the `EVALUATE_CACHE` callback.
  * - In this context, the "tears stat" represents what is shown on the in-game stat UI.
  */
 export function addTearsStat(player: EntityPlayer, tearsStat: float): void {
@@ -11,7 +12,7 @@ export function addTearsStat(player: EntityPlayer, tearsStat: float): void {
 }
 
 /**
- * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+ * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` field. This is
  *   equivalent to how many tears the player can shoot per frame.
  * - If you already have a "tears" stat and you want to convert it back to MaxFireDelay, then use
  *   this function.
@@ -22,7 +23,7 @@ export function getFireDelay(tearsStat: float): float {
 }
 
 /**
- * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+ * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` field. This is
  *   equivalent to how many tears the player can shoot per frame.
  * - If you want to convert this to the "tears" stat that is shown on the in-game stat UI, then use
  *   this function.

package/src/functions/utils.ts

@@ -187,9 +187,13 @@ export function repeat(n: int, func: (i: int) => void): void {
  * When you see this function, it simply means that the programmer intends to add in more code to
  * this spot later.
  *
+ * This function is variadic, meaning that you can pass as many arguments as you want. (This is
+ * useful as a means to prevent lint warnings.)
+ *
  * This function does not actually do anything. (It is an "empty" function.)
  */
-export function todo(): void {}
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function todo(...args: unknown[]): void {}
 
 /**
  * Helper function to sort a two-dimensional array by the first element.

package/src/functions/vector.ts

@@ -11,8 +11,8 @@ export type SerializedVector = LuaMap<string, unknown> & {
   readonly __serializedVectorBrand: symbol;
 };
 
-const KEYS = ["X", "Y"];
 const OBJECT_NAME = "Vector";
+const KEYS = ["X", "Y"];
 
 /** Helper function to copy a `Vector` Isaac API class. */
 export function copyVector(vector: Vector): Vector {
@@ -91,7 +91,7 @@ export function isSerializedVector(
   return tableHasKeys(object, ...KEYS) && object.has(SerializationBrand.VECTOR);
 }
 
-/** Helper function to check if something is an instantiated Vector object. */
+/** Helper function to check if something is an instantiated `Vector` object. */
 export function isVector(object: unknown): object is Vector {
   return isIsaacAPIClassOfType(object, OBJECT_NAME);
 }

package/src/initCustomCallbacks.ts

@@ -37,6 +37,7 @@ import { postPickupStateChangedInit } from "./callbacks/postPickupStateChanged";
 import { postPitRenderInit } from "./callbacks/postPitRender";
 import { postPitUpdateInit } from "./callbacks/postPitUpdate";
 import { postPlayerChangeHealthInit } from "./callbacks/postPlayerChangeHealth";
+import { postPlayerChangeStatInit } from "./callbacks/postPlayerChangeStat";
 import { postPlayerChangeTypeInit } from "./callbacks/postPlayerChangeType";
 import { postPlayerCollectibleCallbacksInit } from "./callbacks/postPlayerCollectible";
 import { postPlayerFatalDamageInit } from "./callbacks/postPlayerFatalDamage";
@@ -109,6 +110,7 @@ export function initCustomCallbacks(mod: ModUpgraded): void {
   postPitRenderInit(mod);
   postPitUpdateInit(mod);
   postPlayerChangeHealthInit(mod);
+  postPlayerChangeStatInit(mod);
   postPlayerChangeTypeInit(mod);
   postPlayerCollectibleCallbacksInit(mod);
   postPlayerFatalDamageInit(mod);

package/src/interfaces/ChargeBarSprites.ts

@@ -1,7 +1,7 @@
 /**
  * A collection of the four sprites necessary in order to render a charge bar.
  *
- * Used in the `newChargeBarSprites` and related helper functions.
+ * This is used in the `newChargeBarSprites` and related helper functions.
  */
 export interface ChargeBarSprites {
   back: Sprite;

package/src/interfaces/Corner.ts

@@ -1,5 +1,10 @@
 import { CornerType } from "../enums/CornerType";
 
+/**
+ * An interface representing a corner in the room.
+ *
+ * This is used by the `getRoomShapeCorners` helper function.
+ */
 export interface Corner {
   readonly type: CornerType;
   readonly position: Readonly<Vector>;

package/src/interfaces/CustomStageLua.ts

@@ -27,6 +27,9 @@ export 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;
 
@@ -39,6 +42,9 @@ export type CustomStageTSConfig = Readonly<{
    * method.)
    *
    * If not specified, `LevelStage.BASEMENT_2` (2) will be used.
+   *
+   * @minimum 2
+   * @maximum 13
    */
   baseStage?: number;
 
@@ -48,6 +54,9 @@ export type CustomStageTSConfig = Readonly<{
    * generation algorithm.
    *
    * If not specified, `StageType.ORIGINAL` (0) will be used.
+   *
+   * @minimum 0
+   * @maximum 5
    */
   baseStageType?: number;
 
@@ -331,9 +340,28 @@ export 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;
     }>;
 
@@ -346,9 +374,28 @@ export 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;
     }>;
   }>;
@@ -376,9 +423,28 @@ export 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/src/interfaces/GridEntityCustomData.ts

@@ -3,6 +3,12 @@ import {
   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/src/interfaces/JSONRoomsFile.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/src/interfaces/PlayerHealth.ts

@@ -1,6 +1,6 @@
 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/src/interfaces/PocketItemDescription.ts

@@ -1,7 +1,7 @@
 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/src/interfaces/RoomDescription.ts

@@ -5,7 +5,7 @@ import {
   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/src/interfaces/SaveData.ts

@@ -20,10 +20,6 @@
  * - serializable Isaac API classes (such as `Color`)
  * - TSTL classes (i.e. classes that you made yourself)
  * - sub-objects or a `LuaMap` that contains the above values
- *
- * (Unfortunately, it is not possible to create a recursive type definition that matches these
- * properties. This means that the TypeScript compiler will not be able to validate that you are
- * passing in serializable data.)
  */
 export interface SaveData<
   Persistent = unknown,
@@ -129,7 +125,7 @@ type SerializableReadonlyMap<K, V> = ReadonlyMap<
 type SerializableSet<T> = Set<SerializableInsideArrayOrMap<T>>;
 type SerializableReadonlySet<T> = ReadonlySet<SerializableInsideArrayOrMap<T>>;
 type SerializableObject<T> = { [K in keyof T]: Serializable<T[K]> };
-type SerializableIsaacAPIClass = Color | KColor | RNG | Vector;
+type SerializableIsaacAPIClass = BitSet128 | Color | KColor | RNG | Vector;
 
 // eslint-disable-next-line @typescript-eslint/ban-types
 type HasMethods<T> = {} extends {

package/src/interfaces/StatTypeType.ts

@@ -0,0 +1,21 @@
+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;
+  [StatType.SHOT_SPEED]: float;
+  [StatType.TEAR_HEIGHT]: float;
+  [StatType.TEAR_RANGE]: float;
+  [StatType.TEAR_FALLING_ACCELERATION]: float;
+  [StatType.TEAR_FALLING_SPEED]: float;
+  [StatType.MOVE_SPEED]: float;
+  [StatType.TEAR_FLAG]: BitFlags<TearFlag>;
+  [StatType.TEAR_COLOR]: Color;
+  [StatType.FLYING]: boolean;
+  [StatType.LUCK]: float;
+}

package/src/interfaces/TrinketSituation.ts

@@ -1,6 +1,6 @@
 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/src/interfaces/index.ts

@@ -7,4 +7,5 @@ export * from "./PlayerHealth";
 export * from "./PocketItemDescription";
 export * from "./RoomDescription";
 export * from "./SaveData";
+export * from "./StatTypeType";
 export * from "./TrinketSituation";

package/src/interfaces/indexTypeDoc.ts

@@ -7,4 +7,5 @@ export * as PlayerHealth from "./PlayerHealth";
 export * as PocketItemDescription from "./PocketItemDescription";
 export * as RoomDescription from "./RoomDescription";
 export * as SaveData from "./SaveData";
+export * as StatTypeType from "./StatTypeType";
 export * as TrinketSituation from "./TrinketSituation";

package/src/interfaces/private/AddCallbackParameterCustom.ts

@@ -50,6 +50,7 @@ import { PostPickupStateChangedRegisterParameters } from "../../callbacks/subscr
 import { PostPitRenderRegisterParameters } from "../../callbacks/subscriptions/postPitRender";
 import { PostPitUpdateRegisterParameters } from "../../callbacks/subscriptions/postPitUpdate";
 import { PostPlayerChangeHealthRegisterParameters } from "../../callbacks/subscriptions/postPlayerChangeHealth";
+import { PostPlayerChangeStatRegisterParameters } from "../../callbacks/subscriptions/postPlayerChangeStat";
 import { PostPlayerChangeTypeRegisterParameters } from "../../callbacks/subscriptions/postPlayerChangeType";
 import { PostPlayerCollectibleAddedRegisterParameters } from "../../callbacks/subscriptions/postPlayerCollectibleAdded";
 import { PostPlayerCollectibleRemovedRegisterParameters } from "../../callbacks/subscriptions/postPlayerCollectibleRemoved";
@@ -140,6 +141,7 @@ export interface AddCallbackParameterCustom {
   [ModCallbackCustom.POST_PIT_RENDER]: PostPitRenderRegisterParameters;
   [ModCallbackCustom.POST_PIT_UPDATE]: PostPitUpdateRegisterParameters;
   [ModCallbackCustom.POST_PLAYER_CHANGE_HEALTH]: PostPlayerChangeHealthRegisterParameters;
+  [ModCallbackCustom.POST_PLAYER_CHANGE_STAT]: PostPlayerChangeStatRegisterParameters;
   [ModCallbackCustom.POST_PLAYER_CHANGE_TYPE]: PostPlayerChangeTypeRegisterParameters;
   [ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED]: PostPlayerCollectibleAddedRegisterParameters;
   [ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED]: PostPlayerCollectibleRemovedRegisterParameters;

package/src/maps/keyboardToString.ts

@@ -0,0 +1,77 @@
+import { Keyboard } from "isaac-typescript-definitions";
+
+/** Maps each keyboard enum member to its corresponding lowercase and uppercase characters. */
+export const KEYBOARD_TO_STRING: ReadonlyMap<
+  Keyboard,
+  readonly [lowercaseCharacter: string, uppercaseCharacter: string]
+> = new Map([
+  [Keyboard.SPACE, [" ", " "]], // 32
+  [Keyboard.APOSTROPHE, ["'", '"']], // 39
+  [Keyboard.COMMA, [",", "<"]], // 44
+  [Keyboard.MINUS, ["-", "_"]], // 45
+  [Keyboard.PERIOD, [".", ">"]], // 46
+  [Keyboard.SLASH, ["/", "?"]], // 47
+
+  [Keyboard.ZERO, ["0", ")"]], // 48
+  [Keyboard.ONE, ["1", "!"]], // 49
+  [Keyboard.TWO, ["2", "@"]], // 50
+  [Keyboard.THREE, ["3", "#"]], // 51
+  [Keyboard.FOUR, ["4", "$"]], // 52
+  [Keyboard.FIVE, ["5", "%"]], // 53
+  [Keyboard.SIX, ["6", "^"]], // 54
+  [Keyboard.SEVEN, ["7", "&"]], // 55
+  [Keyboard.EIGHT, ["8", "*"]], // 56
+  [Keyboard.NINE, ["9", "("]], // 57
+
+  [Keyboard.SEMICOLON, [";", ":"]], // 59
+  [Keyboard.EQUAL, ["=", "+"]], // 61
+
+  [Keyboard.A, ["a", "A"]], // 65
+  [Keyboard.B, ["b", "B"]], // 66
+  [Keyboard.C, ["c", "C"]], // 67
+  [Keyboard.D, ["d", "D"]], // 68
+  [Keyboard.E, ["e", "E"]], // 69
+  [Keyboard.F, ["f", "F"]], // 70
+  [Keyboard.G, ["g", "G"]], // 71
+  [Keyboard.H, ["h", "H"]], // 72
+  [Keyboard.I, ["i", "I"]], // 73
+  [Keyboard.J, ["j", "J"]], // 74
+  [Keyboard.K, ["k", "K"]], // 75
+  [Keyboard.L, ["l", "L"]], // 76
+  [Keyboard.M, ["m", "M"]], // 77
+  [Keyboard.N, ["n", "N"]], // 78
+  [Keyboard.O, ["o", "O"]], // 79
+  [Keyboard.P, ["p", "P"]], // 80
+  [Keyboard.Q, ["q", "Q"]], // 81
+  [Keyboard.R, ["r", "R"]], // 82
+  [Keyboard.S, ["s", "S"]], // 83
+  [Keyboard.T, ["t", "T"]], // 84
+  [Keyboard.U, ["u", "U"]], // 85
+  [Keyboard.V, ["v", "V"]], // 86
+  [Keyboard.W, ["w", "W"]], // 87
+  [Keyboard.X, ["x", "X"]], // 88
+  [Keyboard.Y, ["y", "Y"]], // 89
+  [Keyboard.Z, ["z", "Z"]], // 90
+
+  [Keyboard.KP_0, ["0", "0"]], // 320
+  [Keyboard.KP_1, ["1", "1"]], // 321
+  [Keyboard.KP_2, ["2", "2"]], // 322
+  [Keyboard.KP_3, ["3", "3"]], // 323
+  [Keyboard.KP_4, ["4", "4"]], // 324
+  [Keyboard.KP_5, ["5", "5"]], // 325
+  [Keyboard.KP_6, ["6", "6"]], // 326
+  [Keyboard.KP_7, ["7", "7"]], // 327
+  [Keyboard.KP_8, ["8", "8"]], // 328
+  [Keyboard.KP_9, ["9", "9"]], // 329
+
+  [Keyboard.KP_DECIMAL, [".", "."]], // 330
+  [Keyboard.KP_DIVIDE, ["/", "/"]], // 331
+  [Keyboard.KP_MULTIPLY, ["*", "*"]], // 332
+  [Keyboard.KP_SUBTRACT, ["-", "-"]], // 333
+  [Keyboard.KP_ADD, ["+", "+"]], // 334
+
+  [Keyboard.LEFT_BRACKET, ["[", "{"]], // 91
+  [Keyboard.BACKSLASH, ["\\", "|"]], // 92
+  [Keyboard.RIGHT_BRACKET, ["]", "}"]], // 93
+  [Keyboard.GRAVE_ACCENT, ["`", "~"]], // 96
+]);

package/src/objects/callbackRegisterFunctions.ts

@@ -50,6 +50,7 @@ import { postPickupStateChangedRegister } from "../callbacks/subscriptions/postP
 import { postPitRenderRegister } from "../callbacks/subscriptions/postPitRender";
 import { postPitUpdateRegister } from "../callbacks/subscriptions/postPitUpdate";
 import { postPlayerChangeHealthRegister } from "../callbacks/subscriptions/postPlayerChangeHealth";
+import { postPlayerChangeStatRegister } from "../callbacks/subscriptions/postPlayerChangeStat";
 import { postPlayerChangeTypeRegister } from "../callbacks/subscriptions/postPlayerChangeType";
 import { postPlayerCollectibleAddedRegister } from "../callbacks/subscriptions/postPlayerCollectibleAdded";
 import { postPlayerCollectibleRemovedRegister } from "../callbacks/subscriptions/postPlayerCollectibleRemoved";
@@ -155,6 +156,7 @@ export const CALLBACK_REGISTER_FUNCTIONS: {
   [ModCallbackCustom.POST_PIT_RENDER]: postPitRenderRegister,
   [ModCallbackCustom.POST_PIT_UPDATE]: postPitUpdateRegister,
   [ModCallbackCustom.POST_PLAYER_CHANGE_HEALTH]: postPlayerChangeHealthRegister,
+  [ModCallbackCustom.POST_PLAYER_CHANGE_STAT]: postPlayerChangeStatRegister,
   [ModCallbackCustom.POST_PLAYER_CHANGE_TYPE]: postPlayerChangeTypeRegister,
   [ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED]:
     postPlayerCollectibleAddedRegister,

package/src/objects/isaacAPIClassTypeToBrand.ts

@@ -4,6 +4,7 @@ import { SerializationBrand } from "../enums/private/SerializationBrand";
 export const ISAAC_API_CLASS_TYPE_TO_BRAND: {
   readonly [key in CopyableIsaacAPIClassType]: SerializationBrand;
 } = {
+  [CopyableIsaacAPIClassType.BIT_SET_128]: SerializationBrand.BIT_SET_128,
   [CopyableIsaacAPIClassType.COLOR]: SerializationBrand.COLOR,
   [CopyableIsaacAPIClassType.K_COLOR]: SerializationBrand.K_COLOR,
   [CopyableIsaacAPIClassType.RNG]: SerializationBrand.RNG,

package/src/objects/isaacAPIClassTypeToFunctions.ts

@@ -1,6 +1,12 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClassType";
+import {
+  copyBitSet128,
+  deserializeBitSet128,
+  isSerializedBitSet128,
+  serializeBitSet128,
+} from "../functions/bitSet128";
 import {
   copyColor,
   deserializeColor,
@@ -36,6 +42,12 @@ interface IsaacAPIClassTypeFunctions {
 export const ISAAC_API_CLASS_TYPE_TO_FUNCTIONS: {
   readonly [key in CopyableIsaacAPIClassType]: IsaacAPIClassTypeFunctions;
 } = {
+  [CopyableIsaacAPIClassType.BIT_SET_128]: {
+    isSerialized: isSerializedBitSet128,
+    copy: copyBitSet128,
+    serialize: serializeBitSet128,
+    deserialize: deserializeBitSet128,
+  },
   [CopyableIsaacAPIClassType.COLOR]: {
     isSerialized: isSerializedColor,
     copy: copyColor,

package/src/types/AnyEntity.ts

@@ -1,3 +1,8 @@
+/**
+ * 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 type AnyEntity =
   | Entity
   | EntityBomb

package/src/types/AnyGridEntity.ts

@@ -1,3 +1,8 @@
+/**
+ * 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 type AnyGridEntity =
   | GridEntity
   | GridEntityDoor

package/src/types/CollectibleIndex.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/src/types/Immutable.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/src/types/PickupIndex.ts

@@ -1,6 +1,8 @@
 /**
- * `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/src/types/PlayerIndex.ts

@@ -1,7 +1,8 @@
 /**
  * `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/src/types/SerializedIsaacAPIClass.ts

@@ -1,3 +1,9 @@
+/**
+ * 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 type SerializedIsaacAPIClass = LuaMap<string, unknown> & {
   readonly __serializedIsaacAPIClassBrand: symbol;
 };

package/src/types/TSTLClass.ts

@@ -1,3 +1,8 @@
+/**
+ * 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 type TSTLClass = LuaMap<AnyNotNil, unknown> & {
   readonly __tstlClassBrand: symbol;
 };

package/src/types/TrapdoorDestination.ts

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

package/dist/functions/collectibleCacheFlag.d.ts

@@ -1,24 +0,0 @@
-import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
-export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
-/**
- * Returns a set containing every collectible type with the given cache flag, including modded
- * collectibles.
- */
-export declare function getCollectiblesForCacheFlag(cacheFlag: CacheFlag): Set<CollectibleType>;
-/**
- * Returns an array containing every collectible type that the player has that matches the provided
- * CacheFlag.
- *
- * For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
- * two Dead Doves, then this function would return:
- *
- * ```ts
- * [
- *   CollectibleType.LORD_OF_THE_PIT,
- *   CollectibleType.DEAD_DOVE,
- *   CollectibleType.DEAD_DOVE,
- * ]
- * ```
- */
-export declare function getPlayerCollectiblesForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
-//# sourceMappingURL=collectibleCacheFlag.d.ts.map

package/dist/functions/collectibleCacheFlag.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"collectibleCacheFlag.d.ts","sourceRoot":"","sources":["../../src/functions/collectibleCacheFlag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA2B1E,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,eAAe,CAAC,CAYtB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iCAAiC,CAC/C,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE,CAYnB"}