isaacscript-common 7.0.0 → 7.2.0

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.0.0",
+  "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.1"
+    "isaac-typescript-definitions": "^3.2.4"
   }
 }

package/src/callbacks/postPlayerChangeHealth.ts

@@ -55,7 +55,13 @@ function postPEffectUpdateReordered(player: EntityPlayer) {
       storedHealthValue !== currentHealthValue
     ) {
       const difference = currentHealthValue - storedHealthValue;
-      postPlayerChangeHealthFire(player, healthType, difference);
+      postPlayerChangeHealthFire(
+        player,
+        healthType,
+        difference,
+        storedHealthValue,
+        currentHealthValue,
+      );
     }
   }
 }

package/src/callbacks/postPlayerChangeStat.ts

@@ -0,0 +1,110 @@
+import { TearFlag } from "isaac-typescript-definitions";
+import { DefaultMap } from "../classes/DefaultMap";
+import { ModUpgraded } from "../classes/ModUpgraded";
+import { StatType } from "../enums";
+import { ModCallbackCustom } from "../enums/ModCallbackCustom";
+import { saveDataManager } from "../features/saveDataManager/exports";
+import {
+  colorEquals,
+  getPlayerStat,
+  isBitSet128,
+  isBoolean,
+  isColor,
+  isNumber,
+} from "../functions";
+import { getEnumValues } from "../functions/enums";
+import { getPlayerIndex } from "../functions/playerIndex";
+import { PlayerIndex } from "../types/PlayerIndex";
+import {
+  postPlayerChangeStatFire,
+  postPlayerChangeStatHasSubscriptions,
+} from "./subscriptions/postPlayerChangeStat";
+
+type PossibleStatType = number | boolean | BitFlags<TearFlag> | Color;
+
+const v = {
+  run: {
+    playersStatMap: new DefaultMap<
+      PlayerIndex,
+      Map<StatType, PossibleStatType>
+    >(() => new Map()),
+  },
+};
+
+export function postPlayerChangeStatInit(mod: ModUpgraded): void {
+  saveDataManager("postPlayerChangeStat", v, hasSubscriptions);
+
+  mod.AddCallbackCustom(
+    ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED,
+    postPEffectUpdateReordered,
+  );
+}
+
+function hasSubscriptions() {
+  return postPlayerChangeStatHasSubscriptions();
+}
+
+// ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED
+function postPEffectUpdateReordered(player: EntityPlayer) {
+  if (!hasSubscriptions()) {
+    return;
+  }
+
+  // We call the "getPlayerIndex" function with the "differentiateForgottenAndSoul" argument. If we
+  // don't differentiate between The Forgotten and The Soul, the callback will fire every time the
+  // player switches between the two.
+  const playerIndex = getPlayerIndex(player, true);
+  const playerStatMap = v.run.playersStatMap.getAndSetDefault(playerIndex);
+
+  for (const statType of getEnumValues(StatType)) {
+    const storedStatValue = playerStatMap.get(statType);
+    const currentStatValue = getPlayerStat(player, statType);
+    playerStatMap.set(statType, currentStatValue);
+
+    if (storedStatValue === undefined) {
+      continue;
+    }
+
+    if (!statEquals(storedStatValue, currentStatValue)) {
+      const isNumberStat =
+        isNumber(storedStatValue) && isNumber(currentStatValue);
+      const difference = isNumberStat ? currentStatValue - storedStatValue : 0;
+      postPlayerChangeStatFire(
+        player,
+        statType,
+        difference,
+        storedStatValue,
+        currentStatValue,
+      );
+    }
+  }
+}
+
+function statEquals(
+  oldValue: PossibleStatType,
+  newValue: PossibleStatType,
+): boolean {
+  const isNumberStat = isNumber(oldValue) && isNumber(newValue);
+  if (isNumberStat) {
+    return oldValue === newValue;
+  }
+
+  const isBooleanStat = isBoolean(oldValue) && isBoolean(newValue);
+  if (isBooleanStat) {
+    return oldValue === newValue;
+  }
+
+  const isBitSet128Stat = isBitSet128(oldValue) && isBitSet128(newValue);
+  if (isBitSet128Stat) {
+    return oldValue === newValue; // The class has the "__eq" meta-method.
+  }
+
+  const isColorStat = isColor(oldValue) && isColor(newValue);
+  if (isColorStat) {
+    return colorEquals(oldValue, newValue);
+  }
+
+  error(
+    'Failed to determine the type of a stat in the "POST_PLAYER_CHANGE_STAT" callback.',
+  );
+}

