isaacscript-common 6.7.1 → 6.10.0

package/src/functions/color.ts

@@ -4,7 +4,7 @@ import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
 import { isTable } from "./types";
 
-type SerializedColor = LuaTable<string, unknown> & {
+type SerializedColor = LuaMap<string, unknown> & {
   readonly __serializedColorBrand: symbol;
 };
 
@@ -65,7 +65,7 @@ export function copyColor(
         );
       }
 
-      const colorTable = new LuaTable<string, unknown>();
+      const colorTable = new LuaMap<string, unknown>();
       copyValuesToTable(color, KEYS, colorTable);
       colorTable.set(SerializationBrand.COLOR, "");
       return colorTable as SerializedColor;
@@ -79,7 +79,7 @@ export function copyColor(
       }
 
       const [r, g, b, a, ro, go, bo] = getNumbersFromTable(
-        color as LuaTable<string, unknown>,
+        color as LuaMap<string, unknown>,
         OBJECT_NAME,
         ...KEYS,
       );

package/src/functions/deepCopy.ts

@@ -3,7 +3,7 @@ import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClas
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { SerializationType } from "../enums/SerializationType";
 import { SAVE_DATA_MANAGER_DEBUG } from "../features/saveDataManager/saveDataManagerConstants";
-import { isSerializationBrand } from "../features/saveDataManager/serializationBrand";
+import { isSerializationBrand } from "../features/saveDataManager/serializationBrands";
 import { TSTLClass } from "../types/private/TSTLClass";
 import { isArray } from "./array";
 import { getEnumValues } from "./enums";
