isaacscript-common 1.2.76 → 1.2.79

package/dist/functions/entity.lua

@@ -1,11 +1,10 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local __TS__ArraySome = ____lualib.__TS__ArraySome
-local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
-local Map = ____lualib.Map
+local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local ____constants = require("constants")
 local STORY_BOSSES = ____constants.STORY_BOSSES
@@ -14,20 +13,19 @@ local getRandom = ____random.getRandom
 local nextSeed = ____random.nextSeed
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
-function ____exports.getEntities(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    if ignoreFriendly == nil then
-        ignoreFriendly = false
+function ____exports.removeEntities(self, entities, cap)
+    if #entities == 0 then
+        return false
     end
-    if matchingEntityType == nil then
-        return Isaac.GetRoomEntities()
+    local numEntitiesRemoved = 0
+    for ____, entity in ipairs(entities) do
+        entity:Remove()
+        numEntitiesRemoved = numEntitiesRemoved + 1
+        if cap ~= nil and numEntitiesRemoved >= cap then
+            return true
+        end
     end
-    return Isaac.FindByType(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+    return true
 end
 function ____exports.anyEntityCloserThan(self, entities, position, distance)
     return __TS__ArraySome(
@@ -35,23 +33,6 @@ function ____exports.anyEntityCloserThan(self, entities, position, distance)
         function(____, entity) return position:Distance(entity.Position) <= distance end
     )
 end
-function ____exports.getBombs(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_BOMB, matchingVariant, matchingSubType)
-    local bombs = {}
-    for ____, entity in ipairs(entities) do
-        local bomb = entity:ToBomb()
-        if bomb ~= nil then
-            __TS__ArrayPush(bombs, bomb)
-        end
-    end
-    return bombs
-end
 function ____exports.getClosestEntityTo(self, referenceEntity, entities)
     local closestEntity = nil
     local closestDistance = math.huge
@@ -81,139 +62,20 @@ function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
         end
     )
 end
-function ____exports.getEffects(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_EFFECT, matchingVariant, matchingSubType)
-    local effects = {}
-    for ____, entity in ipairs(entities) do
-        local effect = entity:ToEffect()
-        if effect ~= nil then
-            __TS__ArrayPush(effects, effect)
-        end
-    end
-    return effects
-end
-function ____exports.getEntityPositions(self, entities)
-    if entities == nil then
-        entities = ____exports.getEntities(nil)
-    end
-    local entityPositions = __TS__New(Map)
-    for ____, entity in ipairs(entities) do
-        local ptrHash = GetPtrHash(entity)
-        entityPositions:set(ptrHash, entity.Position)
-    end
-    return entityPositions
-end
-function ____exports.getEntityVelocities(self, entities)
-    if entities == nil then
-        entities = ____exports.getEntities(nil)
-    end
-    local entityVelocities = __TS__New(Map)
-    for ____, entity in ipairs(entities) do
-        local ptrHash = GetPtrHash(entity)
-        entityVelocities:set(ptrHash, entity.Velocity)
-    end
-    return entityVelocities
-end
-function ____exports.getKnives(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_KNIFE, matchingVariant, matchingSubType)
-    local knives = {}
-    for ____, entity in ipairs(entities) do
-        local knife = entity:ToKnife()
-        if knife ~= nil then
-            __TS__ArrayPush(knives, knife)
-        end
-    end
-    return knives
-end
-function ____exports.getLasers(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_LASER, matchingVariant, matchingSubType)
-    local lasers = {}
-    for ____, entity in ipairs(entities) do
-        local laser = entity:ToLaser()
-        if laser ~= nil then
-            __TS__ArrayPush(lasers, laser)
-        end
-    end
-    return lasers
-end
-function ____exports.getPickups(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_PICKUP, matchingVariant, matchingSubType)
-    local pickups = {}
-    for ____, entity in ipairs(entities) do
-        local pickup = entity:ToPickup()
-        if pickup ~= nil then
-            __TS__ArrayPush(pickups, pickup)
-        end
-    end
-    return pickups
-end
-function ____exports.getProjectiles(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_PROJECTILE, matchingVariant, matchingSubType)
-    local projectiles = {}
-    for ____, entity in ipairs(entities) do
-        local projectile = entity:ToProjectile()
-        if projectile ~= nil then
-            __TS__ArrayPush(projectiles, projectile)
-        end
-    end
-    return projectiles
-end
-function ____exports.getSlots(self, matchingVariant, matchingSubType)
+function ____exports.getEntities(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
     if matchingVariant == nil then
         matchingVariant = -1
     end
     if matchingSubType == nil then
         matchingSubType = -1
     end
-    local slots = ____exports.getEntities(nil, EntityType.ENTITY_SLOT, matchingVariant, matchingSubType)
-    return slots
-end
-function ____exports.getTears(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
     end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_TEAR, matchingVariant, matchingSubType)
-    local tears = {}
-    for ____, entity in ipairs(entities) do
-        local tear = entity:ToTear()
-        if tear ~= nil then
-            __TS__ArrayPush(tears, tear)
-        end
+    if matchingEntityType == nil then
+        return Isaac.GetRoomEntities()
     end
-    return tears
+    return Isaac.FindByType(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
 end
 function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
@@ -224,36 +86,6 @@ end
 function ____exports.isStoryBoss(self, entity)
     return STORY_BOSSES:has(entity.Type)
 end
-function ____exports.removeEntities(self, entities, cap)
-    if #entities == 0 then
-        return false
-    end
-    local numEntitiesRemoved = 0
-    for ____, entity in ipairs(entities) do
-        entity:Remove()
-        numEntitiesRemoved = numEntitiesRemoved + 1
-        if cap ~= nil and numEntitiesRemoved >= cap then
-            return true
-        end
-    end
-    return true
-end
-function ____exports.removeAllBombs(self, variant, subType, cap)
-    local bombs = ____exports.getBombs(nil, variant, subType)
-    return ____exports.removeEntities(nil, bombs, cap)
-end
-function ____exports.removeAllEffects(self, variant, subType, cap)
-    local effects = ____exports.getEffects(nil, variant, subType)
-    return ____exports.removeEntities(nil, effects, cap)
-end
-function ____exports.removeAllKnives(self, variant, subType, cap)
-    local knives = ____exports.getKnives(nil, variant, subType)
-    return ____exports.removeEntities(nil, knives, cap)
-end
-function ____exports.removeAllLasers(self, variant, subType, cap)
-    local lasers = ____exports.getLasers(nil, variant, subType)
-    return ____exports.removeEntities(nil, lasers, cap)
-end
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then
         entityVariant = -1
@@ -267,44 +99,20 @@ function ____exports.removeAllMatchingEntities(self, entityType, entityVariant,
     local entities = ____exports.getEntities(nil, entityType, entityVariant, entitySubType)
     return ____exports.removeEntities(nil, entities, cap)
 end
-function ____exports.removeAllPickups(self, variant, subType, cap)
-    local pickups = ____exports.getPickups(nil, variant, subType)
-    return ____exports.removeEntities(nil, pickups, cap)
-end
-function ____exports.removeAllProjectiles(self, variant, subType, cap)
-    local projectiles = ____exports.getProjectiles(nil, variant, subType)
-    return ____exports.removeEntities(nil, projectiles, cap)
-end
-function ____exports.removeAllTears(self, variant, subType, cap)
-    local tears = ____exports.getTears(nil, variant, subType)
-    return ____exports.removeEntities(nil, tears, cap)
-end
 function ____exports.rerollEnemy(self, entity)
     local game = Game()
     local oldEntities = ____exports.getEntities(nil)
     local wasRerolled = game:RerollEnemy(entity)
     if not wasRerolled then
-        return entity
+        return nil
     end
     local newEntities = ____exports.getEntities(nil)
     local filteredNewEntities = ____exports.getFilteredNewEntities(nil, oldEntities, newEntities)
-    if #filteredNewEntities ~= 0 then
+    if #filteredNewEntities == 0 then
         error("Failed to find the new entity generated by the \"RerollEnemy\" method.")
     end
     return filteredNewEntities[1]
 end
-function ____exports.setEntityPositions(self, entityPositions, entities)
-    if entities == nil then
-        entities = ____exports.getEntities(nil)
-    end
-    for ____, entity in ipairs(entities) do
-        local ptrHash = GetPtrHash(entity)
-        local entityPosition = entityPositions:get(ptrHash)
-        if entityPosition ~= nil then
-            entity.Position = entityPosition
-        end
-    end
-end
 function ____exports.setEntityRandomColor(self, entity)
     local colorValues = {}
     local seed = entity.InitSeed
@@ -326,16 +134,4 @@ function ____exports.setEntityRandomColor(self, entity)
         false
     )
 end
-function ____exports.setEntityVelocities(self, entityVelocities, entities)
-    if entities == nil then
-        entities = ____exports.getEntities(nil)
-    end
-    for ____, entity in ipairs(entities) do
-        local ptrHash = GetPtrHash(entity)
-        local entityVelocity = entityVelocities:get(ptrHash)
-        if entityVelocity ~= nil then
-            entity.Velocity = entityVelocity
-        end
-    end
-end
 return ____exports

package/dist/functions/entitySpecific.d.ts

@@ -0,0 +1,148 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to get all of the bombs in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the bombs in the room invisible
+ * for (const bomb of getBombs()) {
+ *   bomb.Visible = false;
+ * }
+ * ```
+ */
+export declare function getBombs(matchingVariant?: BombVariant | int, matchingSubType?: number): EntityBomb[];
+/**
+ * Helper function to get all of the effects in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the effects in the room invisible
+ * for (const effect of getEffects()) {
+ *   effect.Visible = false;
+ * }
+ * ```
+ */
+export declare function getEffects(matchingVariant?: EffectVariant | int, matchingSubType?: number): EntityEffect[];
+/**
+ * Helper function to get all of the knives in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the knives in the room invisible
+ * for (const knife of getKnives()) {
+ *   knife.Visible = false;
+ * }
+ * ```
+ */
+export declare function getKnives(matchingVariant?: KnifeVariant | int, matchingSubType?: number): EntityKnife[];
+/**
+ * Helper function to get all of the lasers in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the lasers in the room invisible
+ * for (const laser of getLasers()) {
+ *   laser.Visible = false;
+ * }
+ * ```
+ */
+export declare function getLasers(matchingVariant?: LaserVariant | int, matchingSubType?: number): EntityLaser[];
+/**
+ * Helper function to get all of the projectiles in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the projectiles in the room invisible
+ * for (const projectile of getProjectiles()) {
+ *   projectile.Visible = false;
+ * }
+ * ```
+ */
+export declare function getProjectiles(matchingVariant?: ProjectileVariant | int, matchingSubType?: number): EntityProjectile[];
+/**
+ * Helper function to get all of the slots in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the slots in the room invisible
+ * for (const slot of getSlots()) {
+ *   slot.Visible = false;
+ * }
+ * ```
+ */
+export declare function getSlots(matchingVariant?: SlotVariant | int, matchingSubType?: number): Entity[];
+/**
+ * Helper function to get all of the tears in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the tears in the room invisible
+ * for (const tear of getTears()) {
+ *   tear.Visible = false;
+ * }
+ * ```
+ */
+export declare function getTears(matchingVariant?: TearVariant | int, matchingSubType?: number): EntityTear[];
+/**
+ * Helper function to remove all of the bombs in the room.
+ *
+ * @param variant 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.
+ * @param cap Optional. If specified, will only remove the given amount of bombs.
+ * @returns True if one or more bombs was removed, false otherwise.
+ */
+export declare function removeAllBombs(variant?: BombVariant | int, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the effects in the room.
+ *
+ * @param variant 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 cap Optional. If specified, will only remove the given amount of effects.
+ * @returns True if one or more effects was removed, false otherwise.
+ */
+export declare function removeAllEffects(variant?: EffectVariant | int, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the knives in the room.
+ *
+ * @param variant 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 cap Optional. If specified, will only remove the given amount of knives.
+ * @returns True if one or more knives was removed, false otherwise.
+ */
+export declare function removeAllKnives(variant?: KnifeVariant | int, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the lasers in the room.
+ *
+ * @param variant 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 cap Optional. If specified, will only remove the given amount of lasers.
+ * @returns True if one or more lasers was removed, false otherwise.
+ */
+export declare function removeAllLasers(variant?: LaserVariant | int, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the projectiles in the room.
+ *
+ * @param variant Optional. If specified, will only remove projectiles that match this variant.
+ * @param subType Optional. If specified, will only remove projectiles that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of projectiles.
+ * @returns True if one or more projectiles was removed, false otherwise.
+ */
+export declare function removeAllProjectiles(variant?: ProjectileVariant | int, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the slots in the room.
+ *
+ * @param variant 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.
+ * @param cap Optional. If specified, will only remove the given amount of slots.
+ * @returns True if one or more slots was removed, false otherwise.
+ */
+export declare function removeAllSlots(variant?: SlotVariant | int, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the tears in the room.
+ *
+ * @param variant 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.
+ * @param cap Optional. If specified, will only remove the given amount of tears.
+ * @returns True if one or more tears was removed, false otherwise.
+ */
+export declare function removeAllTears(variant?: TearVariant | int, subType?: int, cap?: int): boolean;

package/dist/functions/entitySpecific.lua

@@ -0,0 +1,148 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayPush = ____lualib.__TS__ArrayPush
+local ____exports = {}
+local ____entity = require("functions.entity")
+local getEntities = ____entity.getEntities
+local removeEntities = ____entity.removeEntities
+function ____exports.getBombs(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = getEntities(nil, EntityType.ENTITY_BOMB, matchingVariant, matchingSubType)
+    local bombs = {}
+    for ____, entity in ipairs(entities) do
+        local bomb = entity:ToBomb()
+        if bomb ~= nil then
+            __TS__ArrayPush(bombs, bomb)
+        end
+    end
+    return bombs
+end
+function ____exports.getEffects(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = getEntities(nil, EntityType.ENTITY_EFFECT, matchingVariant, matchingSubType)
+    local effects = {}
+    for ____, entity in ipairs(entities) do
+        local effect = entity:ToEffect()
+        if effect ~= nil then
+            __TS__ArrayPush(effects, effect)
+        end
+    end
+    return effects
+end
+function ____exports.getKnives(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = getEntities(nil, EntityType.ENTITY_KNIFE, matchingVariant, matchingSubType)
+    local knives = {}
+    for ____, entity in ipairs(entities) do
+        local knife = entity:ToKnife()
+        if knife ~= nil then
+            __TS__ArrayPush(knives, knife)
+        end
+    end
+    return knives
+end
+function ____exports.getLasers(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = getEntities(nil, EntityType.ENTITY_LASER, matchingVariant, matchingSubType)
+    local lasers = {}
+    for ____, entity in ipairs(entities) do
+        local laser = entity:ToLaser()
+        if laser ~= nil then
+            __TS__ArrayPush(lasers, laser)
+        end
+    end
+    return lasers
+end
+function ____exports.getProjectiles(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = getEntities(nil, EntityType.ENTITY_PROJECTILE, matchingVariant, matchingSubType)
+    local projectiles = {}
+    for ____, entity in ipairs(entities) do
+        local projectile = entity:ToProjectile()
+        if projectile ~= nil then
+            __TS__ArrayPush(projectiles, projectile)
+        end
+    end
+    return projectiles
+end
+function ____exports.getSlots(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local slots = getEntities(nil, EntityType.ENTITY_SLOT, matchingVariant, matchingSubType)
+    return slots
+end
+function ____exports.getTears(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = getEntities(nil, EntityType.ENTITY_TEAR, matchingVariant, matchingSubType)
+    local tears = {}
+    for ____, entity in ipairs(entities) do
+        local tear = entity:ToTear()
+        if tear ~= nil then
+            __TS__ArrayPush(tears, tear)
+        end
+    end
+    return tears
+end
+function ____exports.removeAllBombs(self, variant, subType, cap)
+    local bombs = ____exports.getBombs(nil, variant, subType)
+    return removeEntities(nil, bombs, cap)
+end
+function ____exports.removeAllEffects(self, variant, subType, cap)
+    local effects = ____exports.getEffects(nil, variant, subType)
+    return removeEntities(nil, effects, cap)
+end
+function ____exports.removeAllKnives(self, variant, subType, cap)
+    local knives = ____exports.getKnives(nil, variant, subType)
+    return removeEntities(nil, knives, cap)
+end
+function ____exports.removeAllLasers(self, variant, subType, cap)
+    local lasers = ____exports.getLasers(nil, variant, subType)
+    return removeEntities(nil, lasers, cap)
+end
+function ____exports.removeAllProjectiles(self, variant, subType, cap)
+    local projectiles = ____exports.getProjectiles(nil, variant, subType)
+    return removeEntities(nil, projectiles, cap)
+end
+function ____exports.removeAllSlots(self, variant, subType, cap)
+    local slots = ____exports.getSlots(nil, variant, subType)
+    return removeEntities(nil, slots, cap)
+end
+function ____exports.removeAllTears(self, variant, subType, cap)
+    local tears = ____exports.getTears(nil, variant, subType)
+    return removeEntities(nil, tears, cap)
+end
+return ____exports

package/dist/functions/npc.lua

@@ -11,8 +11,9 @@ local EGGY_STATE_FRAME_OF_FINAL_SPIDER = ____constants.EGGY_STATE_FRAME_OF_FINAL
 local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
 local getFilteredNewEntities = ____entity.getFilteredNewEntities
-local getProjectiles = ____entity.getProjectiles
 local removeEntities = ____entity.removeEntities
+local ____entitySpecific = require("functions.entitySpecific")
+local getProjectiles = ____entitySpecific.getProjectiles
 function ____exports.getAliveNPCs(self)
     local npcs = ____exports.getNPCs(nil)
     return __TS__ArrayFilter(

package/dist/functions/pickups.d.ts

@@ -1,4 +1,16 @@
 /// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to get all of the pickups in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the pickups in the room invisible
+ * for (const pickup of getPickups()) {
+ *   pickup.Visible = false;
+ * }
+ * ```
+ */
+export declare function getPickups(matchingVariant?: PickupVariant | int, matchingSubType?: number): EntityPickup[];
 /**
  * Has as an equal chance of returning any value in the `HeartSubType` enum. Useful for spawning a random type of heart.
  *
@@ -7,3 +19,12 @@
  */
 export declare function getRandomHeartSubType(seed?: number, exceptions?: HeartSubType[]): HeartSubType;
 export declare function isChest(pickup: EntityPickup): boolean;
+/**
+ * Helper function to remove all of the pickups in the room.
+ *
+ * @param variant 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.
+ * @param cap Optional. If specified, will only remove the given amount of pickups.
+ * @returns True if one or more pickups was removed, false otherwise.
+ */
+export declare function removeAllPickups(variant?: PickupVariant | int, subType?: int, cap?: int): boolean;