package/src/callbacks/subscriptions/postPlayerChangeHealth.ts

@@ -6,6 +6,8 @@ export type PostPlayerChangeHealthRegisterParameters = [
     player: EntityPlayer,
     healthType: HealthType,
     difference: int,
+    oldValue: int,
+    newValue: int,
   ) => void,
   playerVariant?: PlayerVariant,
   character?: PlayerType,
@@ -27,6 +29,8 @@ export function postPlayerChangeHealthFire(
   player: EntityPlayer,
   healthType: HealthType,
   difference: int,
+  oldValue: int,
+  newValue: int,
 ): void {
   const character = player.GetPlayerType();
 
@@ -41,6 +45,6 @@ export function postPlayerChangeHealthFire(
       continue;
     }
 
-    callback(player, healthType, difference);
+    callback(player, healthType, difference, oldValue, newValue);
   }
 }

package/src/callbacks/subscriptions/postPlayerChangeStat.ts

@@ -0,0 +1,55 @@
+import {
+  PlayerType,
+  PlayerVariant,
+  TearFlag,
+} from "isaac-typescript-definitions";
+import { StatType } from "../../enums/StatType";
+import { StatTypeType } from "../../interfaces/StatTypeType";
+
+export type PostPlayerChangeStatRegisterParameters = [
+  callback: (
+    player: EntityPlayer,
+    statType: StatType,
+    difference: int,
+    oldValue: number | boolean | BitFlags<TearFlag> | Color | Vector,
+    newValue: number | boolean | BitFlags<TearFlag> | Color | Vector,
+  ) => void,
+  playerVariant?: PlayerVariant,
+  character?: PlayerType,
+];
+
+const subscriptions: PostPlayerChangeStatRegisterParameters[] = [];
+
+export function postPlayerChangeStatHasSubscriptions(): boolean {
+  return subscriptions.length > 0;
+}
+
+export function postPlayerChangeStatRegister(
+  ...args: PostPlayerChangeStatRegisterParameters
+): void {
+  subscriptions.push(args);
+}
+
+export function postPlayerChangeStatFire<T extends StatType>(
+  player: EntityPlayer,
+  statType: T,
+  difference: int,
+  oldValue: StatTypeType[T],
+  newValue: StatTypeType[T],
+): void {
+  const character = player.GetPlayerType();
+
+  for (const [callback, playerVariant, callbackCharacter] of subscriptions) {
+    // Handle the optional 2nd callback argument.
+    if (playerVariant !== undefined && playerVariant !== player.Variant) {
+      continue;
+    }
+
+    // Handle the optional 3rd callback argument.
+    if (callbackCharacter !== undefined && callbackCharacter !== character) {
+      continue;
+    }
+
+    callback(player, statType, difference, oldValue, newValue);
+  }
+}

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/core/constants.ts

@@ -36,7 +36,7 @@ export const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
 /** Bombs explode when their frame count is equal to this value. */
 export const BOMB_EXPLODE_FRAME = 45;
 
-/** This is the initial value of the `EntityPickup.Wait` property after a collectible is spawned. */
+/** This is the initial value of the `EntityPickup.Wait` field after a collectible is spawned. */
 export const COLLECTIBLE_INITIAL_WAIT = 20;
 
 export const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;

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

