isaacscript-common 6.20.2 → 6.21.0

package/dist/functions/log.lua

@@ -1,20 +1,17 @@
 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__ArrayForEach = ____lualib.__TS__ArrayForEach
 local __TS__TypeOf = ____lualib.__TS__TypeOf
 local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local getEntityLogLine, getGridEntityLogLine
 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 HeartSubType = ____isaac_2Dtypescript_2Ddefinitions.HeartSubType
 local LevelStateFlag = ____isaac_2Dtypescript_2Ddefinitions.LevelStateFlag
@@ -31,15 +28,11 @@ local arrayToString = ____array.arrayToString
 local ____collectibles = require("functions.collectibles")
 local getCollectibleName = ____collectibles.getCollectibleName
 local ____entities = require("functions.entities")
-local getEntities = ____entities.getEntities
 local getEntityID = ____entities.getEntityID
 local ____enums = require("functions.enums")
 local getEnumEntries = ____enums.getEnumEntries
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____gridEntities = require("functions.gridEntities")
-local getGridEntities = ____gridEntities.getGridEntities
-local getGridEntityID = ____gridEntities.getGridEntityID
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____playerHealth = require("functions.playerHealth")
@@ -89,70 +82,6 @@ function ____exports.log(msg)
     local debugMsg = ____exports.getDebugPrependString(nil, msg)
     Isaac.DebugString(debugMsg)
 end
---- Helper function to log information about a specific entity.
-function ____exports.logEntity(entity)
-    local msg = getEntityLogLine(nil, entity)
-    ____exports.log(msg)
-end
-function getEntityLogLine(self, entity, num)
-    local msg = num == nil and "" or tostring(num) .. ") "
-    msg = msg .. getEntityID(nil, entity)
-    local bomb = entity:ToBomb()
-    if bomb ~= nil then
-        msg = msg .. " (bomb)"
-    end
-    local effect = entity:ToEffect()
-    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
-    return msg
-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
@@ -175,132 +104,6 @@ function ____exports.logFlags(flags, flagEnum, description)
         ____exports.log("  n/a (no flags)")
     end
 end
