isaacscript-common 6.6.1-dev.2 → 6.6.1

package/dist/functions/log.lua

@@ -0,0 +1,593 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+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")
+local DamageFlag = ____isaac_2Dtypescript_2Ddefinitions.DamageFlag
+local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local GameStateFlag = ____isaac_2Dtypescript_2Ddefinitions.GameStateFlag
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
+local LevelStateFlag = ____isaac_2Dtypescript_2Ddefinitions.LevelStateFlag
+local ProjectileFlag = ____isaac_2Dtypescript_2Ddefinitions.ProjectileFlag
+local SeedEffect = ____isaac_2Dtypescript_2Ddefinitions.SeedEffect
+local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
+local TearFlag = ____isaac_2Dtypescript_2Ddefinitions.TearFlag
+local UseFlag = ____isaac_2Dtypescript_2Ddefinitions.UseFlag
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local sfxManager = ____cachedClasses.sfxManager
+local ____array = require("functions.array")
+local arrayToString = ____array.arrayToString
+local ____collectibles = require("functions.collectibles")
+local getCollectibleName = ____collectibles.getCollectibleName
+local ____entity = require("functions.entity")
+local getEntities = ____entity.getEntities
+local getEntityID = ____entity.getEntityID
+local ____enums = require("functions.enums")
+local getEnumEntries = ____enums.getEnumEntries
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____gridEntity = require("functions.gridEntity")
+local getGridEntities = ____gridEntity.getGridEntities
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
+local ____player = require("functions.player")
+local getEffectsList = ____player.getEffectsList
+local getPlayerName = ____player.getPlayerName
+local ____playerHealth = require("functions.playerHealth")
+local getPlayerHealth = ____playerHealth.getPlayerHealth
+local ____roomData = require("functions.roomData")
+local getRoomData = ____roomData.getRoomData
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+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")
+local vectorToString = ____vector.vectorToString
+--- Helper function to prefix the name of the function and the line number before a debug message.
+function ____exports.getDebugPrependString(self, msg, numParentFunctions)
+    if numParentFunctions == nil then
+        numParentFunctions = 3
+    end
+    if debug ~= nil then
+        local debugTable = debug.getinfo(numParentFunctions)
+        if debugTable ~= nil then
+            return (((tostring(debugTable.name) .. ":") .. tostring(debugTable.linedefined)) .. " - ") .. msg
+        end
+    end
+    if getParentFunctionDescription ~= nil then
+        return (tostring(getParentFunctionDescription(numParentFunctions + 1)) .. " - ") .. msg
+    end
+    return msg
+end
+--- 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.
+function ____exports.log(msg)
+    local debugMsg = ____exports.getDebugPrependString(nil, msg)
+    Isaac.DebugString(debugMsg)
+end
+--- Helper function for printing out every flag that is turned on. Useful when debugging.
+function ____exports.logFlags(flags, flagEnum, description)
+    if description == nil then
+        description = ""
+    end
+    if description ~= "" then
+        description = "flag"
+    end
+    ____exports.log((("Logging " .. description) .. " values for: ") .. tostring(flags))
+    local hasNoFlags = true
+    for ____, ____value in ipairs(getEnumEntries(nil, flagEnum)) do
+        local key = ____value[1]
+        local value = ____value[2]
+        if hasFlag(nil, flags, value) then
+            ____exports.log(((("  Has flag: " .. key) .. " (") .. tostring(value)) .. ")")
+            hasNoFlags = false
+        end
+    end
+    if hasNoFlags then
+        ____exports.log("  n/a (no flags)")
+    end
+end
+local IGNORE_EFFECT_VARIANTS = __TS__New(Set, {
+    EffectVariant.BLOOD_EXPLOSION,
+    EffectVariant.BLOOD_PARTICLE,
+    EffectVariant.TINY_BUG,
+    EffectVariant.TINY_FLY,
+    EffectVariant.WATER_DROPLET,
+    EffectVariant.WALL_BUG,
+    EffectVariant.FALLING_EMBER,
+    EffectVariant.LIGHT,
+    EffectVariant.TADPOLE
+})
+function ____exports.logArray(array)
+    local arrayString = arrayToString(nil, array)
+    ____exports.log("Array: " .. arrayString)
+end
+function ____exports.logColor(color)
+    ____exports.log((((((((((((("Color: R" .. tostring(color.R)) .. ", G") .. tostring(color.G)) .. ", B") .. tostring(color.B)) .. ", A") .. tostring(color.A)) .. ", RO") .. tostring(color.RO)) .. ", BO") .. tostring(color.BO)) .. ", GO") .. tostring(color.GO))
+end
+--- Helper function for printing out every damage flag that is turned on. Useful when debugging.
+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)
+            local effectDescription
+            if effect.Item:IsCollectible() then
+                local collectibleName = getCollectibleName(nil, effect.Item.ID)
+                effectDescription = "Collectible: " .. collectibleName
+            elseif effect.Item:IsTrinket() then
+                local trinketName = getTrinketName(nil, effect.Item.ID)
+                effectDescription = "Trinket: " .. trinketName
+            elseif effect.Item:IsNull() then
+                effectDescription = "Null item: " .. tostring(effect.Item.ID)
+            else
+                effectDescription = "Unknown type of effect: " .. tostring(effect.Item.ID)
+            end
+            ____exports.log(((((("  " .. tostring(i + 1)) .. ") ") .. effectDescription) .. " (x") .. tostring(effect.Count)) .. ")")
+        end
+    )
+end
+--- Helper function for printing out every entity (or filtered entity) in the current room.
+function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
+    local msg = "Entities in the room"
+    if entityTypeFilter ~= nil then
+        msg = msg .. (" (filtered to entity type " .. tostring(entityTypeFilter)) .. ")"
+    elseif not includeBackgroundEffects then
+        msg = msg .. " (not including background effects)"
+    end
+    msg = msg .. ":\n"
+    local entities = getEntities(nil)
+    local numMatchedEntities = 0
+    __TS__ArrayForEach(
+        entities,
+        function(____, entity, i)
+            if entityTypeFilter ~= nil and entity.Type ~= entityTypeFilter then
+                return
+            end
+            local effect = entity:ToEffect()
+            if not includeBackgroundEffects and effect ~= nil and IGNORE_EFFECT_VARIANTS:has(effect.Variant) then
+                return
+            end
+            local entityID = getEntityID(nil, entity)
+            msg = msg .. (tostring(i + 1) .. ") ") .. entityID
+            local bomb = entity:ToBomb()
+            if bomb ~= nil then
+                msg = msg .. " (bomb)"
+            end
+            if effect ~= nil then
+                msg = msg .. (" (effect) (State: " .. tostring(effect.State)) .. ")"
+            end
+            local familiar = entity:ToFamiliar()
+            if familiar ~= nil then
+                msg = msg .. (" (familiar) (State: " .. tostring(familiar.State)) .. ")"
+            end
+            local knife = entity:ToKnife()
+            if knife ~= nil then
+                msg = msg .. " (knife)"
+            end
+            local laser = entity:ToLaser()
+            if laser ~= nil then
+                msg = msg .. " (laser)"
+            end
+            local npc = entity:ToNPC()
+            if npc ~= nil then
+                msg = msg .. (" (NPC) (State: " .. tostring(npc.State)) .. ")"
+            end
+            local pickup = entity:ToPickup()
+            if pickup ~= nil then
+                msg = msg .. (" (pickup) (State: " .. tostring(pickup.State)) .. ")"
+            end
+            local player = entity:ToPlayer()
+            if player ~= nil then
+                msg = msg .. " (player)"
+            end
+            local projectile = entity:ToProjectile()
+            if projectile ~= nil then
+                msg = msg .. " (projectile)"
+            end
+            local tear = entity:ToTear()
+            if tear ~= nil then
+                msg = msg .. " (tear)"
+            end
+            msg = msg .. "\n"
+            msg = msg .. ("  - Index: " .. tostring(entity.Index)) .. "\n"
+            msg = msg .. ("  - InitSeed: " .. tostring(entity.InitSeed)) .. "\n"
+            msg = msg .. ("  - DropSeed: " .. tostring(entity.DropSeed)) .. "\n"
+            msg = msg .. ((("  - Position: (" .. tostring(entity.Position.X)) .. ", ") .. tostring(entity.Position.Y)) .. ")\n"
+            msg = msg .. ((("  - Velocity: (" .. tostring(entity.Velocity.X)) .. ", ") .. tostring(entity.Velocity.Y)) .. ")\n"
+            msg = msg .. ((("  - HP: " .. tostring(entity.HitPoints)) .. " / ") .. tostring(entity.MaxHitPoints)) .. "\n"
+            msg = msg .. ("  - Parent: " .. tostring(entity.Parent)) .. "\n"
+            msg = msg .. ("  - Child: " .. tostring(entity.Child)) .. "\n"
+            msg = msg .. ("  - SpawnerEntity: " .. tostring(entity.SpawnerEntity)) .. "\n"
+            msg = msg .. ((("  - SpawnerType / SpawnerVariant: " .. tostring(entity.SpawnerType)) .. ".") .. tostring(entity.SpawnerVariant)) .. "\n"
+            if npc ~= nil then
+                msg = msg .. ("  - CanShutDoors: " .. tostring(npc.CanShutDoors)) .. "\n"
+            end
+            numMatchedEntities = numMatchedEntities + 1
+        end
+    )
+    if numMatchedEntities == 0 then
+        msg = msg .. "(no entities matched)\n"
+    else
+        msg = msg .. ((("(" .. tostring(numMatchedEntities)) .. " total ") .. (numMatchedEntities == 1 and "entity" or "entities")) .. ")\n"
+    end
+    ____exports.log(msg)
+end
+--- Helper function for printing out every entity flag that is turned on. Useful when debugging.
+function ____exports.logEntityFlags(flags)
+    ____exports.logFlags(flags, EntityFlag, "entity")
+end
+function ____exports.logEntityID(entity)
+    local entityID = getEntityID(nil, entity)
+    ____exports.log("Entity: " .. entityID)
+end
+--- Helper function to log an error message and also print it to the console for better visibility.
+-- 
+-- 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).
+function ____exports.logError(msg)
+    local errorMsg = "Error: " .. msg
+    ____exports.log(errorMsg)
+    printConsole(nil, errorMsg)
+end
+--- Helper function for printing out every game state flag that is turned on. Useful when debugging.
+function ____exports.logGameStateFlags()
+    ____exports.log("Logging game state flags:")
+    local gameStateFlagEntries = getEnumEntries(nil, GameStateFlag)
+    local hasNoFlags = true
+    for ____, ____value in ipairs(gameStateFlagEntries) do
+        local key = ____value[1]
+        local gameStateFlag = ____value[2]
+        local flagValue = game:GetStateFlag(gameStateFlag)
+        if flagValue then
+            ____exports.log(((("  Has flag: " .. key) .. " (") .. tostring(gameStateFlag)) .. ")")
+            hasNoFlags = false
+        end
+    end
+    if hasNoFlags then
+        ____exports.log("  n/a (no flags)")
+    end
+end
+--- Helper function for printing out every grid entity (or filtered grid entity) in the current room.
+function ____exports.logGridEntities(includeWalls, gridEntityTypeFilter)
+    local msg = "Grid entities in the room"
+    if gridEntityTypeFilter ~= nil then
+        msg = msg .. (" (filtered to grid entity type " .. tostring(gridEntityTypeFilter)) .. ")"
+    elseif not includeWalls then
+        msg = msg .. " (not including walls)"
+    end
+    msg = msg .. ":\n"
+    local gridEntities = getGridEntities(nil)
+    local numMatchedEntities = 0
+    __TS__ArrayForEach(
+        gridEntities,
+        function(____, gridEntity)
+            local gridEntityIndex = gridEntity:GetGridIndex()
+            local gridEntityType = gridEntity:GetType()
+            local gridEntityVariant = gridEntity:GetVariant()
+            local gridEntityDesc = gridEntity:GetSaveState()
+            if gridEntityTypeFilter ~= nil and gridEntityType ~= gridEntityTypeFilter then
+                return
+            end
+            if not includeWalls and gridEntityType == GridEntityType.WALL and gridEntityTypeFilter ~= GridEntityType.WALL then
+                return
+            end
+            msg = msg .. (((((tostring(gridEntityIndex) .. ") ") .. tostring(gridEntityType)) .. ".") .. tostring(gridEntityVariant)) .. ".") .. tostring(gridEntity.State)
+            local door = gridEntity:ToDoor()
+            if door ~= nil then
+                msg = msg .. " (door)"
+            end
+            local pit = gridEntity:ToPit()
+            if pit ~= nil then
+                msg = msg .. " (pit)"
+            end
+            local poop = gridEntity:ToPoop()
+            if poop ~= nil then
+                msg = msg .. " (poop)"
+            end
+            local pressurePlate = gridEntity:ToPressurePlate()
+            if pressurePlate ~= nil then
+                msg = msg .. " (pressurePlate)"
+            end
+            local rock = gridEntity:ToRock()
+            if rock ~= nil then
+                msg = msg .. " (rock)"
+            end
+            local spikes = gridEntity:ToSpikes()
+            if spikes ~= nil then
+                msg = msg .. " (spikes)"
+            end
+            local tnt = gridEntity:ToTNT()
+            if tnt ~= nil then
+                msg = msg .. " (TNT)"
+            end
+            msg = msg .. ("  - VarData: " .. tostring(gridEntity.VarData)) .. "\n"
+            msg = msg .. ((("  - Position: (" .. tostring(gridEntity.Position.X)) .. ", ") .. tostring(gridEntity.Position.Y)) .. ")\n"
+            msg = msg .. ("  - SpawnSeed: " .. tostring(gridEntityDesc.SpawnSeed)) .. "\n"
+            msg = msg .. ("  - VariableSeed: " .. tostring(gridEntityDesc.VariableSeed)) .. ")\n"
+            if door ~= nil then
+                msg = msg .. ("  - Slot: " .. tostring(door.Slot)) .. "\n"
+                msg = msg .. ("  - Direction: " .. tostring(door.Direction)) .. "\n"
+                msg = msg .. ("  - TargetRoomIndex: " .. tostring(door.TargetRoomIndex)) .. "\n"
+                msg = msg .. ("  - TargetRoomType: " .. tostring(door.TargetRoomType)) .. "\n"
+            end
+            numMatchedEntities = numMatchedEntities + 1
+        end
+    )
+    if numMatchedEntities == 0 then
+        msg = msg .. "(no grid entities matched)\n"
+    else
+        msg = msg .. ((("(" .. tostring(numMatchedEntities)) .. " total grid ") .. (numMatchedEntities == 1 and "entity" or "entities")) .. ")\n"
+    end
+    ____exports.log(msg)
+end
+function ____exports.logKColor(kColor)
+    ____exports.log((((((("Color: R" .. tostring(kColor.Red)) .. ", G") .. tostring(kColor.Green)) .. ", B") .. tostring(kColor.Blue)) .. ", A") .. tostring(kColor.Alpha))
+end
+--- Helper function for printing out every level state flag that is turned on. Useful when debugging.
+function ____exports.logLevelStateFlags()
+    local level = game:GetLevel()
+    local levelStateFlagEntries = getEnumEntries(nil, LevelStateFlag)
+    ____exports.log("Logging level state flags:")
+    local hasNoFlags = true
+    for ____, ____value in ipairs(levelStateFlagEntries) do
+        local key = ____value[1]
+        local levelStateFlag = ____value[2]
+        local flagValue = level:GetStateFlag(levelStateFlag)
+        if flagValue then
+            ____exports.log(((("  Has flag: " .. key) .. " (") .. tostring(levelStateFlag)) .. ")")
+            hasNoFlags = false
+        end
+    end
+    if hasNoFlags then
+        ____exports.log("  n/a (no flags)")
+    end
+end
+function ____exports.logMap(map)
+    ____exports.log("Printing out a TSTL Map:")
+    local mapKeys = {__TS__Spread(map:keys())}
+    __TS__ArraySort(mapKeys)
+    for ____, key in ipairs(mapKeys) do
+        local value = map:get(key)
+        ____exports.log((("  " .. tostring(key)) .. " --> ") .. tostring(value))
+    end
+    ____exports.log("  The size of the map was: " .. tostring(map.size))
+end
+function ____exports.logPlayerHealth(player)
+    local playerName = getPlayerName(nil, player)
+    local playerHealth = getPlayerHealth(nil, player)
+    ____exports.log(("Player health for " .. playerName) .. ":")
+    ____exports.log("  Max hearts: " .. tostring(playerHealth.maxHearts))
+    ____exports.log("  Hearts: " .. tostring(playerHealth.hearts))
+    ____exports.log("  Eternal hearts: " .. tostring(playerHealth.eternalHearts))
+    ____exports.log("  Soul hearts: " .. tostring(playerHealth.soulHearts))
+    ____exports.log("  Bone hearts: " .. tostring(playerHealth.boneHearts))
+    ____exports.log("  Golden hearts: " .. tostring(playerHealth.goldenHearts))
+    ____exports.log("  Rotten hearts: " .. tostring(playerHealth.rottenHearts))
+    ____exports.log("  Broken hearts: " .. tostring(playerHealth.brokenHearts))
+    ____exports.log("  Soul charges: " .. tostring(playerHealth.soulCharges))
+    ____exports.log("  Blood charges: " .. tostring(playerHealth.bloodCharges))
+    ____exports.log(("  Soul heart types: [" .. table.concat(playerHealth.soulHeartTypes, ",")) .. "]")
+end
+--- Helper function for printing out every projectile flag that is turned on. Useful when debugging.
+function ____exports.logProjectileFlags(flags)
+    ____exports.logFlags(flags, ProjectileFlag, "projectile")
+end
+--- Helper function for logging information about the current room.
+function ____exports.logRoom()
+    local roomGridIndex = getRoomGridIndex(nil)
+    local roomListIndex = getRoomListIndex(nil)
+    local roomData = getRoomData(nil)
+    if roomData == nil then
+        ____exports.log("Current room data is undefined.")
+    else
+        ____exports.log("Current room stage ID: " .. tostring(roomData.StageID))
+        ____exports.log((((("Current room type/variant/sub-type: " .. tostring(roomData.Type)) .. ".") .. tostring(roomData.Variant)) .. ".") .. tostring(roomData.Subtype))
+        ____exports.log("Current room name: " .. roomData.Name)
+    end
+    local roomGridIndexName = GridRoom[roomGridIndex]
+    if roomGridIndexName == nil then
+        ____exports.log("Current room grid index: " .. tostring(roomGridIndex))
+    else
+        ____exports.log(((("Current room grid index: " .. tostring(roomGridIndex)) .. " (GridRoom.") .. roomGridIndexName) .. ")")
+    end
+    ____exports.log("Current room list index: " .. tostring(roomListIndex))
+end
+--- Helper function for printing out every seed effect (i.e. Easter Egg) that is turned on for the
+-- particular run.
+function ____exports.logSeedEffects()
+    local seeds = game:GetSeeds()
+    local seedEffectEntries = getEnumEntries(nil, SeedEffect)
+    ____exports.log("Logging seed effects:")
+    local hasNoSeedEffects = true
+    for ____, ____value in ipairs(seedEffectEntries) do
+        local key = ____value[1]
+        local seedEffect = ____value[2]
+        if seeds:HasSeedEffect(seedEffect) then
+            ____exports.log(((("  " .. key) .. " (") .. tostring(seedEffect)) .. ")")
+            hasNoSeedEffects = false
+        end
+    end
+    if hasNoSeedEffects then
+        ____exports.log("  n/a (no seed effects)")
+    end
+end
+function ____exports.logSet(set)
+    ____exports.log("Printing out a TSTL Set:")
+    local setValues = getSortedSetValues(nil, set)
+    for ____, value in ipairs(setValues) do
+        ____exports.log("  Value: " .. tostring(value))
+    end
+    ____exports.log("  The size of the set was: " .. tostring(set.size))
+end
+--- Helper function for logging every sound effect that is currently playing.
+function ____exports.logSounds()
+    local soundEffects = getEnumEntries(nil, SoundEffect)
+    for ____, ____value in ipairs(soundEffects) do
+        local key = ____value[1]
+        local soundEffect = ____value[2]
+        if sfxManager:IsPlaying(soundEffect) then
+            ____exports.log(((("Currently playing sound effect: " .. key) .. " (") .. tostring(soundEffect)) .. ")")
+        end
+    end
+end
+--- 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
+    if parentTables == 0 then
+        ____exports.log("Printing out a Lua table:")
+    end
+    local numSpaces = (parentTables + 1) * 2
+    local indentation = string.rep(
+        " ",
+        math.floor(numSpaces)
+    )
+    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
+    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
+    )
+    ____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(table1, table2)
+    ____exports.log("Comparing two Lua tables:")
+    local table1Keys = __TS__ObjectKeys(table1)
+    local table1KeysSet = __TS__New(Set, table1Keys)
+    local table2Keys = __TS__ObjectKeys(table2)
+    local table2KeysSet = __TS__New(Set, table2Keys)
+    local keysSet = combineSets(nil, table1KeysSet, table2KeysSet)
+    local keys = {__TS__Spread(keysSet:values())}
+    __TS__ArraySort(keys)
+    for ____, key in ipairs(keys) do
+        if not table1KeysSet:has(key) then
+            ____exports.log("  Table 1 is missing key: " .. key)
+        elseif not table2KeysSet:has(key) then
+            ____exports.log("  Table 2 is missing key: " .. key)
+        else
+            local value1 = table1[key]
+            local value2 = table2[key]
+            if value1 ~= value2 then
+                ____exports.log(((((("  " .. key) .. " --> \"") .. tostring(value1)) .. "\" versus \"") .. tostring(value2)) .. "\"")
+            end
+        end
+    end
+end
+--- Helper function for printing out every tear flag that is turned on. Useful when debugging.
+function ____exports.logTearFlags(flags)
+    ____exports.logFlags(flags, TearFlag, "tear")
+end
+--- Helper function for printing out every use flag that is turned on. Useful when debugging.
+function ____exports.logUseFlags(flags)
+    ____exports.logFlags(flags, UseFlag, "use")
+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)
+    if isUserdata(nil, 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 = getIsaacAPIClassName(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, round)
+    if round == nil then
+        round = false
+    end
+    local vectorString = vectorToString(nil, vector, round)
+    ____exports.log("Vector: " .. vectorString)
+end
+--- Converts every `isaacscript-common` function that begins with "log" to a global function.
+-- 
+-- This is useful when printing out variables from the in-game debug console.
+function ____exports.setLogFunctionsGlobal(self)
+    local globals = _G
+    globals.log = ____exports.log
+    globals.logArray = ____exports.logArray
+    globals.logColor = ____exports.logColor
+    globals.logDamageFlags = ____exports.logDamageFlags
+    globals.logEffects = ____exports.logEffects
+    globals.logEntities = ____exports.logEntities
+    globals.logEntityID = ____exports.logEntityID
+    globals.logEntityFlags = ____exports.logEntityFlags
+    globals.logError = ____exports.logError
+    globals.logFlags = ____exports.logFlags
+    globals.logGameStateFlags = ____exports.logGameStateFlags
+    globals.logGridEntities = ____exports.logGridEntities
+    globals.logKColor = ____exports.logKColor
+    globals.logLevelStateFlags = ____exports.logLevelStateFlags
+    globals.logMap = ____exports.logMap
+    globals.logPlayerHealth = ____exports.logPlayerHealth
+    globals.logProjectileFlags = ____exports.logProjectileFlags
+    globals.logRoom = ____exports.logRoom
+    globals.logSeedEffects = ____exports.logSeedEffects
+    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
+    globals.logVector = ____exports.logVector
+end
+return ____exports

package/dist/functions/map.d.ts

@@ -0,0 +1,23 @@
+/** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
+export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
+/**
+ * Helper function to get the closest value from a map based on partial search text. For the
+ * purposes of this function, both search text and map keys are converted to lowercase before
+ * attempting to find a match.
+ *
+ * For example:
+ *
+ * ```ts
+ * const map = new <string, number>Map([
+ *   ["foo", 123],
+ *   ["bar", 456],
+ * ]);
+ * const searchText = "f";
+ * const match = getMapPartialMatch(map, searchText); // match is now equal to 123
+ *
+ * @returns If a match was found, returns a tuple of the map key and value. If a match was not
+ * found, returns undefined.
+ * ```
+ */
+export declare function getMapPartialMatch<T>(searchText: string, map: ReadonlyMap<string, T>): [string, T] | undefined;
+//# sourceMappingURL=map.d.ts.map

package/dist/functions/map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/map.ts"],"names":[],"mappings":"AAAA,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAO1D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAuBzB"}

package/dist/functions/map.lua

@@ -0,0 +1,61 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__ArraySort = ____lualib.__TS__ArraySort
+local __TS__StringReplaceAll = ____lualib.__TS__StringReplaceAll
+local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+--- Helper function to copy a map. (You can also use a Map constructor to accomplish this task.)
+function ____exports.copyMap(self, oldMap)
+    local newMap = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(oldMap:entries()) do
+        local key = ____value[1]
+        local value = ____value[2]
+        newMap:set(key, value)
+    end
+    return newMap
+end
+--- Helper function to get the closest value from a map based on partial search text. For the
+-- purposes of this function, both search text and map keys are converted to lowercase before
+-- attempting to find a match.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const map = new <string, number>Map([
+--   ["foo", 123],
+--   ["bar", 456],
+-- ]);
+-- const searchText = "f";
+-- const match = getMapPartialMatch(map, searchText); // match is now equal to 123
+-- 
+-- @returns If a match was found, returns a tuple of the map key and value. If a match was not
+-- found, returns undefined.
+-- ```
+function ____exports.getMapPartialMatch(self, searchText, map)
+    local keys = {__TS__Spread(map:keys())}
+    __TS__ArraySort(keys)
+    searchText = string.lower(searchText)
+    searchText = __TS__StringReplaceAll(searchText, " ", "")
+    local matchingKeys = __TS__ArrayFilter(
+        keys,
+        function(____, key) return __TS__StringStartsWith(
+            string.lower(key),
+            searchText
+        ) end
+    )
+    __TS__ArraySort(matchingKeys)
+    local matchingKey = matchingKeys[1]
+    if matchingKey == nil then
+        return nil
+    end
+    local value = map:get(matchingKey)
+    if value == nil then
+        return nil
+    end
+    return {matchingKey, value}
+end
+return ____exports