isaacscript-common 87.9.6 → 87.9.7

package/dist/types/PickingUpItem.js

@@ -1,9 +1,5 @@
 "use strict";
-/**
- * This is the type that is fed to the `PRE_ITEM_PICKUP` and `POST_ITEM_PICKUP` custom callbacks.
- *
- * @module
- */
+/* eslint-disable complete/type-declaration-immutability */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.newPickingUpItem = newPickingUpItem;
 exports.resetPickingUpItem = resetPickingUpItem;

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

@@ -1 +1 @@
-{"version":3,"file":"PossibleStatType.d.ts","sourceRoot":"","sources":["../../src/types/PossibleStatType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,OAAO,GACP,QAAQ,CAAC,QAAQ,CAAC,GAClB,KAAK,GACL,MAAM,CAAC"}
+{"version":3,"file":"PossibleStatType.d.ts","sourceRoot":"","sources":["../../src/types/PossibleStatType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAC1B,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "87.9.6",
+  "version": "87.9.7",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -34,13 +34,12 @@
     "lint": "tsx --tsconfig ./scripts/tsconfig.json ./scripts/lint.mts"
   },
   "dependencies": {
-    "isaac-typescript-definitions": "43.0.6"
+    "isaac-typescript-definitions": "43.0.7"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "7.57.7",
-    "complete-node": "16.4.0",
-    "eslint-plugin-sort-exports": "0.9.1",
-    "typescript-eslint": "8.57.1",
-    "typescript-to-lua": "1.34.0"
+    "@microsoft/api-extractor": "7.59.0",
+    "complete-node": "18.0.1",
+    "typescript-eslint": "8.69.0",
+    "typescript-to-lua": "1.37.1"
   }
 }

package/src/classes/DefaultMap.ts

@@ -85,8 +85,7 @@ export class DefaultMap<Key, Value, Args extends unknown[] = []> extends Map<
 > {
   private readonly defaultValue: Value | undefined;
   private readonly defaultValueFactory:
-    | FactoryFunction<Value, Args>
-    | undefined;
+    FactoryFunction<Value, Args> | undefined;
 
   /**
    * See the main `DefaultMap` documentation:

package/src/classes/ModFeature.ts

@@ -36,8 +36,7 @@ type ModFeatureConstructor = TSTLClassMetatable["constructor"] & {
     | undefined;
   [WRAPPED_CALLBACK_METHODS_KEY]: Map<ModCallback, AnyFunction> | undefined;
   [WRAPPED_CUSTOM_CALLBACK_METHODS_KEY]:
-    | Map<ModCallbackCustom, AnyFunction>
-    | undefined;
+    Map<ModCallbackCustom, AnyFunction> | undefined;
 };
 
 /**
@@ -368,8 +367,7 @@ function initSaveDataManager(
     ? "saveDataManager"
     : "saveDataManagerRemove";
   const saveDataManagerMethod = mod[saveDataManagerMethodName] as
-    | AnyFunction
-    | undefined;
+    AnyFunction | undefined;
   assertDefined(
     saveDataManagerMethod,
     'Failed to initialize a mod feature class due to having a "v" object and not having the save data manager initialized. You must pass "ISCFeature.SAVE_DATA_MANAGER" to the "upgradeMod" function.',

package/src/classes/ModUpgraded.ts

@@ -31,12 +31,6 @@ import type { Feature } from "./private/Feature";
  * corresponds to the internal-type `ModUpgradedWithFeatures` type, which extends `ModUpgraded`.)
  */
 export class ModUpgraded implements Mod {
-  // -----------------
-  // Vanilla variables
-  // -----------------
-
-  public Name: string;
-
   // ----------------
   // Custom variables
   // ----------------
@@ -50,6 +44,12 @@ export class ModUpgraded implements Mod {
   private readonly callbacks;
   private readonly features;
 
+  // -----------------
+  // Vanilla variables
+  // -----------------
+
+  public readonly Name: string;
+
   // -----------
   // Constructor
   // -----------
@@ -66,6 +66,148 @@ export class ModUpgraded implements Mod {
     );
   }
 
+  // ----------------------
+  // Custom private methods
+  // ----------------------
+
+  /**
+   * This is used to initialize both custom callbacks and "extra features".
+   *
+   * This mirrors the `uninitFeature` method.
+   */
+  private initFeature(feature: Feature): void {
+    feature.numConsumers++;
+
+    if (feature.initialized) {
+      return;
+    }
+
+    feature.initialized = true;
+
+    if (feature.v !== undefined) {
+      feature.featuresUsed ??= [];
+      if (!feature.featuresUsed.includes(ISCFeature.SAVE_DATA_MANAGER)) {
+        // eslint-disable-next-line unicorn/no-array-front-mutation
+        feature.featuresUsed.unshift(ISCFeature.SAVE_DATA_MANAGER);
+      }
+    }
+
+    if (feature.featuresUsed !== undefined) {
+      for (const featureUsed of feature.featuresUsed) {
+        const featureClass = this.features[featureUsed];
+        this.initFeature(featureClass);
+      }
+    }
+
+    if (feature.callbacksUsed !== undefined) {
+      for (const callbackTuple of feature.callbacksUsed) {
+        const [modCallback, callbackFunc, optionalArgs] = callbackTuple;
+        // TypeScript is not smart enough to know that the arguments match the function.
+        (this.AddPriorityCallback as AnyFunction)(
+          modCallback,
+          CallbackPriority.IMPORTANT,
+          callbackFunc,
+          ...(optionalArgs ?? []),
+        );
+      }
+    }
+
+    if (feature.customCallbacksUsed !== undefined) {
+      for (const callbackTuple of feature.customCallbacksUsed) {
+        const [modCallback, callbackFunc, optionalArgs] = callbackTuple;
+        // TypeScript is not smart enough to know that the arguments match the function.
+        (this.AddPriorityCallbackCustom as AnyFunction)(
+          modCallback,
+          CallbackPriority.IMPORTANT,
+          callbackFunc,
+          ...(optionalArgs ?? []),
+        );
+      }
+    }
+
+    if (feature.v !== undefined) {
+      const className = getTSTLClassName(feature);
+      assertDefined(className, "Failed to get the name of a feature.");
+
+      const saveDataManagerClass = this.features[ISCFeature.SAVE_DATA_MANAGER];
+      saveDataManagerClass.saveDataManager(
+        className,
+        feature.v,
+        feature.vConditionalFunc,
+      );
+    }
+  }
+
+  /**
+   * This is used to uninitialize both custom callbacks and "extra features".
+   *
+   * This mirrors the `initFeature` method.
+   */
+  private uninitFeature(feature: Feature): void {
+    if (feature.numConsumers <= 0) {
+      const className = getTSTLClassName(feature) ?? "unknown";
+      error(
+        `Failed to uninit feature "${className}" since it has ${feature.numConsumers} consumers, which should never happen.`,
+      );
+    }
+
+    if (!feature.initialized) {
+      const className = getTSTLClassName(feature) ?? "unknown";
+      error(
+        `Failed to uninit feature "${className}" since it was not initialized, which should never happen.`,
+      );
+    }
+
+    feature.numConsumers--;
+
+    if (feature.numConsumers > 0) {
+      return;
+    }
+
+    feature.initialized = false;
+
+    if (feature.featuresUsed !== undefined) {
+      for (const featureUsed of feature.featuresUsed) {
+        const featureClass = this.features[featureUsed];
+        this.uninitFeature(featureClass);
+      }
+    }
+
+    if (feature.callbacksUsed !== undefined) {
+      for (const callbackTuple of feature.callbacksUsed) {
+        const [modCallback, callbackFunc] = callbackTuple;
+        this.RemoveCallback(modCallback, callbackFunc);
+      }
+    }
+
+    if (feature.customCallbacksUsed !== undefined) {
+      for (const callbackTuple of feature.customCallbacksUsed) {
+        const [modCallback, callbackFunc] = callbackTuple;
+        this.RemoveCallbackCustom(modCallback, callbackFunc);
+      }
+    }
+
+    if (feature.v !== undefined) {
+      const className = getTSTLClassName(feature);
+      assertDefined(className, "Failed to get the name of a feature.");
+
+      const saveDataManagerClass = this.features[ISCFeature.SAVE_DATA_MANAGER];
+      saveDataManagerClass.saveDataManagerRemove(className);
+    }
+  }
+
+  /**
+   * Returns the names of the exported class methods from the features that were added. This is
+   * called from the "upgradeMod" function, but we want to mark it as private so that end-users
+   * don't have access to it.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-private-class-members
+  private initOptionalFeature(feature: ISCFeature): readonly FunctionTuple[] {
+    const featureClass = this.features[feature];
+    this.initFeature(featureClass);
+
+    return getExportedMethodsFromFeature(featureClass);
+  }
   // ---------------
   // Vanilla methods
   // ---------------
@@ -275,148 +417,6 @@ export class ModUpgraded implements Mod {
       log(`- ISCFeature.${ISCFeature[iscFeature]} (${iscFeature})`);
     }
   }
-
-  // ----------------------
-  // Custom private methods
-  // ----------------------
-
-  /**
-   * This is used to initialize both custom callbacks and "extra features".
-   *
-   * This mirrors the `uninitFeature` method.
-   */
-  private initFeature(feature: Feature): void {
-    feature.numConsumers++;
-
-    if (feature.initialized) {
-      return;
-    }
-
-    feature.initialized = true;
-
-    if (feature.v !== undefined) {
-      feature.featuresUsed ??= [];
-      if (!feature.featuresUsed.includes(ISCFeature.SAVE_DATA_MANAGER)) {
-        feature.featuresUsed.unshift(ISCFeature.SAVE_DATA_MANAGER);
-      }
-    }
-
-    if (feature.featuresUsed !== undefined) {
-      for (const featureUsed of feature.featuresUsed) {
-        const featureClass = this.features[featureUsed];
-        this.initFeature(featureClass);
-      }
-    }
-
-    if (feature.callbacksUsed !== undefined) {
-      for (const callbackTuple of feature.callbacksUsed) {
-        const [modCallback, callbackFunc, optionalArgs] = callbackTuple;
-        // TypeScript is not smart enough to know that the arguments match the function.
-        (this.AddPriorityCallback as AnyFunction)(
-          modCallback,
-          CallbackPriority.IMPORTANT,
-          callbackFunc,
-          ...(optionalArgs ?? []),
-        );
-      }
-    }
-
-    if (feature.customCallbacksUsed !== undefined) {
-      for (const callbackTuple of feature.customCallbacksUsed) {
-        const [modCallback, callbackFunc, optionalArgs] = callbackTuple;
-        // TypeScript is not smart enough to know that the arguments match the function.
-        (this.AddPriorityCallbackCustom as AnyFunction)(
-          modCallback,
-          CallbackPriority.IMPORTANT,
-          callbackFunc,
-          ...(optionalArgs ?? []),
-        );
-      }
-    }
-
-    if (feature.v !== undefined) {
-      const className = getTSTLClassName(feature);
-      assertDefined(className, "Failed to get the name of a feature.");
-
-      const saveDataManagerClass = this.features[ISCFeature.SAVE_DATA_MANAGER];
-      saveDataManagerClass.saveDataManager(
-        className,
-        feature.v,
-        feature.vConditionalFunc,
-      );
-    }
-  }
-
-  /**
-   * This is used to uninitialize both custom callbacks and "extra features".
-   *
-   * This mirrors the `initFeature` method.
-   */
-  private uninitFeature(feature: Feature): void {
-    if (feature.numConsumers <= 0) {
-      const className = getTSTLClassName(feature) ?? "unknown";
-      error(
-        `Failed to uninit feature "${className}" since it has ${feature.numConsumers} consumers, which should never happen.`,
-      );
-    }
-
-    if (!feature.initialized) {
-      const className = getTSTLClassName(feature) ?? "unknown";
-      error(
-        `Failed to uninit feature "${className}" since it was not initialized, which should never happen.`,
-      );
-    }
-
-    feature.numConsumers--;
-
-    if (feature.numConsumers > 0) {
-      return;
-    }
-
-    feature.initialized = false;
-
-    if (feature.featuresUsed !== undefined) {
-      for (const featureUsed of feature.featuresUsed) {
-        const featureClass = this.features[featureUsed];
-        this.uninitFeature(featureClass);
-      }
-    }
-
-    if (feature.callbacksUsed !== undefined) {
-      for (const callbackTuple of feature.callbacksUsed) {
-        const [modCallback, callbackFunc] = callbackTuple;
-        this.RemoveCallback(modCallback, callbackFunc);
-      }
-    }
-
-    if (feature.customCallbacksUsed !== undefined) {
-      for (const callbackTuple of feature.customCallbacksUsed) {
-        const [modCallback, callbackFunc] = callbackTuple;
-        this.RemoveCallbackCustom(modCallback, callbackFunc);
-      }
-    }
-
-    if (feature.v !== undefined) {
-      const className = getTSTLClassName(feature);
-      assertDefined(className, "Failed to get the name of a feature.");
-
-      const saveDataManagerClass = this.features[ISCFeature.SAVE_DATA_MANAGER];
-      saveDataManagerClass.saveDataManagerRemove(className);
-    }
-  }
-
-  /**
-   * Returns the names of the exported class methods from the features that were added. This is
-   * called from the "upgradeMod" function, but we want to mark it as private so that end-users
-   * don't have access to it.
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-private-class-members
-  private initOptionalFeature(feature: ISCFeature): readonly FunctionTuple[] {
-    const featureClass = this.features[feature];
-    this.initFeature(featureClass);
-
-    return getExportedMethodsFromFeature(featureClass);
-  }
 }
 
 /**
@@ -434,8 +434,7 @@ function getExportedMethodsFromFeature(
     unknown
   >;
   const exportedMethodNames = constructor[EXPORTED_METHOD_NAMES_KEY] as
-    | string[]
-    | undefined;
+    string[] | undefined;
 
   if (exportedMethodNames === undefined) {
     return [];

package/src/classes/callbacks/EntityTakeDmgFilter.ts

@@ -5,17 +5,6 @@ import { shouldFireEntity } from "../../shouldFire";
 import { CustomCallback } from "../private/CustomCallback";
 
 export class EntityTakeDmgFilter extends CustomCallback<ModCallbackCustom.ENTITY_TAKE_DMG_FILTER> {
-  constructor() {
-    super();
-
-    this.callbacksUsed = [
-      // 11
-      [ModCallback.ENTITY_TAKE_DMG, this.entityTakeDmg],
-    ];
-  }
-
-  protected override shouldFire = shouldFireEntity;
-
   // ModCallback.ENTITY_TAKE_DMG (11)
   private readonly entityTakeDmg = (
     entity: Entity,
@@ -24,4 +13,15 @@ export class EntityTakeDmgFilter extends CustomCallback<ModCallbackCustom.ENTITY
     source: EntityRef,
     countdownFrames: number,
   ) => this.fire(entity, amount, damageFlags, source, countdownFrames);
+
+  protected override shouldFire = shouldFireEntity;
+
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 11
+      [ModCallback.ENTITY_TAKE_DMG, this.entityTakeDmg],
+    ];
+  }
 }

package/src/classes/callbacks/EntityTakeDmgPlayer.ts

@@ -5,21 +5,6 @@ import { shouldFirePlayer } from "../../shouldFire";
 import { CustomCallback } from "../private/CustomCallback";
 
 export class EntityTakeDmgPlayer extends CustomCallback<ModCallbackCustom.ENTITY_TAKE_DMG_PLAYER> {
-  constructor() {
-    super();
-
-    this.callbacksUsed = [
-      // 11
-      [
-        ModCallback.ENTITY_TAKE_DMG,
-        this.entityTakeDmgPlayer,
-        [EntityType.PLAYER],
-      ],
-    ];
-  }
-
-  protected override shouldFire = shouldFirePlayer;
-
   // ModCallback.ENTITY_TAKE_DMG (11)
   private readonly entityTakeDmgPlayer = (
     entity: Entity,
@@ -35,4 +20,19 @@ export class EntityTakeDmgPlayer extends CustomCallback<ModCallbackCustom.ENTITY
 
     return this.fire(player, amount, damageFlags, source, countdownFrames);
   };
+
+  protected override shouldFire = shouldFirePlayer;
+
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 11
+      [
+        ModCallback.ENTITY_TAKE_DMG,
+        this.entityTakeDmgPlayer,
+        [EntityType.PLAYER],
+      ],
+    ];
+  }
 }

package/src/classes/callbacks/InputActionFilter.ts

@@ -7,14 +7,12 @@ import { CustomCallback } from "../private/CustomCallback";
 type T = ModCallbackCustom.INPUT_ACTION_FILTER;
 
 export class InputActionFilter extends CustomCallback<T> {
-  constructor() {
-    super();
-
-    this.callbacksUsed = [
-      // 13
-      [ModCallback.INPUT_ACTION, this.inputAction],
-    ];
-  }
+  // ModCallback.INPUT_ACTION (13)
+  private readonly inputAction = (
+    entity: Entity | undefined,
+    inputHook: InputHook,
+    buttonAction: ButtonAction,
+  ): boolean | float | undefined => this.fire(entity, inputHook, buttonAction);
 
   protected override shouldFire = (
     fireArgs: FireArgs<T>,
@@ -30,10 +28,12 @@ export class InputActionFilter extends CustomCallback<T> {
     );
   };
 
-  // ModCallback.INPUT_ACTION (13)
-  private readonly inputAction = (
-    entity: Entity | undefined,
-    inputHook: InputHook,
-    buttonAction: ButtonAction,
-  ): boolean | float | undefined => this.fire(entity, inputHook, buttonAction);
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 13
+      [ModCallback.INPUT_ACTION, this.inputAction],
+    ];
+  }
 }

package/src/classes/callbacks/InputActionPlayer.ts

@@ -7,14 +7,23 @@ import { CustomCallback } from "../private/CustomCallback";
 type T = ModCallbackCustom.INPUT_ACTION_PLAYER;
 
 export class InputActionPlayer extends CustomCallback<T> {
-  constructor() {
-    super();
+  // ModCallback.INPUT_ACTION (13)
+  private readonly inputAction = (
+    entity: Entity | undefined,
+    inputHook: InputHook,
+    buttonAction: ButtonAction,
+  ): boolean | float | undefined => {
+    if (entity === undefined) {
+      return undefined;
+    }
 
-    this.callbacksUsed = [
-      // 13
-      [ModCallback.INPUT_ACTION, this.inputAction],
-    ];
-  }
+    const player = entity.ToPlayer();
+    if (player === undefined) {
+      return undefined;
+    }
+
+    return this.fire(player, inputHook, buttonAction);
+  };
 
   protected override shouldFire = (
     fireArgs: FireArgs<T>,
@@ -40,21 +49,12 @@ export class InputActionPlayer extends CustomCallback<T> {
     );
   };
 
-  // ModCallback.INPUT_ACTION (13)
-  private readonly inputAction = (
-    entity: Entity | undefined,
-    inputHook: InputHook,
-    buttonAction: ButtonAction,
-  ): boolean | float | undefined => {
-    if (entity === undefined) {
-      return undefined;
-    }
-
-    const player = entity.ToPlayer();
-    if (player === undefined) {
-      return undefined;
-    }
+  constructor() {
+    super();
 
-    return this.fire(player, inputHook, buttonAction);
-  };
+    this.callbacksUsed = [
+      // 13
+      [ModCallback.INPUT_ACTION, this.inputAction],
+    ];
+  }
 }

package/src/classes/callbacks/PostAmbushFinished.ts

@@ -12,19 +12,6 @@ const v = {
 };
 
 export class PostAmbushFinished extends CustomCallback<ModCallbackCustom.POST_AMBUSH_FINISHED> {
-  public override v = v;
-
-  constructor() {
-    super();
-
-    this.callbacksUsed = [
-      // 1
-      [ModCallback.POST_UPDATE, this.postUpdate],
-    ];
-  }
-
-  protected override shouldFire = shouldFireAmbush;
-
   private readonly postUpdate = (): void => {
     if (v.room.ambushDone) {
       return;
@@ -42,4 +29,17 @@ export class PostAmbushFinished extends CustomCallback<ModCallbackCustom.POST_AM
       this.fire(ambushType);
     }
   };
+
+  public override v = v;
+
+  protected override shouldFire = shouldFireAmbush;
+
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 1
+      [ModCallback.POST_UPDATE, this.postUpdate],
+    ];
+  }
 }

package/src/classes/callbacks/PostAmbushStarted.ts

@@ -12,19 +12,6 @@ const v = {
 };
 
 export class PostAmbushStarted extends CustomCallback<ModCallbackCustom.POST_AMBUSH_STARTED> {
-  public override v = v;
-
-  constructor() {
-    super();
-
-    this.callbacksUsed = [
-      // 1
-      [ModCallback.POST_UPDATE, this.postUpdate],
-    ];
-  }
-
-  protected override shouldFire = shouldFireAmbush;
-
   private readonly postUpdate = (): void => {
     if (v.room.ambushActive) {
       return;
@@ -42,4 +29,17 @@ export class PostAmbushStarted extends CustomCallback<ModCallbackCustom.POST_AMB
       this.fire(ambushType);
     }
   };
+
+  public override v = v;
+
+  protected override shouldFire = shouldFireAmbush;
+
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 1
+      [ModCallback.POST_UPDATE, this.postUpdate],
+    ];
+  }
 }

package/src/classes/callbacks/PostBombExploded.ts

@@ -5,6 +5,15 @@ import { shouldFireBomb } from "../../shouldFire";
 import { CustomCallback } from "../private/CustomCallback";
 
 export class PostBombExploded extends CustomCallback<ModCallbackCustom.POST_BOMB_EXPLODED> {
+  // ModCallback.POST_BOMB_UPDATE (58)
+  private readonly postBombUpdate = (bomb: EntityBomb): void => {
+    if (bomb.FrameCount === BOMB_EXPLODE_FRAME) {
+      this.fire(bomb);
+    }
+  };
+
+  protected override shouldFire = shouldFireBomb;
+
   constructor() {
     super();
 
@@ -13,13 +22,4 @@ export class PostBombExploded extends CustomCallback<ModCallbackCustom.POST_BOMB
       [ModCallback.POST_BOMB_UPDATE, this.postBombUpdate],
     ];
   }
-
-  protected override shouldFire = shouldFireBomb;
-
-  // ModCallback.POST_BOMB_UPDATE (58)
-  private readonly postBombUpdate = (bomb: EntityBomb): void => {
-    if (bomb.FrameCount === BOMB_EXPLODE_FRAME) {
-      this.fire(bomb);
-    }
-  };
 }