isaacscript-common 6.6.4 → 6.7.1

package/dist/functions/{gridEntity.lua → gridEntities.lua}

@@ -32,8 +32,10 @@ local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
 local ____rooms = require("functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
-local ____sprite = require("functions.sprite")
-local clearSprite = ____sprite.clearSprite
+local ____sprites = require("functions.sprites")
+local clearSprite = ____sprites.clearSprite
+local ____types = require("functions.types")
+local isNumber = ____types.isNumber
 local ____utils = require("functions.utils")
 local erange = ____utils.erange
 local ____vector = require("functions.vector")
@@ -46,6 +48,43 @@ function ____exports.getAllGridIndexes(self)
     local gridSize = room:GetGridSize()
     return erange(nil, gridSize)
 end
+--- Helper function to get every grid entity in the current room.
+-- 
+-- Use this function with no arguments to get every grid entity, or specify a variadic amount of
+-- arguments to match specific grid entity types.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- for (const gridEntity of getGridEntities()) {
+--   print(gridEntity.GetType())
+-- }
+-- ```
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const rocks = getGridEntities(
+--   GridEntityType.ROCK,
+--   GridEntityType.BLOCK,
+--   GridEntityType.ROCK_TINTED,
+-- );
+-- ```
+function ____exports.getGridEntities(self, ...)
+    local gridEntityTypes = {...}
+    local gridEntities = getAllGridEntities(nil)
+    if #gridEntityTypes == 0 then
+        return gridEntities
+    end
+    local gridEntityTypesSet = __TS__New(Set, gridEntityTypes)
+    return __TS__ArrayFilter(
+        gridEntities,
+        function(____, gridEntity)
+            local gridEntityType = gridEntity:GetType()
+            return gridEntityTypesSet:has(gridEntityType)
+        end
+    )
+end
 function getAllGridEntities(self)
     local room = game:GetRoom()
     local gridEntities = {}
@@ -57,6 +96,17 @@ function getAllGridEntities(self)
     end
     return gridEntities
 end
+--- 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.
+function ____exports.getMatchingGridEntities(self, gridEntityType, variant)
+    local gridEntities = ____exports.getGridEntities(nil, gridEntityType)
+    return __TS__ArrayFilter(
+        gridEntities,
+        function(____, gridEntity) return gridEntity:GetVariant() == variant end
+    )
+end
 --- Helper function to get the grid index of the top left wall. (This will depend on what the current
 -- room shape is.)
 function ____exports.getTopLeftWallGridIndex(self)
@@ -65,22 +115,18 @@ function ____exports.getTopLeftWallGridIndex(self)
     local topLeftWallGridIndex = ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP:get(roomShape)
     return topLeftWallGridIndex == nil and DEFAULT_TOP_LEFT_WALL_GRID_INDEX or topLeftWallGridIndex
 end
---- 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 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.
-function ____exports.removeGrid(self, gridEntityOrGridIndex, updateRoom)
-    if updateRoom == nil then
-        updateRoom = true
-    end
+-- @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.
+function ____exports.removeGridEntity(self, gridEntityOrGridIndex, updateRoom)
     local room = game:GetRoom()
-    local gridIndex = gridEntityOrGridIndex:GetGridIndex()
+    local gridIndex = isNumber(nil, gridEntityOrGridIndex) and gridEntityOrGridIndex or gridEntityOrGridIndex:GetGridIndex()
     room:RemoveGridEntity(gridIndex, 0, false)
     if updateRoom then
         roomUpdateSafe(nil)
@@ -92,7 +138,7 @@ end
 -- - handles giving pits collision
 -- - removes existing grid entities on the same tile, if any
 -- - allows you to specify the grid index or the position
-function ____exports.spawnGridWithVariant(self, gridEntityType, variant, gridIndexOrPosition)
+function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndexOrPosition)
     local room = game:GetRoom()
     local ____isVector_result_0
     if isVector(nil, gridIndexOrPosition) then
@@ -102,7 +148,7 @@ function ____exports.spawnGridWithVariant(self, gridEntityType, variant, gridInd
     end
     local existingGridEntity = ____isVector_result_0
     if existingGridEntity ~= nil then
-        ____exports.removeGrid(nil, existingGridEntity)
+        ____exports.removeGridEntity(nil, existingGridEntity, true)
     end
     local position = isVector(nil, gridIndexOrPosition) and gridIndexOrPosition or room:GetGridPosition(gridIndexOrPosition)
     local gridEntity = Isaac.GridSpawn(gridEntityType, variant, position)
@@ -171,42 +217,18 @@ function ____exports.getCollidingEntitiesWithGridEntity(self, gridEntity)
         ) end
     )
 end
