isaacscript-common 1.2.214 → 1.2.217

package/dist/features/extraConsoleCommands/commands.lua

@@ -19,12 +19,12 @@ local getCharacterName = ____character.getCharacterName
 local ____gridEntity = require("functions.gridEntity")
 local spawnGridEntityWithVariant = ____gridEntity.spawnGridEntityWithVariant
 local ____log = require("functions.log")
+local logEffects = ____log.logEffects
 local logEntities = ____log.logEntities
 local logGridEntities = ____log.logGridEntities
 local logRoom = ____log.logRoom
 local logSeedEffects = ____log.logSeedEffects
 local logSounds = ____log.logSounds
-local logTemporaryEffects = ____log.logTemporaryEffects
 local ____map = require("functions.map")
 local getMapPartialMatch = ____map.getMapPartialMatch
 local ____npc = require("functions.npc")
@@ -487,7 +487,7 @@ function ____exports.dungeon(self)
 end
 function ____exports.effects(self)
     local player = Isaac.GetPlayer()
-    logTemporaryEffects(player)
+    logEffects(player)
     printConsole(nil, "Logged the player's effects to the \"log.txt\" file.")
 end
 function ____exports.eh(self, params)

package/dist/functions/color.lua

@@ -8,9 +8,10 @@ local SerializationType = ____SerializationType.SerializationType
 local ____table = require("functions.table")
 local copyValuesToTable = ____table.copyValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
+local ____userdata = require("functions.userdata")
+local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
-local isUserdataObject = ____utils.isUserdataObject
 function ____exports.isColor(self, object)
     return isUserdataObject(nil, object, OBJECT_NAME)
 end

package/dist/functions/log.d.ts

@@ -14,11 +14,12 @@ export declare function logArray<T>(this: void, array: T[]): void;
 export declare function logColor(this: void, color: Color): void;
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
 export declare function logDamageFlags(this: void, flags: int): void;
+export declare function logEffects(this: void, player: EntityPlayer): 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
@@ -56,9 +57,13 @@ export declare function logSounds(this: void): void;
 export declare function logTable(this: void, table: unknown, parentTables?: number): void;
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 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

@@ -35,6 +35,8 @@ local ____set = require("functions.set")
 local getSortedSetValues = ____set.getSortedSetValues
 local ____trinkets = require("functions.trinkets")
 local getTrinketName = ____trinkets.getTrinketName
+local ____userdata = require("functions.userdata")
+local getUserdataType = ____userdata.getUserdataType
 local ____utils = require("functions.utils")
 local printConsole = ____utils.printConsole
 function ____exports.getDebugPrependString(self, msg, numParentFunctions)
@@ -78,14 +80,14 @@ function ____exports.logFlags(flags, flagEnum, description)
     for key, value in pairs(flagEnum) do
         do
             if type(value) ~= "number" then
-                goto __continue35
+                goto __continue42
             end
             if hasFlag(nil, flags, value) then
                 ____exports.log(((("  Has flag: " .. tostring(key)) .. " (") .. tostring(value)) .. ")")
                 hasNoFlags = false
             end
         end
-        ::__continue35::
+        ::__continue42::
     end
     if hasNoFlags then
         ____exports.log("  n/a (no flags)")
@@ -112,6 +114,30 @@ end
 function ____exports.logDamageFlags(flags)
     ____exports.logFlags(flags, DamageFlag, "damage")
 end
+function ____exports.logEffects(player)
+    local effects = getEffectsList(nil, player)
+    ____exports.log("Logging player effects:")
+    if #effects == 0 then
+        ____exports.log("  n/a (no effects)")
+        return
+    end
+    __TS__ArrayForEach(
+        effects,
+        function(____, effect, i)
+            if effect.Item:IsCollectible() then
+                local collectibleName = getCollectibleName(nil, effect.Item.ID)
+                ____exports.log((("  " .. tostring(i + 1)) .. ") Collectible: ") .. collectibleName)
+            elseif effect.Item:IsTrinket() then
+                local trinketName = getTrinketName(nil, effect.Item.ID)
+                ____exports.log((("  " .. tostring(i + 1)) .. ") Trinket: ") .. trinketName)
+            elseif effect.Item:IsNull() then
+                ____exports.log((("  " .. tostring(i + 1)) .. ") Null item: ") .. tostring(effect.Item.ID))
+            else
+                ____exports.log((("  " .. tostring(i + 1)) .. ") Unknown type of effect: ") .. tostring(effect.Item.ID))
+            end
+        end
+    )
+end
 function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
     local headerMsg = "Entities in the room"
     if entityTypeFilter ~= nil then
@@ -190,12 +216,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 +405,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
@@ -388,33 +418,28 @@ end
 function ____exports.logTearFlags(flags)
     ____exports.logFlags(flags, TearFlags, "tear")
 end
