isaacscript-common 3.15.0 → 3.15.3

package/functions/deepCopy.lua

@@ -39,6 +39,9 @@ local isTSTLMap = ____tstlClass.isTSTLMap
 local isTSTLSet = ____tstlClass.isTSTLSet
 local isUserDefinedTSTLClass = ____tstlClass.isUserDefinedTSTLClass
 local newTSTLClass = ____tstlClass.newTSTLClass
+local ____types = require("functions.types")
+local isNumber = ____types.isNumber
+local isPrimitive = ____types.isPrimitive
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local getTraversalDescription = ____utils.getTraversalDescription
@@ -106,8 +109,8 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
         ____cond6 = ____cond6 or ____switch6 == "table"
         if ____cond6 then
             do
-                local valueTable = value
-                return deepCopyTable(nil, valueTable, serializationType, traversalDescription)
+                local luaTable = value
+                return deepCopyTable(nil, luaTable, serializationType, traversalDescription)
             end
         end
         ____cond6 = ____cond6 or ____switch6 == "userdata"
@@ -123,34 +126,34 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
         end
     until true
 end
-function deepCopyTable(self, ____table, serializationType, traversalDescription)
-    if isDefaultMap(nil, ____table) or ____table[SerializationBrand.DEFAULT_MAP] ~= nil then
-        return deepCopyDefaultMap(nil, ____table, serializationType, traversalDescription)
+function deepCopyTable(self, luaTable, serializationType, traversalDescription)
+    if isDefaultMap(nil, luaTable) or luaTable[SerializationBrand.DEFAULT_MAP] ~= nil then
+        return deepCopyDefaultMap(nil, luaTable, serializationType, traversalDescription)
     end
-    if isTSTLMap(nil, ____table) or ____table[SerializationBrand.MAP] ~= nil then
-        return deepCopyMap(nil, ____table, serializationType, traversalDescription)
+    if isTSTLMap(nil, luaTable) or luaTable[SerializationBrand.MAP] ~= nil then
+        return deepCopyMap(nil, luaTable, serializationType, traversalDescription)
     end
-    if isTSTLSet(nil, ____table) or ____table[SerializationBrand.SET] ~= nil then
-        return deepCopySet(nil, ____table, serializationType, traversalDescription)
+    if isTSTLSet(nil, luaTable) or luaTable[SerializationBrand.SET] ~= nil then
+        return deepCopySet(nil, luaTable, serializationType, traversalDescription)
     end
-    local className = getTSTLClassName(nil, ____table)
+    local className = getTSTLClassName(nil, luaTable)
     if className == "WeakMap" then
         error("The deep copy function does not support copying the \"WeakMap\" class for: " .. traversalDescription)
     end
     if className == "WeakSet" then
         error("The deep copy function does not support copying the \"WeakSet\" class for: " .. traversalDescription)
     end
-    if isUserDefinedTSTLClass(nil, ____table) then
-        return deepCopyTSTLClass(nil, ____table, serializationType, traversalDescription)
+    if isUserDefinedTSTLClass(nil, luaTable) then
+        return deepCopyTSTLClass(nil, luaTable, serializationType, traversalDescription)
     end
-    checkMetatable(nil, ____table, traversalDescription)
-    if isSerializedIsaacAPIClass(nil, ____table) and serializationType == SerializationType.DESERIALIZE then
-        return deserializeIsaacAPIClass(nil, ____table)
+    checkMetatable(nil, luaTable, traversalDescription)
+    if isSerializedIsaacAPIClass(nil, luaTable) and serializationType == SerializationType.DESERIALIZE then
+        return deserializeIsaacAPIClass(nil, luaTable)
     end
-    if isArray(nil, ____table) then
-        return deepCopyArray(nil, ____table, serializationType, traversalDescription)
+    if isArray(nil, luaTable) then
+        return deepCopyArray(nil, luaTable, serializationType, traversalDescription)
     end