---- Helper function to get every grid entity in the current room.
--- 
--- Use this function with no arguments to get every grid entity, or specify a variadic amount of
--- arguments to match specific grid entity types.
--- 
--- For example:
+--- Helper function to get all of the crawl spaces in the room.
 -- 
--- ```ts
--- for (const gridEntity of getGridEntities()) {
---   print(gridEntity.GetType())
--- }
--- ```
--- 
--- For example:
--- 
--- ```ts
--- const rocks = getGridEntities(
---   GridEntityType.ROCK,
---   GridEntityType.BLOCK,
---   GridEntityType.ROCK_TINTED,
--- );
--- ```
-function ____exports.getGridEntities(self, ...)
-    local gridEntityTypes = {...}
-    local gridEntities = getAllGridEntities(nil)
-    if #gridEntityTypes == 0 then
-        return gridEntities
+-- @param crawlSpaceVariant Optional. If specified, will only get the crawl spaces that match the
+-- variant. Default is -1, which matches every variant.
+function ____exports.getCrawlSpaces(self, crawlSpaceVariant)
+    if crawlSpaceVariant == nil then
+        crawlSpaceVariant = -1
     end
-    local gridEntityTypesSet = __TS__New(Set, gridEntityTypes)
-    return __TS__ArrayFilter(
-        gridEntities,
-        function(____, gridEntity)
-            local gridEntityType = gridEntity:GetType()
-            return gridEntityTypesSet:has(gridEntityType)
-        end
-    )
+    if crawlSpaceVariant == -1 then
+        return ____exports.getGridEntities(nil, GridEntityType.CRAWL_SPACE)
+    end
+    return ____exports.getMatchingGridEntities(nil, GridEntityType.CRAWL_SPACE, crawlSpaceVariant)
 end
 --- Helper function to get every grid entity in the current room except for certain specific types.
 -- 
@@ -252,15 +274,6 @@ end
 function ____exports.getGridEntityIDFromConstituents(self, gridEntityType, variant)
     return (tostring(gridEntityType) .. ".") .. tostring(variant)
 end
---- Helper function to get all of the grid entities in the room that specifically match the type and
--- variant provided.
-function ____exports.getMatchingGridEntities(self, gridEntityType, variant)
-    local gridEntities = ____exports.getGridEntities(nil, gridEntityType)
-    return __TS__ArrayFilter(
-        gridEntities,
-        function(____, gridEntity) return gridEntity:GetVariant() == variant end
-    )
-end
 --- Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
 -- will have.
 -- 
@@ -306,25 +319,35 @@ function ____exports.getTopLeftWall(self)
     local topLeftWallGridIndex = ____exports.getTopLeftWallGridIndex(nil)
     return room:GetGridEntity(topLeftWallGridIndex)
 end
-function ____exports.isGridEntityBreakableByExplosion(self, gridEntity)
-    local gridEntityType = gridEntity:GetType()
-    local gridEntityVariant = gridEntity:GetVariant()
-    local gridEntityTypeVariant = (tostring(gridEntityType) .. ".") .. tostring(gridEntityVariant)
-    return BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS:has(gridEntityType) or BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS:has(gridEntityTypeVariant)
+--- 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.
+function ____exports.getTrapdoors(self, trapdoorVariant)
+    if trapdoorVariant == nil then
+        return ____exports.getGridEntities(nil, GridEntityType.TRAPDOOR)
+    end
+    return ____exports.getMatchingGridEntities(nil, GridEntityType.TRAPDOOR, trapdoorVariant)
 end
 --- 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.
 -- 
 -- 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.
-function ____exports.isGridEntityBroken(self, gridEntity)
+function ____exports.isGridEntityBreakableByExplosion(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
-    local brokenState = GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP:get(gridEntityType)
-    return gridEntity.State == brokenState
+    local gridEntityVariant = gridEntity:GetVariant()
+    local gridEntityTypeVariant = (tostring(gridEntityType) .. ".") .. tostring(gridEntityVariant)
+    return BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS:has(gridEntityType) or BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS:has(gridEntityTypeVariant)
 end
 --- 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.)
