isaacscript-common 6.6.3 → 6.7.0

package/dist/functions/{entitySpecific.lua → entitiesSpecific.lua}

@@ -3,21 +3,26 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local ____constants = require("constants")
 local VectorZero = ____constants.VectorZero
-local ____entity = require("functions.entity")
-local getEntities = ____entity.getEntities
-local getFilteredNewEntities = ____entity.getFilteredNewEntities
-local removeEntities = ____entity.removeEntities
-local spawn = ____entity.spawn
---- Helper function to get all of the `EntityType.BOMB` in the room.
+local ____entities = require("functions.entities")
+local getEntities = ____entities.getEntities
+local removeEntities = ____entities.removeEntities
+local spawn = ____entities.spawn
+--- Helper function to get all of the bombs in the room. (Specifically, this refers to the
+-- `EntityBomb` class, not bomb pickups.)
 -- 
 -- For example:
 -- 
 -- ```ts
--- // Make all of the bombs in the room invisible
+-- // Make all of the bombs in the room invisible.
 -- for (const bomb of getBombs()) {
 --   bomb.Visible = false;
 -- }
 -- ```
+-- 
+-- @param bombVariant Optional. If specified, will only get the bombs that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only get the bombs that match the sub-type. Default
+-- is -1, which matches every sub-type.
 function ____exports.getBombs(self, bombVariant, subType)
     if bombVariant == nil then
         bombVariant = -1
@@ -35,16 +40,21 @@ function ____exports.getBombs(self, bombVariant, subType)
     end
     return bombs
 end
---- Helper function to get all of the `EntityType.EFFECT` in the room.
+--- Helper function to get all of the effects in the room.
 -- 
 -- For example:
 -- 
 -- ```ts
--- // Make all of the effects in the room invisible
+-- // Make all of the effects in the room invisible.
 -- for (const effect of getEffects()) {
 --   effect.Visible = false;
 -- }
 -- ```
+-- 
+-- @param effectVariant Optional. If specified, will only get the effects that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only get the effects that match the sub-type. Default
+-- is -1, which matches every sub-type.
 function ____exports.getEffects(self, effectVariant, subType)
     if effectVariant == nil then
         effectVariant = -1
@@ -67,11 +77,16 @@ end
 -- For example:
 -- 
 -- ```ts
--- // Make all of the familiars in the room invisible
+-- // Make all of the familiars in the room invisible.
 -- for (const familiar of getFamiliars()) {
 --   familiar.Visible = false;
 -- }
 -- ```
+-- 
+-- @param familiarVariant Optional. If specified, will only get the familiars that match the
+-- variant. Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only get the familiars that match the sub-type.
+-- Default is -1, which matches every sub-type.
 function ____exports.getFamiliars(self, familiarVariant, subType)
     if familiarVariant == nil then
         familiarVariant = -1
@@ -89,16 +104,21 @@ function ____exports.getFamiliars(self, familiarVariant, subType)
     end
     return familiars
 end
---- Helper function to get all of the `EntityType.KNIFE` in the room.
+--- Helper function to get all of the knives in the room.
 -- 
 -- For example:
 -- 
 -- ```ts
--- // Make all of the knives in the room invisible
+-- // Make all of the knives in the room invisible.
 -- for (const knife of getKnives()) {
 --   knife.Visible = false;
 -- }
 -- ```
+-- 
+-- @param knifeVariant Optional. If specified, will only get the knives that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only get the knives that match the sub-type. Default
+-- is -1, which matches every sub-type.
 function ____exports.getKnives(self, knifeVariant, subType)
     if knifeVariant == nil then
         knifeVariant = -1
@@ -116,16 +136,21 @@ function ____exports.getKnives(self, knifeVariant, subType)
     end
     return knives
 end
---- Helper function to get all of the `EntityType.LASER` in the room.
+--- Helper function to get all of the lasers in the room.
 -- 
 -- For example:
 -- 
 -- ```ts
--- // Make all of the lasers in the room invisible
+-- // Make all of the lasers in the room invisible.
 -- for (const laser of getLasers()) {
 --   laser.Visible = false;
 -- }
 -- ```
+-- 
+-- @param laserVariant Optional. If specified, will only get the lasers that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only get the lasers that match the sub-type. Default
+-- is -1, which matches every sub-type.
 function ____exports.getLasers(self, laserVariant, subType)
     if laserVariant == nil then
         laserVariant = -1
