isaacscript-common 1.0.544 → 1.0.545

package/dist/functions/collectibles.d.ts

@@ -68,8 +68,9 @@ export declare function isSingleUseCollectible(collectibleType: CollectibleType
  * @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.
+ * @returns True if one or more collectibles was removed, false otherwise.
  */
-export declare function removeAllCollectibles(collectibleType?: CollectibleType | int, cap?: int): void;
+export declare function removeAllCollectibles(collectibleType?: CollectibleType | int, cap?: int): boolean;
 /**
  * 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

@@ -151,7 +151,7 @@ function ____exports.isSingleUseCollectible(self, collectibleType)
     return SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES:has(collectibleType)
 end
 function ____exports.removeAllCollectibles(self, collectibleType, cap)
-    removeAllPickups(nil, PickupVariant.PICKUP_COLLECTIBLE, collectibleType, cap)
+    return 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

@@ -164,48 +164,54 @@ export declare function isEntityMoving(entity: Entity, threshold?: number): bool
  *
  * @param entities The array of entities to remove.
  * @param cap Optional. If specified, will only remove the given amount of entities.
+ * @returns True if one or more entities was removed, false otherwise.
  */
-export declare function removeEntities(entities: Entity[], cap?: int): void;
+export declare function removeEntities(entities: Entity[], cap?: int): boolean;
 /**
  * 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): void;
+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, subType?: int, cap?: int): void;
+export declare function removeAllEffects(variant?: EffectVariant, subType?: int, cap?: int): boolean;
 /**
  * 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.
+ * @returns True if one or more familiars was removed, false otherwise.
  */
-export declare function removeAllFamiliars(variant?: FamiliarVariant | int, subType?: int, cap?: int): void;
+export declare function removeAllFamiliars(variant?: FamiliarVariant | 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): void;
+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): void;
+export declare function removeAllLasers(variant?: LaserVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the matching entities in the room.
  *
@@ -215,32 +221,36 @@ export declare function removeAllLasers(variant?: LaserVariant | int, subType?:
  * @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.
+ * @returns True if one or more entities was removed, false otherwise.
  */
-export declare function removeAllMatchingEntities(entityType: int, entityVariant?: number, entitySubType?: number, cap?: int | undefined): void;
+export declare function removeAllMatchingEntities(entityType: int, entityVariant?: number, entitySubType?: number, cap?: int | undefined): 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): void;
+export declare function removeAllPickups(variant?: PickupVariant | 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): void;
+export declare function removeAllProjectiles(variant?: ProjectileVariant | 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): void;
+export declare function removeAllTears(variant?: TearVariant | int, subType?: int, cap?: int): boolean;
 /**
  * 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

@@ -217,6 +217,9 @@ function ____exports.isEntityMoving(self, entity, threshold)
     return entity.Velocity:Length() >= threshold
 end
 function ____exports.removeEntities(self, entities, cap)
+    if #entities == 0 then
+        return false
+    end
     local numEntitiesRemoved = 0
     do
         local i = 0
@@ -225,31 +228,32 @@ function ____exports.removeEntities(self, entities, cap)
             entity:Remove()
             numEntitiesRemoved = numEntitiesRemoved + 1
             if (cap ~= nil) and (numEntitiesRemoved >= cap) then
-                return
+                return true
             end
             i = i + 1
         end
     end
+    return true
 end
 function ____exports.removeAllBombs(self, variant, subType, cap)
     local bombs = ____exports.getBombs(nil, variant, subType)
-    ____exports.removeEntities(nil, bombs, cap)
+    return ____exports.removeEntities(nil, bombs, cap)
 end
 function ____exports.removeAllEffects(self, variant, subType, cap)
     local effects = ____exports.getEffects(nil, variant, subType)
-    ____exports.removeEntities(nil, effects, cap)
+    return ____exports.removeEntities(nil, effects, cap)
 end
 function ____exports.removeAllFamiliars(self, variant, subType, cap)
     local familiars = ____exports.getFamiliars(nil, variant, subType)
-    ____exports.removeEntities(nil, familiars, cap)
+    return ____exports.removeEntities(nil, familiars, cap)
 end
 function ____exports.removeAllKnives(self, variant, subType, cap)
     local knives = ____exports.getKnives(nil, variant, subType)
-    ____exports.removeEntities(nil, knives, cap)
+    return ____exports.removeEntities(nil, knives, cap)
 end
 function ____exports.removeAllLasers(self, variant, subType, cap)
     local lasers = ____exports.getLasers(nil, variant, subType)
-    ____exports.removeEntities(nil, lasers, cap)
+    return ____exports.removeEntities(nil, lasers, cap)
 end
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then
@@ -262,19 +266,19 @@ function ____exports.removeAllMatchingEntities(self, entityType, entityVariant,
         cap = nil
     end
     local entities = Isaac.FindByType(entityType, entityVariant, entitySubType)
-    ____exports.removeEntities(nil, entities, cap)
+    return ____exports.removeEntities(nil, entities, cap)
 end
 function ____exports.removeAllPickups(self, variant, subType, cap)
     local pickups = ____exports.getPickups(nil, variant, subType)
-    ____exports.removeEntities(nil, pickups, cap)
+    return ____exports.removeEntities(nil, pickups, cap)
 end
 function ____exports.removeAllProjectiles(self, variant, subType, cap)
     local projectiles = ____exports.getProjectiles(nil, variant, subType)
-    ____exports.removeEntities(nil, projectiles, cap)
+    return ____exports.removeEntities(nil, projectiles, cap)
 end
 function ____exports.removeAllTears(self, variant, subType, cap)
     local tears = ____exports.getTears(nil, variant, subType)
-    ____exports.removeEntities(nil, tears, cap)
+    return ____exports.removeEntities(nil, tears, cap)
 end
 function ____exports.setEntityPositions(self, entityPositions, entities)
     if entities == nil then

package/dist/functions/gridEntity.d.ts

@@ -55,8 +55,10 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  *   GridEntityType.GRID_DOOR,
  * );
  * ```
+ *
+ * @returns True if one or more grid entities was removed, false otherwise.
  */
-export declare function removeAllGridEntitiesExceptFor(...gridEntityTypes: GridEntityType[]): void;
+export declare function removeAllGridEntitiesExceptFor(...gridEntityTypes: GridEntityType[]): boolean;
 /**
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.
@@ -69,8 +71,10 @@ export declare function removeAllGridEntitiesExceptFor(...gridEntityTypes: GridE
  *   GridEntityType.GRID_ROCKT,
  * );
  * ```
+ *
+ * @returns True if one or more grid entities was removed, false otherwise.
  */
-export declare function removeAllMatchingGridEntities(...gridEntityType: GridEntityType[]): void;
+export declare function removeAllMatchingGridEntities(...gridEntityType: GridEntityType[]): boolean;
 /**
  * Helper function to remove a grid entity simply by providing the grid entity object.
  *

package/dist/functions/gridEntity.lua

@@ -135,20 +135,29 @@ function ____exports.removeAllGridEntitiesExceptFor(self, ...)
     local gridEntityTypes = {...}
     local gridEntityTypeExceptions = __TS__New(Set, gridEntityTypes)
     local gridEntities = ____exports.getGridEntities(nil)
+    local removedOneOrMoreGridEntities = false
     for ____, gridEntity in ipairs(gridEntities) do
         local gridEntityType = gridEntity:GetType()
         if not gridEntityTypeExceptions:has(gridEntityType) then
             ____exports.removeGridEntity(nil, gridEntity, false)
+            removedOneOrMoreGridEntities = true
         end
     end
-    roomUpdateSafe(nil)
+    if removedOneOrMoreGridEntities then
+        roomUpdateSafe(nil)
+    end
+    return removedOneOrMoreGridEntities
 end
 function ____exports.removeAllMatchingGridEntities(self, ...)
     local gridEntities = ____exports.getGridEntities(nil, ...)
+    if #gridEntities == 0 then
+        return false
+    end
     for ____, gridEntity in ipairs(gridEntities) do
         ____exports.removeGridEntity(nil, gridEntity, false)
     end
     roomUpdateSafe(nil)
+    return true
 end
 function ____exports.setGridEntityInvisible(self, gridEntity)
     local sprite = gridEntity:GetSprite()

package/dist/functions/npc.d.ts

@@ -39,5 +39,6 @@ export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
  * Helper function to remove all NPCs in the room.
  *
  * @param cap Optional. If specified, will only remove the given amount of NPCs.
+ * @returns True if one or more NPCs was removed, false otherwise.
  */
-export declare function removeAllNPCs(cap?: int): void;
+export declare function removeAllNPCs(cap?: int): boolean;

package/dist/functions/npc.lua

@@ -99,6 +99,6 @@ function ____exports.getAliveNPCs(self)
 end
 function ____exports.removeAllNPCs(self, cap)
     local npcs = ____exports.getNPCs(nil)
-    removeEntities(nil, npcs, cap)
+    return removeEntities(nil, npcs, cap)
 end
 return ____exports

package/package.json

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