isaacscript-common 18.3.0 → 18.3.2

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

@@ -1,6 +1,8 @@
-import { Direction } from "isaac-typescript-definitions";
+import { ButtonAction, Direction } from "isaac-typescript-definitions";
 import { DIRECTION_NAMES } from "../objects/directionNames";
 import { DIRECTION_TO_DEGREES } from "../objects/directionToDegrees";
+import { DIRECTION_TO_MOVE_ACTION } from "../objects/directionToMoveAction";
+import { DIRECTION_TO_SHOOT_ACTION } from "../objects/directionToShootAction";
 import { DIRECTION_TO_VECTOR } from "../objects/directionToVector";
 
 /**
@@ -40,6 +42,18 @@ export function directionToDegrees(direction: Direction): int {
   return DIRECTION_TO_DEGREES[direction];
 }
 
+export function directionToMoveAction(
+  direction: Direction,
+): ButtonAction | undefined {
+  return DIRECTION_TO_MOVE_ACTION[direction];
+}
+
+export function directionToShootAction(
+  direction: Direction,
+): ButtonAction | undefined {
+  return DIRECTION_TO_SHOOT_ACTION[direction];
+}
+
 export function directionToVector(direction: Direction): Readonly<Vector> {
   return DIRECTION_TO_VECTOR[direction];
 }

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/objects/directionToMoveAction.ts

@@ -0,0 +1,10 @@
+import { ButtonAction, Direction } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
+
+export const DIRECTION_TO_MOVE_ACTION = {
+  [Direction.NO_DIRECTION]: undefined, // -1
+  [Direction.LEFT]: ButtonAction.LEFT, // 0
+  [Direction.UP]: ButtonAction.UP, // 1
+  [Direction.RIGHT]: ButtonAction.RIGHT, // 2
+  [Direction.DOWN]: ButtonAction.DOWN, // 3
+} as const satisfies HasAllEnumKeys<Direction, ButtonAction | undefined>;

package/src/objects/directionToShootAction.ts

@@ -0,0 +1,10 @@
+import { ButtonAction, Direction } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
+
+export const DIRECTION_TO_SHOOT_ACTION = {
+  [Direction.NO_DIRECTION]: undefined, // -1
+  [Direction.LEFT]: ButtonAction.SHOOT_LEFT, // 0
+  [Direction.UP]: ButtonAction.SHOOT_UP, // 1
+  [Direction.RIGHT]: ButtonAction.SHOOT_RIGHT, // 2
+  [Direction.DOWN]: ButtonAction.SHOOT_DOWN, // 3
+} as const satisfies HasAllEnumKeys<Direction, ButtonAction | undefined>;

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[];