@@ -143,8 +168,27 @@ function ____exports.getLasers(self, laserVariant, subType)
     end
     return lasers
 end
---- The same thing as the `getEntities` function, but returns only NPCs.
+--- Helper function to get all of the NPCs in the room.
+-- 
+-- @param entityType Optional. If specified, will only get the NPCs that match the type. Default is
+-- -1, which matches every entity type.
+-- @param variant Optional. If specified, will only get the NPCs that match the variant. Default is
+-- -1, which matches every entity type.
+-- @param subType Optional. If specified, will only get the bombs that match the sub-type. Default
+-- is -1, which 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 the
+-- `entityType` is specified.
 function ____exports.getNPCs(self, entityType, variant, subType, ignoreFriendly)
+    if entityType == nil then
+        entityType = -1
+    end
+    if variant == nil then
+        variant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     if ignoreFriendly == nil then
         ignoreFriendly = false
     end
@@ -169,11 +213,16 @@ end
 -- For example:
 -- 
 -- ```ts
--- // Make all of the pickups in the room invisible
+-- // Make all of the pickups in the room invisible.
 -- for (const pickup of getPickups()) {
 --   pickup.Visible = false;
 -- }
 -- ```
+-- 
+-- @param pickupVariant Optional. If specified, will only get the pickups that match the variant.
+-- Default is -1, which matches every entity type.
+-- @param subType Optional. If specified, will only get the pickups that match the sub-type. Default
+-- is -1, which matches every sub-type.
 function ____exports.getPickups(self, pickupVariant, subType)
     if pickupVariant == nil then
         pickupVariant = -1
@@ -191,16 +240,21 @@ function ____exports.getPickups(self, pickupVariant, subType)
     end
     return pickups
 end
---- Helper function to get all of the `EntityType.PROJECTILE` in the room.
+--- Helper function to get all of the projectiles in the room.
 -- 
 -- For example:
 -- 
 -- ```ts
--- // Make all of the projectiles in the room invisible
+-- // Make all of the projectiles in the room invisible.
 -- for (const projectile of getProjectiles()) {
 --   projectile.Visible = false;
 -- }
 -- ```
+-- 
+-- @param projectileVariant Optional. If specified, will only get the projectiles that match the
+-- variant. Default is -1, which matches every entity type.
+-- @param subType Optional. If specified, will only get the projectiles that match the sub-type.
+-- Default is -1, which matches every sub-type.
 function ____exports.getProjectiles(self, projectileVariant, subType)
     if projectileVariant == nil then
         projectileVariant = -1
@@ -218,16 +272,21 @@ function ____exports.getProjectiles(self, projectileVariant, subType)
     end
     return projectiles
 end
---- Helper function to get all of the `EntityType.SLOT` in the room.
+--- Helper function to get all of the slots in the room.
 -- 
 -- For example:
 -- 
 -- ```ts
--- // Make all of the slots in the room invisible
+-- // Make all of the slots in the room invisible.
 -- for (const slot of getSlots()) {
 --   slot.Visible = false;
 -- }
 -- ```
+-- 
+-- @param slotVariant Optional. If specified, will only get the slots that match the variant.
+-- Default is -1, which matches every entity type.
+-- @param subType Optional. If specified, will only get the slots that match the sub-type. Default
+-- is -1, which matches every sub-type.
 function ____exports.getSlots(self, slotVariant, subType)
     if slotVariant == nil then
         slotVariant = -1
@@ -238,16 +297,21 @@ function ____exports.getSlots(self, slotVariant, subType)
     local slots = getEntities(nil, EntityType.SLOT, slotVariant, subType)
     return slots
 end
---- Helper function to get all of the `EntityType.TEAR` in the room.
+--- Helper function to get all of the tears in the room.
 -- 
 -- For example:
 -- 
 -- ```ts
--- // Make all of the tears in the room invisible
+-- // Make all of the tears in the room invisible.
 -- for (const tear of getTears()) {
 --   tear.Visible = false;
 -- }
 -- ```
+-- 
+-- @param tearVariant Optional. If specified, will only get the tears that match the variant.
+-- Default is -1, which matches every entity type.
+-- @param subType Optional. If specified, will only get the tears that match the sub-type. Default
+-- is -1, which matches every sub-type.
 function ____exports.getTears(self, tearVariant, subType)
     if tearVariant == nil then
         tearVariant = -1