-    return deepCopyNormalLuaTable(nil, ____table, serializationType, traversalDescription)
+    return deepCopyNormalLuaTable(nil, luaTable, serializationType, traversalDescription)
 end
 function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescription)
     local ____isDefaultMap_result_0
@@ -173,7 +176,7 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
         ____cond23 = ____cond23 or ____switch23 == SerializationType.SERIALIZE
         if ____cond23 then
             do
-                if type(constructorArg) ~= "boolean" and type(constructorArg) ~= "number" and type(constructorArg) ~= "string" then
+                if not isPrimitive(nil, constructorArg) then
                     return deepCopyMap(nil, defaultMap, serializationType, traversalDescription)
                 end
                 newDefaultMap = {}
@@ -308,9 +311,9 @@ function deepCopyArray(self, array, serializationType, traversalDescription)
     end
     return newArray
 end
-function deepCopyNormalLuaTable(self, ____table, serializationType, traversalDescription)
+function deepCopyNormalLuaTable(self, luaTable, serializationType, traversalDescription)
     local newTable = {}
-    local ____getCopiedEntries_result_5 = getCopiedEntries(nil, ____table, serializationType, traversalDescription)
+    local ____getCopiedEntries_result_5 = getCopiedEntries(nil, luaTable, serializationType, traversalDescription)
     local entries = ____getCopiedEntries_result_5.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_5.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
@@ -345,7 +348,7 @@ function getCopiedEntries(self, object, serializationType, traversalDescription)
         function(____, ____bindingPattern0)
             local key
             key = ____bindingPattern0[1]
-            return type(key) == "number"
+            return isNumber(nil, key)
         end
     )
     local convertNumberKeysToStrings = serializationType == SerializationType.SERIALIZE and hasNumberKeys
@@ -366,8 +369,8 @@ function getCopiedEntries(self, object, serializationType, traversalDescription)
     end
     return {entries = copiedEntries, convertedNumberKeysToStrings = convertNumberKeysToStrings}
 end
-function checkMetatable(self, ____table, traversalDescription)
-    local metatable = getmetatable(____table)
+function checkMetatable(self, luaTable, traversalDescription)
+    local metatable = getmetatable(luaTable)
     if metatable == nil then
         return
     end

package/functions/deepCopyTests.lua

@@ -1,4 +1,5 @@
 local ____lualib = require("lualib_bundle")
+local __TS__TypeOf = ____lualib.__TS__TypeOf
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local Set = ____lualib.Set
@@ -20,12 +21,15 @@ local ____tstlClass = require("functions.tstlClass")
 local isDefaultMap = ____tstlClass.isDefaultMap
 local isTSTLMap = ____tstlClass.isTSTLMap
 local isTSTLSet = ____tstlClass.isTSTLSet
+local ____types = require("functions.types")
+local isNumber = ____types.isNumber
+local isString = ____types.isString
+local isTable = ____types.isTable
 function copiedObjectIsTable(self)
     local oldObject = {abc = "def"}
     local newObject = deepCopy(nil, oldObject)
-    local newObjectType = type(newObject)
-    if newObjectType ~= "table" then
-        error("The copied object is not a table.")
+    if not isTable(nil, newObject) then
+        error("The copied object had a type of: " .. __TS__TypeOf(newObject))
     end
 end
 function copiedObjectHasKeyAndValueString(self)
@@ -38,9 +42,8 @@ function copiedObjectHasKeyAndValueString(self)
     if value == nil then
         error("The copied object did not have a key of: " .. keyToLookFor)
     end
-    local valueType = type(value)
-    if valueType ~= "string" then
-        error("The copied object had a value type of: " .. valueType)
+    if not isString(nil, value) then
+        error("The copied object had a value type of: " .. __TS__TypeOf(value))
     end
     if value ~= valueToLookFor then
         error("The copied object had a value of: " .. value)
@@ -57,9 +60,8 @@ function copiedTableHasKeyAndValueNumber(self)
     if value == nil then
         error("The copied object did not have a key of: " .. tostring(keyToLookFor))
     end
