isaacscript-common 1.2.277 → 1.2.280

package/dist/functions/entity.d.ts

@@ -5,9 +5,9 @@ import { AnyEntity } from "../types/AnyEntity";
  * `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
  * enemies.
  *
- * @param entityType Default is -1.
- * @param variant Default is -1.
- * @param subType Default is -1.
+ * @param entityType Default is -1. -1 matches every entity type.
+ * @param variant Default is -1. -1 matches every variant.
+ * @param subType Default is -1. -1 matches every sub-type.
  * @param ignoreFriendly Default is false.
  */
 export declare function countEntities(entityType?: EntityType | int, variant?: number, subType?: number, ignoreFriendly?: boolean): int;
@@ -41,8 +41,10 @@ export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity:
  *
  * @param entityType Optional. If specified, will only return NPCs that match this entity
  * type.
- * @param variant Optional. If specified, will only return NPCs that match this variant.
- * @param subType Optional. If specified, will only return NPCs that match this sub-type.
+ * @param variant Optional. If specified, will only return NPCs that match this variant. Default is
+ * -1. -1 matches every variant.
+ * @param subType Optional. If specified, will only return NPCs that match this sub-type. Default is
+ * -1. -1 matches every sub-type.
  * @param ignoreFriendly Optional. If set to true, it will exclude friendly NPCs from being
  * returned. Default is false. Will only be taken into account if `matchingEntityType` is specified.
  */
@@ -89,10 +91,8 @@ export declare function parseEntityTypeVariantString(entityTypeVariantString: st
  * Helper function to remove all of the matching entities in the room.
  *
  * @param entityType The entity type to match.
- * @param entityVariant Optional. The variant to match. Default is -1 (which will match every
- * variant).
- * @param entitySubType Optional. The sub-type to match. Default is -1 (which will match every
- * sub-type).
+ * @param entityVariant Optional. The variant to match. Default is -1. -1 matches every variant.
+ * @param entitySubType Optional. The sub-type to match. Default is -1. -1 matches every sub-type.
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns True if one or more entities were removed, false otherwise.
  */

package/dist/functions/log.lua

@@ -82,14 +82,14 @@ function ____exports.logFlags(flags, flagEnum, description)
     for key, value in pairs(flagEnum) do
         do
             if type(value) ~= "number" then
-                goto __continue42
+                goto __continue43
             end
             if hasFlag(nil, flags, value) then
                 ____exports.log(((("  Has flag: " .. tostring(key)) .. " (") .. tostring(value)) .. ")")
                 hasNoFlags = false
             end
         end
-        ::__continue42::
+        ::__continue43::
     end
     if hasNoFlags then
         ____exports.log("  n/a (no flags)")
@@ -143,15 +143,13 @@ function ____exports.logEffects(player)
     )
 end
 function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
-    local headerMsg = "Entities in the room"
+    local msg = "Entities in the room"
     if entityTypeFilter ~= nil then
-        headerMsg = headerMsg .. (" (filtered to entity type " .. tostring(entityTypeFilter)) .. ")"
+        msg = msg .. (" (filtered to entity type " .. tostring(entityTypeFilter)) .. ")"
+    elseif not includeBackgroundEffects then
+        msg = msg .. " (not including background effects)"
     end
-    if not includeBackgroundEffects then
-        headerMsg = headerMsg .. " (not excluding background effects)"
-    end
-    headerMsg = headerMsg .. ":"
-    ____exports.log(headerMsg)
+    msg = msg .. ":\n"
     local entities = getEntities(nil)
     local numMatchedEntities = 0
     __TS__ArrayForEach(
@@ -164,62 +162,70 @@ function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
                 return
             end
             local entityID = getEntityID(nil, entity)
-            local debugString = (tostring(i + 1) .. " - ") .. entityID
+            msg = msg .. (tostring(i + 1) .. ") ") .. entityID
             local bomb = entity:ToBomb()
             if bomb ~= nil then
-                debugString = debugString .. " (bomb)"
+                msg = msg .. " (bomb)"
             end
             local effect = entity:ToEffect()
             if effect ~= nil then
-                debugString = debugString .. (" (effect) (State: " .. tostring(effect.State)) .. ")"
+                msg = msg .. (" (effect) (State: " .. tostring(effect.State)) .. ")"
             end
             local familiar = entity:ToFamiliar()
             if familiar ~= nil then
-                debugString = debugString .. (" (familiar) (State: " .. tostring(familiar.State)) .. ")"
+                msg = msg .. (" (familiar) (State: " .. tostring(familiar.State)) .. ")"
             end
             local knife = entity:ToKnife()
             if knife ~= nil then
-                debugString = debugString .. " (knife)"
+                msg = msg .. " (knife)"
             end
             local laser = entity:ToLaser()
             if laser ~= nil then
-                debugString = debugString .. " (laser)"
+                msg = msg .. " (laser)"
             end
             local npc = entity:ToNPC()
             if npc ~= nil then
-                debugString = debugString .. (((" (NPC) (State: " .. tostring(npc.State)) .. ") (CanShutDoors: ") .. tostring(npc.CanShutDoors)) .. ")"
+                msg = msg .. (" (NPC) (State: " .. tostring(npc.State)) .. ")"
             end
             local pickup = entity:ToPickup()
             if pickup ~= nil then
-                debugString = debugString .. (" (pickup) (State: " .. tostring(pickup.State)) .. ")"
+                msg = msg .. (" (pickup) (State: " .. tostring(pickup.State)) .. ")"
             end
             local player = entity:ToPlayer()
             if player ~= nil then
-                debugString = debugString .. " (player)"
+                msg = msg .. " (player)"
             end
             local projectile = entity:ToProjectile()
             if projectile ~= nil then
-                debugString = debugString .. " (projectile)"
+                msg = msg .. " (projectile)"
             end
             local tear = entity:ToTear()
             if tear ~= nil then
-                debugString = debugString .. " (tear)"
+                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
-            debugString = debugString .. (" (Index: " .. tostring(entity.Index)) .. ")"
-            debugString = debugString .. (" (InitSeed: " .. tostring(entity.InitSeed)) .. ")"
-            debugString = debugString .. (" (DropSeed: " .. tostring(entity.DropSeed)) .. ")"
-            debugString = debugString .. (((" (Position: " .. tostring(entity.Position.X)) .. ", ") .. tostring(entity.Position.Y)) .. ")"
-            debugString = debugString .. (((" (Velocity: " .. tostring(entity.Velocity.X)) .. ", ") .. tostring(entity.Velocity.Y)) .. ")"
-            debugString = debugString .. (((" (HP: " .. tostring(entity.HitPoints)) .. " / ") .. tostring(entity.MaxHitPoints)) .. ")"
-            ____exports.log(debugString)
             numMatchedEntities = numMatchedEntities + 1
         end
     )
     if numMatchedEntities == 0 then
-        ____exports.log("(no entities matched)")
+        msg = msg .. "(no entities matched)\n"
     else
-        ____exports.log(("(" .. tostring(numMatchedEntities)) .. " total entities)")
+        msg = msg .. ("(" .. tostring(numMatchedEntities)) .. " total entities)\n"
     end
+    ____exports.log(msg)
 end
 function ____exports.logEntityFlags(flags)
     ____exports.logFlags(flags, EntityFlag, "entity")
@@ -248,14 +254,13 @@ function ____exports.logGameStateFlags()
     end
 end
 function ____exports.logGridEntities(includeWalls, gridEntityTypeFilter)
-    local headerMsg = "Grid entities in the room"
+    local msg = "Grid entities in the room"
     if gridEntityTypeFilter ~= nil then
-        headerMsg = headerMsg .. (" (filtered to grid entity type " .. tostring(gridEntityTypeFilter)) .. ")"
+        msg = msg .. (" (filtered to grid entity type " .. tostring(gridEntityTypeFilter)) .. ")"
+    elseif not includeWalls then
+        msg = msg .. " (not including walls)"
     end
-    if not includeWalls then
-        headerMsg = headerMsg .. " (not including walls)"
-    end
-    ____exports.log(headerMsg)
+    msg = msg .. ":\n"
     local gridEntities = getGridEntities(nil)
     local numMatchedEntities = 0
     __TS__ArrayForEach(
@@ -271,47 +276,54 @@ function ____exports.logGridEntities(includeWalls, gridEntityTypeFilter)
             if not includeWalls and gridEntityType == GridEntityType.GRID_WALL and gridEntityTypeFilter ~= GridEntityType.GRID_WALL then
                 return
             end
-            local debugString = (((((tostring(gridEntityIndex) .. " - ") .. tostring(gridEntityType)) .. ".") .. tostring(gridEntityVariant)) .. ".") .. tostring(gridEntity.State)
+            msg = msg .. (((((tostring(gridEntityIndex) .. ") ") .. tostring(gridEntityType)) .. ".") .. tostring(gridEntityVariant)) .. ".") .. tostring(gridEntity.State)
             local door = gridEntity:ToDoor()
             if door ~= nil then
-                debugString = debugString .. (((((((" (door) (Slot: " .. tostring(door.Slot)) .. ", Direction: ") .. tostring(door.Direction)) .. ", TargetRoomIndex: ") .. tostring(door.TargetRoomIndex)) .. ", TargetRoomType: ") .. tostring(door.TargetRoomType)) .. ")"
+                msg = msg .. " (door)"
             end
             local pit = gridEntity:ToPit()
             if pit ~= nil then
-                debugString = debugString .. " (pit)"
+                msg = msg .. " (pit)"
             end
             local poop = gridEntity:ToPoop()
             if poop ~= nil then
-                debugString = debugString .. " (poop)"
+                msg = msg .. " (poop)"
             end
             local pressurePlate = gridEntity:ToPressurePlate()
             if pressurePlate ~= nil then
-                debugString = debugString .. " (pressurePlate)"
+                msg = msg .. " (pressurePlate)"
             end
             local rock = gridEntity:ToRock()
             if rock ~= nil then
-                debugString = debugString .. " (rock)"
+                msg = msg .. " (rock)"
             end
             local spikes = gridEntity:ToSpikes()
             if spikes ~= nil then
-                debugString = debugString .. " (spikes)"
+                msg = msg .. " (spikes)"
             end
             local tnt = gridEntity:ToTNT()
             if tnt ~= nil then
-                debugString = debugString .. " (TNT)"
+                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
-            debugString = debugString .. (" (VarData: " .. tostring(gridEntity.VarData)) .. ")"
-            debugString = debugString .. (((" (Position: " .. tostring(gridEntity.Position.X)) .. ", ") .. tostring(gridEntity.Position.Y)) .. ")"
-            debugString = debugString .. (((" (SpawnSeed: " .. tostring(gridEntityDesc.SpawnSeed)) .. ", VariableSeed: ") .. tostring(gridEntityDesc.VariableSeed)) .. ")"
-            ____exports.log(debugString)
             numMatchedEntities = numMatchedEntities + 1
         end
     )
     if numMatchedEntities == 0 then
-        ____exports.log("(no grid entities matched)")
+        msg = msg .. "(no grid entities matched)\n"
     else
-        ____exports.log(("(" .. tostring(numMatchedEntities)) .. " total grid entities)")
+        msg = msg .. ("(" .. tostring(numMatchedEntities)) .. " total grid 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))

package/dist/functions/rooms.d.ts

@@ -32,13 +32,20 @@ export declare function getRoomGridIndexesForType(...roomTypes: RoomType[]): int
 export declare function getRoomItemPoolType(): ItemPoolType;
 /**
  * Helper function to get the room descriptor for every room on the level. Uses the `Level.GetRooms`
- * method to accomplish this.
+ * method to accomplish this. Rooms without data are assumed to be non-existent and are not added to
+ * the list.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
  * extra-dimensional rooms are automatically be generated and can be seen when you iterate over the
  * `RoomList`. Default is false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
+/**
+ * Helper function to get the room descriptor for every room on the level in a specific dimension.
+ * Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
+ * non-existent and are not added to the list.
+ */
+export declare function getRoomsOfDimension(dimension: Dimension): RoomDescriptor[];
 /**
  * Helper function to determine if the current room shape is equal to `RoomShape.ROOMSHAPE_1x2` or
  * `RoomShape.ROOMSHAPE_2x1`.

package/dist/functions/rooms.lua

@@ -53,7 +53,7 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
             local i = 0
             while i < roomList.Size do
                 local roomDescriptor = roomList:Get(i)
-                if roomDescriptor ~= nil then
+                if roomDescriptor ~= nil and roomDescriptor.Data ~= nil then
                     rooms[#rooms + 1] = roomDescriptor
                 end
                 i = i + 1
@@ -64,7 +64,7 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
             local i = 0
             while i <= MAX_ROOM_INDEX do
                 local roomDescriptor = level:GetRoomByIdx(i)
-                if roomDescriptor ~= nil then
+                if roomDescriptor.Data ~= nil then
                     rooms[#rooms + 1] = roomDescriptor
                 end
                 i = i + 1
@@ -134,6 +134,21 @@ function ____exports.getRoomItemPoolType(self)
     local roomSeed = room:GetSpawnSeed()
     return itemPool:GetPoolForRoom(roomType, roomSeed)
 end
+function ____exports.getRoomsOfDimension(self, dimension)
+    local level = game:GetLevel()
+    local rooms = {}
+    do
+        local i = 0
+        while i <= MAX_ROOM_INDEX do
+            local roomDescriptor = level:GetRoomByIdx(i, dimension)
+            if roomDescriptor.Data ~= nil then
+                rooms[#rooms + 1] = roomDescriptor
+            end
+            i = i + 1
+        end
+    end
+    return rooms
+end
 function ____exports.in2x1Room(self)
     local room = game:GetRoom()
     local roomShape = room:GetRoomShape()
@@ -274,12 +289,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue52
+                goto __continue55
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue52::
+        ::__continue55::
     end
     sfxManager:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.277",
+  "version": "1.2.280",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,9 +25,9 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.392",
+    "isaac-typescript-definitions": "^1.0.393",
     "isaacscript-lint": "^1.0.99",
-    "isaacscript-tsconfig": "^1.1.8",
+    "isaacscript-tsconfig": "^1.1.9",
     "typedoc": "^0.22.15",
     "typescript": "4.6.3",
     "typescript-to-lua": "^1.4.3"