isaacscript-common 9.19.3 → 10.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "9.19.3",
+  "version": "10.0.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^6.0.0"
+    "isaac-typescript-definitions": "^7.0.0"
   }
 }

package/src/functions/bitSet128.ts

@@ -1,6 +1,10 @@
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isIsaacAPIClassOfType } from "./isaacAPIClass";
-import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
+import {
+  copyUserdataValuesToTable,
+  getNumbersFromTable,
+  tableHasKeys,
+} from "./table";
 import { isTable } from "./types";
 
 export type SerializedBitSet128 = LuaMap<string, unknown> & {
@@ -86,7 +90,7 @@ export function serializeBitSet128(bitSet128: BitSet128): SerializedBitSet128 {
   }
 
   const bitSet128Table = new LuaMap<string, unknown>();
-  copyValuesToTable(bitSet128, KEYS, bitSet128Table);
+  copyUserdataValuesToTable(bitSet128, KEYS, bitSet128Table);
   bitSet128Table.set(SerializationBrand.BIT_SET_128, "");
   return bitSet128Table as SerializedBitSet128;
 }

package/src/functions/color.ts

@@ -2,7 +2,11 @@ import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getRandom } from "./random";
 import { getRandomSeed, isRNG, newRNG } from "./rng";
-import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
+import {
+  copyUserdataValuesToTable,
+  getNumbersFromTable,
+  tableHasKeys,
+} from "./table";
 import { isTable } from "./types";
 
 export type SerializedColor = LuaMap<string, unknown> & {
@@ -120,7 +124,7 @@ export function serializeColor(color: Color): SerializedColor {
   }
 
   const colorTable = new LuaMap<string, unknown>();
-  copyValuesToTable(color, KEYS, colorTable);
+  copyUserdataValuesToTable(color, KEYS, colorTable);
   colorTable.set(SerializationBrand.COLOR, "");
   return colorTable as SerializedColor;
 }

package/src/functions/kColor.ts

@@ -2,7 +2,11 @@ import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getRandom } from "./random";
 import { getRandomSeed, isRNG, newRNG } from "./rng";
-import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
+import {
+  copyUserdataValuesToTable,
+  getNumbersFromTable,
+  tableHasKeys,
+} from "./table";
 import { isTable } from "./types";
 
 export type SerializedKColor = LuaMap<string, unknown> & {
@@ -117,7 +121,7 @@ export function serializeKColor(kColor: KColor): SerializedKColor {
   }
 
   const kColorTable = new LuaMap<string, unknown>();
-  copyValuesToTable(kColor, KEYS, kColorTable);
+  copyUserdataValuesToTable(kColor, KEYS, kColorTable);
   kColorTable.set(SerializationBrand.K_COLOR, "");
   return kColorTable as SerializedKColor;
 }

package/src/functions/log.ts

