isaacscript-common 20.12.2 → 20.12.3

package/dist/src/functions/utils.lua

@@ -94,7 +94,7 @@ end
 --- Helper function to log a message to the "log.txt" file and to print it to the screen at the same
 -- time.
 function ____exports.logAndPrint(self, msg)
-    log(nil, msg)
+    log(msg)
     print(msg)
 end
 --- Helper function to print whether something was enabled or disabled to the in-game console.
@@ -154,6 +154,20 @@ end
 -- From:
 -- https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
 function ____exports.twoDimensionalSort(self, array1, array2)
+    local type1 = type(array1)
+    local type2 = type(array2)
+    if type1 ~= type2 then
+        error(((((((("Failed to two-dimensional sort since the two elements were disparate types: " .. tostring(array1)) .. " & ") .. tostring(array2)) .. " (") .. type1) .. " & ") .. type2) .. ")")
+    end
+    if type1 == "string" or type1 == "number" then
+        if array1 == array2 then
+            return 0
+        end
+        return array1 < array2 and -1 or 1
+    end
+    if type1 ~= "table" then
+        error("Failed to two-dimensional sort since the elements were not a string, number, or table.")
+    end
     local firstElement1 = array1[1]
     local firstElement2 = array2[1]
     if firstElement1 == nil or firstElement1 == nil then
@@ -162,6 +176,11 @@ function ____exports.twoDimensionalSort(self, array1, array2)
     if firstElement2 == nil or firstElement2 == nil then
         error("Failed to two-dimensional sort since the first element of the second array was undefined.")
     end
+    local elementType1 = type(firstElement1)
+    local elementType2 = type(firstElement2)
+    if elementType1 ~= elementType2 then
+        error(((((((("Failed to two-dimensional sort since the first element of each array were disparate types: " .. tostring(firstElement1)) .. " & ") .. tostring(firstElement2)) .. " (") .. elementType1) .. " & ") .. elementType2) .. ")")
+    end
     if firstElement1 == firstElement2 then
         return 0
     end

package/dist/src/lib/jsonLua.lua

@@ -24,6 +24,9 @@
 -- SOFTWARE.
 --
 
+-- The IsaacScript version of this file contains modifications for better error messages, which
+-- assist when debugging.
+
 local json = { _version = "0.1.2" }
 
 -------------------------------------------------------------------------------
@@ -58,9 +61,10 @@ local function encode_nil(val)
 end
 
 
-local function encode_table(val, stack)
+local function encode_table(val, stack, traversalDescription)
   local res = {}
   stack = stack or {}
+  traversalDescription = traversalDescription or ""
 
   -- Circular reference?
   if stack[val] then error("circular reference") end
@@ -72,7 +76,7 @@ local function encode_table(val, stack)
     local n = 0
     for k in pairs(val) do
       if type(k) ~= "number" then
-        error("invalid table: mixed or invalid key types")
+        error("invalid table: mixed or invalid key types for array, excepted number, got: " .. tostring(type(k)))
       end
       n = n + 1
     end
@@ -81,7 +85,8 @@ local function encode_table(val, stack)
     end
     -- Encode
     for i, v in ipairs(val) do
-      table.insert(res, encode(v, stack))
+      local newTraversalDescription = traversalDescription .. tostring(i) .. " - "
+      table.insert(res, encode(v, stack, newTraversalDescription))
     end
     stack[val] = nil
     return "[" .. table.concat(res, ",") .. "]"
@@ -89,10 +94,14 @@ local function encode_table(val, stack)
   else
     -- Treat as an object
     for k, v in pairs(val) do
+      local newTraversalDescription = traversalDescription .. tostring(k) .. " - "
       if type(k) ~= "string" then
-        error("invalid table: mixed or invalid key types")
+        error(
+          "invalid table: mixed or invalid key types for object \"" .. newTraversalDescription .. "\", "
+          .. "excepted string, got: " .. tostring(type(k))
+        )
       end
-      table.insert(res, encode(k, stack) .. ":" .. encode(v, stack))
+      table.insert(res, encode(k, stack, newTraversalDescription) .. ":" .. encode(v, stack, newTraversalDescription))
     end
     stack[val] = nil
     return "{" .. table.concat(res, ",") .. "}"
