isaacscript-common 7.1.1 → 7.2.0

package/src/functions/cacheFlag.ts

@@ -1,5 +1,62 @@
-import { CacheFlag } from "isaac-typescript-definitions";
+import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
+import { itemConfig } from "../core/cachedClasses";
 import { DEFAULT_PLAYER_STAT_MAP } from "../maps/defaultPlayerStatMap";
+import { getCollectibleArray } from "./collectibleSet";
+import { getEnumValues } from "./enums";
+import { hasFlag } from "./flag";
+import { copySet, getSortedSetValues } from "./set";
+import { repeat } from "./utils";
+
+const CACHE_FLAG_TO_COLLECTIBLES_MAP = new Map<
+  CacheFlag,
+  Set<CollectibleType>
+>();
+
+function initCacheFlagMap() {
+  for (const cacheFlag of getEnumValues(CacheFlag)) {
+    const collectiblesSet = new Set<CollectibleType>();
+
+    for (const collectibleType of getCollectibleArray()) {
+      if (collectibleHasCacheFlag(collectibleType, cacheFlag)) {
+        collectiblesSet.add(collectibleType);
+      }
+    }
+
+    CACHE_FLAG_TO_COLLECTIBLES_MAP.set(cacheFlag, collectiblesSet);
+  }
+}
+
+export function collectibleHasCacheFlag(
+  collectibleType: CollectibleType,
+  cacheFlag: CacheFlag,
+): boolean {
+  const itemConfigItem = itemConfig.GetCollectible(collectibleType);
+  if (itemConfigItem === undefined) {
+    return false;
+  }
+
+  return hasFlag(itemConfigItem.CacheFlags, cacheFlag);
+}
+
+/**
+ * Returns a set containing every collectible type with the given cache flag, including modded
+ * collectibles.
+ */
+export function getCollectiblesForCacheFlag(
+  cacheFlag: CacheFlag,
+): Set<CollectibleType> {
+  // Lazy initialize the map.
+  if (CACHE_FLAG_TO_COLLECTIBLES_MAP.size === 0) {
+    initCacheFlagMap();
+  }
+
+  const collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP.get(cacheFlag);
+  if (collectiblesSet === undefined) {
+    return new Set();
+  }
+
+  return copySet(collectiblesSet);
+}
 
 /**
  * Returns the starting stat that Isaac (the default character) starts with. For example, if you
@@ -10,3 +67,35 @@ import { DEFAULT_PLAYER_STAT_MAP } from "../maps/defaultPlayerStatMap";
 export function getDefaultPlayerStat(cacheFlag: CacheFlag): number | undefined {
   return DEFAULT_PLAYER_STAT_MAP.get(cacheFlag);
 }
+
+/**
+ * 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 function getPlayerCollectiblesForCacheFlag(
+  player: EntityPlayer,
+  cacheFlag: CacheFlag,
+): CollectibleType[] {
+  const collectiblesForCacheFlag = getCollectiblesForCacheFlag(cacheFlag);
+
+  const playerCollectibles: CollectibleType[] = [];
+  for (const collectibleType of getSortedSetValues(collectiblesForCacheFlag)) {
+    const numCollectibles = player.GetCollectibleNum(collectibleType);
+    repeat(numCollectibles, () => {
+      playerCollectibles.push(collectibleType);
+    });
+  }
+
+  return playerCollectibles;
+}

package/src/functions/flying.ts

@@ -5,7 +5,7 @@ import {
   PlayerType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { getCollectiblesForCacheFlag } from "./collectibleCacheFlag";
+import { getCollectiblesForCacheFlag } from "./cacheFlag";
 import { copySet, deleteSetsFromSet } from "./set";
 
 const FLYING_CHARACTERS: ReadonlySet<PlayerType> = new Set([

package/src/functions/index.ts

@@ -13,7 +13,6 @@ export * from "./challenges";
 export * from "./characters";
 export * from "./charge";
 export * from "./chargeBar";
-export * from "./collectibleCacheFlag";
 export * from "./collectibles";
 export * from "./collectibleSet";
 export * from "./collectibleTag";

package/src/functions/indexTypeDoc.ts

@@ -13,7 +13,6 @@ export * as Challenges from "./challenges";
 export * as Characters from "./characters";
 export * as Charge from "./charge";
 export * as ChargeBar from "./chargeBar";
-export * as CollectibleCacheFlag from "./collectibleCacheFlag";
 export * as Collectibles from "./collectibles";
 export * as CollectibleSet from "./collectibleSet";
 export * as CollectibleTag from "./collectibleTag";

package/src/functions/input.ts

@@ -4,6 +4,7 @@ import {
   ControllerIndex,
   Keyboard,
 } from "isaac-typescript-definitions";
+import { KEYBOARD_TO_STRING } from "../maps/keyboardToString";
 import { getEnumValues } from "./enums";
 import { copySet } from "./set";
 import { trimPrefix } from "./string";
@@ -133,6 +134,18 @@ export function isShootActionTriggeredOnAnyInput(): boolean {
   );
 }
 
-export function keyboardToString(keyboard: Keyboard): string {
-  return Keyboard[keyboard] ?? "unknown";
+/**
+ * Helper function to get the string that would be typed if someone pressed the corresponding key.
+ */
+export function keyboardToString(
+  keyboard: Keyboard,
+  uppercase: boolean,
+): string | undefined {
+  const tuple = KEYBOARD_TO_STRING.get(keyboard);
+  if (tuple === undefined) {
+    return undefined;
+  }
+
+  const [lowercaseCharacter, uppercaseCharacter] = tuple;
+  return uppercase ? uppercaseCharacter : lowercaseCharacter;
 }