@@ -265,121 +329,189 @@ function ____exports.getTears(self, tearVariant, subType)
     end
     return tears
 end
---- The base game `EntityNPC.FireProjectiles` method does not return anything, which is a problem in
--- situations where you need to work with the fired projectiles. This function invokes that method,
--- and then returns the projectiles that were spawned.
--- 
--- @param npc The EntityNPC firing projectiles.
--- @param position The starting position of the projectiles.
--- @param velocity The starting velocity of the projectiles.
--- @param projectilesMode A ProjectilesMode enum value defining how to fire the projectiles.
--- @param projectileParams A ProjectileParams object containing various parameters for the
--- projectiles.
--- @returns An array of EntityProjectiles containing all fired projectiles.
-function ____exports.npcFireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
-    local oldEntities = ____exports.getProjectiles(nil)
-    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
-    local newEntities = ____exports.getProjectiles(nil)
-    local filteredNewEntities = getFilteredNewEntities(nil, oldEntities, newEntities)
-    return filteredNewEntities
-end
---- Helper function to remove all of the `EntityType.BOMB` in the room.
--- 
--- @param bombVariant Optional. If specified, will only remove bombs that match this variant.
--- @param subType Optional. If specified, will only remove bombs that match this sub-type.
+--- Helper function to remove all of the bombs in the room. (Specifically, this refers to the
+-- `EntityBomb` class, not bomb pickups.)
+-- 
+-- @param bombVariant Optional. If specified, will only remove the bombs that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove the bombs that match the sub-type.
+-- Default is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of bombs.
 -- @returns An array of the bombs that were removed.
 function ____exports.removeAllBombs(self, bombVariant, subType, cap)
+    if bombVariant == nil then
+        bombVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local bombs = ____exports.getBombs(nil, bombVariant, subType)
     return removeEntities(nil, bombs, cap)
 end
 --- Helper function to remove all of the effects in the room.
 -- 
--- @param effectVariant Optional. If specified, will only remove effects that match this variant.
--- @param subType Optional. If specified, will only remove effects that match this sub-type.
+-- @param effectVariant Optional. If specified, will only remove the effects that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove the effects that match the sub-type.
+-- Default is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of effects.
 -- @returns An array of the effects that were removed.
 function ____exports.removeAllEffects(self, effectVariant, subType, cap)
+    if effectVariant == nil then
+        effectVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local effects = ____exports.getEffects(nil, effectVariant, subType)
     return removeEntities(nil, effects, cap)
 end
 --- Helper function to remove all of the familiars in the room.
 -- 
--- @param familiarVariant Optional. If specified, will only remove familiars that match this
--- variant.
--- @param subType Optional. If specified, will only remove familiars that match this sub-type.
+-- @param familiarVariant Optional. If specified, will only remove the familiars that match the
+-- variant. Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove the familiars that match the sub-type.
+-- Default is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of familiars.
 -- @returns An array of the familiars that were removed.
 function ____exports.removeAllFamiliars(self, familiarVariant, subType, cap)
+    if familiarVariant == nil then
+        familiarVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local familiars = ____exports.getFamiliars(nil, familiarVariant, subType)
     return removeEntities(nil, familiars, cap)
 end
---- Helper function to remove all of the `EntityType.KNIFE` in the room.
+--- Helper function to remove all of the knives in the room.
 -- 
--- @param knifeVariant Optional. If specified, will only remove knives that match this variant.
--- @param subType Optional. If specified, will only remove knives that match this sub-type.
+-- @param knifeVariant Optional. If specified, will only remove the knives that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove the knives that match the sub-type.
+-- Default is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of knives.
 -- @returns An array of the knives that were removed.
 function ____exports.removeAllKnives(self, knifeVariant, subType, cap)
+    if knifeVariant == nil then
+        knifeVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local knives = ____exports.getKnives(nil, knifeVariant, subType)
     return removeEntities(nil, knives, cap)
 end
---- Helper function to remove all of the `EntityType.LASER` in the room.
+--- Helper function to remove all of the lasers in the room.
 -- 
