isaacscript-common 1.0.492 → 1.0.493

package/dist/functions/collectibles.d.ts

@@ -56,7 +56,14 @@ export declare function isGlitchedCollectible(entity: Entity): boolean;
  */
 export declare function isPassiveCollectible(collectibleType: CollectibleType | int): boolean;
 export declare function isQuestCollectible(collectibleType: CollectibleType | int): boolean;
-export declare function removeAllCollectibles(): void;
+/**
+ * Helper function to remove all of the collectibles in the room.
+ *
+ * @param collectibleType Optional. If specified, will only remove collectibles that match this
+ * collectible type.
+ * @param cap Optional. If specified, will only remove the given amount of collectibles.
+ */
+export declare function removeAllCollectibles(collectibleType?: CollectibleType | int, cap?: int): void;
 /**
  * Helper function to remove all pickup delay on a collectible. By default, collectibles have a 20
  * frame delay before they can be picked up by a player.

package/dist/functions/collectibles.lua

@@ -7,7 +7,7 @@ local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DE
 local ____collectibleNameMap = require("maps.collectibleNameMap")
 local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
 local ____entity = require("functions.entity")
-local removeAllMatchingEntities = ____entity.removeAllMatchingEntities
+local removeAllPickups = ____entity.removeAllPickups
 function ____exports.setCollectibleSprite(self, collectible, pngPath)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error("You cannot set a collectible sprite for pickups of variant: " .. tostring(collectible.Variant))
@@ -136,8 +136,8 @@ end
 function ____exports.isQuestCollectible(self, collectibleType)
     return ____exports.collectibleHasTag(nil, collectibleType, 32768)
 end
-function ____exports.removeAllCollectibles(self)
-    removeAllMatchingEntities(nil, EntityType.ENTITY_PICKUP, PickupVariant.PICKUP_COLLECTIBLE)
+function ____exports.removeAllCollectibles(self, collectibleType, cap)
+    removeAllPickups(nil, PickupVariant.PICKUP_COLLECTIBLE, collectibleType, cap)
 end
 function ____exports.removeCollectiblePickupDelay(self, collectible)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then

package/dist/functions/entity.d.ts

@@ -152,17 +152,88 @@ export declare function getSlots(matchingVariant?: number, matchingSubType?: num
  * ```
  */
 export declare function getTears(matchingVariant?: number, matchingSubType?: number): EntityTear[];