@@ -798,8 +798,8 @@ export enum ModCallbackCustom {
   POST_PIT_UPDATE,
 
   /**
-   * Fires from the `POST_PEFFECT_UPDATE` callback when a player entity gains or loses any health
-   * (i.e. hearts). For more information, see the `PlayerHealth` enum.
+   * Fires from the `POST_PEFFECT_UPDATE` callback when a player's health (i.e. hearts) is different
+   * than what it was on the previous frame. For more information, see the `PlayerHealth` enum.
    *
    * - When registering the callback, takes an optional second argument that will make the callback
    *   only fire if the player matches the `PlayerVariant` provided.
@@ -811,15 +811,47 @@ export enum ModCallbackCustom {
    *   player: EntityPlayer,
    *   healthType: HealthType,
    *   difference: int,
+   *   oldValue: int,
+   *   newValue: int,
    * ): void {}
    * ```
    */
   POST_PLAYER_CHANGE_HEALTH,
 
+  /**
+   * Fires from the `POST_PEFFECT_UPDATE` callback when one of the player's stats change from what
+   * they were on the previous frame.
+   *
+   * The type of `oldValue` and `newValue` will depend on what kind of stat it is. For example,
+   * `StatType.FLYING` will be a boolean. (You can use the "Types" helper functions to narrow the
+   * type.)
+   *
+   * For `StatType.TEAR_FLAG`, `StatType.TEAR_COLOR`, `StatType.FLYING`, and `StatType.SIZE`, the
+   * `difference` argument will always be a value of 0, since the type of these stats are not
+   * numbers. (For these cases, you should examine the `oldValue` and `newValue` arguments
+   * accordingly.)
+   *
+   * - When registering the callback, takes an optional second argument that will make the callback
+   *   only fire if the player matches the `PlayerVariant` provided.
+   * - When registering the callback, takes an optional third argument that will make the callback
+   *   only fire if the player matches the `PlayerType` provided.
+   *
+   * ```ts
+   * function postPlayerChangeStat(
+   *   player: EntityPlayer,
+   *   statType: StatType,
+   *   difference: int,
+   *   oldValue: number | boolean | BitFlags<TearFlag> | Color | Vector,
+   *   newValue: number | boolean | BitFlags<TearFlag> | Color | Vector,
+   * ): void {}
+   * ```
+   */
+  POST_PLAYER_CHANGE_STAT,
+
   /**
    * Fires from the `POST_PEFFECT_UPDATE` callback when a player entity changes its player type
-   * (i.e. character). For example, it will fire after using Clicker, after dying with the Judas'
-   * Shadow collectible, etc.
+   * (i.e. character) from what it was on the previous frame. For example, it will fire after using
+   * Clicker, after dying with the Judas' Shadow collectible, etc.
    *
    * Notably, it does not fire after the player uses the Flip item or the Esau Jr. item, because
    * those items cause separate player entities to be created. Use the `POST_FLIP` and

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/enums/StatType.ts

@@ -0,0 +1,47 @@
+/** This represents the kinds of stats that a player can have. */
+export enum StatType {
+  /** Corresponds to `CacheFlag.DAMAGE` (1 << 0) and `EntityPlayer.Damage`. */
+  DAMAGE,
+
+  /** Corresponds to `CacheFlag.FIRE_DELAY` (1 << 1) and `EntityPlayer.MaxFireDelay`. */
+  FIRE_DELAY,
+
+  /** Corresponds to `CacheFlag.SHOT_SPEED` (1 << 2) and `EntityPlayer.ShotSpeed`. */
+  SHOT_SPEED,
+
+  /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearHeight`. */
+  TEAR_HEIGHT,
+
+  /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearRange`. */
+  TEAR_RANGE,
+
+  /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearFallingAcceleration`. */
+  TEAR_FALLING_ACCELERATION,
+
+  /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearFallingSpeed`. */
+  TEAR_FALLING_SPEED,
+
+  /** Corresponds to `CacheFlag.SPEED` (1 << 4) and `EntityPlayer.MoveSpeed`. */
+  MOVE_SPEED,
+
+  /** Corresponds to `CacheFlag.TEAR_FLAG` (1 << 5) and `EntityPlayer.TearFlags`. */
+  TEAR_FLAG,
+
+  /** Corresponds to `CacheFlag.TEAR_COLOR` (1 << 6) and `EntityPlayer.TearColor`. */
+  TEAR_COLOR,
+
+  /** Corresponds to `CacheFlag.FLYING` (1 << 7) and `EntityPlayer.CanFly`. */
+  FLYING,
+
+  // - `CacheFlag.WEAPON` (1 << 8) does not have a corresponding `EntityPlayer` field.
+  // - `CacheFlag.FAMILIARS` (1 << 9) does not have a corresponding `EntityPlayer` field.
+
+  /** Corresponds to `CacheFlag.LUCK` (1 << 10) and `EntityPlayer.Luck`. */
+  LUCK,
+
+  // - `CacheFlag.SIZE` (1 << 12) does not have a corresponding `EntityPlayer` field. (After picking
+  //   up Magic Mushroom, the values of `EntityPlayer.Size` and `EntityPlayer.SizeMulti` do not
+  //   change.)
+  // - `CacheFlag.COLOR` (1 << 12) does not have a corresponding `EntityPlayer` field.
+  // - `CacheFlag.PICKUP_VISION` (1 << 13) does not have a corresponding `EntityPlayer` field.
+}

package/src/enums/index.ts

@@ -6,3 +6,4 @@ export * from "./PocketItemType";
 export * from "./RockAltType";
 export * from "./SerializationType";
 export * from "./SlotDestructionType";
+export * from "./StatType";

package/src/enums/indexTypeDoc.ts

@@ -6,3 +6,4 @@ export * as PocketItemType from "./PocketItemType";
 export * as RockAltType from "./RockAltType";
 export * as SerializationType from "./SerializationType";
 export * as SlotDestructionType from "./SlotDestructionType";
+export * as StatType from "./StatType";

package/src/enums/private/CopyableIsaacAPIClassType.ts

@@ -1,5 +1,9 @@
-/** This must match the enumeration in the JSDoc comments for `deepCopy` and `merge`. */
+/**
+ * - This must match the JSDoc comments for `deepCopy` and `merge`.
+ * - This must match the `SerializableIsaacAPIClass` type union.
+ */
 export enum CopyableIsaacAPIClassType {
+  BIT_SET_128 = "BitSet128",
   COLOR = "Color",
   K_COLOR = "KColor",
   RNG = "RNG",

package/src/enums/private/SerializationBrand.ts

@@ -12,6 +12,7 @@ export enum SerializationBrand {
   SET = "__TSTL_SET",
 
   // Specific Isaac API class brands:
+  BIT_SET_128 = "__BIT_SET_128",
   COLOR = "__COLOR",
   K_COLOR = "__K_COLOR",
   RNG = "__RNG",

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/customStage/versusScreen.ts

@@ -76,13 +76,13 @@ const versusScreenSprite = Sprite();
 
 /**
  * Unfortunately, we must split the background layer into an entirely different sprite so that we
- * can color it with the `Color` property.
+ * can color it with the `Color` field.
  */
 const versusScreenBackgroundSprite = Sprite();
 
 /**
  * Unfortunately, we must split the dirt layer into an entirely different sprite so that we can
- * color it with the `Color` property.
+ * color it with the `Color` field.
  */
 const versusScreenDirtSpotSprite = Sprite();
 

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";

package/src/features/saveDataManager/merge.ts

@@ -25,6 +25,7 @@ import { isSerializationBrand } from "./serializationBrands";
  * - TSTL `Set`
  * - TSTL classes
  * - `DefaultMap`
+ * - Isaac `BitSet128` objects
  * - Isaac `Color` objects
  * - Isaac `KColor` objects
  * - Isaac `RNG` objects