isaacscript-common 18.2.1 → 18.3.1

package/src/classes/features/other/debugDisplay/DebugDisplayKnife.ts

@@ -11,7 +11,7 @@ export class DebugDisplayKnife extends Feature {
 
     this.callbacksUsed = [
       // 52
-      [ModCallback.POST_KNIFE_RENDER, [this.postKnifeRender]],
+      [ModCallback.POST_KNIFE_RENDER, this.postKnifeRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayLaser.ts

@@ -11,7 +11,7 @@ export class DebugDisplayLaser extends Feature {
 
     this.callbacksUsed = [
       // 49
-      [ModCallback.POST_LASER_RENDER, [this.postLaserRender]],
+      [ModCallback.POST_LASER_RENDER, this.postLaserRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayNPC.ts

@@ -11,7 +11,7 @@ export class DebugDisplayNPC extends Feature {
 
     this.callbacksUsed = [
       // 28
-      [ModCallback.POST_NPC_RENDER, [this.postNPCRender]],
+      [ModCallback.POST_NPC_RENDER, this.postNPCRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayPickup.ts

@@ -11,7 +11,7 @@ export class DebugDisplayPickup extends Feature {
 
     this.callbacksUsed = [
       // 36
-      [ModCallback.POST_PICKUP_RENDER, [this.postPickupRender]],
+      [ModCallback.POST_PICKUP_RENDER, this.postPickupRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayPit.ts

@@ -10,7 +10,7 @@ export class DebugDisplayPit extends Feature {
     super();
 
     this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_PIT_RENDER, [this.postPitRender]],
+      [ModCallbackCustom.POST_PIT_RENDER, this.postPitRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayPlayer.ts

@@ -11,7 +11,7 @@ export class DebugDisplayPlayer extends Feature {
 
     this.callbacksUsed = [
       // 32
-      [ModCallback.POST_PLAYER_RENDER, [this.postPlayerRender]],
+      [ModCallback.POST_PLAYER_RENDER, this.postPlayerRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayPoop.ts

@@ -10,7 +10,7 @@ export class DebugDisplayPoop extends Feature {
     super();
 
     this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_POOP_RENDER, [this.postPoopRender]],
+      [ModCallbackCustom.POST_POOP_RENDER, this.postPoopRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayPressurePlate.ts

@@ -12,7 +12,7 @@ export class DebugDisplayPressurePlate extends Feature {
     this.customCallbacksUsed = [
       [
         ModCallbackCustom.POST_PRESSURE_PLATE_RENDER,
-        [this.postPressurePlateRender],
+        this.postPressurePlateRender,
       ],
     ];
   }

package/src/classes/features/other/debugDisplay/DebugDisplayProjectile.ts

@@ -11,7 +11,7 @@ export class DebugDisplayProjectile extends Feature {
 
     this.callbacksUsed = [
       // 45
-      [ModCallback.POST_PROJECTILE_RENDER, [this.postProjectileRender]],
+      [ModCallback.POST_PROJECTILE_RENDER, this.postProjectileRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayRock.ts

@@ -10,7 +10,7 @@ export class DebugDisplayRock extends Feature {
     super();
 
     this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_ROCK_RENDER, [this.postRockRender]],
+      [ModCallbackCustom.POST_ROCK_RENDER, this.postRockRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplaySlot.ts

@@ -10,7 +10,7 @@ export class DebugDisplaySlot extends Feature {
     super();
 
     this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_SLOT_RENDER, [this.postSlotRender]],
+      [ModCallbackCustom.POST_SLOT_RENDER, this.postSlotRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplaySpikes.ts

@@ -10,7 +10,7 @@ export class DebugDisplaySpikes extends Feature {
     super();
 
     this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_SPIKES_RENDER, [this.postSpikesRender]],
+      [ModCallbackCustom.POST_SPIKES_RENDER, this.postSpikesRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayTNT.ts

@@ -10,7 +10,7 @@ export class DebugDisplayTNT extends Feature {
     super();
 
     this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_TNT_RENDER, [this.postTNTRender]],
+      [ModCallbackCustom.POST_TNT_RENDER, this.postTNTRender],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayTear.ts

@@ -11,7 +11,7 @@ export class DebugDisplayTear extends Feature {
 
     this.callbacksUsed = [
       // 41
-      [ModCallback.POST_TEAR_RENDER, [this.postTearRender]],
+      [ModCallback.POST_TEAR_RENDER, this.postTearRender],
     ];
   }
 

package/src/classes/private/CustomCallback.ts

@@ -1,6 +1,7 @@
 import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { AddCallbackParametersCustom } from "../../interfaces/private/AddCallbackParametersCustom";
-import { AllButFirst } from "../../types/private/AllButFirst";
+import { AllButFirst } from "../../types/AllButFirst";
+import { AnyFunction } from "../../types/AnyFunction";
 import { Feature } from "./Feature";
 
 export type FireArgs<T extends ModCallbackCustom> = Parameters<
@@ -10,6 +11,11 @@ export type OptionalArgs<T extends ModCallbackCustom> = AllButFirst<
   AddCallbackParametersCustom[T]
 >;
 
+type Subscription<T extends ModCallbackCustom> = [
+  callbackFunc: AddCallbackParametersCustom[T][0],
+  optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>,
+];
+
 /**
  * The base class for a custom callback. Individual custom callbacks (and validation callbacks) will
  * extend from this class.
@@ -17,10 +23,14 @@ export type OptionalArgs<T extends ModCallbackCustom> = AllButFirst<
 export abstract class CustomCallback<
   T extends ModCallbackCustom,
 > extends Feature {
-  private subscriptions: Array<AddCallbackParametersCustom[T]> = [];
+  private subscriptions: Array<Subscription<T>> = [];
 
-  public addSubscriber(...args: AddCallbackParametersCustom[T]): void {
-    this.subscriptions.push(args);
+  public addSubscriber(
+    callbackFunc: AddCallbackParametersCustom[T][0],
+    ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>
+  ): void {
+    const subscription: Subscription<T> = [callbackFunc, optionalArgs];
+    this.subscriptions.push(subscription);
   }
 
   /**
@@ -42,20 +52,14 @@ export abstract class CustomCallback<
   public fire = (
     ...fireArgs: FireArgs<T>
   ): ReturnType<AddCallbackParametersCustom[T][0]> => {
-    for (const [callback, ...optionalArgsArray] of this.subscriptions) {
-      // The TypeScript compiler is bugged with the spread operator here, as it converts the
-      // optional arguments to an array instead of a tuple.
-      const optionalArgs = optionalArgsArray as OptionalArgs<T>;
+    for (const subscription of this.subscriptions) {
+      const [callbackFunc, optionalArgs] = subscription;
 
       if (this.shouldFire(fireArgs, optionalArgs)) {
-        // The TypeScript compiler is not smart enough to know that the fire args match the callback
-        // signature.
-        const callbackCasted = callback as (
-          ...args: FireArgs<T>
-        ) => ReturnType<AddCallbackParametersCustom[T][0]>;
-        const value = callbackCasted(...fireArgs);
+        // TypeScript is not smart enough to know that the arguments match the function.
+        const value = (callbackFunc as AnyFunction)(...fireArgs);
         if (value !== undefined) {
-          return value;
+          return value as ReturnType<AddCallbackParametersCustom[T][0]>;
         }
       }
     }

package/src/enums/ModCallbackCustom.ts

@@ -65,6 +65,50 @@ export enum ModCallbackCustom {
    */
   ENTITY_TAKE_DMG_PLAYER,
 
+  /**
+   * The exact same thing as the vanilla `INPUT_ACTION` callback, except this callback allows you to
+   * specify extra arguments for additional filtration.
+   *
+   * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+   * - You can provide an optional third argument that will make the callback only fire if it
+   *   matches the `InputHook` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the `ButtonAction` provided.
+   *
+   * ```ts
+   * function inputActionFilter(
+   *   entity: Entity | undefined,
+   *   inputHook: InputHook,
+   *   buttonAction: ButtonAction,
+   * ): boolean | undefined {}
+   * ```
+   */
+  INPUT_ACTION_FILTER,
+
+  /**
+   * The exact same thing as the vanilla `INPUT_ACTION` callback, except this callback automatically
+   * filters for `EntityType.ENTITY_PLAYER` and casts the `Entity` object to a `EntityPlayer`. It
+   * also allows you to specify extra arguments for additional filtration.
+   *
+   * - You can provide an optional third argument that will make the callback only fire if it
+   *   matches the `PlayerVariant` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the `PlayerType` provided.
+   * - You can provide an optional fifth argument that will make the callback only fire if it
+   *   matches the `InputHook` provided.
+   * - You can provide an optional sixth argument that will make the callback only fire if it
+   *   matches the `ButtonAction` provided.
+   *
+   * ```ts
+   * function inputActionPlayer(
+   *   player: EntityPlayer,
+   *   inputHook: InputHook,
+   *   buttonAction: ButtonAction,
+   * ): boolean | undefined {}
+   * ```
+   */
+  INPUT_ACTION_PLAYER,
+
   /**
    * Fires from the `POST_UPDATE` callback when a Challenge Room or Boss Rush is started.
    * Specifically, this happens on the first frame that `Room.IsAmbushDone` is true.

package/src/functions/array.ts

@@ -405,8 +405,15 @@ export function getRandomArrayIndex<T>(
  *
  * - the table contains all numerical indexes that are contiguous, starting at 1
  * - the table has no keys (i.e. an "empty" table)
+ *
+ * @param object The object to analyze.
+ * @param ensureContiguousValues Optional. Whether or not the Lua table has to have all contiguous
+ *                               keys in order to be considered an array. Default is true.
  */
-export function isArray(object: unknown): object is unknown[] {
+export function isArray(
+  object: unknown,
+  ensureContiguousValues = true,
+): object is unknown[] {
   if (!isTable(object)) {
     return false;
   }
@@ -431,10 +438,12 @@ export function isArray(object: unknown): object is unknown[] {
   }
 
   // Fourth, check for non-contiguous elements. (Lua tables start at an index of 1.)
-  for (let i = 1; i <= keys.length; i++) {
-    const element = object.get(i);
-    if (element === undefined) {
-      return false;
+  if (ensureContiguousValues) {
+    for (let i = 1; i <= keys.length; i++) {
+      const element = object.get(i);
+      if (element === undefined) {
+        return false;
+      }
     }
   }
 

package/src/functions/decorators.ts

@@ -22,9 +22,9 @@
 
 import { ModCallback } from "isaac-typescript-definitions";
 import {
-  ADD_CALLBACK_ARGS_KEY,
-  ADD_CALLBACK_CUSTOM_ARGS_KEY,
   ModFeature,
+  MOD_FEATURE_CALLBACKS_KEY,
+  MOD_FEATURE_CUSTOM_CALLBACKS_KEY,
 } from "../classes/ModFeature";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { AddCallbackParametersCustom } from "../interfaces/private/AddCallbackParametersCustom";
@@ -50,11 +50,7 @@ export function Callback<T extends ModCallback>(
     // First, prepare the arguments for the `Mod.AddCallback` method.
     const methodName = propertyKey as keyof Class;
     const method = target[methodName] as AddCallbackParameters[T][0];
-    const addCallbackArgs = [
-      modCallback,
-      method,
-      ...optionalArgs,
-    ] as unknown as AddCallbackParameters[T];
+    const callbackTuple = [modCallback, method, optionalArgs];
 
     // Since the decorator runs prior to instantiation, we only have access to get and set static
     // properties, which are located on the "constructor" table. Thus, we store the callback
@@ -70,12 +66,14 @@ export function Callback<T extends ModCallback>(
       );
     }
 
-    if (!constructor.has(ADD_CALLBACK_ARGS_KEY)) {
-      constructor.set(ADD_CALLBACK_ARGS_KEY, []);
+    if (!constructor.has(MOD_FEATURE_CALLBACKS_KEY)) {
+      constructor.set(MOD_FEATURE_CALLBACKS_KEY, []);
     }
 
-    const callbackTuples = constructor.get(ADD_CALLBACK_ARGS_KEY) as unknown[];
-    callbackTuples.push(addCallbackArgs);
+    const callbackTuples = constructor.get(
+      MOD_FEATURE_CALLBACKS_KEY,
+    ) as unknown[];
+    callbackTuples.push(callbackTuple);
   };
 }
 
@@ -101,11 +99,7 @@ export function CallbackCustom<T extends ModCallbackCustom>(
     // First, prepare the arguments for the `Mod.AddCallbackCustom` method.
     const methodName = propertyKey as keyof Class;
     const method = target[methodName] as AddCallbackParametersCustom[T][0];
-    const addCallbackArgs = [
-      modCallbackCustom,
-      method,
-      ...optionalArgs,
-    ] as unknown as AddCallbackParametersCustom[T];
+    const callbackTuple: unknown[] = [modCallbackCustom, method, optionalArgs];
 
     // Since the decorator runs prior to instantiation, we only have access to get and set static
     // properties, which are located on the "constructor" table. Thus, we store the callback
@@ -121,13 +115,13 @@ export function CallbackCustom<T extends ModCallbackCustom>(
       );
     }
 
-    if (!constructor.has(ADD_CALLBACK_CUSTOM_ARGS_KEY)) {
-      constructor.set(ADD_CALLBACK_CUSTOM_ARGS_KEY, []);
+    if (!constructor.has(MOD_FEATURE_CUSTOM_CALLBACKS_KEY)) {
+      constructor.set(MOD_FEATURE_CUSTOM_CALLBACKS_KEY, []);
     }
 
     const callbackTuples = constructor.get(
-      ADD_CALLBACK_CUSTOM_ARGS_KEY,
+      MOD_FEATURE_CUSTOM_CALLBACKS_KEY,
     ) as unknown[];
-    callbackTuples.push(addCallbackArgs);
+    callbackTuples.push(callbackTuple);
   };
 }

package/src/functions/logMisc.ts

@@ -31,8 +31,11 @@ import { isTable, isUserdata } from "./types";
 import { printConsole } from "./utils";
 import { vectorToString } from "./vector";
 
+/** Helper function to enumerate all of the values in an array. */
 export function logArray<T>(array: T[] | readonly T[]): void {
-  if (!isArray(array)) {
+  // We do not assume the given array has contiguous values in order to be more permissive about the
+  // kinds of arrays that will successfully log without a run-time error.
+  if (!isArray(array, false)) {
     log("Tried to log an array, but the given object was not an array.");
     return;
   }

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -1,6 +1,7 @@
 import {
   ActiveSlot,
   BombVariant,
+  ButtonAction,
   CollectibleType,
   DamageFlag,
   DiceFloorSubType,
@@ -9,6 +10,7 @@ import {
   EntityType,
   FamiliarVariant,
   GridEntityType,
+  InputHook,
   ItemType,
   KnifeVariant,
   LaserVariant,
@@ -63,6 +65,28 @@ export interface AddCallbackParametersCustom {
     character?: PlayerType,
   ];
 
+  [ModCallbackCustom.INPUT_ACTION_FILTER]: [
+    callback: (
+      entity: Entity | undefined,
+      inputHook: InputHook,
+      buttonAction: ButtonAction,
+    ) => boolean | float | undefined,
+    inputHook?: InputHook,
+    buttonAction?: ButtonAction,
+  ];
+
+  [ModCallbackCustom.INPUT_ACTION_PLAYER]: [
+    callback: (
+      player: EntityPlayer,
+      inputHook: InputHook,
+      buttonAction: ButtonAction,
+    ) => boolean | float | undefined,
+    playerVariant?: PlayerVariant,
+    character?: PlayerType,
+    inputHook?: InputHook,
+    buttonAction?: ButtonAction,
+  ];
+
   [ModCallbackCustom.POST_AMBUSH_FINISHED]: [
     callback: (ambushType: AmbushType) => void,
     ambushType?: AmbushType,

package/src/types/ModUpgraded.ts

@@ -33,5 +33,5 @@ type ISCFeaturesToKeys<T extends readonly ISCFeature[]> = Omit<
  * same private fields will cause a `never` type.
  */
 type ISCFeatureTupleToClassTuple<T extends ISCFeature[]> = {
-  [K in keyof T]: PublicInterface<ISCFeatureToClass[T[K]]>;
+  [Key in keyof T]: PublicInterface<ISCFeatureToClass[T[Key]]>;
 };

package/src/types/private/CallbackTuple.ts

@@ -1,21 +1,30 @@
 import { ModCallback } from "isaac-typescript-definitions";
 import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { AddCallbackParametersCustom } from "../../interfaces/private/AddCallbackParametersCustom";
+import { AllButFirst } from "../AllButFirst";
 
 /**
- * A mapping of the callback enum to the associated callback functions (and optional arguments).
- * This is so that the respective callback functions can be added/removed on demand as subscribers
- * get added/removed.
+ * A mapping of the callback enum to the associated callback function and optional arguments. This
+ * is so that the respective callback functions can be added/removed on demand as subscribers get
+ * added/removed.
  */
 export type CallbackTuple = {
-  [K in ModCallback]: [K, AddCallbackParameters[K]];
+  [Key in ModCallback]: [
+    modCallback: Key,
+    callbackFunc: AddCallbackParameters[Key][0],
+    optionalArgs?: AllButFirst<AddCallbackParameters[Key]>,
+  ];
 }[ModCallback];
 
 /**
- * A mapping of the custom callback enum to the associated callback functions (and optional
- * arguments). This is so that the respective callback functions can be added/removed on demand as
- * subscribers get added/removed.
+ * A mapping of the custom callback enum to the associated callback function and optional arguments.
+ * This is so that the respective callback functions can be added/removed on demand as subscribers
+ * get added/removed.
  */
 export type CustomCallbackTuple = {
-  [K in ModCallbackCustom]: [K, AddCallbackParametersCustom[K]];
+  [Key in ModCallbackCustom]: [
+    modCallback: Key,
+    callbackFunc: AddCallbackParametersCustom[Key][0],
+    optionalArgs?: AllButFirst<AddCallbackParametersCustom[Key]>,
+  ];
 }[ModCallbackCustom];

package/dist/src/types/private/AllButFirst.d.ts

@@ -1,5 +0,0 @@
-export type AllButFirst<T extends unknown[]> = T extends [
-    unknown,
-    ...infer Tail
-] ? Tail : unknown[];
-//# sourceMappingURL=AllButFirst.d.ts.map

package/dist/src/types/private/AllButFirst.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AllButFirst.d.ts","sourceRoot":"","sources":["../../../../src/types/private/AllButFirst.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,SAAS;IACvD,OAAO;IACP,GAAG,MAAM,IAAI;CACd,GACG,IAAI,GACJ,OAAO,EAAE,CAAC"}

package/dist/src/types/private/AllButFirst.lua

@@ -1,2 +0,0 @@
-local ____exports = {}
-return ____exports

package/src/types/private/AllButFirst.ts

@@ -1,6 +0,0 @@
-export type AllButFirst<T extends unknown[]> = T extends [
-  unknown,
-  ...infer Tail,
-]
-  ? Tail
-  : unknown[];