-/** Removes all of the entities in the supplied array. */
-export declare function removeEntities(entities: Entity[]): void;
-export declare function removeAllBombs(): void;
-export declare function removeAllEffects(): void;
-export declare function removeAllFamiliars(): void;
-export declare function removeAllKnives(): void;
-export declare function removeAllLasers(): void;
-export declare function removeAllMatchingEntities(entityType: int, entityVariant?: number, entitySubType?: number): void;
-export declare function removeAllPickups(): void;
-export declare function removeAllProjectiles(): void;
-export declare function removeAllTears(): void;
+/**
+ * Helper function to remove all of the entities in the supplied array.
+ *
+ * @param entities The array of entities to remove.
+ * @param cap Optional. If specified, will only remove the given amount of entities.
+ */
+export declare function removeEntities(entities: Entity[], cap?: int): void;
+/**
+ * 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.
+ */
+export declare function removeAllBombs(variant?: BombVariant, subType?: int, cap?: int): void;
+/**
+ * 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.
+ */
+export declare function removeAllEffects(variant?: EffectVariant, subType?: int, cap?: int): void;
+/**
+ * Helper function to remove all of the familiars in the room.
+ *
+ * @param variant 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 cap Optional. If specified, will only remove the given amount of familiars.
+ */
+export declare function removeAllFamiliars(variant?: FamiliarVariant, subType?: int, cap?: int): void;
+/**
+ * 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.
+ */
+export declare function removeAllKnives(variant?: KnifeVariant, subType?: int, cap?: int): void;
+/**
+ * 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.
+ */
+export declare function removeAllLasers(variant?: LaserVariant, subType?: int, cap?: int): void;
+/**
+ * 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. -1 by default (which will match every
+ * variant).
+ * @param entitySubType Optional. The sub-type to match. -1 by default (which will match every
+ * sub-type).
+ * @param cap Optional. If specified, will only remove the given amount of collectibles.
+ */
+export declare function removeAllMatchingEntities(entityType: int, entityVariant?: number, entitySubType?: number, cap?: int | undefined): void;
+/**
+ * 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.
+ */
+export declare function removeAllPickups(variant?: PickupVariant, subType?: int, cap?: int): void;
+/**
+ * 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.
+ */
+export declare function removeAllProjectiles(variant?: ProjectileVariant, subType?: int, cap?: int): void;
+/**
+ * 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.
+ */
+export declare function removeAllTears(variant?: TearVariant, subType?: int, cap?: int): void;
 /**
  * Helper function to set the position of every entity in the room based on a map of positions. If
  * an entity is found that does not have matching element in the provided map, then that entity will

package/dist/functions/entity.lua

@@ -210,68 +210,65 @@ function ____exports.getTears(self, matchingVariant, matchingSubType)
     end
     return tears
 end
-function ____exports.removeEntities(self, entities)
-    for ____, entity in ipairs(entities) do
-        entity:Remove()
+function ____exports.removeEntities(self, entities, cap)
+    local numEntitiesRemoved = 0
+    do
+        local i = 0
+        while i < #entities do
+            local entity = entities[i + 1]
+            entity:Remove()
+            numEntitiesRemoved = numEntitiesRemoved + 1
+            if cap ~= nil and numEntitiesRemoved >= cap then
+                return
+            end
+            i = i + 1
+        end
     end
 end
-function ____exports.removeAllBombs(self)
-    local bombs = ____exports.getBombs(nil)
-    for ____, bomb in ipairs(bombs) do
-        bomb:Remove()
-    end
+function ____exports.removeAllBombs(self, variant, subType, cap)
+    local bombs = ____exports.getBombs(nil, variant, subType)
+    ____exports.removeEntities(nil, bombs, cap)
 end
-function ____exports.removeAllEffects(self)
-    local effects = ____exports.getEffects(nil)
-    for ____, effect in ipairs(effects) do
-        effect:Remove()
-    end
+function ____exports.removeAllEffects(self, variant, subType, cap)
+    local effects = ____exports.getEffects(nil, variant, subType)
+    ____exports.removeEntities(nil, effects, cap)
 end
-function ____exports.removeAllFamiliars(self)
-    local familiars = ____exports.getFamiliars(nil)
-    for ____, familiar in ipairs(familiars) do
-        familiar:Remove()
-    end
+function ____exports.removeAllFamiliars(self, variant, subType, cap)
+    local familiars = ____exports.getFamiliars(nil, variant, subType)
+    ____exports.removeEntities(nil, familiars, cap)
 end
-function ____exports.removeAllKnives(self)
-    local knives = ____exports.getKnives(nil)
-    for ____, knife in ipairs(knives) do
-        knife:Remove()
-    end
+function ____exports.removeAllKnives(self, variant, subType, cap)
+    local knives = ____exports.getKnives(nil, variant, subType)
+    ____exports.removeEntities(nil, knives, cap)
 end
-function ____exports.removeAllLasers(self)
-    local lasers = ____exports.getLasers(nil)
-    for ____, laser in ipairs(lasers) do
-        laser:Remove()
-    end
+function ____exports.removeAllLasers(self, variant, subType, cap)
+    local lasers = ____exports.getLasers(nil, variant, subType)
+    ____exports.removeEntities(nil, lasers, cap)
 end
-function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType)
+function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then
         entityVariant = -1
     end
     if entitySubType == nil then
         entitySubType = -1
     end
+    if cap == nil then
+        cap = nil
+    end
     local entities = Isaac.FindByType(entityType, entityVariant, entitySubType)
-    ____exports.removeEntities(nil, entities)
+    ____exports.removeEntities(nil, entities, cap)
 end
-function ____exports.removeAllPickups(self)
-    local pickups = ____exports.getPickups(nil)
-    for ____, pickup in ipairs(pickups) do
-        pickup:Remove()
-    end
+function ____exports.removeAllPickups(self, variant, subType, cap)
+    local pickups = ____exports.getPickups(nil, variant, subType)
+    ____exports.removeEntities(nil, pickups, cap)
 end
-function ____exports.removeAllProjectiles(self)
-    local projectiles = ____exports.getProjectiles(nil)
-    for ____, projectile in ipairs(projectiles) do
-        projectile:Remove()
-    end
+function ____exports.removeAllProjectiles(self, variant, subType, cap)
+    local projectiles = ____exports.getProjectiles(nil, variant, subType)
+    ____exports.removeEntities(nil, projectiles, cap)
 end
-function ____exports.removeAllTears(self)
-    local tears = ____exports.getTears(nil)
-    for ____, tear in ipairs(tears) do
-        tear:Remove()
-    end
+function ____exports.removeAllTears(self, variant, subType, cap)
+    local tears = ____exports.getTears(nil, variant, subType)
+    ____exports.removeEntities(nil, tears, cap)
 end
 function ____exports.setEntityPositions(self, entityPositions, entities)
     if entities == nil then

package/dist/functions/gridEntity.d.ts

@@ -39,7 +39,8 @@ export declare function isAllPressurePlatesPushed(): boolean;
  */
 export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
 /**
- * Helper function to remove most grid entities in the room.
+ * Helper function to all grid entities in the room except for ones matching the grid entity types
+ * provided.
  *
  * Example:
  * ```
@@ -50,7 +51,20 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  * ```
  */
 export declare function removeAllGridEntitiesExceptFor(...gridEntityTypes: GridEntityType[]): void;
