isaacscript-common 9.20.0 → 10.0.2

package/dist/src/interfaces/private/TSTLClassMetatable.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="lua-types/5.3" />
 /// <reference types="lua-types/5.3" />
 /// <reference types="lua-types/5.3" />
-/// <reference types="typescript-to-lua/language-extensions" />
+/// <reference types="@typescript-to-lua/language-extensions" />
 export interface TSTLClassMetatable {
     ____constructor: () => void;
     __index: unknown;

package/dist/src/objects/isaacAPIClassTypeToBrand.d.ts

@@ -1,4 +1,4 @@
-import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClassType";
+import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 export declare const ISAAC_API_CLASS_TYPE_TO_BRAND: {
     readonly [key in CopyableIsaacAPIClassType]: SerializationBrand;

package/dist/src/objects/isaacAPIClassTypeToBrand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isaacAPIClassTypeToBrand.d.ts","sourceRoot":"","sources":["../../../src/objects/isaacAPIClassTypeToBrand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,eAAO,MAAM,6BAA6B,EAAE;IAC1C,QAAQ,EAAE,GAAG,IAAI,yBAAyB,GAAG,kBAAkB;CAOvD,CAAC"}
+{"version":3,"file":"isaacAPIClassTypeToBrand.d.ts","sourceRoot":"","sources":["../../../src/objects/isaacAPIClassTypeToBrand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,eAAO,MAAM,6BAA6B,EAAE;IAC1C,QAAQ,EAAE,GAAG,IAAI,yBAAyB,GAAG,kBAAkB;CAOvD,CAAC"}

package/dist/src/objects/isaacAPIClassTypeToBrand.lua

@@ -1,6 +1,6 @@
 local ____exports = {}
-local ____CopyableIsaacAPIClassType = require("src.enums.private.CopyableIsaacAPIClassType")
-local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CopyableIsaacAPIClassType = ____isaac_2Dtypescript_2Ddefinitions.CopyableIsaacAPIClassType
 local ____SerializationBrand = require("src.enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 ____exports.ISAAC_API_CLASS_TYPE_TO_BRAND = {

package/dist/src/objects/isaacAPIClassTypeToFunctions.d.ts

@@ -1,12 +1,40 @@
-import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClassType";
-interface IsaacAPIClassTypeFunctions {
-    isSerialized: (object: unknown) => object is unknown;
-    copy: (object: any) => any;
-    serialize: (object: any) => any;
-    deserialize: (object: any) => any;
+import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
+import { SerializedBitSet128 } from "../functions/bitSet128";
+import { SerializedColor } from "../functions/color";
+import { SerializedKColor } from "../functions/kColor";
+import { SerializedRNG } from "../functions/rng";
+import { SerializedVector } from "../functions/vector";
+/** A type representing an Isaac API class that can be safely copied or serialized. */
+export declare type CopyableIsaacAPIClass = BitSet128 | Color | KColor | RNG | Vector;
+/**
+ * A type representing an Isaac API class like `Color` or `RNG` that has been written to the
+ * "save#.dat" file. It is used by the save data manager when reading and writing to that file.
+ *
+ * For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+ */
+export declare type SerializedIsaacAPIClass = SerializedBitSet128 | SerializedColor | SerializedKColor | SerializedRNG | SerializedVector;
+export interface IsaacAPIClassTypeToType {
+    [CopyableIsaacAPIClassType.BIT_SET_128]: BitSet128;
+    [CopyableIsaacAPIClassType.COLOR]: Color;
+    [CopyableIsaacAPIClassType.K_COLOR]: KColor;
+    [CopyableIsaacAPIClassType.RNG]: RNG;
+    [CopyableIsaacAPIClassType.VECTOR]: Vector;
+}
+export interface IsaacAPIClassTypeToSerializedType {
+    [CopyableIsaacAPIClassType.BIT_SET_128]: SerializedBitSet128;
+    [CopyableIsaacAPIClassType.COLOR]: SerializedColor;
+    [CopyableIsaacAPIClassType.K_COLOR]: SerializedKColor;
+    [CopyableIsaacAPIClassType.RNG]: SerializedRNG;
+    [CopyableIsaacAPIClassType.VECTOR]: SerializedVector;
+}
+export interface IsaacAPIClassTypeFunctions<T, SerializedT> {
+    is: (object: unknown) => object is T;
+    isSerialized: (object: unknown) => object is SerializedT;
+    copy: (object: T) => T;
+    serialize: (object: T) => SerializedT;
+    deserialize: (object: SerializedT) => T;
 }
 export declare const ISAAC_API_CLASS_TYPE_TO_FUNCTIONS: {
-    readonly [key in CopyableIsaacAPIClassType]: IsaacAPIClassTypeFunctions;
+    readonly [key in CopyableIsaacAPIClassType]: IsaacAPIClassTypeFunctions<IsaacAPIClassTypeToType[key], IsaacAPIClassTypeToSerializedType[key]>;
 };
-export {};
 //# sourceMappingURL=isaacAPIClassTypeToFunctions.d.ts.map

package/dist/src/objects/isaacAPIClassTypeToFunctions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isaacAPIClassTypeToFunctions.d.ts","sourceRoot":"","sources":["../../../src/objects/isaacAPIClassTypeToFunctions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AAgCvF,UAAU,0BAA0B;IAClC,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,MAAM,IAAI,OAAO,CAAC;IACrD,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC;IAC3B,SAAS,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC;IAChC,WAAW,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC;CACnC;AAED,eAAO,MAAM,iCAAiC,EAAE;IAC9C,QAAQ,EAAE,GAAG,IAAI,yBAAyB,GAAG,0BAA0B;CAgC/D,CAAC"}
+{"version":3,"file":"isaacAPIClassTypeToFunctions.d.ts","sourceRoot":"","sources":["../../../src/objects/isaacAPIClassTypeToFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAML,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAML,eAAe,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAKL,gBAAgB,EAEjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAKL,aAAa,EAEd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAKL,gBAAgB,EAEjB,MAAM,qBAAqB,CAAC;AAE7B,sFAAsF;AACtF,oBAAY,qBAAqB,GAAG,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC;AAE9E;;;;;GAKG;AACH,oBAAY,uBAAuB,GAC/B,mBAAmB,GACnB,eAAe,GACf,gBAAgB,GAChB,aAAa,GACb,gBAAgB,CAAC;AAErB,MAAM,WAAW,uBAAuB;IACtC,CAAC,yBAAyB,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC;IACnD,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACzC,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC5C,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;IACrC,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC5C;AAED,MAAM,WAAW,iCAAiC;IAChD,CAAC,yBAAyB,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAC7D,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC;IACnD,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IACtD,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC;IAC/C,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,gBAAgB,CAAC;CACtD;AAED,MAAM,WAAW,0BAA0B,CAAC,CAAC,EAAE,WAAW;IACxD,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC,CAAC;IACrC,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,MAAM,IAAI,WAAW,CAAC;IACzD,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;IACvB,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,WAAW,CAAC;IACtC,WAAW,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;CACzC;AAED,eAAO,MAAM,iCAAiC,EAAE;IAC9C,QAAQ,EAAE,GAAG,IAAI,yBAAyB,GAAG,0BAA0B,CACrE,uBAAuB,CAAC,GAAG,CAAC,EAC5B,iCAAiC,CAAC,GAAG,CAAC,CACvC;CAqCO,CAAC"}

package/dist/src/objects/isaacAPIClassTypeToFunctions.lua

@@ -1,36 +1,71 @@
 local ____exports = {}
-local ____CopyableIsaacAPIClassType = require("src.enums.private.CopyableIsaacAPIClassType")
-local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CopyableIsaacAPIClassType = ____isaac_2Dtypescript_2Ddefinitions.CopyableIsaacAPIClassType
 local ____bitSet128 = require("src.functions.bitSet128")
 local copyBitSet128 = ____bitSet128.copyBitSet128
 local deserializeBitSet128 = ____bitSet128.deserializeBitSet128
+local isBitSet128 = ____bitSet128.isBitSet128
 local isSerializedBitSet128 = ____bitSet128.isSerializedBitSet128
 local serializeBitSet128 = ____bitSet128.serializeBitSet128
 local ____color = require("src.functions.color")
 local copyColor = ____color.copyColor
 local deserializeColor = ____color.deserializeColor
+local isColor = ____color.isColor
 local isSerializedColor = ____color.isSerializedColor
 local serializeColor = ____color.serializeColor
 local ____kColor = require("src.functions.kColor")
 local copyKColor = ____kColor.copyKColor
 local deserializeKColor = ____kColor.deserializeKColor
+local isKColor = ____kColor.isKColor
 local isSerializedKColor = ____kColor.isSerializedKColor
 local serializeKColor = ____kColor.serializeKColor
 local ____rng = require("src.functions.rng")
 local copyRNG = ____rng.copyRNG
 local deserializeRNG = ____rng.deserializeRNG
+local isRNG = ____rng.isRNG
 local isSerializedRNG = ____rng.isSerializedRNG
 local serializeRNG = ____rng.serializeRNG
 local ____vector = require("src.functions.vector")
 local copyVector = ____vector.copyVector
 local deserializeVector = ____vector.deserializeVector
 local isSerializedVector = ____vector.isSerializedVector
+local isVector = ____vector.isVector
 local serializeVector = ____vector.serializeVector
 ____exports.ISAAC_API_CLASS_TYPE_TO_FUNCTIONS = {
-    [CopyableIsaacAPIClassType.BIT_SET_128] = {isSerialized = isSerializedBitSet128, copy = copyBitSet128, serialize = serializeBitSet128, deserialize = deserializeBitSet128},
-    [CopyableIsaacAPIClassType.COLOR] = {isSerialized = isSerializedColor, copy = copyColor, serialize = serializeColor, deserialize = deserializeColor},
-    [CopyableIsaacAPIClassType.K_COLOR] = {isSerialized = isSerializedKColor, copy = copyKColor, serialize = serializeKColor, deserialize = deserializeKColor},
-    [CopyableIsaacAPIClassType.RNG] = {isSerialized = isSerializedRNG, copy = copyRNG, serialize = serializeRNG, deserialize = deserializeRNG},
-    [CopyableIsaacAPIClassType.VECTOR] = {isSerialized = isSerializedVector, copy = copyVector, serialize = serializeVector, deserialize = deserializeVector}
+    [CopyableIsaacAPIClassType.BIT_SET_128] = {
+        is = isBitSet128,
+        isSerialized = isSerializedBitSet128,
+        copy = copyBitSet128,
+        serialize = serializeBitSet128,
+        deserialize = deserializeBitSet128
+    },
+    [CopyableIsaacAPIClassType.COLOR] = {
+        is = isColor,
+        isSerialized = isSerializedColor,
+        copy = copyColor,
+        serialize = serializeColor,
+        deserialize = deserializeColor
+    },
+    [CopyableIsaacAPIClassType.K_COLOR] = {
+        is = isKColor,
+        isSerialized = isSerializedKColor,
+        copy = copyKColor,
+        serialize = serializeKColor,
+        deserialize = deserializeKColor
+    },
+    [CopyableIsaacAPIClassType.RNG] = {
+        is = isRNG,
+        isSerialized = isSerializedRNG,
+        copy = copyRNG,
+        serialize = serializeRNG,
+        deserialize = deserializeRNG
+    },
+    [CopyableIsaacAPIClassType.VECTOR] = {
+        is = isVector,
+        isSerialized = isSerializedVector,
+        copy = copyVector,
+        serialize = serializeVector,
+        deserialize = deserializeVector
+    }
 }
 return ____exports

package/dist/src/types/TSTLClass.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="typescript-to-lua/language-extensions" />
+/// <reference types="@typescript-to-lua/language-extensions" />
 /**
  * This is a type representing a user-created class from TypeScript code.
  *

package/dist/src/types/WeightedArray.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="isaac-typescript-definitions" />
+/** An array where each element is paired with a number indicating that elements 'weight'. */
+export declare type WeightedArray<T> = Array<[T, float]>;
+//# sourceMappingURL=WeightedArray.d.ts.map

package/dist/src/types/WeightedArray.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WeightedArray.d.ts","sourceRoot":"","sources":["../../../src/types/WeightedArray.ts"],"names":[],"mappings":";AAAA,6FAA6F;AAC7F,oBAAY,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "9.20.0",
+  "version": "10.0.2",
   "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.2.0"
   }
 }

package/src/features/deployJSONRoom.ts

@@ -225,16 +225,21 @@ function respawnPersistentEntities() {
  * Specifically, this will clear the current room of all entities and grid entities, and then spawn
  * all of the entries and grid entities in the provided JSON room.
  *
+ * You can create JSON rooms by using the `convert-xml-to-json` tool (e.g. `npx convert-xml-to-json
+ * my-rooms.xml`).
+ *
  * This function is meant to be used in the `POST_NEW_ROOM` callback.
  *
  * For example:
  *
  * ```ts
  *
- * import customRooms from "./customRooms";
+ * import customRooms from "./customRooms.json";
  *
- * const firstJSONRoom = customRooms.rooms.room[0];
- * deployJSONRoom(firstJSONRoom);
+ * export function postNewRoom(): void {
+ *   const firstJSONRoom = customRooms.rooms.room[0];
+ *   deployJSONRoom(firstJSONRoom);
+ * }
  * ```
  *
  * @param jsonRoom The JSON room to deploy. *
@@ -277,6 +282,9 @@ export function deployJSONRoom(
  * Specifically, this will clear the current room of all entities and grid entities, and then spawn
  * all of the entries and grid entities in one of the provided JSON rooms.
  *
+ * You can create JSON rooms by using the `convert-xml-to-json` tool (e.g. `npx convert-xml-to-json
+ * my-rooms.xml`).
+ *
  * This function is meant to be used in the `POST_NEW_ROOM` callback.
  *
  * Note that this function does not simply choose a random element in the provided array; it will
@@ -286,10 +294,12 @@ export function deployJSONRoom(
  * For example:
  *
  * ```ts
- * import customRooms from "./customRooms";
+ * import customRooms from "./customRooms.json";
  *
- * const jsonRooms = customRooms.rooms.room;
- * deployRandomJSONRoom(jsonRooms);
+ * export function postNewRoom(): void {
+ *   const jsonRooms = customRooms.rooms.room;
+ *   deployRandomJSONRoom(jsonRooms);
+ * }
  * ```
  *
  * @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be

package/src/features/saveDataManager/exports.ts

@@ -153,7 +153,7 @@ export function saveDataManager<Persistent, Run, Level>(
 
   // Make a copy of the initial save data so that we can use it to restore the default values later
   // on.
-  const saveDataCopy = deepCopy(v, SerializationType.NONE, key) as typeof v;
+  const saveDataCopy = deepCopy(v, SerializationType.NONE, key);
   saveDataDefaultsMap.set(key, saveDataCopy);
 
   // Store the conditional function for later, if present.

package/src/functions/bitSet128.ts

@@ -1,10 +1,16 @@
+import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 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> & {
   readonly __serializedBitSet128Brand: symbol;
+  readonly __kind: CopyableIsaacAPIClassType.BIT_SET_128;
 };
 
 const OBJECT_NAME = "BitSet128";
@@ -86,7 +92,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

@@ -1,12 +1,18 @@
+import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 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> & {
   readonly __serializedColorBrand: symbol;
+  readonly __kind: CopyableIsaacAPIClassType.COLOR;
 };
 
 const OBJECT_NAME = "Color";
@@ -120,7 +126,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/curses.ts

@@ -5,7 +5,7 @@ import { hasFlag } from "./flag";
 /**
  * Helper function to get the actual bit flag for modded curses.
  *
- * Will throw a runtime error if the provided curse does not exist.
+ * Will throw a run-time error if the provided curse does not exist.
  *
  * Use this over the `Isaac.GetCurseIdByName` method because that will return an integer instead of
  * a bit flag.

package/src/functions/deepCopy.ts

@@ -1,17 +1,16 @@
 import { DefaultMap } from "../classes/DefaultMap";
-import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClassType";
 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/serializationBrands";
 import { TSTLClass } from "../types/TSTLClass";
 import { isArray } from "./array";
-import { getEnumValues } from "./enums";
 import { getIsaacAPIClassName } from "./isaacAPIClass";
 import { log } from "./log";
 import {
   copyIsaacAPIClass,
   deserializeIsaacAPIClass,
+  isCopyableIsaacAPIClass,
   isSerializedIsaacAPIClass,
   serializeIsaacAPIClass,
 } from "./serialization";
@@ -26,10 +25,6 @@ import {
 import { asString, isNumber, isPrimitive } from "./types";
 import { getTraversalDescription, twoDimensionalSort } from "./utils";
 
-const COPYABLE_ISAAC_API_CLASS_TYPES_SET = new Set<string>(
-  getEnumValues(CopyableIsaacAPIClassType),
-);
-
 /**
  * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
  * of the nested references remain.
@@ -64,6 +59,18 @@ const COPYABLE_ISAAC_API_CLASS_TYPES_SET = new Set<string>(
  * @param insideMap Optional. Tracks whether or not the deep copy function is in the process of
  *                  recursively copying a TSTL Map. Default is false.
  */
+export function deepCopy<T>(
+  value: T,
+  serializationType?: SerializationType.NONE,
+  traversalDescription?: string,
+  insideMap?: boolean,
+): T;
+export function deepCopy(
+  value: unknown,
+  serializationType: SerializationType,
+  traversalDescription?: string,
+  insideMap?: boolean,
+): unknown; // The return types for serialization/deserialization are non-trivial, so we do not type them.
 export function deepCopy(
   value: unknown,
   serializationType = SerializationType.NONE,
@@ -101,6 +108,12 @@ export function deepCopy(
         );
       }
 
+      if (serializationType === SerializationType.DESERIALIZE) {
+        error(
+          `The deep copy function does not support deserialization of "${traversalDescription}", since it is type: ${valueType}`,
+        );
+      }
+
       // We cannot copy this, so simply return the reference.
       return value;
     }
@@ -126,7 +139,7 @@ function deepCopyTable(
   serializationType: SerializationType,
   traversalDescription: string,
   insideMap: boolean,
-) {
+): unknown {
   // First, handle the cases of TSTL classes or serialized TSTL classes.
   if (isDefaultMap(luaMap) || luaMap.has(SerializationBrand.DEFAULT_MAP)) {
     return deepCopyDefaultMap(
@@ -651,11 +664,6 @@ function deepCopyUserdata(
   serializationType: SerializationType,
   traversalDescription: string,
 ) {
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (SAVE_DATA_MANAGER_DEBUG) {
-    log("deepCopy is copying userdata.");
-  }
-
   const classType = getIsaacAPIClassName(value);
   if (classType === undefined) {
     error(
@@ -663,9 +671,9 @@ function deepCopyUserdata(
     );
   }
 
-  if (!COPYABLE_ISAAC_API_CLASS_TYPES_SET.has(classType)) {
+  if (!isCopyableIsaacAPIClass(value)) {
     error(
-      `The deep copy function does not support copying "${traversalDescription}", since it is an Isaac API class of type: ${classType}`,
+      `The deep copy function does not support serializing "${traversalDescription}", since it is an Isaac API class of type: ${classType}`,
     );
   }
 
@@ -679,7 +687,9 @@ function deepCopyUserdata(
     }
 
     case SerializationType.DESERIALIZE: {
-      return deserializeIsaacAPIClass(value);
+      error(
+        `The deep copy function can not deserialize "${traversalDescription}", since it is userdata.`,
+      );
     }
   }
 }

package/src/functions/deepCopyTests.ts

@@ -49,7 +49,7 @@ function copiedObjectIsTable() {
     abc: "def",
   };
   const newObject = deepCopy(
-    oldObject as unknown as LuaMap,
+    oldObject,
     SerializationType.NONE,
     "copiedObjectIsTable",
   );
@@ -64,12 +64,11 @@ function copiedObjectHasKeyAndValueString() {
   const oldObject = {
     abc: valueToLookFor,
   };
-  const newTable = deepCopy(
-    oldObject as unknown as LuaMap,
+  const newObject = deepCopy(
+    oldObject,
     SerializationType.NONE,
     "copiedObjectHasKeyAndValueString",
   );
-  const newObject = newTable as typeof oldObject;
 
   const value = newObject[keyToLookFor];
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
@@ -91,12 +90,11 @@ function copiedTableHasKeyAndValueNumber() {
   const oldTable = new LuaMap<AnyNotNil, unknown>();
   oldTable.set(keyToLookFor, valueToLookFor);
 
-  const newObject = deepCopy(
+  const newTable = deepCopy(
     oldTable,
     SerializationType.NONE,
     "copiedTableHasKeyAndValueNumber",
   );
-  const newTable = newObject as LuaMap<AnyNotNil, unknown>;
 
   const value = newTable.get(keyToLookFor) as number | undefined;
   if (value === undefined) {
@@ -117,12 +115,11 @@ function copiedTableDoesNotCoerceTypes() {
   const oldTable = new LuaMap<AnyNotNil, unknown>();
   oldTable.set(keyToLookFor, valueToLookFor);
 
-  const newObject = deepCopy(
+  const newTable = deepCopy(
     oldTable,
     SerializationType.NONE,
     "copiedTableDoesNotCoerceTypes",
   );
-  const newTable = newObject as LuaMap<AnyNotNil, unknown>;
 
   const keyString = tostring(keyToLookFor);
   const valueString = tostring(valueToLookFor);
@@ -148,12 +145,11 @@ function copiedObjectHasNoReferencesForPrimitivesForward() {
     abc: originalStringValue,
     def: originalNumberValue,
   };
-  const newTable = deepCopy(
-    oldObject as unknown as LuaMap,
+  const newObject = deepCopy(
+    oldObject,
     SerializationType.NONE,
     "copiedObjectHasNoReferencesForPrimitivesForward",
   );
-  const newObject = newTable as typeof oldObject;
 
   oldObject.abc = "newValue";
   if (oldObject.abc === newObject.abc) {
@@ -173,12 +169,11 @@ function copiedObjectHasNoReferencesForPrimitivesBackward() {
     abc: originalStringValue,
     def: originalNumberValue,
   };
-  const newTable = deepCopy(
-    oldObject as unknown as LuaMap,
+  const newObject = deepCopy(
+    oldObject,
     SerializationType.NONE,
     "copiedObjectHasNoReferencesForPrimitivesBackward",
   );
-  const newObject = newTable as typeof oldObject;
 
   newObject.abc = "newValue";
   if (newObject.abc === oldObject.abc) {
@@ -196,12 +191,11 @@ function copiedObjectHasNoReferencesForArray() {
   const oldObject = {
     abc: [1, 2, 3],
   };
-  const newTable = deepCopy(
-    oldObject as unknown as LuaMap,
+  const newObject = deepCopy(
+    oldObject,
     SerializationType.NONE,
     "copiedObjectHasNoReferencesForArray",
   );
-  const newObject = newTable as typeof oldObject;
 
   if (oldObject.abc === newObject.abc) {
     error("The copied object has the same point to the child array.");
@@ -237,12 +231,11 @@ function copiedObjectHasChildObject() {
       def: valueToLookFor,
     },
   };
-  const newTable = deepCopy(
-    oldObject as unknown as LuaMap,
+  const newObject = deepCopy(
+    oldObject,
     SerializationType.NONE,
     "copiedObjectHasChildObject",
   );
-  const newObject = newTable as typeof oldObject;
 
   const childObject = newObject[childObjectIndex];
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
@@ -274,8 +267,7 @@ function copiedMapIsMap() {
   const oldMap = new Map<string, string>();
   oldMap.set(keyToLookFor, valueToLookFor);
 
-  const newObject = deepCopy(oldMap, SerializationType.NONE, "copiedMapIsMap");
-  const newMap = newObject as Map<string, string>;
+  const newMap = deepCopy(oldMap, SerializationType.NONE, "copiedMapIsMap");
 
   if (!isTSTLMap(newMap)) {
     error(`The copied Map was not a Map and has a type of: ${typeof newMap}`);
@@ -288,13 +280,7 @@ function copiedMapHasValue() {
   const oldMap = new Map<string, string>();
   oldMap.set(keyToLookFor, valueToLookFor);
 
-  const newTable = deepCopy(
-    oldMap,
-    SerializationType.NONE,
-    "copiedMapHasValue",
-  );
-
-  const newMap = newTable as typeof oldMap;
+  const newMap = deepCopy(oldMap, SerializationType.NONE, "copiedMapHasValue");
 
   if (!isTSTLMap(newMap)) {
     error(`The copied Map was not a Map and has a type of: ${typeof newMap}`);
@@ -314,8 +300,7 @@ function copiedSetIsSet() {
   const oldSet = new Set<string>();
   oldSet.add(valueToLookFor);
 
-  const newTable = deepCopy(oldSet, SerializationType.NONE, "copiedSetIsSet");
-  const newSet = newTable as Set<string>;
+  const newSet = deepCopy(oldSet, SerializationType.NONE, "copiedSetIsSet");
 
   if (!isTSTLSet(newSet)) {
     error(`The copied Set was not a Set and has a type of: ${typeof newSet}`);
@@ -327,12 +312,7 @@ function copiedSetHasValue() {
   const oldSet = new Set<string>();
   oldSet.add(valueToLookFor);
 
-  const newTable = deepCopy(
-    oldSet,
-    SerializationType.NONE,
-    "copiedSetHasValue",
-  );
-  const newSet = newTable as Set<string>;
+  const newSet = deepCopy(oldSet, SerializationType.NONE, "copiedSetHasValue");
 
   if (!isTSTLSet(newSet)) {
     error(`The copied Set was not a Set and has a type of: ${typeof newSet}`);
@@ -354,12 +334,11 @@ function copiedMapHasChildMap() {
   const oldMap = new Map<string, Map<number, number>>();
   oldMap.set(keyToLookFor, oldChildMap);
 
-  const newTable = deepCopy(
+  const newMap = deepCopy(
     oldMap,
     SerializationType.NONE,
     "copiedMapHasChildMap",
   );
-  const newMap = newTable as typeof oldMap;
 
   if (!isTSTLMap(newMap)) {
     error(`The copied Map was not a Map and had a type of: ${typeof newMap}`);
@@ -398,12 +377,11 @@ function copiedDefaultMapHasChildDefaultMap() {
   oldChildMap.getAndSetDefault(childMapKey1);
   oldChildMap.set(childMapKey2, childMapCustomValue);
 
-  const newTable = deepCopy(
+  const newParentMap = deepCopy(
     oldParentMap,
     SerializationType.NONE,
     "copiedDefaultMapHasChildDefaultMap",
   );
-  const newParentMap = newTable as typeof oldParentMap;
 
   if (!isDefaultMap(newParentMap)) {
     error(

package/src/functions/initArray.ts

@@ -23,7 +23,7 @@ export function initArray<T>(defaultValue: T, size: int): T[] {
     if (isPrimitive(defaultValue)) {
       array.push(defaultValue);
     } else {
-      const copy = deepCopy(defaultValue) as T;
+      const copy = deepCopy(defaultValue);
       array.push(copy);
     }
   });