-    local valueType = type(value)
-    if valueType ~= "number" then
-        error("The copied object had a value type of: " .. valueType)
+    if not isNumber(nil, value) then
+        error("The copied object had a value type of: " .. __TS__TypeOf(value))
     end
     if value ~= valueToLookFor then
         error("The copied object had a value of: " .. tostring(value))
@@ -149,17 +151,15 @@ function copiedObjectHasChildObject(self)
     if childObject == nil then
         error("Failed to find the child object at index: " .. childObjectIndex)
     end
-    local childObjectType = type(childObject)
-    if childObjectType ~= "table" then
-        error("The copied child object was not a table.")
+    if not isTable(nil, childObject) then
+        error("The copied child object had a type of: " .. __TS__TypeOf(childObject))
     end
     local value = childObject[keyToLookFor]
     if value == nil then
         error("The child object did not have a key of: " .. keyToLookFor)
     end
-    local valueType = type(value)
-    if valueType ~= "string" then
-        error("The child object value had a type of: " .. valueType)
+    if not isString(nil, value) then
+        error("The child object value had a type of: " .. __TS__TypeOf(value))
     end
     if value ~= valueToLookFor then
         error("The child object value was: " .. valueToLookFor)
@@ -172,9 +172,8 @@ function copiedMapIsMap(self)
     oldMap:set(keyToLookFor, valueToLookFor)
     local newObject = deepCopy(nil, oldMap)
     local newMap = newObject
-    local newMapType = type(newMap)
-    if newMapType ~= "table" then
-        error("The copied Map was not a table.")
+    if not isTable(nil, newMap) then
+        error("The copied Map had a type of: " .. __TS__TypeOf(newMap))
     end
     if not isTSTLMap(nil, newMap) then
         error("The copied Map was not a Map.")
@@ -201,9 +200,8 @@ function copiedSetIsSet(self)
     oldSet:add(valueToLookFor)
     local newTable = deepCopy(nil, oldSet)
     local newSet = newTable
-    local newSetType = type(newSet)
-    if newSetType ~= "table" then
-        error("The copied Set was not a table.")
+    if not isTable(nil, newSet) then
+        error("The copied Set had a type of: " .. __TS__TypeOf(newSet))
     end
     if not isTSTLSet(nil, newSet) then
         error("The copied Set was not a Map.")
@@ -234,9 +232,8 @@ function copiedMapHasChildMap(self)
     if newChildMap == nil then
         error("The copied Map did not have a child map at key: " .. keyToLookFor)
     end
-    local newChildMapType = type(newChildMap)
-    if newChildMapType ~= "table" then
-        error("The copied child Map had a type of: " .. newChildMapType)
+    if not isTable(nil, newChildMap) then
+        error("The copied child Map had a type of: " .. __TS__TypeOf(newChildMap))
     end
     if not isTSTLMap(nil, newChildMap) then
         error("The copied child Map was not a Map.")
@@ -268,9 +265,8 @@ function copiedDefaultMapHasChildDefaultMap(self)
     if newChildMap == nil then
         error("The copied DefaultMap did not have a child map at key: " .. parentMapKey)
     end
-    local newChildMapType = type(newChildMap)
-    if newChildMapType ~= "table" then
-        error("The copied child DefaultMap had a type of: " .. newChildMapType)
+    if not isTable(nil, newChildMap) then
+        error("The copied child DefaultMap had a type of: " .. __TS__TypeOf(newChildMap))
     end
     if not isDefaultMap(nil, newChildMap) then
         error("The copied child DefaultMap was not a DefaultMap.")

package/functions/entity.d.ts