+function ____exports.isGridEntityBroken(self, gridEntity)
+    local gridEntityType = gridEntity:GetType()
+    local brokenState = GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP:get(gridEntityType)
+    return gridEntity.State == brokenState
+end
+--- 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.
 function ____exports.isPostBossVoidPortal(self, gridEntity)
     local saveState = gridEntity:GetSaveState()
     return saveState.VarData == 1
@@ -344,7 +367,7 @@ end
 -- );
 -- ```
 -- 
--- @returns True if one or more grid entities were removed, false otherwise.
+-- @returns The grid entities that were removed.
 function ____exports.removeAllGridExcept(self, ...)
     local gridEntityTypes = {...}
     local gridEntityTypeExceptions = __TS__New(Set, gridEntityTypes)
@@ -353,7 +376,7 @@ function ____exports.removeAllGridExcept(self, ...)
     for ____, gridEntity in ipairs(gridEntities) do
         local gridEntityType = gridEntity:GetType()
         if not gridEntityTypeExceptions:has(gridEntityType) then
-            ____exports.removeGrid(nil, gridEntity, false)
+            ____exports.removeGridEntity(nil, gridEntity, false)
             removedGridEntities[#removedGridEntities + 1] = gridEntity
         end
     end
@@ -385,11 +408,38 @@ function ____exports.removeAllMatchingGridEntities(self, ...)
         return {}
     end
     for ____, gridEntity in ipairs(gridEntities) do
-        ____exports.removeGrid(nil, gridEntity, false)
+        ____exports.removeGridEntity(nil, gridEntity, false)
     end
     roomUpdateSafe(nil)
     return gridEntities
 end
+--- 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.
+function ____exports.removeGridEntities(self, gridEntities, updateRoom, cap)
+    if #gridEntities == 0 then
+        return {}
+    end
+    local gridEntitiesRemoved = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        ____exports.removeGridEntity(nil, gridEntity, false)
+        gridEntitiesRemoved[#gridEntitiesRemoved + 1] = gridEntity
+        if cap ~= nil and #gridEntitiesRemoved >= cap then
+            break
+        end
+    end
+    if updateRoom then
+        roomUpdateSafe(nil)
+    end
+    return gridEntitiesRemoved
+end
 --- Helper function to make a grid entity invisible. This is accomplished by setting its sprite to an
 -- empty/missing PNG file.
 -- 
@@ -406,22 +456,22 @@ function ____exports.spawnGiantPoop(self, topLeftGridIndex)
     local topRightGridIndex = topLeftGridIndex + 1
     local bottomLeftGridIndex = topLeftGridIndex + gridWidth
     local bottomRightGridIndex = bottomLeftGridIndex + 1
-    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_TOP_LEFT, topLeftGridIndex)
-    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_TOP_RIGHT, topRightGridIndex)
-    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_BOTTOM_LEFT, bottomLeftGridIndex)
-    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_BOTTOM_RIGHT, bottomRightGridIndex)
+    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_TOP_LEFT, topLeftGridIndex)
+    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_TOP_RIGHT, topRightGridIndex)
+    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_BOTTOM_LEFT, bottomLeftGridIndex)
+    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_BOTTOM_RIGHT, bottomRightGridIndex)
 end
 --- 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
-function ____exports.spawnGrid(self, gridEntityType, gridIndexOrPosition)
-    return ____exports.spawnGridWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
+function ____exports.spawnGridEntity(self, gridEntityType, gridIndexOrPosition)
+    return ____exports.spawnGridEntityWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
 end
 --- Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
 -- breaks.
@@ -443,33 +493,33 @@ function ____exports.spawnRockAltReward(self, rockAltType, _seedOrRNG)
         _seedOrRNG = getRandomSeed(nil)
     end
     repeat
-        local ____switch56 = rockAltType
-        local ____cond56 = ____switch56 == RockAltType.URN
-        if ____cond56 then
+        local ____switch66 = rockAltType
+        local ____cond66 = ____switch66 == RockAltType.URN
+        if ____cond66 then
             do
                 return false
             end
         end
-        ____cond56 = ____cond56 or ____switch56 == RockAltType.MUSHROOM
-        if ____cond56 then
+        ____cond66 = ____cond66 or ____switch66 == RockAltType.MUSHROOM
+        if ____cond66 then
             do
                 return false
             end
         end
-        ____cond56 = ____cond56 or ____switch56 == RockAltType.SKULL
-        if ____cond56 then
+        ____cond66 = ____cond66 or ____switch66 == RockAltType.SKULL
+        if ____cond66 then
             do
                 return false
             end
         end
-        ____cond56 = ____cond56 or ____switch56 == RockAltType.POLYP
-        if ____cond56 then
+        ____cond66 = ____cond66 or ____switch66 == RockAltType.POLYP
+        if ____cond66 then
             do
                 return false
             end
         end
-        ____cond56 = ____cond56 or ____switch56 == RockAltType.BUCKET
-        if ____cond56 then
+        ____cond66 = ____cond66 or ____switch66 == RockAltType.BUCKET
+        if ____cond66 then
             do
                 return false
             end
@@ -479,7 +529,7 @@ end
 --- Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
 -- with the appropriate variant, as the game does not give it the correct sprite automatically.
 function ____exports.spawnVoidPortal(self, gridIndex)
-    local voidPortal = ____exports.spawnGridWithVariant(nil, GridEntityType.TRAPDOOR, TrapdoorVariant.VOID_PORTAL, gridIndex)
+    local voidPortal = ____exports.spawnGridEntityWithVariant(nil, GridEntityType.TRAPDOOR, TrapdoorVariant.VOID_PORTAL, gridIndex)
     if voidPortal == nil then
         return voidPortal
     end

package/dist/functions/gridEntitiesSpecific.d.ts

@@ -0,0 +1,141 @@
+import { DoorVariant, PitVariant, PoopGridEntityVariant, PressurePlateVariant, RockVariant } from "isaac-typescript-definitions";
+/**
+ * Helper function to get all of the `GridEntityPit` in the room.
+ *
+ * @param pitVariant Optional. If specified, will only get the pits that match the variant. Default
+ *                   is -1, which matches every variant.
+ */
+export declare function getPits(pitVariant?: PitVariant): GridEntityPit[];
+/**
+ * Helper function to get all of the `GridEntityPoop` in the room.
+ *
+ * @param poopVariant Optional. If specified, will only get the poops that match the variant.
+ *                    Default is -1, which matches every variant.
+ */
+export declare function getPoops(poopVariant?: PoopGridEntityVariant): GridEntityPoop[];
+/**
+ * Helper function to get all of the `GridEntityPressurePlate` in the room.
+ *
+ * @param pressurePlateVariant Optional. If specified, will only get the pressure plates that match
+ *                             the variant. Default is -1, which matches every variant.
+ */
+export declare function getPressurePlates(pressurePlateVariant?: PressurePlateVariant): GridEntityPressurePlate[];
+/**
+ * Helper function to get all of the `GridEntityRock` in the room.
+ *
+ * @param variant Optional. If specified, will only get the rocks that match the variant. Default is
+ *                -1, which matches every variant. Note that this is not the same thing as the
+ *                `RockVariant` enum, since that only applies to `GridEntityType.ROCK`, and other
+ *                types of grid entities can be the `GridEntityRock` class.
+ */
+export declare function getRocks(variant?: number): GridEntityRock[];
+/** Helper function to get all of the `GridEntitySpikes` in the room. */
+export declare function getSpikes(variant?: number): GridEntitySpikes[];
+/** Helper function to get all of the `GridEntityTNT` in the room. */
+export declare function getTNT(variant?: number): GridEntityTNT[];
+/**
+ * Helper function to remove all of the `GridEntityPit` in the room.
+ *
+ * @param pitVariant Optional. If specified, will only remove the pits that match this variant.
+ *                   Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the pits are removed. Default
+ *                   is false. For more information, see the description of the `removeGridEntities`
+ *                   helper function.
+ * @param cap Optional. If specified, will only remove the given amount of pits.
+ * @returns The pits that were removed.
+ */
+export declare function removeAllPits(pitVariant?: PitVariant, updateRoom?: boolean, cap?: int): GridEntityPit[];
+/**
+ * Helper function to remove all of the `GridEntityPoop` in the room.
+ *
+ * Note that poops can either be an entity or a grid entity, depending on the situation. This
+ * function will only remove the grid entity poops.
+ *
+ * @param poopVariant Optional. If specified, will only remove the poops that match this variant.
+ *                    Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the poops are removed.
+ *                   Default is false. For more information, see the description of the
+ *                   `removeGridEntities` helper function.
+ * @param cap Optional. If specified, will only remove the given amount of poops.
+ * @returns The poops that were removed.
+ */
+export declare function removeAllPoops(poopVariant?: PoopGridEntityVariant, updateRoom?: boolean, cap?: int): GridEntityPoop[];
+/**
+ * Helper function to remove all of the `GridEntityPressurePlate` in the room.
+ *
+ * @param pressurePlateVariant Optional. If specified, will only remove the pressure plates that
+ *                             match this variant. Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the pressure plates are
+ *                   removed. Default is false. For more information, see the description of the
+ *                   `removeGridEntities` helper function.
+ * @param cap Optional. If specified, will only remove the given amount of pressure plates.
+ * @returns The pressure plates that were removed.
+ */
+export declare function removeAllPressurePlates(pressurePlateVariant?: PressurePlateVariant, updateRoom?: boolean, cap?: int): GridEntityPressurePlate[];
+/**
+ * Helper function to remove all of the `GridEntityRock` in the room.
+ *
+ * @param variant Optional. If specified, will only remove the rocks that match this variant.
+ *                Default is -1, which matches every variant. Note that this is not the same thing
+ *                as the `RockVariant` enum, since that only applies to `GridEntityType.ROCK`, and
+ *                other types of grid entities can be the `GridEntityRock` class.
+ * @param updateRoom Optional. Whether or not to update the room after the rocks are removed.
+ *                   Default is false. For more information, see the description of the
+ *                   `removeGridEntities` helper function.
+ * @param cap Optional. If specified, will only remove the given amount of rocks.
+ * @returns The rocks that were removed.
+ */
+export declare function removeAllRocks(variant?: number, updateRoom?: boolean, cap?: int): GridEntityRock[];
+/**
+ * Helper function to remove all of the `GridEntitySpikes` in the room.
+ *
+ * @param variant Optional. If specified, will only remove the spikes that match this variant.
+ *                Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the spikes are removed.
+ *                   Default is false. For more information, see the description of the
+ *                   `removeGridEntities` helper function.
+ * @param cap Optional. If specified, will only remove the given amount of spikes.
+ * @returns The spikes that were removed.
+ */
+export declare function removeAllSpikes(variant?: number, updateRoom?: boolean, cap?: int): GridEntitySpikes[];
+/**
+ * Helper function to remove all of the `GridEntityTNT` in the room.
+ *
+ * @param variant Optional. If specified, will only remove the TNTs that match this variant. Default
+ *                is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the TNTs are removed. Default
+ *                   is false. For more information, see the description of the `removeGridEntities`
+ *                   helper function.
+ * @param cap Optional. If specified, will only remove the given amount of TNTs.
+ * @returns The TNTs that were removed.
+ */
+export declare function removeAllTNT(variant?: number, updateRoom?: boolean, cap?: int): GridEntityTNT[];
+/** Helper function to spawn a `GridEntityType.DOOR` (16). */
+export declare function spawnDoor(gridIndexOrPosition: int | Vector): GridEntityDoor | undefined;
+/** Helper function to spawn a `GridEntityType.DOOR` (16) with a specific variant. */
+export declare function spawnDoorWithVariant(doorVariant: DoorVariant, gridIndexOrPosition: int | Vector): GridEntityDoor | undefined;
+/** Helper function to spawn a `GridEntityType.PIT` (7). */
+export declare function spawnPit(gridIndexOrPosition: int | Vector): GridEntityPit | undefined;
+/** Helper function to spawn a `GridEntityType.PIT` (7) with a specific variant. */
+export declare function spawnPitWithVariant(pitVariant: PitVariant, gridIndexOrPosition: int | Vector): GridEntityPit | undefined;
+/** Helper function to spawn a `GridEntityType.POOP` (14). */
+export declare function spawnPoop(gridIndexOrPosition: int | Vector): GridEntityPoop | undefined;
+/** Helper function to spawn a `GridEntityType.POOP` (14) with a specific variant. */
+export declare function spawnPoopWithVariant(poopVariant: PoopGridEntityVariant, gridIndexOrPosition: int | Vector): GridEntityPoop | undefined;
+/** Helper function to spawn a `GridEntityType.PRESSURE_PLATE` (20). */
+export declare function spawnPressurePlate(gridIndexOrPosition: int | Vector): GridEntityPressurePlate | undefined;
+/** Helper function to spawn a `GridEntityType.PRESSURE_PLATE` (20) with a specific variant. */
+export declare function spawnPressurePlateWithVariant(pressurePlateVariant: PressurePlateVariant, gridIndexOrPosition: int | Vector): GridEntityPressurePlate | undefined;
+/** Helper function to spawn a `GridEntityType.ROCK` (2). */
+export declare function spawnRock(gridIndexOrPosition: int | Vector): GridEntityRock | undefined;
+/** Helper function to spawn a `GridEntityType.ROCK` (2) with a specific variant. */
+export declare function spawnRockWithVariant(rockVariant: RockVariant, gridIndexOrPosition: int | Vector): GridEntityRock | undefined;
+/** Helper function to spawn a `GridEntityType.SPIKES` (8). */
+export declare function spawnSpikes(gridIndexOrPosition: int | Vector): GridEntitySpikes | undefined;
+/** Helper function to spawn a `GridEntityType.SPIKES` (8) with a specific variant. */
+export declare function spawnSpikesWithVariant(variant: int, gridIndexOrPosition: int | Vector): GridEntitySpikes | undefined;
+/** Helper function to spawn a `GridEntityType.TNT` (12). */
+export declare function spawnTNT(gridIndexOrPosition: int | Vector): GridEntityTNT | undefined;
+/** Helper function to spawn a `GridEntityType.TNT` (12) with a specific variant. */
+export declare function spawnTNTWithVariant(variant: int, gridIndexOrPosition: int | Vector): GridEntityTNT | undefined;
+//# sourceMappingURL=gridEntitiesSpecific.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gridEntitiesSpecific.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntitiesSpecific.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAEX,UAAU,EACV,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAUtC;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,UAAU,GAAE,UAAe,GAAG,aAAa,EAAE,CAepE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,WAAW,GAAE,qBAA0B,GACtC,cAAc,EAAE,CAelB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,oBAAoB,GAAE,oBAAyB,GAC9C,uBAAuB,EAAE,CAkB3B;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,OAAO,SAAK,GAAG,cAAc,EAAE,CAevD;AAED,wEAAwE;AACxE,wBAAgB,SAAS,CAAC,OAAO,SAAK,GAAG,gBAAgB,EAAE,CAe1D;AAED,qEAAqE;AACrE,wBAAgB,MAAM,CAAC,OAAO,SAAK,GAAG,aAAa,EAAE,CAepD;AAKD;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,EAAE,CAGjB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,WAAW,GAAE,qBAA0B,EACvC,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,cAAc,EAAE,CAGlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,oBAAoB,GAAE,oBAAyB,EAC/C,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,uBAAuB,EAAE,CAG3B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAC5B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,cAAc,EAAE,CAGlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAGpB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,EAAE,CAGjB;AAED,6DAA6D;AAC7D,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAE5B;AAED,qFAAqF;AACrF,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,2DAA2D;AAC3D,wBAAgB,QAAQ,CACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAE3B;AAED,mFAAmF;AACnF,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,UAAU,EACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAgB3B;AAED,6DAA6D;AAC7D,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAK5B;AAED,qFAAqF;AACrF,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,qBAAqB,EAClC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,uEAAuE;AACvE,wBAAgB,kBAAkB,CAChC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,uBAAuB,GAAG,SAAS,CAKrC;AAED,+FAA+F;AAC/F,wBAAgB,6BAA6B,CAC3C,oBAAoB,EAAE,oBAAoB,EAC1C,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,uBAAuB,GAAG,SAAS,CAgBrC;AAED,4DAA4D;AAC5D,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAE5B;AAED,oFAAoF;AACpF,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,8DAA8D;AAC9D,wBAAgB,WAAW,CACzB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,gBAAgB,GAAG,SAAS,CAE9B;AAED,sFAAsF;AACtF,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,gBAAgB,GAAG,SAAS,CAgB9B;AAED,4DAA4D;AAC5D,wBAAgB,QAAQ,CACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAE3B;AAED,oFAAoF;AACpF,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAgB3B"}