isaacscript-common 7.1.0 → 7.2.1

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

@@ -16,10 +16,10 @@ import {
   StageID,
 } from "isaac-typescript-definitions";
 import { game, sfxManager } from "../core/cachedClasses";
-import { MAX_LEVEL_GRID_INDEX, NUM_DIMENSIONS } from "../core/constants";
+import { MAX_LEVEL_GRID_INDEX } from "../core/constants";
 import { ROOM_TYPE_NAMES } from "../objects/roomTypeNames";
 import { MINE_SHAFT_ROOM_SUB_TYPE_SET } from "../sets/mineShaftRoomSubTypesSet";
-import { inDimension } from "./dimensions";
+import { getAllDimensions, inDimension } from "./dimensions";
 import {
   closeAllDoors,
   getDoors,
@@ -45,7 +45,8 @@ import {
 } from "./roomData";
 import { reloadRoom } from "./roomTransition";
 import { getGotoCommand } from "./stage";
-import { erange, irange } from "./utils";
+import { asNumber } from "./types";
+import { irange } from "./utils";
 
 /**
  * Helper function for quickly switching to a new room without playing a particular animation. Use
@@ -207,7 +208,7 @@ export function getRoomsInsideGrid(
   const level = game.GetLevel();
 
   const dimensions = includeExtraDimensionalRooms
-    ? (erange(NUM_DIMENSIONS) as Dimension[])
+    ? getAllDimensions()
     : [Dimension.CURRENT];
 
   /** We use a map instead of an array because room shapes occupy more than one room grid index. */
@@ -284,8 +285,10 @@ export function inAngelShop(): boolean {
   const roomType = room.GetType();
   const roomSubType = getRoomSubType();
 
-  // eslint-disable-next-line isaacscript/strict-enums
-  return roomType === RoomType.ANGEL && roomSubType === AngelRoomSubType.SHOP;
+  return (
+    roomType === RoomType.ANGEL &&
+    roomSubType === asNumber(AngelRoomSubType.SHOP)
+  );
 }
 
 export function inBeastRoom(): boolean {
@@ -294,8 +297,8 @@ export function inBeastRoom(): boolean {
   const roomSubType = getRoomSubType();
 
   return (
-    // eslint-disable-next-line isaacscript/strict-enums
-    roomType === RoomType.DUNGEON && roomSubType === DungeonSubType.BEAST_ROOM
+    roomType === RoomType.DUNGEON &&
+    roomSubType === asNumber(DungeonSubType.BEAST_ROOM)
   );
 }
 
@@ -312,7 +315,7 @@ export function inBossRoomOf(bossID: BossID): boolean {
   return (
     roomType === RoomType.BOSS &&
     roomStageID === StageID.SPECIAL_ROOMS &&
-    roomSubType === bossID // eslint-disable-line isaacscript/strict-enums
+    roomSubType === asNumber(bossID)
   );
 }
 
@@ -326,13 +329,14 @@ export function inCrawlSpace(): boolean {
   const roomType = room.GetType();
   const roomSubType = getRoomSubType();
 
-  // eslint-disable-next-line isaacscript/strict-enums
-  return roomType === RoomType.DUNGEON && roomSubType === DungeonSubType.NORMAL;
+  return (
+    roomType === RoomType.DUNGEON &&
+    roomSubType === asNumber(DungeonSubType.NORMAL)
+  );
 }
 
 /**
- * We cannot use the standard code in the `inDimension` function for this purpose since it is bugged
- * with the Death Certificate area.
+ * Helper function to detect if the current room is one of the room in the Death Certificate area.
  */
 export function inDeathCertificateArea(): boolean {
   const roomStageID = getRoomStageID();
@@ -340,17 +344,16 @@ export function inDeathCertificateArea(): boolean {
 
   return (
     roomStageID === StageID.HOME &&
-    // eslint-disable-next-line isaacscript/strict-enums
-    (roomSubType === HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE ||
-      // eslint-disable-next-line isaacscript/strict-enums
-      roomSubType === HomeRoomSubType.DEATH_CERTIFICATE_ITEMS)
+    (roomSubType === asNumber(HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE) ||
+      roomSubType === asNumber(HomeRoomSubType.DEATH_CERTIFICATE_ITEMS))
   );
 }
 
 /**
  * Helper function to detect if the current room is a Treasure Room created when entering with a
- * Devil's Crown trinket. Under the hood, this checks for the `RoomDescriptorFlag.DEVIL_TREASURE`
- * flag.
+ * Devil's Crown trinket.
+ *
+ * Under the hood, this checks for `RoomDescriptorFlag.DEVIL_TREASURE`.
  */
 export function inDevilsCrownTreasureRoom(): boolean {
   const roomDescriptor = getRoomDescriptorReadOnly();
@@ -368,8 +371,7 @@ export function inDoubleTrouble(): boolean {
 export function inGenesisRoom(): boolean {
   const roomGridIndex = getRoomGridIndex();
 
-  // eslint-disable-next-line isaacscript/strict-enums
-  return roomGridIndex === GridRoom.GENESIS;
+  return roomGridIndex === asNumber(GridRoom.GENESIS);
 }
 
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
@@ -388,8 +390,7 @@ export function inLRoom(): boolean {
 export function inMegaSatanRoom(): boolean {
   const roomGridIndex = getRoomGridIndex();
 
-  // eslint-disable-next-line isaacscript/strict-enums
-  return roomGridIndex === GridRoom.MEGA_SATAN;
+  return roomGridIndex === asNumber(GridRoom.MEGA_SATAN);
 }
 
 /**
@@ -420,7 +421,7 @@ export function inMinibossRoomOf(minibossID: MinibossID): boolean {
   return (
     roomType === RoomType.MINI_BOSS &&
     roomStageID === StageID.SPECIAL_ROOMS &&
-    roomSubType === minibossID // eslint-disable-line isaacscript/strict-enums
+    roomSubType === asNumber(minibossID)
   );
 }
 
@@ -434,8 +435,7 @@ export function inMinibossRoomOf(minibossID: MinibossID): boolean {
 export function inSecretShop(): boolean {
   const roomGridIndex = getRoomGridIndex();
 
-  // eslint-disable-next-line isaacscript/strict-enums
-  return roomGridIndex === GridRoom.SECRET_SHOP;
+  return roomGridIndex === asNumber(GridRoom.SECRET_SHOP);
 }
 
 /**
@@ -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/functions/spawnCollectible.ts

@@ -1,6 +1,5 @@
 import {
   CollectibleType,
-  PickupPrice,
   PickupVariant,
   PlayerType,
 } from "isaac-typescript-definitions";
@@ -65,7 +64,7 @@ export function spawnCollectible(
 
     // We can set the price to any arbitrary value; it will auto-update to the true price on the
     // next frame.
-    collectible.Price = 15 as PickupPrice;
+    collectible.Price = 15;
   }
 
   if (isQuestCollectible(collectibleType) && areFeaturesInitialized()) {

package/src/functions/stage.ts

@@ -8,6 +8,7 @@ import { game } from "../core/cachedClasses";
 import { ROOM_TYPE_GOTO_PREFIXES } from "../objects/roomTypeGotoPrefixes";
 import { STAGE_TYPE_SUFFIXES } from "../objects/stageTypeSuffixes";
 import { STAGE_TYPE_TO_LETTER } from "../objects/stageTypeToLetter";
+import { asLevelStage, asNumber } from "./types";
 
 /**
  * Helper function that calculates what the stage type should be for the provided stage. This
@@ -57,7 +58,7 @@ export function calculateStageTypeRepentance(stage: LevelStage): StageType {
   // This algorithm is from Kilburn. We add one because the alt path is offset by 1 relative to the
   // normal path.
   const seeds = game.GetSeeds();
-  const adjustedStage = ((stage as int) + 1) as LevelStage;
+  const adjustedStage = asLevelStage(asNumber(stage) + 1);
   const stageSeed = seeds.GetStageSeed(adjustedStage);
 
   // Kilburn does not know why he divided the stage seed by 2 first.
@@ -79,7 +80,7 @@ export function getEffectiveStage(): int {
   const stage = level.GetStage();
 
   if (onRepentanceStage()) {
-    return stage + 1; // eslint-disable-line isaacscript/strict-enums
+    return asNumber(stage) + 1;
   }
 
   return stage;

package/src/functions/trinkets.ts

@@ -21,6 +21,7 @@ import { hasFlag } from "./flag";
 import { isTrinket } from "./pickupVariants";
 import { isCharacter } from "./players";
 import { clearSprite } from "./sprites";
+import { asNumber } from "./types";
 import { irange } from "./utils";
 
 /**
@@ -41,7 +42,7 @@ const TRINKET_SPRITE_LAYER = 0;
  * corresponds to the golden trinket sub-type for Swallowed Penny.
  */
 export function getGoldenTrinketType(trinketType: TrinketType): TrinketType {
-  return trinketType + GOLDEN_TRINKET_ADJUSTMENT; // eslint-disable-line isaacscript/strict-enums
+  return asNumber(trinketType) + GOLDEN_TRINKET_ADJUSTMENT;
 }
 
 /**
@@ -54,7 +55,7 @@ export function getModdedTrinketTypes(): TrinketType[] {
     return [];
   }
 
-  return irange(FIRST_MODDED_TRINKET_TYPE, LAST_TRINKET_TYPE) as TrinketType[];
+  return irange(FIRST_MODDED_TRINKET_TYPE, LAST_TRINKET_TYPE);
 }
 
 /**
@@ -140,12 +141,12 @@ export function getTrinketName(trinketType: TrinketType): string {
 
 /** Helper function to get an array that contains every trinket type. */
 export function getTrinketTypes(): TrinketType[] {
-  return irange(FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE) as TrinketType[];
+  return irange(FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE);
 }
 
 /** Helper function to get an array that represents every vanilla trinket type. */
 export function getVanillaTrinketTypes(): TrinketType[] {
-  return irange(FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE) as TrinketType[];
+  return irange(FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE);
 }
 
 /**
@@ -165,7 +166,7 @@ export function hasOpenTrinketSlot(player: EntityPlayer): boolean {
 }
 
 export function isGoldenTrinket(trinketType: TrinketType): boolean {
-  return trinketType > (GOLDEN_TRINKET_ADJUSTMENT as TrinketType);
+  return asNumber(trinketType) > GOLDEN_TRINKET_ADJUSTMENT;
 }
 
 /**

package/src/functions/types.ts

@@ -1,3 +1,103 @@
+import {
+  Card,
+  CollectibleType,
+  LevelStage,
+  PillColor,
+  PillEffect,
+  PlayerType,
+  TrinketType,
+} from "isaac-typescript-definitions";
+
+/**
+ * Helper function to safely cast a `number` to a `Card`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asCard(num: number): Card {
+  return num;
+}
+
+/**
+ * Helper function to safely cast a `number` to a `CollectibleType`. (This is better than using the
+ * `as` TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asCollectibleType(num: number): CollectibleType {
+  return num;
+}
+
+/**
+ * Helper function to safely cast a `number` to a `LevelStage`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asLevelStage(num: number): LevelStage {
+  return num;
+}
+
+/**
+ * Helper function to safely cast an enum to a `number`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asNumber(num: number): number {
+  return num;
+}
+
+/**
+ * Helper function to safely cast a `number` to a `PillColor`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asPillColor(num: number): PillColor {
+  return num;
+}
+
+/**
+ * Helper function to safely cast a `number` to a `PillEffect`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asPillEffect(num: number): PillEffect {
+  return num;
+}
+
+/**
+ * Helper function to safely cast a `number` to a `PlayerType`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asPlayerType(num: number): PlayerType {
+  return num;
+}
+
+/**
+ * Helper function to safely cast an enum to a `string`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asString(str: string): string {
+  return str;
+}
+
+/**
+ * Helper function to safely cast a `number` to a `TrinketType`. (This is better than using the `as`
+ * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
+ *
+ * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
+ */
+export function asTrinketType(num: number): TrinketType {
+  return num;
+}
+
 export function isBoolean(variable: unknown): variable is boolean {
   return type(variable) === "boolean";
 }

package/src/functions/vector.ts

@@ -36,11 +36,7 @@ export function deserializeVector(vector: SerializedVector): Vector {
     );
   }
 
-  const [x, y] = getNumbersFromTable(
-    vector as LuaMap<string, unknown>,
-    OBJECT_NAME,
-    ...KEYS,
-  );
+  const [x, y] = getNumbersFromTable(vector, OBJECT_NAME, ...KEYS);
 
   if (x === undefined) {
     error(

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;
@@ -14,5 +18,4 @@ export interface StatTypeType {
   [StatType.TEAR_COLOR]: Color;
   [StatType.FLYING]: boolean;
   [StatType.LUCK]: float;
-  [StatType.SIZE]: Vector;
 }