@@ -123,11 +132,11 @@ local type_func_map = {
 }
 
 
-encode = function(val, stack)
+encode = function(val, stack, traversalDescription)
   local t = type(val)
   local f = type_func_map[t]
   if f then
-    return f(val, stack)
+    return f(val, stack, traversalDescription)
   end
   error("unexpected type '" .. t .. "'")
 end

package/dist/src/patchErrorFunctions.lua

@@ -14,7 +14,7 @@ function errorWithTraceback(message, level)
     if level == nil then
         level = 1
     end
-    local tracebackOutput = getTraceback(nil)
+    local tracebackOutput = getTraceback()
     local slimmedTracebackOutput = slimTracebackOutput(nil, tracebackOutput)
     message = message .. "\n"
     message = message .. slimmedTracebackOutput

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "20.12.2",
+  "version": "20.12.3",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/classes/ModFeature.ts

@@ -330,18 +330,12 @@ function initSaveDataManager(
   tstlClassName: string,
   init: boolean,
 ) {
-  if (tstlClassName === "AtePoopBaby") {
-    Isaac.DebugString("GETTING HERE 1");
-  }
-
   // Do nothing if this class does not have any variables.
   const { v } = modFeature as unknown as Record<string, unknown>;
   if (v === undefined) {
     return;
   }
 
-  Isaac.DebugString("GETTING HERE 2");
-
   if (!isTable(v)) {
     error(
       'Failed to initialize a mod feature class due to having a "v" property that is not an object. (The "v" property is supposed to be an object that holds the variables for the class, managed by the save data manager.)',

package/src/classes/features/other/saveDataManager/saveToDisk.ts

@@ -16,7 +16,7 @@ export function saveToDisk(
     saveDataConditionalFuncMap,
   );
   const jsonString = jsonEncode(allSaveData);
-  mod.SaveData(jsonString); // Write it to the "save#.dat" file
+  mod.SaveData(jsonString);
   log('The save data manager wrote data to the "save#.dat" file.');
 }
 
@@ -52,9 +52,8 @@ function getAllSaveDataToWriteToDisk(
         return;
       }
 
-      // If we encode TypeScriptToLua Maps into JSON, it will result in a lot of extraneous data
-      // that is unnecessary. Make a copy of the data and recursively convert all TypeScriptToLua
-      // Maps into Lua tables.
+      // We need to serialize TypeScriptToLua maps and Isaac API objects such as `Color`.
+      // Recursively convert all such objects to Lua tables.
       const saveDataCopy = deepCopy(
         saveDataWithoutRoom,
         SerializationType.SERIALIZE,

package/src/functions/debugFunctions.ts

@@ -45,7 +45,7 @@ export function getTime(useSocketIfAvailable = true): float {
  * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
  * enabled.
  */
-export function getTraceback(): string {
+export function getTraceback(this: void): string {
   if (SandboxGetTraceback !== undefined) {
     return SandboxGetTraceback();
   }
@@ -88,7 +88,7 @@ export function isLuaDebugEnabled(): boolean {
  * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
  * enabled.
  */
-export function traceback(): void {
+export function traceback(this: void): void {
   const tracebackOutput = getTraceback();
   log(tracebackOutput);
 }

package/src/functions/deepCopy.ts

@@ -615,6 +615,8 @@ function deepCopyNormalLuaTable(
 /**
  * Recursively clones the object's entries, automatically converting number keys to strings, if
  * necessary.
+ *
+ * This should work on objects/tables, maps, sets, default maps, and classes.
  */
 function getCopiedEntries(
   object: unknown,

package/src/functions/log.ts

@@ -9,6 +9,7 @@
  *               function, and the third level is the parent of the calling function).
  */
 export function getParentFunctionDescription(
+  this: void,
   // We use 3 as a default because:
   // - The first level is this function.
   // - The second level is the calling function.
@@ -36,8 +37,8 @@ export function getParentFunctionDescription(
 /**
  * Helper function to avoid typing out `Isaac.DebugString()`.
  *
- * If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
- * function will also prepend the function name and the line number before the string, like this:
+ * If you have the "--luadebug" launch flag turned on, then this function will also prepend the
+ * function name and the line number before the string, like this:
  *
  * ```text
  * [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
@@ -45,9 +46,19 @@ export function getParentFunctionDescription(
  *
  * Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
  * your mod so that debugging becomes a little bit easier.
+ *
+ * @param msg The message to log.
+ * @param includeParentFunction Optional. Whether to prefix the message with the function name and
+ *                              line number, as shown in the above example. Default is true.
  */
-export function log(msg: string): void {
-  const parentFunctionDescription = getParentFunctionDescription();
+export function log(
+  this: void,
+  msg: string,
+  includeParentFunction = true,
+): void {
+  const parentFunctionDescription = includeParentFunction
+    ? getParentFunctionDescription()
+    : undefined;
   const debugMsg =
     parentFunctionDescription === undefined
       ? msg

package/src/functions/logEntities.ts

@@ -29,6 +29,7 @@ const IGNORE_EFFECT_VARIANTS: ReadonlySet<EffectVariant> = new Set([
 
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
 export function logAllEntities(
+  this: void,
   includeBackgroundEffects: boolean,
   entityTypeFilter?: EntityType,
 ): void {
@@ -83,6 +84,7 @@ export function logAllEntities(
  *                             Default is undefined.
  */
 export function logAllGridEntities(
+  this: void,
   includeWalls = false,
   gridEntityTypeFilter?: GridEntityType,
 ): void {
@@ -136,19 +138,19 @@ export function logAllGridEntities(
 }
 
 /** Helper function for logging an array of specific entities. */
-export function logEntities(entities: Entity[]): void {
+export function logEntities(this: void, entities: Entity[]): void {
   for (const entity of entities) {
     logEntity(entity);
   }
 }
 
 /** Helper function to log information about a specific entity. */
-export function logEntity(entity: Entity): void {
+export function logEntity(this: void, entity: Entity): void {
   const msg = getEntityLogLine(entity);
   log(msg);
 }
 
-function getEntityLogLine(entity: Entity, num?: int): string {
+function getEntityLogLine(this: void, entity: Entity, num?: int): string {
   let msg = num === undefined ? "" : `${num}) `;
 
   msg += getEntityID(entity);
@@ -230,19 +232,23 @@ function getEntityLogLine(entity: Entity, num?: int): string {
 }
 
 /** Helper function for logging an array of specific grid entities. */
-export function logGridEntities(gridEntities: GridEntity[]): void {
+export function logGridEntities(this: void, gridEntities: GridEntity[]): void {
   for (const gridEntity of gridEntities) {
     logGridEntity(gridEntity);
   }
 }
 
 /** Helper function for log information about a specific grid entity. */
-export function logGridEntity(gridEntity: GridEntity): void {
+export function logGridEntity(this: void, gridEntity: GridEntity): void {
   const msg = getGridEntityLogLine(gridEntity);
   log(msg);
 }
 
-function getGridEntityLogLine(gridEntity: GridEntity, num?: int): string {
+function getGridEntityLogLine(
+  this: void,
+  gridEntity: GridEntity,
+  num?: int,
+): string {
   const gridEntityDesc = gridEntity.GetSaveState();
 
   let msg = num === undefined ? "" : `${num}) `;
@@ -303,7 +309,7 @@ function getGridEntityLogLine(gridEntity: GridEntity, num?: int): string {
  * Helper function to log information about the entity that corresponding to a pointer hash. (Only
  * use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-export function logPtrHash(ptrHash: PtrHash): void {
+export function logPtrHash(this: void, ptrHash: PtrHash): void {
   log(`PtrHash: ${ptrHash}`);
   const entity = getEntityFromPtrHash(ptrHash);
   if (entity === undefined) {
@@ -317,7 +323,7 @@ export function logPtrHash(ptrHash: PtrHash): void {
  * Helper function to log information about the entity that corresponding to one or more pointer
  * hashes. (Only use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-export function logPtrHashes(ptrHashes: PtrHash[]): void {
+export function logPtrHashes(this: void, ptrHashes: PtrHash[]): void {
   for (const ptrHash of ptrHashes) {
     logPtrHash(ptrHash);
   }

package/src/functions/logMisc.ts

@@ -31,7 +31,7 @@ import { isTable, isUserdata } from "./types";
 import { vectorToString } from "./vector";
 
 /** Helper function to enumerate all of the values in an array. */
-export function logArray<T>(array: T[] | readonly T[]): void {
+export function logArray<T>(this: void, array: T[] | readonly T[]): void {
   // 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)) {
@@ -43,7 +43,10 @@ export function logArray<T>(array: T[] | readonly T[]): void {
   log(`Array: ${arrayString}`);
 }
 
-export function logCollectibleTypes(collectibleTypes: CollectibleType[]): void {
+export function logCollectibleTypes(
+  this: void,
+  collectibleTypes: CollectibleType[],
+): void {
   log("Collectibles:");
 
   let i = 1;
@@ -54,23 +57,29 @@ export function logCollectibleTypes(collectibleTypes: CollectibleType[]): void {
   }
 }
 
-export function logColor(color: Color): void {
+export function logColor(this: void, color: Color): void {
   log(
     `Color: R${color.R}, G${color.G}, B${color.B}, A${color.A}, RO${color.RO}, BO${color.BO}, GO${color.GO}`,
   );
 }
 
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
-export function logDamageFlags(flags: DamageFlag | BitFlags<DamageFlag>): void {
+export function logDamageFlags(
+  this: void,
+  flags: DamageFlag | BitFlags<DamageFlag>,
+): void {
   logFlags(flags, DamageFlag, "damage");
 }
 
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
-export function logEntityFlags(flags: EntityFlag | BitFlags<EntityFlag>): void {
+export function logEntityFlags(
+  this: void,
+  flags: EntityFlag | BitFlags<EntityFlag>,
+): void {
   logFlags(flags, EntityFlag, "entity");
 }
 
-export function logEntityID(entity: Entity): void {
+export function logEntityID(this: void, entity: Entity): void {
   const entityID = getEntityID(entity);
   log(`Entity: ${entityID}`);
 }
@@ -81,7 +90,7 @@ export function logEntityID(entity: Entity): void {
  * This is useful in situations where using the `error` function would be dangerous (since it
  * prevents all of the subsequent code in the callback from running).
  */
-export function logError(msg: string): void {
+export function logError(this: void, msg: string): void {
   const errorMsg = `Error: ${msg}`;
   log(errorMsg);
   print(errorMsg);
@@ -89,6 +98,7 @@ export function logError(msg: string): void {
 
 /** Helper function for printing out every flag that is turned on. Useful when debugging. */
 export function logFlags<T extends BitFlag | BitFlag128>(
+  this: void,
   flags: T | BitFlags<T>,
   flagEnum: Record<string, T>,
   description = "",
@@ -116,7 +126,7 @@ export function logFlags<T extends BitFlag | BitFlag128>(
 /**
  * Helper function for printing out every game state flag that is turned on. Useful when debugging.
  */
-export function logGameStateFlags(): void {
+export function logGameStateFlags(this: void): void {
   log("Logging game state flags:");
 
   const gameStateFlagEntries = getEnumEntries(GameStateFlag);
@@ -135,7 +145,7 @@ export function logGameStateFlags(): void {
   }
 }
 
-export function logKColor(kColor: KColor): void {
+export function logKColor(this: void, kColor: KColor): void {
   log(
     `Color: R${kColor.Red}, G${kColor.Green}, B${kColor.Blue}, A${kColor.Alpha}`,
   );
@@ -144,7 +154,7 @@ export function logKColor(kColor: KColor): void {
 /**
  * Helper function for printing out every level state flag that is turned on. Useful when debugging.
  */
-export function logLevelStateFlags(): void {
+export function logLevelStateFlags(this: void): void {
   const level = game.GetLevel();
 
   const levelStateFlagEntries = getEnumEntries(LevelStateFlag);
@@ -164,7 +174,7 @@ export function logLevelStateFlags(): void {
   }
 }
 
-export function logMap(map: Map<AnyNotNil, unknown>): void {
+export function logMap(this: void, map: Map<AnyNotNil, unknown>): void {
   if (!isTSTLMap(map) && !isDefaultMap(map)) {
     log("Tried to log a TSTL map, but the given object was not a TSTL map.");
     return;
@@ -184,7 +194,7 @@ export function logMap(map: Map<AnyNotNil, unknown>): void {
   log(`  The size of the map was: ${map.size}`);
 }
 
-export function logPlayerEffects(player: EntityPlayer): void {
+export function logPlayerEffects(this: void, player: EntityPlayer): void {
   const effects = getEffectsList(player);
 
   log("Logging player effects:");
@@ -212,7 +222,7 @@ export function logPlayerEffects(player: EntityPlayer): void {
   });
 }
 
-export function logPlayerHealth(player: EntityPlayer): void {
+export function logPlayerHealth(this: void, player: EntityPlayer): void {
   const playerName = getPlayerName(player);
   const playerHealth = getPlayerHealth(player);
 
@@ -238,13 +248,14 @@ export function logPlayerHealth(player: EntityPlayer): void {
  * Helper function for printing out every projectile flag that is turned on. Useful when debugging.
  */
 export function logProjectileFlags(
+  this: void,
   flags: ProjectileFlag | BitFlags<ProjectileFlag>,
 ): void {
   logFlags(flags, ProjectileFlag, "projectile");
 }
 
 /** Helper function for logging information about the current room. */
-export function logRoom(): void {
+export function logRoom(this: void): void {
   const room = game.GetRoom();
   const bossID = room.GetBossID();
   const roomGridIndex = getRoomGridIndex();
@@ -277,7 +288,7 @@ export function logRoom(): void {
  * Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
  * particular run.
  */
-export function logSeedEffects(): void {
+export function logSeedEffects(this: void): void {
   const seeds = game.GetSeeds();
 
   const seedEffectEntries = getEnumEntries(SeedEffect);
@@ -296,7 +307,10 @@ export function logSeedEffects(): void {
   }
 }
 
-export function logSet(set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void {
+export function logSet(
+  this: void,
+  set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>,
+): void {
   if (!isTSTLSet(set)) {
     log("Tried to log a TSTL set, but the given object was not a TSTL set.");
     return;
@@ -314,7 +328,7 @@ export function logSet(set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void {
 }
 
 /** Helper function for logging every sound effect that is currently playing. */
-export function logSounds(): void {
+export function logSounds(this: void): void {
   const soundEffects = getEnumEntries(SoundEffect);
 
   for (const [key, soundEffect] of soundEffects) {
@@ -334,9 +348,13 @@ export function logSounds(): void {
  * In order to prevent infinite recursion, this function will not log a sub-table when there are 10
  * or more parent tables.
  */
-export function logTable(luaTable: unknown, parentTables = 0): void {
+export function logTable(
+  this: void,
+  luaTable: unknown,
+  parentTables = 0,
+): void {
   if (parentTables === 0) {
-    log("Printing out a Lua table:");
+    log("Printing out a Lua table:", false);
   } else if (parentTables > 10) {
     return;
   }
@@ -345,14 +363,10 @@ export function logTable(luaTable: unknown, parentTables = 0): void {
   const indentation = " ".repeat(numSpaces);
 
   if (!isTable(luaTable)) {
-    // Put it in an IIFE so that it will show as "func" instead of "logTable" and align with the
-    // other text. We have to use a non-arrow function to prevent Lua language server errors with
-    // the self argument.
-    (function func() {
-      log(
-        `${indentation}n/a (encountered a variable of type "${typeof luaTable}" instead of a table)`,
-      );
-    })();
+    log(
+      `${indentation}n/a (encountered a variable of type "${typeof luaTable}" instead of a table)`,
+      false,
+    );
 
     return;
   }
@@ -360,12 +374,13 @@ export function logTable(luaTable: unknown, parentTables = 0): void {
   let numElements = 0;
   iterateTableInOrder(luaTable, (key, value) => {
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
-    log(`${indentation}${key} --> ${value}`);
+    log(`${indentation}${key} --> ${value}`, false);
 
     if (isTable(value)) {
       if (key === "__class") {
         log(
           `${indentation}  (skipping enumerating this key to avoid infinite recursion)`,
+          false,
         );
       } else {
         logTable(value, parentTables + 1);
@@ -375,12 +390,7 @@ export function logTable(luaTable: unknown, parentTables = 0): void {
     numElements++;
   });
 
-  // Put it in an IIFE so that it will show as "func" instead of "logTable" and align with the other
-  // text. We have to use a non-arrow function to prevent Lua language server errors with the self
-  // argument.
-  (function func() {
-    log(`${indentation}The size of the table was: ${numElements}`);
-  })();
+  log(`${indentation}The size of the table was: ${numElements}`, false);
 }
 
 /**
@@ -388,6 +398,7 @@ export function logTable(luaTable: unknown, parentTables = 0): void {
  * will only do a shallow comparison.
  */
 export function logTableDifferences<K extends AnyNotNil, V>(
+  this: void,
   table1: LuaMap<K, V>,
   table2: LuaMap<K, V>,
 ): void {
@@ -428,7 +439,7 @@ export function logTableDifferences<K extends AnyNotNil, V>(
  *
  * This function is useful for tables that have recursive references.
  */
-export function logTableKeys(luaTable: unknown): void {
+export function logTableKeys(this: void, luaTable: unknown): void {
   log("Printing out the keys of a Lua table:");
 
   if (!isTable(luaTable)) {
@@ -449,12 +460,18 @@ export function logTableKeys(luaTable: unknown): void {
 }
 
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
-export function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void {
+export function logTearFlags(
+  this: void,
+  flags: TearFlag | BitFlags<TearFlag>,
+): void {
   logFlags(flags, TearFlag, "tear");
 }
 
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
-export function logUseFlags(flags: UseFlag | BitFlags<UseFlag>): void {
+export function logUseFlags(
+  this: void,
+  flags: UseFlag | BitFlags<UseFlag>,
+): void {
   logFlags(flags, UseFlag, "use");
 }
 
@@ -462,7 +479,7 @@ export function logUseFlags(flags: UseFlag | BitFlags<UseFlag>): void {
  * Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
  * the Isaac API).
  */
-export function logUserdata(userdata: unknown): void {
+export function logUserdata(this: void, userdata: unknown): void {
   if (!isUserdata(userdata)) {
     log("Userdata: [not userdata]");
     return;
@@ -484,7 +501,7 @@ export function logUserdata(userdata: unknown): void {
   logTable(metatable);
 }
 
-export function logVector(vector: Vector, round = false): void {
+export function logVector(this: void, vector: Vector, round = false): void {
   const vectorString = vectorToString(vector, round);
   log(`Vector: ${vectorString}`);
 }

package/src/functions/utils.ts

@@ -174,6 +174,28 @@ export function todo(...args: unknown[]): void {}
  * https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
  */
 export function twoDimensionalSort<T>(array1: T[], array2: T[]): -1 | 0 | 1 {
+  const type1 = type(array1);
+  const type2 = type(array2);
+  if (type1 !== type2) {
+    error(
+      `Failed to two-dimensional sort since the two elements were disparate types: ${array1} & ${array2} (${type1} & ${type2})`,
+    );
+  }
+
+  if (type1 === "string" || type1 === "number") {
+    if (array1 === array2) {
+      return 0;
+    }
+
+    return array1 < array2 ? -1 : 1;
+  }
+
+  if (type1 !== "table") {
+    error(
+      "Failed to two-dimensional sort since the elements were not a string, number, or table.",
+    );
+  }
+
   const firstElement1 = array1[0];
   const firstElement2 = array2[0];
 
@@ -189,6 +211,14 @@ export function twoDimensionalSort<T>(array1: T[], array2: T[]): -1 | 0 | 1 {
     );
   }
 
+  const elementType1 = type(firstElement1);
+  const elementType2 = type(firstElement2);
+  if (elementType1 !== elementType2) {
+    error(
+      `Failed to two-dimensional sort since the first element of each array were disparate types: ${firstElement1} & ${firstElement2} (${elementType1} & ${elementType2})`,
+    );
+  }
+
   if (firstElement1 === firstElement2) {
     return 0;
   }