package/src/functions/rockAlt.ts

@@ -41,6 +41,13 @@ const ROCK_ALT_CHANCES = {
 } as const;
 
 const COIN_VELOCITY_MULTIPLIER = 2;
+
+/** Matches the vanilla value, according to Fly's decompilation. */
+const FIND_FREE_INITIAL_STEP = 70;
+
+/** Matches the vanilla value, according to Fly's decompilation. */
+const FART_RADIUS = DISTANCE_OF_GRID_TILE * 3;
+
 const POLYP_PROJECTILE_SPEED = 10;
 const POLYP_NUM_PROJECTILES = 6;
 
@@ -128,6 +135,8 @@ export function spawnRockAltReward(
 }
 
 function spawnRockAltRewardUrn(position: Vector, rng: RNG): boolean {
+  const room = game.GetRoom();
+
   const chance = getRandom(rng);
   let totalChance = 0;
 
@@ -171,11 +180,11 @@ function spawnRockAltRewardUrn(position: Vector, rng: RNG): boolean {
   // Since the detrimental effect is the final option, we don't need to check the chance.
   const numEnemiesChance = getRandom(rng);
   const numEnemies = numEnemiesChance < 0.5 ? 1 : 2;
-  const length = DISTANCE_OF_GRID_TILE * 3;
   repeat(numEnemies, () => {
-    const randomVector = getRandomVector(rng);
-    const offset = randomVector.mul(length);
-    const targetPos = position.add(offset);
+    const targetPos = room.FindFreePickupSpawnPosition(
+      position,
+      FIND_FREE_INITIAL_STEP,
+    );
     EntityNPC.ThrowSpider(position, undefined, targetPos, false, 0);
   });
   return true;
@@ -253,7 +262,8 @@ function spawnRockAltRewardMushroom(position: Vector, rng: RNG): boolean {
   }
 
   // Since the detrimental effect is the final option, we don't need to check the chance.
-  spawnEffectWithSeed(EffectVariant.FART, 0, position, rng);
+  game.Fart(position);
+  game.ButterBeanFart(position, FART_RADIUS, undefined);
   return true;
 }
 
@@ -383,6 +393,8 @@ function spawnRockAltRewardPolyp(position: Vector, rng: RNG): boolean {
 }
 
 function spawnRockAltRewardBucketDownpour(position: Vector, rng: RNG): boolean {
+  const room = game.GetRoom();
+
   const chance = getRandom(rng);
   let totalChance = 0;
 
@@ -430,11 +442,12 @@ function spawnRockAltRewardBucketDownpour(position: Vector, rng: RNG): boolean {
 
   const numEnemiesChance = getRandom(rng);
   const numEnemies = numEnemiesChance < 0.5 ? 1 : 2;
-  const jumpDistance = DISTANCE_OF_GRID_TILE * 3;
   repeat(numEnemies, () => {
-    const randomVector = getRandomVector(rng);
-    const offset = randomVector.mul(jumpDistance);
-    const targetPos = position.add(offset);
+    const targetPos = room.FindFreePickupSpawnPosition(
+      position,
+      FIND_FREE_INITIAL_STEP,
+    );
+
     // If the room has water, Spiders will automatically be replaced with Striders.
     const spider = EntityNPC.ThrowSpider(
       position,
@@ -455,6 +468,8 @@ function spawnRockAltRewardBucketDownpour(position: Vector, rng: RNG): boolean {
 }
 
 function spawnRockAltRewardBucketDross(position: Vector, rng: RNG): boolean {
+  const room = game.GetRoom();
+
   const chance = getRandom(rng);
   let totalChance = 0;
 
@@ -502,11 +517,11 @@ function spawnRockAltRewardBucketDross(position: Vector, rng: RNG): boolean {
 
   const numEnemiesChance = getRandom(rng);
   const numEnemies = numEnemiesChance < 0.5 ? 1 : 2;
-  const jumpDistance = DISTANCE_OF_GRID_TILE * 3;
   repeat(numEnemies, () => {
-    const randomVector = getRandomVector(rng);
-    const offset = randomVector.mul(jumpDistance);
-    const targetPos = position.add(offset);
+    const targetPos = room.FindFreePickupSpawnPosition(
+      position,
+      FIND_FREE_INITIAL_STEP,
+    );
     const spider = EntityNPC.ThrowSpider(
       position,
       undefined,

package/src/functions/rooms.ts

@@ -498,6 +498,7 @@ export function roomUpdateSafe(): void {
 /** Helper function to set the backdrop of the current room. */
 export function setBackdrop(backdropType: BackdropType): void {
   game.ShowHallucination(0, backdropType);
+  sfxManager.Stop(SoundEffect.DEATH_CARD);
 }
 
 /**

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/StatTypeType.ts

@@ -1,6 +1,10 @@
 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/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/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/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];