@@ -65,8 +65,11 @@ export declare function getEntities(entityType?: EntityType, variant?: number, s
 /**
  * Helper function to get all the fields on an entity. For example, this is useful for comparing it
  * to another entity later.
+ *
+ * This function will only get fields that are equal to booleans, numbers, or strings, as comparing
+ * other types is non-trivial.
  */
-export declare function getEntityFields(entity: Entity): LuaTable<string, unknown>;
+export declare function getEntityFields(entity: Entity): LuaTable<string, boolean | number | string>;
 /** Helper function to return a string containing the entity's type, variant, and sub-type. */
 export declare function getEntityID(entity: Entity): string;
 /**

package/functions/entity.lua

@@ -4,6 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__StringSplit = ____lualib.__TS__StringSplit
 local ____exports = {}
+local setPrimitiveEntityFields
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("constants")
@@ -16,8 +17,21 @@ local ____random = require("functions.random")
 local getRandom = ____random.getRandom
 local ____rng = require("functions.rng")
 local newRNG = ____rng.newRNG
-local ____utils = require("functions.utils")
-local isPrimitive = ____utils.isPrimitive
+local ____types = require("functions.types")
+local isPrimitive = ____types.isPrimitive
+function setPrimitiveEntityFields(self, entity, metatable, entityFields)
+    local propGetTable = metatable.__propget
+    if propGetTable == nil then
+        error("Failed to get the \"__propget\" table for an entity.")
+    end
+    for key in pairs(propGetTable) do
+        local indexKey = key
+        local value = entity[indexKey]
+        if isPrimitive(nil, value) then
+            entityFields[indexKey] = value
+        end
+    end
+end
 --- Helper function to remove all of the entities in the supplied array.
 -- 
 -- @param entities The array of entities to remove.
@@ -162,23 +176,16 @@ function ____exports.getEntities(self, entityType, variant, subType, ignoreFrien
 end
 --- Helper function to get all the fields on an entity. For example, this is useful for comparing it
 -- to another entity later.
+-- 
+-- This function will only get fields that are equal to booleans, numbers, or strings, as comparing
+-- other types is non-trivial.
 function ____exports.getEntityFields(self, entity)
+    local entityFields = {}
     local metatable = getmetatable(entity)
     if metatable == nil then
         error("Failed to get the metatable for an entity.")
     end
-    local propGetTable = metatable.__propget
-    if propGetTable == nil then
-        error("Failed to get the \"__propget\" table for an entity.")
-    end
-    local entityFields = {}
-    for key in pairs(propGetTable) do
-        local indexKey = key
-        local value = entity[indexKey]
-        if isPrimitive(nil, value) then
-            entityFields[indexKey] = value
-        end
-    end
+    setPrimitiveEntityFields(nil, entity, metatable, entityFields)
     local className = getIsaacAPIClassName(nil, entity)
     if className == "Entity" then
         return entityFields
@@ -187,17 +194,7 @@ function ____exports.getEntityFields(self, entity)
     if parentTable == nil then
         error("Failed to get the \"__parent\" table for an entity.")
     end
-    local parentPropGetTable = parentTable.__propget
-    if parentPropGetTable == nil then
-        error("Failed to get the parent's \"__propget\" table for an entity.")
-    end
-    for key in pairs(parentPropGetTable) do
-        local indexKey = key
-        local value = entity[indexKey]
-        if isPrimitive(nil, value) then
-            entityFields[indexKey] = value
-        end
-    end
+    setPrimitiveEntityFields(nil, entity, parentTable, entityFields)
     return entityFields
 end
 --- Helper function to return a string containing the entity's type, variant, and sub-type.

package/functions/enums.lua

@@ -6,6 +6,8 @@ local ____array = require("functions.array")
 local getRandomArrayElement = ____array.getRandomArrayElement
 local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
+local ____types = require("functions.types")
+local isString = ____types.isString
 --- TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
 -- when you iterate over them, you will get both the names of the enums and the values of the enums,
 -- in a random order. Use this helper function to get the entries of the enum with the reverse
@@ -24,7 +26,7 @@ local getRandomSeed = ____rng.getRandomSeed
 function ____exports.getEnumEntries(self, transpiledEnum)
     local enumEntries = {}
     for key, value in pairs(transpiledEnum) do
-        if type(key) == "string" then
+        if isString(nil, key) then
             enumEntries[#enumEntries + 1] = {key, value}
         end
     end

package/functions/gridEntity.d.ts

@@ -85,7 +85,7 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  *
  * @returns True if one or more grid entities were removed, false otherwise.
  */
-export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]): boolean;
+export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]): GridEntity[];
 /**
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.
@@ -100,9 +100,9 @@ export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]
  * );
  * ```
  *
- * @returns True if one or more grid entities were removed, false otherwise.
+ * @returns An array of the grid entities removed.
  */