-export declare function removeAllMatchingGridEntities(gridEntityType: GridEntityType): void;
+/**
+ * Helper function to remove all of the grid entities in the room that match the grid entity types
+ * provided.
+ *
+ * Example:
+ * ```
+ * removeAllMatchingGridEntities(
+ *   GridEntityType.GRID_ROCK,
+ *   GridEntityType.GRID_ROCKB,
+ *   GridEntityType.GRID_ROCKT,
+ * );
+ * ```
+ */
+export declare function removeAllMatchingGridEntities(...gridEntityType: GridEntityType[]): void;
 /**
  * Helper function to remove a grid entity simply by providing the grid entity object.
  *

package/dist/functions/gridEntity.lua

@@ -130,8 +130,8 @@ function ____exports.removeAllGridEntitiesExceptFor(self, ...)
     end
     roomUpdateSafe(nil)
 end
-function ____exports.removeAllMatchingGridEntities(self, gridEntityType)
-    local gridEntities = ____exports.getGridEntities(nil, gridEntityType)
+function ____exports.removeAllMatchingGridEntities(self, ...)
+    local gridEntities = ____exports.getGridEntities(nil, ...)
     for ____, gridEntity in ipairs(gridEntities) do
         ____exports.removeGridEntity(nil, gridEntity, false)
     end

package/dist/functions/npc.d.ts

@@ -35,4 +35,9 @@ export declare function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean;
  * enemies.
  */
 export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
-export declare function removeAllNPCs(): void;
+/**
+ * Helper function to remove all NPCs in the room.
+ *
+ * @param cap Optional. If specified, will only remove the given amount of NPCs.
+ */
+export declare function removeAllNPCs(cap?: int): void;

package/dist/functions/npc.lua

@@ -6,6 +6,7 @@ local ____constants = require("constants")
 local EGGY_STATE_FRAME_OF_FINAL_SPIDER = ____constants.EGGY_STATE_FRAME_OF_FINAL_SPIDER
 local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
+local removeEntities = ____entity.removeEntities
 function ____exports.getBosses(self)
     local bosses = {}
     for ____, npc in ipairs(____exports.getNPCs(nil)) do
@@ -94,10 +95,8 @@ function ____exports.getAliveNPCs(self)
     end
     return aliveNPCs
 end
-function ____exports.removeAllNPCs(self)
+function ____exports.removeAllNPCs(self, cap)
     local npcs = ____exports.getNPCs(nil)
-    for ____, npc in ipairs(npcs) do
-        npc:Remove()
-    end
+    removeEntities(nil, npcs, cap)
 end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.492",
+  "version": "1.0.493",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",