--- @param laserVariant Optional. If specified, will only remove lasers that match this variant.
--- @param subType Optional. If specified, will only remove lasers that match this sub-type.
+-- @param laserVariant Optional. If specified, will only remove the lasers that match the variant.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove the lasers that match the sub-type.
+-- Default is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of lasers.
 -- @returns An array of the lasers that were removed.
 function ____exports.removeAllLasers(self, laserVariant, subType, cap)
+    if laserVariant == nil then
+        laserVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local lasers = ____exports.getLasers(nil, laserVariant, subType)
     return removeEntities(nil, lasers, cap)
 end
---- Helper function to remove all NPCs in the room.
+--- Helper function to remove all of the NPCs in the room.
 -- 
+-- @param entityType Optional. If specified, will only remove the NPCs that match the type. Default
+-- is -1, which matches every type.
+-- @param variant Optional. If specified, will only remove the NPCs that match the variant. Default
+-- is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove the NPCs that match the sub-type. Default
+-- is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of NPCs.
 -- @returns An array of the NPCs that were removed.
-function ____exports.removeAllNPCs(self, cap)
-    local npcs = ____exports.getNPCs(nil)
+function ____exports.removeAllNPCs(self, entityType, variant, subType, cap)
+    if entityType == nil then
+        entityType = -1
+    end
+    if variant == nil then
+        variant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local npcs = ____exports.getNPCs(nil, entityType, variant, subType)
     return removeEntities(nil, npcs, cap)
 end
 --- Helper function to remove all of the pickups in the room.
 -- 
 -- @param pickupVariant Optional. If specified, will only remove pickups that match this variant.
--- @param subType Optional. If specified, will only remove pickups that match this sub-type.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove pickups that match this sub-type. Default
+-- is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of pickups.
 -- @returns An array of the pickups that were removed.
 function ____exports.removeAllPickups(self, pickupVariant, subType, cap)
+    if pickupVariant == nil then
+        pickupVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local pickups = ____exports.getPickups(nil, pickupVariant, subType)
     return removeEntities(nil, pickups, cap)
 end
---- Helper function to remove all of the `EntityType.PROJECTILE` in the room.
+--- Helper function to remove all of the projectiles in the room.
 -- 
 -- @param projectileVariant Optional. If specified, will only remove projectiles that match this
--- variant.
+-- variant. Default is -1, which matches every variant.
 -- @param subType Optional. If specified, will only remove projectiles that match this sub-type.
+-- Default is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of projectiles.
 -- @returns An array of the projectiles that were removed.
 function ____exports.removeAllProjectiles(self, projectileVariant, subType, cap)
+    if projectileVariant == nil then
+        projectileVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local projectiles = ____exports.getProjectiles(nil, projectileVariant, subType)
     return removeEntities(nil, projectiles, cap)
 end
---- Helper function to remove all of the `EntityType.SLOT` in the room.
+--- Helper function to remove all of the slots in the room.
 -- 
 -- @param slotVariant Optional. If specified, will only remove slots that match this variant.
--- @param subType Optional. If specified, will only remove slots that match this sub-type.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove slots that match this sub-type. Default
+-- is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of slots.
 -- @returns An array of the slots that were removed.
 function ____exports.removeAllSlots(self, slotVariant, subType, cap)
+    if slotVariant == nil then
+        slotVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local slots = ____exports.getSlots(nil, slotVariant, subType)
     return removeEntities(nil, slots, cap)
 end
---- Helper function to remove all of the `EntityType.TEAR` in the room.
+--- Helper function to remove all of the tears in the room.
 -- 
 -- @param tearVariant Optional. If specified, will only remove tears that match this variant.
--- @param subType Optional. If specified, will only remove tears that match this sub-type.
+-- Default is -1, which matches every variant.
+-- @param subType Optional. If specified, will only remove tears that match this sub-type. Default
+-- is -1, which matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of tears.
 -- @returns An array of the tears that were removed.
 function ____exports.removeAllTears(self, tearVariant, subType, cap)
+    if tearVariant == nil then
+        tearVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
     local tears = ____exports.getTears(nil, tearVariant, subType)
     return removeEntities(nil, tears, cap)
 end
@@ -609,6 +741,9 @@ function ____exports.spawnLaserWithSeed(self, laserVariant, subType, position, s
     )
 end
 --- Helper function to spawn an NPC.