-export declare function removeAllMatchingGridEntities(...gridEntityType: GridEntityType[]): boolean;
+export declare function removeAllMatchingGridEntities(...gridEntityType: GridEntityType[]): GridEntity[];
 /**
  * Helper function to remove a grid entity simply by providing the grid entity object.
  *

package/functions/gridEntity.lua

@@ -282,18 +282,18 @@ function ____exports.removeAllGridExcept(self, ...)
     local gridEntityTypes = {...}
     local gridEntityTypeExceptions = __TS__New(Set, gridEntityTypes)
     local gridEntities = ____exports.getGridEntities(nil)
-    local removedOneOrMoreGridEntities = false
+    local removedGridEntities = {}
     for ____, gridEntity in ipairs(gridEntities) do
         local gridEntityType = gridEntity:GetType()
         if not gridEntityTypeExceptions:has(gridEntityType) then
             ____exports.removeGrid(nil, gridEntity, false)
-            removedOneOrMoreGridEntities = true
+            removedGridEntities[#removedGridEntities + 1] = gridEntity
         end
     end
-    if removedOneOrMoreGridEntities then
+    if #removedGridEntities > 0 then
         roomUpdateSafe(nil)
     end
-    return removedOneOrMoreGridEntities
+    return removedGridEntities
 end
 --- Helper function to remove all of the grid entities in the room that match the grid entity types
 -- provided.
@@ -308,17 +308,17 @@ end
 -- );
 -- ```
 -- 
--- @returns True if one or more grid entities were removed, false otherwise.
+-- @returns An array of the grid entities removed.
 function ____exports.removeAllMatchingGridEntities(self, ...)
     local gridEntities = ____exports.getGridEntities(nil, ...)
     if #gridEntities == 0 then
-        return false
+        return {}
     end
     for ____, gridEntity in ipairs(gridEntities) do
         ____exports.removeGrid(nil, gridEntity, false)
     end
     roomUpdateSafe(nil)
-    return true
+    return gridEntities
 end
 --- Helper function to make a grid entity invisible. This is accomplished by setting its sprite to an
 -- empty/missing PNG file.

package/functions/isaacAPIClass.lua

@@ -1,6 +1,9 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
+local ____types = require("functions.types")
+local isString = ____types.isString
+local isUserdata = ____types.isUserdata
 --- Helper function to get the name of a class from the Isaac API. This is contained within the
 -- "__type" metatable key.
 -- 
@@ -9,8 +12,7 @@ local ____exports = {}
 -- Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
 -- not exist.
 function ____exports.getIsaacAPIClassName(self, object)
-    local objectType = type(object)
-    if objectType ~= "userdata" then
+    if not isUserdata(nil, object) then
         return nil
     end
     local metatable = getmetatable(object)
@@ -18,7 +20,7 @@ function ____exports.getIsaacAPIClassName(self, object)
         return nil
     end
     local classType = metatable.__type
-    if type(classType) ~= "string" then
+    if not isString(nil, classType) then
         return nil
     end
     return classType

package/functions/jsonHelpers.d.ts

@@ -15,4 +15,4 @@ export declare function jsonDecode(jsonString: string): LuaTable<AnyNotNil, unkn
  * fails, it will throw an error to prevent writing a blank string or corrupted data to a user's
  * "save#.dat" file.
  */
-export declare function jsonEncode(table: unknown): string;
+export declare function jsonEncode(luaTable: unknown): string;

package/functions/jsonHelpers.lua

@@ -5,8 +5,8 @@ local logError = ____log.logError
 local function tryDecode(jsonString)
     return json.decode(jsonString)
 end
