isaacscript-common 1.2.214 → 1.2.215

package/dist/functions/log.d.ts

@@ -16,9 +16,9 @@ export declare function logColor(this: void, color: Color): void;
 export declare function logDamageFlags(this: void, flags: int): void;
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
 export declare function logEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType | int): void;
-export declare function logEntity(this: void, entity: Entity): void;
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
 export declare function logEntityFlags(this: void, flags: int): void;
+export declare function logEntityID(this: void, entity: Entity): void;
 /**
  * Helper function to log an error message and also print it to the console for better visibility.
  * This is useful in combination with an early return when invoking the `error` function would be
@@ -59,6 +59,11 @@ export declare function logTearFlags(this: void, flags: int): void;
 export declare function logTemporaryEffects(this: void, player: EntityPlayer): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
 export declare function logUseFlags(this: void, flags: int): void;
+/**
+ * Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
+ * the Isaac API).
+ */
+export declare function logUserdata(this: void, userdata: unknown): void;
 export declare function logVector(this: void, vector: Vector): void;
 /**
  * Converts every `isaacscript-common` function that begins with "log" to a global function.

package/dist/functions/log.lua

@@ -190,12 +190,12 @@ function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
         ____exports.log(("(" .. tostring(numMatchedEntities)) .. " total entities)")
     end
 end
-function ____exports.logEntity(entity)
-    ____exports.log((((("Entity: " .. tostring(entity.Type)) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType))
-end
 function ____exports.logEntityFlags(flags)
     ____exports.logFlags(flags, EntityFlag, "entity")
 end
+function ____exports.logEntityID(entity)
+    ____exports.log((((("Entity: " .. tostring(entity.Type)) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType))
+end
 function ____exports.logError(msg)
     local errorMsg = "Error: " .. msg
     ____exports.log(errorMsg)
@@ -379,7 +379,11 @@ function ____exports.logTable(____table, parentTables)
         ____exports.log((((indentation .. "Key: ") .. tostring(key)) .. ", Value: ") .. tostring(value))
         local valueType = type(value)
         if valueType == "table" then
-            ____exports.logTable(value, parentTables + 1)
+            if key == "__class" then
+                ____exports.log(indentation .. "(skipping enumerating this key to avoid infinite recursion)")
+            else
+                ____exports.logTable(value, parentTables + 1)
+            end
         end
         numKeys = numKeys + 1
     end
@@ -415,6 +419,20 @@ end
 function ____exports.logUseFlags(flags)
     ____exports.logFlags(flags, UseFlag, "use")
 end
+function ____exports.logUserdata(userdata)
+    local userdataType = type(userdata)
+    if userdataType ~= "userdata" then
+        ____exports.log("Userdata: [not userdata]")
+        return
+    end
+    local metatable = getmetatable(userdata)
+    if metatable == nil then
+        ____exports.log("Userdata: [no metatable]")
+        return
+    end
+    ____exports.log("Userdata: " .. metatable.__type)
+    ____exports.logTable(metatable)
+end
 function ____exports.logVector(vector)
     ____exports.log(((("Vector: (" .. tostring(vector.X)) .. ", ") .. tostring(vector.Y)) .. ")")
 end
@@ -425,7 +443,7 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logColor = ____exports.logColor
     globals.logDamageFlags = ____exports.logDamageFlags
     globals.logEntities = ____exports.logEntities
-    globals.logEntity = ____exports.logEntity
+    globals.logEntityID = ____exports.logEntityID
     globals.logEntityFlags = ____exports.logEntityFlags
     globals.logError = ____exports.logError
     globals.logFlags = ____exports.logFlags
@@ -443,6 +461,7 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logTearFlags = ____exports.logTearFlags
     globals.logTemporaryEffects = ____exports.logTemporaryEffects
     globals.logUseFlags = ____exports.logUseFlags
+    globals.logUserdata = ____exports.logUserdata
     globals.logVector = ____exports.logVector
 end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.214",
+  "version": "1.2.215",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",