@@ -36,7 +36,7 @@ const COPYABLE_ISAAC_API_CLASS_TYPES_SET = new Set<string>(
  * It supports the following object types:
  *
  * - Primitives (i.e. strings, numbers, and booleans)
- * - `LuaTable` / basic TSTL objects
+ * - Basic TSTL objects / tables
  * - TSTL `Map`
  * - TSTL `Set`
  * - TSTL classes
@@ -101,9 +101,9 @@ export function deepCopy(
     }
 
     case "table": {
-      const luaTable = value as LuaTable<AnyNotNil, unknown>;
+      const luaMap = value as LuaMap<AnyNotNil, unknown>;
       return deepCopyTable(
-        luaTable,
+        luaMap,
         serializationType,
         traversalDescription,
         insideMap,
@@ -117,40 +117,40 @@ export function deepCopy(
 }
 
 function deepCopyTable(
-  luaTable: LuaTable<AnyNotNil, unknown>,
+  luaMap: LuaMap<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
   insideMap: boolean,
 ) {
   // First, handle the cases of TSTL classes or serialized TSTL classes.
-  if (isDefaultMap(luaTable) || luaTable.has(SerializationBrand.DEFAULT_MAP)) {
+  if (isDefaultMap(luaMap) || luaMap.has(SerializationBrand.DEFAULT_MAP)) {
     return deepCopyDefaultMap(
-      luaTable,
+      luaMap,
       serializationType,
       traversalDescription,
       insideMap,
     );
   }
 
-  if (isTSTLMap(luaTable) || luaTable.has(SerializationBrand.MAP)) {
+  if (isTSTLMap(luaMap) || luaMap.has(SerializationBrand.MAP)) {
     return deepCopyMap(
-      luaTable,
+      luaMap,
       serializationType,
       traversalDescription,
       insideMap,
     );
   }
 
-  if (isTSTLSet(luaTable) || luaTable.has(SerializationBrand.SET)) {
+  if (isTSTLSet(luaMap) || luaMap.has(SerializationBrand.SET)) {
     return deepCopySet(
-      luaTable,
+      luaMap,
       serializationType,
       traversalDescription,
       insideMap,
     );
   }
 
-  const className = getTSTLClassName(luaTable);
+  const className = getTSTLClassName(luaMap);
 
   if (className === "WeakMap") {
     error(
@@ -164,9 +164,9 @@ function deepCopyTable(
     );
   }
 
-  if (isUserDefinedTSTLClass(luaTable)) {
+  if (isUserDefinedTSTLClass(luaMap)) {
     return deepCopyTSTLClass(
-      luaTable,
+      luaMap,
       serializationType,
       traversalDescription,
       insideMap,
@@ -174,20 +174,20 @@ function deepCopyTable(
   }
 
   // This is not a TSTL Map/Set/class. If it has a metatable, abort.
-  checkMetatable(luaTable, traversalDescription);
+  checkMetatable(luaMap, traversalDescription);
 
   // Handle the special case of serialized Isaac API classes.
   if (
-    isSerializedIsaacAPIClass(luaTable) &&
+    isSerializedIsaacAPIClass(luaMap) &&
     serializationType === SerializationType.DESERIALIZE
   ) {
-    return deserializeIsaacAPIClass(luaTable);
+    return deserializeIsaacAPIClass(luaMap);
   }
 
   // Handle the special case of an array.
-  if (isArray(luaTable)) {
+  if (isArray(luaMap)) {
     return deepCopyArray(
-      luaTable,
+      luaMap,
       serializationType,
       traversalDescription,
       insideMap,
@@ -196,7 +196,7 @@ function deepCopyTable(
 
   // Base case: copy a normal Lua table
   return deepCopyNormalLuaTable(
-    luaTable,
+    luaMap,
     serializationType,
     traversalDescription,
     insideMap,
@@ -204,7 +204,7 @@ function deepCopyTable(
 }
 
 function deepCopyDefaultMap(
-  defaultMap: DefaultMap<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>,
+  defaultMap: DefaultMap<AnyNotNil, unknown> | LuaMap<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
   insideMap: boolean,
@@ -287,7 +287,7 @@ function deepCopyDefaultMap(
  * whether we are serializing or not.
  */
 function getNewDefaultMap(
-  defaultMap: DefaultMap<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>,
+  defaultMap: DefaultMap<AnyNotNil, unknown> | LuaMap<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
   constructorArg: unknown,
@@ -301,7 +301,7 @@ function getNewDefaultMap(
     case SerializationType.SERIALIZE: {
       // Since we are serializing, the new object will be a Lua table. (At this point, we already
       // handled the special case of a DefaultMap instantiated with a factory function.)
-      const newDefaultMap = new LuaTable<AnyNotNil, unknown>();
+      const newDefaultMap = new LuaMap<AnyNotNil, unknown>();
       newDefaultMap.set(SerializationBrand.DEFAULT_MAP, "");
       newDefaultMap.set(SerializationBrand.DEFAULT_MAP_VALUE, constructorArg);
 
@@ -331,15 +331,15 @@ function getNewDefaultMap(
 }
 
 function deepCopyMap(
-  map: Map<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>,
+  map: Map<AnyNotNil, unknown> | LuaMap<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
   insideMap: boolean,
 ) {
-  let newMap: Map<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>;
+  let newMap: Map<AnyNotNil, unknown> | LuaMap<AnyNotNil, unknown>;
   if (serializationType === SerializationType.SERIALIZE) {
     // Since we are serializing, the new object will be a Lua table.
-    newMap = new LuaTable<AnyNotNil, unknown>();
+    newMap = new LuaMap<AnyNotNil, unknown>();
     newMap.set(SerializationBrand.MAP, "");
   } else {
     newMap = new Map();
@@ -379,16 +379,16 @@ function deepCopyMap(
 }
 
 function deepCopySet(
-  set: Set<AnyNotNil> | LuaTable<AnyNotNil, unknown>,
+  set: Set<AnyNotNil> | LuaMap<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
   insideMap: boolean,
 ) {
-  let newSet: Set<AnyNotNil> | LuaTable<AnyNotNil, string>;
+  let newSet: Set<AnyNotNil> | LuaMap<AnyNotNil, string>;
   if (serializationType === SerializationType.SERIALIZE) {
     // For serialization purposes, we represent a `Set` as a table with keys that match the
     // keys/values in the Set and values of an empty string.
-    newSet = new LuaTable<AnyNotNil, string>();
+    newSet = new LuaMap<AnyNotNil, string>();
     newSet.set(SerializationBrand.SET, "");
   } else {
     newSet = new Set();
@@ -433,10 +433,10 @@ function deepCopyTSTLClass(
   traversalDescription: string,
   insideMap: boolean,
 ) {
-  let newClass: TSTLClass | LuaTable<AnyNotNil, unknown>;
+  let newClass: TSTLClass | LuaMap<AnyNotNil, unknown>;
   if (serializationType === SerializationType.SERIALIZE) {
     // Since we are serializing, the new object will be a Lua table.
-    newClass = new LuaTable<AnyNotNil, unknown>();
+    newClass = new LuaMap<AnyNotNil, unknown>();
     // (We do not brand it with the class type because we will not have the associated class
     // constructor during deserialization, so knowing what type of class it is is pointless.)
   } else {
@@ -483,14 +483,14 @@ function deepCopyArray(
 }
 
 function deepCopyNormalLuaTable(
-  luaTable: LuaTable<AnyNotNil, unknown>,
+  luaMap: LuaMap<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
   insideMap: boolean,
 ) {
-  const newTable = new LuaTable<AnyNotNil, unknown>();
+  const newTable = new LuaMap<AnyNotNil, unknown>();
   const { entries, convertedNumberKeysToStrings } = getCopiedEntries(
-    luaTable,
+    luaMap,
     serializationType,
     traversalDescription,
     insideMap,
@@ -575,8 +575,11 @@ function getCopiedEntries(
  * copy function will refuse to copy a table type that has a metatable, outside of specifically
  * supported TSTL objects.
  */
-function checkMetatable(luaTable: LuaTable, traversalDescription: string) {
-  const metatable = getmetatable(luaTable);
+function checkMetatable(
+  luaMap: LuaMap<AnyNotNil, unknown>,
+  traversalDescription: string,
+) {
+  const metatable = getmetatable(luaMap);
   if (metatable === undefined) {
     return;
   }

package/src/functions/deepCopyTests.ts

@@ -40,7 +40,7 @@ function copiedObjectIsTable() {
     abc: "def",
   };
   const newObject = deepCopy(
-    oldObject as unknown as LuaTable,
+    oldObject as unknown as LuaMap,
     SerializationType.NONE,
     "copiedObjectIsTable",
   );
@@ -56,7 +56,7 @@ function copiedObjectHasKeyAndValueString() {
     abc: valueToLookFor,
   };
   const newTable = deepCopy(
-    oldObject as unknown as LuaTable,
+    oldObject as unknown as LuaMap,
     SerializationType.NONE,
     "copiedObjectHasKeyAndValueString",
   );
@@ -79,7 +79,7 @@ function copiedObjectHasKeyAndValueString() {
 function copiedTableHasKeyAndValueNumber() {
   const keyToLookFor = 123;
   const valueToLookFor = 456;
-  const oldTable = new LuaTable<AnyNotNil, unknown>();
+  const oldTable = new LuaMap<AnyNotNil, unknown>();
   oldTable.set(keyToLookFor, valueToLookFor);
 
   const newObject = deepCopy(
@@ -87,7 +87,7 @@ function copiedTableHasKeyAndValueNumber() {
     SerializationType.NONE,
     "copiedTableHasKeyAndValueNumber",
   );
-  const newTable = newObject as LuaTable<AnyNotNil, unknown>;
+  const newTable = newObject as LuaMap<AnyNotNil, unknown>;
 
   const value = newTable.get(keyToLookFor) as number | undefined;
   if (value === undefined) {
@@ -105,7 +105,7 @@ function copiedTableHasKeyAndValueNumber() {
 function copiedTableDoesNotCoerceTypes() {
   const keyToLookFor = 123;
   const valueToLookFor = 456;
-  const oldTable = new LuaTable<AnyNotNil, unknown>();
+  const oldTable = new LuaMap<AnyNotNil, unknown>();
   oldTable.set(keyToLookFor, valueToLookFor);
 
   const newObject = deepCopy(
@@ -113,7 +113,7 @@ function copiedTableDoesNotCoerceTypes() {
     SerializationType.NONE,
     "copiedTableDoesNotCoerceTypes",
   );
-  const newTable = newObject as LuaTable<AnyNotNil, unknown>;
+  const newTable = newObject as LuaMap<AnyNotNil, unknown>;
 
   const keyString = tostring(keyToLookFor);
   const valueString = tostring(valueToLookFor);
@@ -140,7 +140,7 @@ function copiedObjectHasNoReferencesForPrimitivesForward() {
     def: originalNumberValue,
   };
   const newTable = deepCopy(
-    oldObject as unknown as LuaTable,
+    oldObject as unknown as LuaMap,
     SerializationType.NONE,
     "copiedObjectHasNoReferencesForPrimitivesForward",
   );
@@ -165,7 +165,7 @@ function copiedObjectHasNoReferencesForPrimitivesBackward() {
     def: originalNumberValue,
   };
   const newTable = deepCopy(
-    oldObject as unknown as LuaTable,
+    oldObject as unknown as LuaMap,
     SerializationType.NONE,
     "copiedObjectHasNoReferencesForPrimitivesBackward",
   );
@@ -188,7 +188,7 @@ function copiedObjectHasNoReferencesForArray() {
     abc: [1, 2, 3],
   };
   const newTable = deepCopy(
-    oldObject as unknown as LuaTable,
+    oldObject as unknown as LuaMap,
     SerializationType.NONE,
     "copiedObjectHasNoReferencesForArray",
   );
@@ -229,7 +229,7 @@ function copiedObjectHasChildObject() {
     },
   };
   const newTable = deepCopy(
-    oldObject as unknown as LuaTable,
+    oldObject as unknown as LuaMap,
     SerializationType.NONE,
     "copiedObjectHasChildObject",
   );
@@ -432,7 +432,7 @@ function copiedDefaultMapHasBrand() {
     oldDefaultMap,
     SerializationType.SERIALIZE,
     "copiedDefaultMapHasBrand",
-  ) as LuaTable<AnyNotNil, unknown>;
+  ) as LuaMap<AnyNotNil, unknown>;
 
   if (!newTable.has(SerializationBrand.DEFAULT_MAP)) {
     error(

package/src/functions/entities.ts

@@ -137,11 +137,11 @@ export function getEntities(
  */
 export function getEntityFields(
   entity: Entity,
-): LuaTable<string, boolean | number | string> {
-  const entityFields = new LuaTable<string, boolean | number | string>();
+): LuaMap<string, boolean | number | string> {
+  const entityFields = new LuaMap<string, boolean | number | string>();
 
   const metatable = getmetatable(entity) as
-    | LuaTable<AnyNotNil, unknown>
+    | LuaMap<AnyNotNil, unknown>
     | undefined;
   if (metatable === undefined) {
     error("Failed to get the metatable for an entity.");
@@ -158,7 +158,7 @@ export function getEntityFields(
   }
 
   const parentTable = metatable.get("__parent") as
-    | LuaTable<AnyNotNil, unknown>
+    | LuaMap<AnyNotNil, unknown>
     | undefined;
   if (parentTable === undefined) {
     error('Failed to get the "__parent" table for an entity.');
@@ -171,11 +171,11 @@ export function getEntityFields(
 
 function setPrimitiveEntityFields(
   entity: Entity,
-  metatable: LuaTable<AnyNotNil, unknown>,
-  entityFields: LuaTable<string, boolean | number | string>,
+  metatable: LuaMap<AnyNotNil, unknown>,
+  entityFields: LuaMap<string, boolean | number | string>,
 ) {
   const propGetTable = metatable.get("__propget") as
-    | LuaTable<AnyNotNil, unknown>
+    | LuaMap<AnyNotNil, unknown>
     | undefined;
   if (propGetTable === undefined) {
     error('Failed to get the "__propget" table for an entity.');

package/src/functions/input.ts

@@ -4,10 +4,9 @@ import {
   ControllerIndex,
   Keyboard,
 } from "isaac-typescript-definitions";
-import { MAX_NUM_INPUTS } from "../constants";
+import { getEnumValues } from "./enums";
 import { copySet } from "./set";
 import { trimPrefix } from "./string";
-import { erange } from "./utils";
 
 const MODIFIER_KEYS: readonly Keyboard[] = [
   Keyboard.LEFT_SHIFT, // 340
@@ -62,9 +61,9 @@ export function getShootActions(): Set<ButtonAction> {
 
 /** Iterates over all inputs to determine if a particular button is pressed (i.e. held down). */
 export function isActionPressedOnAnyInput(buttonAction: ButtonAction): boolean {
-  const validInputs = erange(MAX_NUM_INPUTS);
-  return validInputs.some((input) =>
-    Input.IsActionPressed(buttonAction, input),
+  const controllerIndexes = getEnumValues(ControllerIndex);
+  return controllerIndexes.some((controllerIndex) =>
+    Input.IsActionPressed(buttonAction, controllerIndex),
   );
 }
 
@@ -75,9 +74,9 @@ export function isActionPressedOnAnyInput(buttonAction: ButtonAction): boolean {
 export function isActionTriggeredOnAnyInput(
   buttonAction: ButtonAction,
 ): boolean {
-  const validInputs = erange(MAX_NUM_INPUTS);
-  return validInputs.some((input) =>
-    Input.IsActionTriggered(buttonAction, input),
+  const controllerIndexes = getEnumValues(ControllerIndex);
+  return controllerIndexes.some((controllerIndex) =>
+    Input.IsActionTriggered(buttonAction, controllerIndex),
   );
 }
 

package/src/functions/isaacAPIClass.ts

@@ -16,7 +16,7 @@ export function getIsaacAPIClassName(object: unknown): string | undefined {
   }
 
   const metatable = getmetatable(object) as
-    | LuaTable<AnyNotNil, unknown>
+    | LuaMap<AnyNotNil, unknown>
     | undefined;
   if (metatable === undefined) {
     return undefined;
@@ -60,8 +60,8 @@ export function isaacAPIClassEquals(
   object2: unknown,
   keys: string[],
 ): boolean {
-  const table1 = object1 as LuaTable<AnyNotNil, unknown>;
-  const table2 = object2 as LuaTable<AnyNotNil, unknown>;
+  const table1 = object1 as LuaMap<AnyNotNil, unknown>;
+  const table2 = object2 as LuaMap<AnyNotNil, unknown>;
 
   return keys.every((key) => table1.get(key) === table2.get(key));
 }

package/src/functions/jsonHelpers.ts

@@ -2,7 +2,7 @@ import * as json from "json";
 import { logError } from "./log";
 
 function tryDecode(this: void, jsonString: string) {
-  return json.decode(jsonString) as LuaTable;
+  return json.decode(jsonString) as LuaMap;
 }
 
 function tryEncode(this: void, luaTable: unknown) {
@@ -17,12 +17,12 @@ function tryEncode(this: void, luaTable: unknown) {
  * continue in cases where users have no current save data or have manually removed their existing
  * save data.)
  */
-export function jsonDecode(jsonString: string): LuaTable<AnyNotNil, unknown> {
+export function jsonDecode(jsonString: string): LuaMap<AnyNotNil, unknown> {
   const [ok, luaTableOrErrMsg] = pcall(tryDecode, jsonString);
   if (!ok) {
     // Instead of throwing an error, continue execution of the callback.
     logError(`Failed to convert the JSON string to a Lua table: ${jsonString}`);
-    return new LuaTable();
+    return new LuaMap();
   }
 
   return luaTableOrErrMsg;

package/src/functions/kColor.ts

@@ -4,7 +4,7 @@ import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
 import { isTable } from "./types";
 
-type SerializedKColor = LuaTable<string, unknown> & {
+type SerializedKColor = LuaMap<string, unknown> & {
   readonly __serializedKColorBrand: symbol;
 };
 
@@ -53,7 +53,7 @@ export function copyKColor(
         );
       }
 
-      const kColorTable = new LuaTable<string, unknown>();
+      const kColorTable = new LuaMap<string, unknown>();
       copyValuesToTable(kColor, KEYS, kColorTable);
       kColorTable.set(SerializationBrand.K_COLOR, "");
       return kColorTable as SerializedKColor;
@@ -67,7 +67,7 @@ export function copyKColor(
       }
 
       const [r, g, b, a] = getNumbersFromTable(
-        kColor as LuaTable<string, unknown>,
+        kColor as LuaMap<string, unknown>,
         OBJECT_NAME,
         ...KEYS,
       );