@@ -402,7 +402,7 @@ export function logTable(luaTable: unknown, parentTables = 0): void {
  * Helper function to print out the differences between the entries of two tables. Note that this
  * will only do a shallow comparison.
  */
-export function logTableDifferences<K, V>(
+export function logTableDifferences<K extends AnyNotNil, V>(
   table1: LuaMap<K, V>,
   table2: LuaMap<K, V>,
 ): void {
@@ -420,13 +420,17 @@ export function logTableDifferences<K, V>(
 
   for (const key of keys) {
     if (!table1KeysSet.has(key)) {
+      // eslint-disable-next-line @typescript-eslint/no-base-to-string
       log(`  Table 1 is missing key: ${key}`);
     } else if (!table2KeysSet.has(key)) {
+      // eslint-disable-next-line @typescript-eslint/no-base-to-string
       log(`  Table 2 is missing key: ${key}`);
     } else {
-      const value1 = table1.get(key as unknown as K);
-      const value2 = table2.get(key as unknown as K);
+      const value1 = table1.get(key);
+
+      const value2 = table2.get(key);
       if (value1 !== value2) {
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
         log(`  ${key} --> "${value1}" versus "${value2}"`);
       }
     }
@@ -453,9 +457,7 @@ export function logUserdata(userdata: unknown): void {
     return;
   }
 
-  const metatable = getmetatable(userdata) as
-    | LuaMap<AnyNotNil, unknown>
-    | undefined;
+  const metatable = getmetatable(userdata);
   if (metatable === undefined) {
     log("Userdata: [no metatable]");
     return;

package/src/functions/positionVelocity.ts

@@ -47,10 +47,13 @@ export function anyPlayerCloserThan(
  * @param startingPosition The position to start searching from. If this position is not overlapping
  *                         with anything, then it will be returned.
  * @param avoidActiveEntities Optional. Default is false.
+ * @param minimumDistance Optional. If specified, will ensure that the randomly generated position
+ *                        is equal to or greater than the distance provided.
  */
 export function findFreePosition(
   startingPosition: Vector,
   avoidActiveEntities = false,
+  minimumDistance?: float,
 ): Vector {
   const room = game.GetRoom();
   const heavenDoors = getEffects(
@@ -79,6 +82,13 @@ export function findFreePosition(
       continue;
     }
 
+    if (minimumDistance !== undefined) {
+      const distance = startingPosition.Distance(position);
+      if (distance < minimumDistance) {
+        continue;
+      }
+    }
+
     return position;
   }
 

package/src/functions/table.ts

@@ -1,4 +1,4 @@
-import { isBoolean, isNumber, isString } from "./types";
+import { isBoolean, isNumber, isString, isUserdata } from "./types";
 
 /**
  * In a `Map`, you can use the `clear` method to delete every element. However, in a `LuaMap`, the
@@ -10,16 +10,25 @@ export function clearTable(luaMap: LuaMap<AnyNotNil, unknown>): void {
   }
 }
 
-/** Helper function to copy specific values from a object to a table. */
-export function copyValuesToTable(
+/** Helper function to copy specific values from a userdata object (e.g. `Vector`) to a table. */
+export function copyUserdataValuesToTable(
   object: unknown,
   keys: string[],
   luaMap: LuaMap<string, unknown>,
 ): void {
-  const otherTable = object as LuaMap<string, string | number>;
+  if (!isUserdata(object)) {
+    error(
+      `Failed to copy an object values to a table, since the object was of type: ${type(
+        object,
+      )}`,
+    );
+  }
+
+  // We can access values on userdata objects similar to a normal table.
+  const userdata = object as unknown as LuaMap<AnyNotNil, unknown>;
 
   for (const key of keys) {
-    const value = otherTable.get(key);
+    const value = userdata.get(key);
     luaMap.set(key, value);
   }
 }
@@ -142,7 +151,7 @@ export function getStringsFromTable(
  *                false in situations where iterating randomly would not matter and you need the
  *                extra performance.
  */
-export function iterateTableInOrder<K, V>(
+export function iterateTableInOrder<K extends AnyNotNil, V>(
   luaMap: LuaMap<K, V>,
   func: (key: K, value: V) => void,
   inOrder = true,

package/src/functions/vector.ts

@@ -4,7 +4,11 @@ import { angleToDirection } from "./direction";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getRandomFloat } from "./random";
 import { getRandomSeed, isRNG, newRNG } from "./rng";
-import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
+import {
+  copyUserdataValuesToTable,
+  getNumbersFromTable,
+  tableHasKeys,
+} from "./table";
 import { isTable } from "./types";
 
 export type SerializedVector = LuaMap<string, unknown> & {
@@ -104,7 +108,7 @@ export function serializeVector(vector: Vector): SerializedVector {
   }
 
   const vectorTable = new LuaMap<string, unknown>();
-  copyValuesToTable(vector, KEYS, vectorTable);
+  copyUserdataValuesToTable(vector, KEYS, vectorTable);
   vectorTable.set(SerializationBrand.VECTOR, "");
   return vectorTable as SerializedVector;
 }