-local function tryEncode(____table)
-    return json.encode(____table)
+local function tryEncode(luaTable)
+    return json.encode(luaTable)
 end
 --- Converts a JSON string to a Lua table.
 -- 
@@ -27,8 +27,8 @@ end
 -- In most cases, this function will be used for writing data to a "save#.dat" file. If encoding
 -- fails, it will throw an error to prevent writing a blank string or corrupted data to a user's
 -- "save#.dat" file.
-function ____exports.jsonEncode(self, ____table)
-    local ok, jsonStringOrErrMsg = pcall(tryEncode, ____table)
+function ____exports.jsonEncode(self, luaTable)
+    local ok, jsonStringOrErrMsg = pcall(tryEncode, luaTable)
     if not ok then
         error("Failed to convert the Lua table to JSON: " .. jsonStringOrErrMsg)
     end

package/functions/kColor.lua

@@ -11,6 +11,8 @@ local ____table = require("functions.table")
 local copyValuesToTable = ____table.copyValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
+local ____types = require("functions.types")
+local isTable = ____types.isTable
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 --- Helper function to check if something is an instantiated KColor object.
@@ -54,8 +56,7 @@ function ____exports.copyKColor(self, kColor, serializationType)
         ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
         if ____cond3 then
             do
-                local kColorType = type(kColor)
-                if ____exports.isKColor(nil, kColor) or kColorType ~= "table" then
+                if not isTable(nil, kColor) then
                     error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
                 end
                 local r, g, b, a = table.unpack(getNumbersFromTable(
@@ -93,16 +94,14 @@ end
 --- Used to determine is the given table is a serialized `KColor` object created by the save data
 -- manager and/or the `deepCopy` function.
 function ____exports.isSerializedKColor(self, object)
-    local objectType = type(object)
-    if objectType ~= "table" then
+    if not isTable(nil, object) then
         return false
     end
-    local ____table = object
     return tableHasKeys(
         nil,
-        ____table,
+        object,
         table.unpack(KEYS)
-    ) and ____table[SerializationBrand.K_COLOR] ~= nil
+    ) and object[SerializationBrand.K_COLOR] ~= nil
 end
 function ____exports.kColorEquals(self, kColor1, kColor2)
     return isaacAPIClassEquals(nil, kColor1, kColor2, KEYS)

package/functions/log.d.ts

@@ -59,12 +59,19 @@ export declare function logSeedEffects(this: void): void;
 export declare function logSet(this: void, set: Set<AnyNotNil>): void;
 /** Helper function for logging every sound effect that is currently playing. */
 export declare function logSounds(this: void): void;
-export declare function logTable(this: void, table: unknown, parentTables?: number): void;
+/**
+ * Helper function for logging every key and value of a table. This is a deep log; the function will
+ * recursively call itself if it counters a table within a table.
+ *
+ * This function will only work on tables that have string keys (because it logs the keys in order,
+ * instead of randomly). It will throw a runtime error if it encounters a non-string key.
+ */
+export declare function logTable(this: void, luaTable: unknown, parentTables?: number): void;
 /**
  * Helper function to print out the differences between the entries of two tables. Note that this
  * will only do a shallow comparison.
  */
-export declare function logTableDifferences<K, V>(table1: LuaTable<K, V>, table2: LuaTable<K, V>): void;
+export declare function logTableDifferences<K, V>(this: void, table1: LuaTable<K, V>, table2: LuaTable<K, V>): void;
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(this: void, flags: TearFlag | BitFlags<TearFlag>): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */

package/functions/log.lua

@@ -5,6 +5,7 @@ local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local Map = ____lualib.Map
 local __TS__Spread = ____lualib.__TS__Spread
 local __TS__ArraySort = ____lualib.__TS__ArraySort
+local __TS__TypeOf = ____lualib.__TS__TypeOf
 local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -49,8 +50,13 @@ local getRoomListIndex = ____roomData.getRoomListIndex
 local ____set = require("functions.set")
 local combineSets = ____set.combineSets
 local getSortedSetValues = ____set.getSortedSetValues
+local ____table = require("functions.table")
+local iterateTableInOrder = ____table.iterateTableInOrder
 local ____trinkets = require("functions.trinkets")
 local getTrinketName = ____trinkets.getTrinketName
+local ____types = require("functions.types")
+local isTable = ____types.isTable
+local isUserdata = ____types.isUserdata
 local ____utils = require("functions.utils")
 local printConsole = ____utils.printConsole
 local ____vector = require("functions.vector")
@@ -447,7 +453,12 @@ function ____exports.logSounds()
         end
     end
 end
-function ____exports.logTable(____table, parentTables)
+--- Helper function for logging every key and value of a table. This is a deep log; the function will
+-- recursively call itself if it counters a table within a table.
+-- 
+-- This function will only work on tables that have string keys (because it logs the keys in order,
+-- instead of randomly). It will throw a runtime error if it encounters a non-string key.
+function ____exports.logTable(luaTable, parentTables)
     if parentTables == nil then
         parentTables = 0
     end
@@ -459,31 +470,29 @@ function ____exports.logTable(____table, parentTables)
         " ",
         math.floor(numSpaces)
     )