+-- 
+-- Note that if you pass a non-NPC `EntityType` to this function, it will cause a run-time error,
+-- since the `Entity.ToNPC` method will return undefined.
 function ____exports.spawnNPC(self, entityType, variant, subType, position, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
@@ -636,6 +771,9 @@ function ____exports.spawnNPC(self, entityType, variant, subType, position, velo
     return npc
 end
 --- Helper function to spawn an NPC with a specific seed.
+-- 
+-- Note that if you pass a non-NPC `EntityType` to this function, it will cause a run-time error,
+-- since the `Entity.ToNPC` method will return undefined.
 function ____exports.spawnNPCWithSeed(self, entityType, variant, subType, position, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero

package/dist/functions/familiars.lua

@@ -5,8 +5,8 @@ local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____familiarsThatShootPlayerTearsSet = require("sets.familiarsThatShootPlayerTearsSet")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET = ____familiarsThatShootPlayerTearsSet.FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET
-local ____entitySpecific = require("functions.entitySpecific")
-local getFamiliars = ____entitySpecific.getFamiliars
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local getFamiliars = ____entitiesSpecific.getFamiliars
 --- Helper function to add and remove familiars based on a target amount that you specify.
 -- 
 -- This is a convenience wrapper around the `EntityPlayer.CheckFamiliar` method. Use this helper

package/dist/functions/{gridEntity.d.ts → gridEntities.d.ts}

@@ -1,5 +1,6 @@
-import { GridEntityType, GridEntityXMLType } from "isaac-typescript-definitions";
+import { CrawlSpaceVariant, GridEntityType, GridEntityXMLType, TrapdoorVariant } from "isaac-typescript-definitions";
 import { RockAltType } from "../enums/RockAltType";
+import { AnyGridEntity } from "../types/AnyGridEntity";
 /**
  * Helper function to convert the grid entity type found in a room XML file to the corresponding
  * grid entity type and variant normally used by the game. For example, a rock is represented as
@@ -20,6 +21,13 @@ export declare function getAllGridIndexes(): int[];
  * have collision yet in that callback.
  */
 export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntity): Entity[];
+/**
+ * Helper function to get all of the crawl spaces in the room.
+ *
+ * @param crawlSpaceVariant Optional. If specified, will only get the crawl spaces that match the
+ *                          variant. Default is -1, which matches every variant.
+ */
+export declare function getCrawlSpaces(crawlSpaceVariant?: CrawlSpaceVariant): GridEntity[];
 /**
  * Helper function to get every grid entity in the current room.
  *
@@ -70,6 +78,8 @@ export declare function getGridEntityIDFromConstituents(gridEntityType: GridEnti
 /**
  * Helper function to get all of the grid entities in the room that specifically match the type and
  * variant provided.
+ *
+ * If you want to match every variant, use the `getGridEntities` function instead.
  */
 export declare function getMatchingGridEntities(gridEntityType: GridEntityType, variant: int): GridEntity[];
 /**
@@ -94,7 +104,11 @@ export declare function getTopLeftWall(): GridEntity | undefined;
  * room shape is.)
  */
 export declare function getTopLeftWallGridIndex(): int;
-export declare function isGridEntityBreakableByExplosion(gridEntity: GridEntity): boolean;
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` in the room.
+ * Specify a specific trapdoor variant to select only trapdoors of that variant.
+ */
+export declare function getTrapdoors(trapdoorVariant?: TrapdoorVariant): GridEntity[];
 /**
  * Helper function to see if the provided gridEntity is in its respective broken state. See the
  * `GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP` constant for more details.
@@ -102,12 +116,17 @@ export declare function isGridEntityBreakableByExplosion(gridEntity: GridEntity)
  * Note that in the case of `GridEntityType.LOCK` (11), the state will turn to being broken before
  * the actual collision for the entity is removed.
  */
-export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
+export declare function isGridEntityBreakableByExplosion(gridEntity: GridEntity): boolean;
 /**
  * Helper function to detect whether a given Void Portal is one that randomly spawns after a boss is
  * defeated or is one that naturally spawns in the room after Hush. (This is determined by looking
  * at the VarData of the entity.)
  */
+export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
+/**
+ * Helper function to determine if all of the pressure plates in the current room are pushed.
+ * Returns true if there are no pressure plates in the room.
+ */
 export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
 /**
  * Helper function to all grid entities in the room except for ones matching the grid entity types
@@ -125,7 +144,7 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  * );
  * ```
  *
- * @returns True if one or more grid entities were removed, false otherwise.
+ * @returns The grid entities that were removed.
  */
 export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]): GridEntity[];
 /**
@@ -149,18 +168,30 @@ export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]
  */
 export declare function removeAllMatchingGridEntities(...gridEntityType: GridEntityType[]): GridEntity[];
 /**
- * Helper function to remove a grid entity simply by providing the grid entity object. By default,
- * this will also update the room.
+ * Helper function to remove all of the grid entities in the supplied array.
+ *
+ * @param gridEntities The array of grid entities to remove.
+ * @param updateRoom Whether or not to update the room after the grid entities are removed. This is
+ *                   generally a good idea because if the room is not updated, you will be unable to
+ *                   spawn another grid entity on the same tile until a frame has passed. However,
+ *                   doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
+ *                   so set this to false if you need to invoke this function multiple times.
+ * @param cap Optional. If specified, will only remove the given amount of entities.
+ * @returns An array of the entities that were removed.
+ */
+export declare function removeGridEntities<T extends AnyGridEntity>(gridEntities: T[], updateRoom: boolean, cap?: int): T[];
+/**
+ * Helper function to remove a grid entity by providing the grid entity object or the grid index
+ * inside of the room.
  *
  * @param gridEntityOrGridIndex The grid entity or grid index to remove.
- * @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
- *                   Default is true. This is generally a good idea because if the room is not
- *                   updated, you will be unable to spawn another grid entity on the same tile until
- *                   a frame has passed. However, doing this is expensive, since it involves a call
- *                   to `Isaac.GetRoomEntities`, so set it to false if you need to invoke this
- *                   function multiple times.
+ * @param updateRoom Whether or not to update the room after the grid entity is removed. This is
+ *                   generally a good idea because if the room is not updated, you will be unable to
+ *                   spawn another grid entity on the same tile until a frame has passed. However,
+ *                   doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
+ *                   so set this to false if you need to invoke this function multiple times.
  */