-function ____exports.logTemporaryEffects(player)
-    local effects = getEffectsList(nil, player)
-    ____exports.log("Logging player temporary effects:")
-    if #effects == 0 then
-        ____exports.log("  n/a (no temporary effects)")
-        return
-    end
-    __TS__ArrayForEach(
-        effects,
-        function(____, effect, i)
-            if effect.Item:IsCollectible() then
-                local collectibleName = getCollectibleName(nil, effect.Item.ID)
-                ____exports.log((("  " .. tostring(i + 1)) .. ") ") .. collectibleName)
-            elseif effect.Item:IsTrinket() then
-                local trinketName = getTrinketName(nil, effect.Item.ID)
-                ____exports.log((("  " .. tostring(i + 1)) .. ") ") .. trinketName)
-            elseif effect.Item:IsNull() then
-                ____exports.log((("  " .. tostring(i + 1)) .. ") Null item: ") .. tostring(effect.Item.ID))
-            else
-                ____exports.log((("  " .. tostring(i + 1)) .. ") Unknown type of temporary effect: ") .. tostring(effect.Item.ID))
-            end
-        end
-    )
-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
+    local classType = getUserdataType(nil, userdata)
+    if classType == nil then
+        ____exports.log("Userdata: [no class type]")
+    else
+        ____exports.log("Userdata: " .. classType)
+    end
+    ____exports.logTable(metatable)
+end
 function ____exports.logVector(vector)
     ____exports.log(((("Vector: (" .. tostring(vector.X)) .. ", ") .. tostring(vector.Y)) .. ")")
 end
@@ -424,8 +449,9 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logArray = ____exports.logArray
     globals.logColor = ____exports.logColor
     globals.logDamageFlags = ____exports.logDamageFlags
+    globals.logEffects = ____exports.logEffects
     globals.logEntities = ____exports.logEntities
-    globals.logEntity = ____exports.logEntity
+    globals.logEntityID = ____exports.logEntityID
     globals.logEntityFlags = ____exports.logEntityFlags
     globals.logError = ____exports.logError
     globals.logFlags = ____exports.logFlags
@@ -441,8 +467,8 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logSounds = ____exports.logSounds
     globals.logTable = ____exports.logTable
     globals.logTearFlags = ____exports.logTearFlags
-    globals.logTemporaryEffects = ____exports.logTemporaryEffects
     globals.logUseFlags = ____exports.logUseFlags
+    globals.logUserdata = ____exports.logUserdata
     globals.logVector = ____exports.logVector
 end
 return ____exports

package/dist/functions/rng.lua

@@ -11,9 +11,10 @@ local SerializationType = ____SerializationType.SerializationType
 local ____table = require("functions.table")
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
+local ____userdata = require("functions.userdata")
+local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
-local isUserdataObject = ____utils.isUserdataObject
 function ____exports.getRandomSeed(self)
     local randomNumber = Random()
     local safeRandomNumber = randomNumber == 0 and 1 or randomNumber

package/dist/functions/userdata.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Helper function to get the type of a userdata object from the Isaac API. This is contained within
+ * the "__type" metatable key.
+ *
+ * For example, a `Vector` class is userdata with a type of "Vector".
+ */
+export declare function getUserdataType(object: unknown): string | undefined;
+/**
+ * Helper function to check if something is an instantiated class from the Isaac API. (All classes
+ * from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type".)
+ */
+export declare function isUserdataObject(object: unknown, objectType: string): boolean;

package/dist/functions/userdata.lua

@@ -0,0 +1,18 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+function ____exports.getUserdataType(self, object)
+    local objectType = type(object)
+    if objectType ~= "userdata" then
+        return nil
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return nil
+    end
+    return metatable.__type
+end
+function ____exports.isUserdataObject(self, object, objectType)
+    local userdataType = ____exports.getUserdataType(nil, object)
+    return userdataType == objectType or userdataType == "const " .. objectType
+end
+return ____exports

package/dist/functions/utils.d.ts

@@ -93,11 +93,6 @@ export declare function hexToKColor(hexString: string, alpha: float): KColor;
  * is enabled or not.
  */
 export declare function isLuaDebugEnabled(): boolean;
-/**
- * Helper function to check if the something is an instantiated class from the Isaac API. (All
- * classes from the Isaac API have a type of "userdata" in Lua.)
- */
-export declare function isUserdataObject(object: unknown, objectName: string): boolean;
 /**
  * Helper function to print something to the in-game console. Use this instead of invoking the
  * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end

package/dist/functions/utils.lua

@@ -66,18 +66,6 @@ end
 function ____exports.isLuaDebugEnabled(self)
     return package ~= nil
 end
-function ____exports.isUserdataObject(self, object, objectName)
-    local objectType = type(object)
-    if objectType ~= "userdata" then
-        return false
-    end
-    local metatable = getmetatable(object)
-    if metatable == nil then
-        return false
-    end
-    local vectorMetatable = metatable
-    return vectorMetatable.__type == objectName
-end
 function ____exports.printConsole(self, msg)
     Isaac.ConsoleOutput(msg .. "\n")
 end

package/dist/functions/vector.lua

@@ -11,9 +11,10 @@ local ____table = require("functions.table")
 local copyValuesToTable = ____table.copyValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
+local ____userdata = require("functions.userdata")
+local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
-local isUserdataObject = ____utils.isUserdataObject
 function ____exports.isVector(self, object)
     return isUserdataObject(nil, object, OBJECT_NAME)
 end

package/dist/index.d.ts

@@ -88,6 +88,7 @@ export * from "./functions/trinketGive";
 export * from "./functions/trinkets";
 export * from "./functions/trinketSet";
 export * from "./functions/ui";
+export * from "./functions/userdata";
 export * from "./functions/utils";
 export * from "./functions/vector";
 export * from "./maps/cardMap";

package/dist/index.lua

@@ -704,6 +704,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.userdata")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.utils")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

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