-    local tableType = type(____table)
-    if tableType ~= "table" then
-        ____exports.log(((indentation .. "n/a (encountered a variable of type \"") .. tableType) .. "\" instead of a table)")
+    if not isTable(nil, luaTable) then
+        ____exports.log(((indentation .. "n/a (encountered a variable of type \"") .. __TS__TypeOf(luaTable)) .. "\" instead of a table)")
         return
     end
-    local luaTable = ____table
-    local keys = __TS__ObjectKeys(luaTable)
-    __TS__ArraySort(keys)
-    for ____, key in ipairs(keys) do
-        local value = luaTable[key]
-        ____exports.log(((indentation .. key) .. " --> ") .. tostring(value))
-        local valueType = type(value)
-        if valueType == "table" then
-            if key == "__class" then
-                ____exports.log(indentation .. "(skipping enumerating this key to avoid infinite recursion)")
-            else
-                ____exports.logTable(value, parentTables + 1)
+    iterateTableInOrder(
+        nil,
+        luaTable,
+        function(____, key, value)
+            ____exports.log(((indentation .. tostring(key)) .. " --> ") .. tostring(value))
+            if isTable(nil, value) then
+                if key == "__class" then
+                    ____exports.log(indentation .. "  (skipping enumerating this key to avoid infinite recursion)")
+                else
+                    ____exports.logTable(value, parentTables + 1)
+                end
             end
         end
-    end
-    ____exports.log((indentation .. "The size of the table was: ") .. tostring(#keys))
+    )
+    ____exports.log((indentation .. "The size of the table was: ") .. tostring(#luaTable))
 end
 --- Helper function to print out the differences between the entries of two tables. Note that this
 -- will only do a shallow comparison.
-function ____exports.logTableDifferences(self, table1, table2)
+function ____exports.logTableDifferences(table1, table2)
     ____exports.log("Comparing two Lua tables:")
     local table1Keys = __TS__ObjectKeys(table1)
     local table1KeysSet = __TS__New(Set, table1Keys)
@@ -517,8 +526,7 @@ end
 --- Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
 -- the Isaac API).
 function ____exports.logUserdata(userdata)
-    local userdataType = type(userdata)
-    if userdataType ~= "userdata" then
+    if isUserdata(nil, userdata) then
         ____exports.log("Userdata: [not userdata]")
         return
     end
@@ -569,6 +577,7 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logSet = ____exports.logSet
     globals.logSounds = ____exports.logSounds
     globals.logTable = ____exports.logTable
+    globals.logTableDifferences = ____exports.logTableDifferences
     globals.logTearFlags = ____exports.logTearFlags
     globals.logUseFlags = ____exports.logUseFlags
     globals.logUserdata = ____exports.logUserdata