-export declare function removeGrid(gridEntityOrGridIndex: GridEntity, updateRoom?: boolean): void;
+export declare function removeGridEntity(gridEntityOrGridIndex: GridEntity | int, updateRoom: boolean): void;
 /**
  * Helper function to make a grid entity invisible. This is accomplished by setting its sprite to an
  * empty/missing PNG file.
@@ -177,14 +208,14 @@ export declare function spawnGiantPoop(topLeftGridIndex: int): void;
  * Helper function to spawn a grid entity.
  *
  * This function assumes you want to give the grid entity a variant of 0. If you want to specify a
- * variant, use the `spawnGridWithVariant` helper function instead.
+ * variant, use the `spawnGridEntityWithVariant` helper function instead.
  *
  * Use this instead of the `Isaac.GridSpawn` method since it:
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify either the grid index or the position
  */
-export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndexOrPosition: int | Vector): GridEntity | undefined;
 /**
  * Helper function to spawn a grid entity with a specific variant.
  *
@@ -193,7 +224,7 @@ export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPos
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify the grid index or the position
  */
-export declare function spawnGridWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+export declare function spawnGridEntityWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
 /**
  * Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
  * breaks.
@@ -217,4 +248,4 @@ export declare function spawnRockAltReward(rockAltType: RockAltType, _seedOrRNG?
  * with the appropriate variant, as the game does not give it the correct sprite automatically.
  */
 export declare function spawnVoidPortal(gridIndex: int): GridEntity | undefined;
-//# sourceMappingURL=gridEntity.d.ts.map
+//# sourceMappingURL=gridEntities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAEjB,cAAc,EACd,iBAAiB,EAGjB,eAAe,EAChB,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAQnD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AA+BvD;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAqBnC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;GAMG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CA4BV;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,iBAAiB,GAAE,iBAAsB,GACxC,UAAU,EAAE,CAMd;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,wFAAwF;AACxF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAI9D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CA2Bd;AAED,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAS7C;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,UAAU,EAAE,CAM5E;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAKpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAWN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,IAAI,CA4B1D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,EACxB,UAAU,GAAE,IAAI,GAAG,GAAqB,GACvC,OAAO,CA6BT;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}