---- Helper function for log information about a specific grid entity.
-function ____exports.logGridEntity(gridEntity)
-    local msg = getGridEntityLogLine(nil, gridEntity)
-    ____exports.log(msg)
-end
-function getGridEntityLogLine(self, gridEntity, num)
-    local gridEntityDesc = gridEntity:GetSaveState()
-    local msg = num == nil and "" or tostring(num) .. ") "
-    msg = msg .. getGridEntityID(nil, gridEntity)
-    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 .. ("  - State: " .. tostring(gridEntity.State)) .. "\n"
-    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
-    return msg
-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
-})
---- Helper function for printing out every entity (or filtered entity) in the current room.
-function ____exports.logAllEntities(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
-            msg = msg .. getEntityLogLine(nil, entity, i + 1)
-            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 grid entity (or filtered grid entity) in the current room.
-function ____exports.logAllGridEntities(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()
-            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 .. getGridEntityLogLine(nil, gridEntity, gridEntityIndex)
-            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.logArray(array)
     local arrayString = arrayToString(nil, array)
     ____exports.log("Array: " .. arrayString)
@@ -312,12 +115,6 @@ end
 function ____exports.logDamageFlags(flags)
     ____exports.logFlags(flags, DamageFlag, "damage")
 end
---- Helper function for logging an array of specific entities.
-function ____exports.logEntities(entities)
-    for ____, entity in ipairs(entities) do
-        ____exports.logEntity(entity)
-    end
-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")
@@ -353,12 +150,6 @@ function ____exports.logGameStateFlags()
         ____exports.log("  n/a (no flags)")
     end
 end
---- Helper function for logging an array of specific grid entities.
-function ____exports.logGridEntities(gridEntities)
-    for ____, gridEntity in ipairs(gridEntities) do
-        ____exports.logGridEntity(gridEntity)
-    end
-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
@@ -608,20 +399,14 @@ end
 function ____exports.setLogFunctionsGlobal(self)
     local globals = _G
     globals.log = ____exports.log
-    globals.logAllEntities = ____exports.logAllEntities
-    globals.logAllGridEntities = ____exports.logAllGridEntities
     globals.logArray = ____exports.logArray
     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
     globals.logGameStateFlags = ____exports.logGameStateFlags
-    globals.logGridEntities = ____exports.logGridEntities
-    globals.logGridEntity = ____exports.logGridEntity
     globals.logKColor = ____exports.logKColor
     globals.logLevelStateFlags = ____exports.logLevelStateFlags
     globals.logMap = ____exports.logMap

package/dist/functions/logEntities.d.ts

@@ -0,0 +1,16 @@
+import { EntityType, GridEntityType } from "isaac-typescript-definitions";
+/** Helper function for printing out every entity (or filtered entity) in the current room. */
+export declare function logAllEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType): void;
+/**
+ * Helper function for printing out every grid entity (or filtered grid entity) in the current room.
+ */
+export declare function logAllGridEntities(this: void, includeWalls: boolean, gridEntityTypeFilter?: GridEntityType): void;
+/** Helper function for logging an array of specific entities. */
+export declare function logEntities(this: void, entities: Entity[]): void;
+/** Helper function to log information about a specific entity. */
+export declare function logEntity(this: void, entity: Entity): void;
+/** Helper function for logging an array of specific grid entities. */
+export declare function logGridEntities(this: void, gridEntities: GridEntity[]): void;
+/** Helper function for log information about a specific grid entity. */
+export declare function logGridEntity(this: void, gridEntity: GridEntity): void;
+//# sourceMappingURL=logEntities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logEntities.d.ts","sourceRoot":"","sources":["../../src/functions/logEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,cAAc,EACf,MAAM,8BAA8B,CAAC;AAiBtC,8FAA8F;AAC9F,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,wBAAwB,EAAE,OAAO,EACjC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,IAAI,CAuCN;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,OAAO,EACrB,oBAAoB,CAAC,EAAE,cAAc,GACpC,IAAI,CA6CN;AAED,iEAAiE;AACjE,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAIhE;AAED,kEAAkE;AAClE,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAG1D;AA2ED,sEAAsE;AACtE,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAI5E;AAED,wEAAwE;AACxE,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAGtE"}

package/dist/functions/logEntities.lua

@@ -0,0 +1,220 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
+local ____exports = {}
+local getEntityLogLine, getGridEntityLogLine
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ____entities = require("functions.entities")
+local getEntities = ____entities.getEntities
+local getEntityID = ____entities.getEntityID
+local ____gridEntities = require("functions.gridEntities")
+local getGridEntities = ____gridEntities.getGridEntities
+local getGridEntityID = ____gridEntities.getGridEntityID
+local ____log = require("functions.log")
+local log = ____log.log
+--- Helper function to log information about a specific entity.
+function ____exports.logEntity(entity)
+    local msg = getEntityLogLine(nil, entity)
+    log(msg)
+end
+function getEntityLogLine(self, entity, num)
+    local msg = num == nil and "" or tostring(num) .. ") "
+    msg = msg .. getEntityID(nil, entity)
+    local bomb = entity:ToBomb()
+    if bomb ~= nil then
+        msg = msg .. " (bomb)"
+    end
+    local effect = entity:ToEffect()
+    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
+    return msg
+end
+--- Helper function for log information about a specific grid entity.
+function ____exports.logGridEntity(gridEntity)
+    local msg = getGridEntityLogLine(nil, gridEntity)
+    log(msg)
+end
+function getGridEntityLogLine(self, gridEntity, num)
+    local gridEntityDesc = gridEntity:GetSaveState()
+    local msg = num == nil and "" or tostring(num) .. ") "
+    msg = msg .. getGridEntityID(nil, gridEntity)
+    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 .. ("  - State: " .. tostring(gridEntity.State)) .. "\n"
+    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
+    return msg
+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
+})
+--- Helper function for printing out every entity (or filtered entity) in the current room.
+function ____exports.logAllEntities(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
+            msg = msg .. getEntityLogLine(nil, entity, i + 1)
+            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
+    log(msg)
+end
+--- Helper function for printing out every grid entity (or filtered grid entity) in the current room.
+function ____exports.logAllGridEntities(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()
+            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 .. getGridEntityLogLine(nil, gridEntity, gridEntityIndex)
+            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
+    log(msg)
+end
+--- Helper function for logging an array of specific entities.
+function ____exports.logEntities(entities)
+    for ____, entity in ipairs(entities) do
+        ____exports.logEntity(entity)
+    end
+end
+--- Helper function for logging an array of specific grid entities.
+function ____exports.logGridEntities(gridEntities)
+    for ____, gridEntity in ipairs(gridEntities) do
+        ____exports.logGridEntity(gridEntity)
+    end
+end
+return ____exports

package/dist/functions/rockAlt.d.ts

@@ -29,20 +29,21 @@ export declare function getRockAltType(): RockAltType;
  * trinket is still in the pool. Thus, it will always have a chance to spawn the respective trinket
  * (e.g. Swallowed Penny from urns).
  *
+ * When filled buckets are destroyed, 6 projectiles will always spawn in a random pattern (in
+ * addition to any other rewards that are spawned). This function does not account for this, so if
+ * you want to specifically emulate destroying a filled bucket, you have to account for the
+ * projectiles yourself.
+ *
  * The logic in this function is based on the rewards listed on the wiki:
  * https://bindingofisaacrebirth.fandom.com/wiki/Rocks
  *
  * @param position The place to spawn the reward.
  * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
  *                    at spawning coins and spiders.
- * @param variant Optional. The variant of the grid entity to emulate. Default is 0, which
- *                corresponds to a "normal" grid entity or an empty bucket. This only matters when
- *                spawning the reward for buckets. (Empty buckets have different rewards than full
- *                buckets.)
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally, you
  *                  should pass the `InitSeed` of the grid entity that was broken.
  * @returns Whether or not this function spawned something.
  */
-export declare function spawnRockAltReward(position: Vector, rockAltType: RockAltType, variant?: number, seedOrRNG?: Seed | RNG): boolean;
+export declare function spawnRockAltReward(position: Vector, rockAltType: RockAltType, seedOrRNG?: Seed | RNG): boolean;
 //# sourceMappingURL=rockAlt.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AA+BnD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,OAAO,SAAI,EACX,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CAwBT"}
+{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAgCnD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CA4BT"}