isaacscript-common 6.6.5 → 6.7.0

package/dist/functions/gridEntitiesSpecific.lua

@@ -0,0 +1,366 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorVariant = ____isaac_2Dtypescript_2Ddefinitions.DoorVariant
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local PitVariant = ____isaac_2Dtypescript_2Ddefinitions.PitVariant
+local PoopGridEntityVariant = ____isaac_2Dtypescript_2Ddefinitions.PoopGridEntityVariant
+local PressurePlateVariant = ____isaac_2Dtypescript_2Ddefinitions.PressurePlateVariant
+local RockVariant = ____isaac_2Dtypescript_2Ddefinitions.RockVariant
+local ____gridEntities = require("functions.gridEntities")
+local getGridEntities = ____gridEntities.getGridEntities
+local removeGridEntities = ____gridEntities.removeGridEntities
+local spawnGridEntityWithVariant = ____gridEntities.spawnGridEntityWithVariant
+--- Helper function to spawn a `GridEntityType.DOOR` (16) with a specific variant.
+function ____exports.spawnDoorWithVariant(self, doorVariant, gridIndexOrPosition)
+    local gridEntity = spawnGridEntityWithVariant(nil, GridEntityType.DOOR, doorVariant, gridIndexOrPosition)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    local door = gridEntity:ToDoor()
+    if door == nil then
+        error("Failed to spawn a door.")
+    end
+    return door
+end
+--- Helper function to spawn a `GridEntityType.PIT` (7) with a specific variant.
+function ____exports.spawnPitWithVariant(self, pitVariant, gridIndexOrPosition)
+    local gridEntity = spawnGridEntityWithVariant(nil, GridEntityType.PIT, pitVariant, gridIndexOrPosition)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    local pit = gridEntity:ToPit()
+    if pit == nil then
+        error("Failed to spawn a pit.")
+    end
+    return pit
+end
+--- Helper function to spawn a `GridEntityType.POOP` (14) with a specific variant.
+function ____exports.spawnPoopWithVariant(self, poopVariant, gridIndexOrPosition)
+    local gridEntity = spawnGridEntityWithVariant(nil, GridEntityType.POOP, poopVariant, gridIndexOrPosition)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    local poop = gridEntity:ToPoop()
+    if poop == nil then
+        error("Failed to spawn a poop.")
+    end
+    return poop
+end
+--- Helper function to spawn a `GridEntityType.PRESSURE_PLATE` (20) with a specific variant.
+function ____exports.spawnPressurePlateWithVariant(self, pressurePlateVariant, gridIndexOrPosition)
+    local gridEntity = spawnGridEntityWithVariant(nil, GridEntityType.PRESSURE_PLATE, pressurePlateVariant, gridIndexOrPosition)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    local pressurePlate = gridEntity:ToPressurePlate()
+    if pressurePlate == nil then
+        error("Failed to spawn a pressure plate.")
+    end
+    return pressurePlate
+end
+--- Helper function to spawn a `GridEntityType.ROCK` (2) with a specific variant.
+function ____exports.spawnRockWithVariant(self, rockVariant, gridIndexOrPosition)
+    local gridEntity = spawnGridEntityWithVariant(nil, GridEntityType.ROCK, rockVariant, gridIndexOrPosition)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    local rock = gridEntity:ToRock()
+    if rock == nil then
+        error("Failed to spawn a rock.")
+    end
+    return rock
+end
+--- Helper function to spawn a `GridEntityType.SPIKES` (8) with a specific variant.
+function ____exports.spawnSpikesWithVariant(self, variant, gridIndexOrPosition)
+    local gridEntity = spawnGridEntityWithVariant(nil, GridEntityType.SPIKES, variant, gridIndexOrPosition)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    local spikes = gridEntity:ToSpikes()
+    if spikes == nil then
+        error("Failed to spawn spikes.")
+    end
+    return spikes
+end
+--- Helper function to spawn a `GridEntityType.TNT` (12) with a specific variant.
+function ____exports.spawnTNTWithVariant(self, variant, gridIndexOrPosition)
+    local gridEntity = spawnGridEntityWithVariant(nil, GridEntityType.TNT, variant, gridIndexOrPosition)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    local tnt = gridEntity:ToTNT()
+    if tnt == nil then
+        error("Failed to spawn TNT.")
+    end
+    return tnt
+end
+--- 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.
+function ____exports.getPits(self, pitVariant)
+    if pitVariant == nil then
+        pitVariant = -1
+    end
+    local gridEntities = getGridEntities(nil)
+    local pits = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local pit = gridEntity:ToPit()
+        if pit ~= nil then
+            local gridEntityVariant = pit:GetVariant()
+            if pitVariant == -1 or pitVariant == gridEntityVariant then
+                pits[#pits + 1] = pit
+            end
+        end
+    end
+    return pits
+end
+--- 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.
+function ____exports.getPoops(self, poopVariant)
+    if poopVariant == nil then
+        poopVariant = -1
+    end
+    local gridEntities = getGridEntities(nil)
+    local poops = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local poop = gridEntity:ToPoop()
+        if poop ~= nil then
+            local gridEntityVariant = poop:GetVariant()
+            if poopVariant == -1 or poopVariant == gridEntityVariant then
+                poops[#poops + 1] = poop
+            end
+        end
+    end
+    return poops
+end
+--- 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.
+function ____exports.getPressurePlates(self, pressurePlateVariant)
+    if pressurePlateVariant == nil then
+        pressurePlateVariant = -1
+    end
+    local gridEntities = getGridEntities(nil)
+    local pressurePlates = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local pressurePlate = gridEntity:ToPressurePlate()
+        if pressurePlate ~= nil then
+            local gridEntityVariant = pressurePlate:GetVariant()
+            if pressurePlateVariant == -1 or pressurePlateVariant == gridEntityVariant then
+                pressurePlates[#pressurePlates + 1] = pressurePlate
+            end
+        end
+    end
+    return pressurePlates
+end
+--- 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.
+function ____exports.getRocks(self, variant)
+    if variant == nil then
+        variant = -1
+    end
+    local gridEntities = getGridEntities(nil)
+    local rocks = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local rock = gridEntity:ToRock()
+        if rock ~= nil then
+            local gridEntityVariant = rock:GetVariant()
+            if variant == -1 or variant == gridEntityVariant then
+                rocks[#rocks + 1] = rock
+            end
+        end
+    end
+    return rocks
+end
+--- Helper function to get all of the `GridEntitySpikes` in the room.
+function ____exports.getSpikes(self, variant)
+    if variant == nil then
+        variant = -1
+    end
+    local gridEntities = getGridEntities(nil)
+    local spikes = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local spike = gridEntity:ToSpikes()
+        if spike ~= nil then
+            local gridEntityVariant = spike:GetVariant()
+            if variant == -1 or variant == gridEntityVariant then
+                spikes[#spikes + 1] = spike
+            end
+        end
+    end
+    return spikes
+end
+--- Helper function to get all of the `GridEntityTNT` in the room.
+function ____exports.getTNT(self, variant)
+    if variant == nil then
+        variant = -1
+    end
+    local gridEntities = getGridEntities(nil)
+    local tntArray = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local tnt = gridEntity:ToTNT()
+        if tnt ~= nil then
+            local gridEntityVariant = tnt:GetVariant()
+            if variant == -1 or variant == gridEntityVariant then
+                tntArray[#tntArray + 1] = tnt
+            end
+        end
+    end
+    return tntArray
+end
+--- 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.
+function ____exports.removeAllPits(self, pitVariant, updateRoom, cap)
+    if pitVariant == nil then
+        pitVariant = -1
+    end
+    if updateRoom == nil then
+        updateRoom = false
+    end
+    local pits = ____exports.getPits(nil, pitVariant)
+    return removeGridEntities(nil, pits, updateRoom, cap)
+end
+--- 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.
+function ____exports.removeAllPoops(self, poopVariant, updateRoom, cap)
+    if poopVariant == nil then
+        poopVariant = -1
+    end
+    if updateRoom == nil then
+        updateRoom = false
+    end
+    local poops = ____exports.getPoops(nil, poopVariant)
+    return removeGridEntities(nil, poops, updateRoom, cap)
+end
+--- 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.
+function ____exports.removeAllPressurePlates(self, pressurePlateVariant, updateRoom, cap)
+    if pressurePlateVariant == nil then
+        pressurePlateVariant = -1
+    end
+    if updateRoom == nil then
+        updateRoom = false
+    end
+    local pressurePlates = ____exports.getPressurePlates(nil, pressurePlateVariant)
+    return removeGridEntities(nil, pressurePlates, updateRoom, cap)
+end
+--- 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.
+function ____exports.removeAllRocks(self, variant, updateRoom, cap)
+    if variant == nil then
+        variant = -1
+    end
+    if updateRoom == nil then
+        updateRoom = false
+    end
+    local rocks = ____exports.getRocks(nil, variant)
+    return removeGridEntities(nil, rocks, updateRoom, cap)
+end
+--- 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.
+function ____exports.removeAllSpikes(self, variant, updateRoom, cap)
+    if variant == nil then
+        variant = -1
+    end
+    if updateRoom == nil then
+        updateRoom = false
+    end
+    local spikes = ____exports.getSpikes(nil, variant)
+    return removeGridEntities(nil, spikes, updateRoom, cap)
+end
+--- 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.
+function ____exports.removeAllTNT(self, variant, updateRoom, cap)
+    if variant == nil then
+        variant = -1
+    end
+    if updateRoom == nil then
+        updateRoom = false
+    end
+    local tnt = ____exports.getTNT(nil, variant)
+    return removeGridEntities(nil, tnt, updateRoom, cap)
+end
+--- Helper function to spawn a `GridEntityType.DOOR` (16).
+function ____exports.spawnDoor(self, gridIndexOrPosition)
+    return ____exports.spawnDoorWithVariant(nil, DoorVariant.UNSPECIFIED, gridIndexOrPosition)
+end
+--- Helper function to spawn a `GridEntityType.PIT` (7).
+function ____exports.spawnPit(self, gridIndexOrPosition)
+    return ____exports.spawnPitWithVariant(nil, PitVariant.NORMAL, gridIndexOrPosition)
+end
+--- Helper function to spawn a `GridEntityType.POOP` (14).
+function ____exports.spawnPoop(self, gridIndexOrPosition)
+    return ____exports.spawnPoopWithVariant(nil, PoopGridEntityVariant.NORMAL, gridIndexOrPosition)
+end
+--- Helper function to spawn a `GridEntityType.PRESSURE_PLATE` (20).
+function ____exports.spawnPressurePlate(self, gridIndexOrPosition)
+    return ____exports.spawnPressurePlateWithVariant(nil, PressurePlateVariant.PRESSURE_PLATE, gridIndexOrPosition)
+end
+--- Helper function to spawn a `GridEntityType.ROCK` (2).
+function ____exports.spawnRock(self, gridIndexOrPosition)
+    return ____exports.spawnRockWithVariant(nil, RockVariant.NORMAL, gridIndexOrPosition)
+end
+--- Helper function to spawn a `GridEntityType.SPIKES` (8).
+function ____exports.spawnSpikes(self, gridIndexOrPosition)
+    return ____exports.spawnSpikesWithVariant(nil, 0, gridIndexOrPosition)
+end
+--- Helper function to spawn a `GridEntityType.TNT` (12).
+function ____exports.spawnTNT(self, gridIndexOrPosition)
+    return ____exports.spawnTNTWithVariant(nil, 0, gridIndexOrPosition)
+end
+return ____exports

package/dist/functions/log.lua

@@ -28,22 +28,22 @@ local ____array = require("functions.array")
 local arrayToString = ____array.arrayToString
 local ____collectibles = require("functions.collectibles")
 local getCollectibleName = ____collectibles.getCollectibleName
-local ____entity = require("functions.entity")
-local getEntities = ____entity.getEntities
-local getEntityID = ____entity.getEntityID
+local ____entities = require("functions.entities")
+local getEntities = ____entities.getEntities
+local getEntityID = ____entities.getEntityID
 local ____enums = require("functions.enums")
 local getEnumEntries = ____enums.getEnumEntries
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____gridEntity = require("functions.gridEntity")
-local getGridEntities = ____gridEntity.getGridEntities
+local ____gridEntities = require("functions.gridEntities")
+local getGridEntities = ____gridEntities.getGridEntities
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
-local ____player = require("functions.player")
-local getEffectsList = ____player.getEffectsList
-local getPlayerName = ____player.getPlayerName
 local ____playerHealth = require("functions.playerHealth")
 local getPlayerHealth = ____playerHealth.getPlayerHealth
+local ____players = require("functions.players")
+local getEffectsList = ____players.getEffectsList
+local getPlayerName = ____players.getPlayerName
 local ____roomData = require("functions.roomData")
 local getRoomData = ____roomData.getRoomData
 local getRoomGridIndex = ____roomData.getRoomGridIndex

package/dist/functions/{npc.d.ts → npcs.d.ts}

@@ -18,8 +18,16 @@ export declare function fireProjectiles(npc: EntityNPC, position: Vector, veloci
  *
  * This function will not include NPCs on an internal blacklist, such as Death's scythes or Big Horn
  * holes.
+ *
+ * @param entityType Optional. If specified, will only get the NPCs that match the type. Default is
+ *                   -1, which matches every type.
+ * @param variant Optional. If specified, will only get the NPCs that match the variant. Default is
+ *                -1, which matches every variant.
+ * @param subType Optional. If specified, will only get the NPCs that match the sub-type. Default is
+ *                -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
  */
-export declare function getAliveNPCs(matchingEntityType?: EntityType, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
+export declare function getAliveNPCs(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): EntityNPC[];
 /**
  * Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should
  * not actually keep the doors closed (like Death's scythes).
@@ -38,4 +46,18 @@ export declare function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean;
  * enemies.
  */
 export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
-//# sourceMappingURL=npc.d.ts.map
+/**
+ * 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.
+ */
+export declare function npcFireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode: ProjectilesMode, projectileParams: ProjectileParams): EntityProjectile[];
+//# sourceMappingURL=npcs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"npcs.d.ts","sourceRoot":"","sources":["../../src/functions/npcs.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,UAAU,EAMV,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAgCtC;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,eAAe,GAAE,eAAgD,EACjE,gBAAgB,GAAE,gBAAqC,GACtD,gBAAgB,EAAE,CAMpB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAC1B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAoB3D;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAKpE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAO3D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,eAAe,EAChC,gBAAgB,EAAE,gBAAgB,GACjC,gBAAgB,EAAE,CAOpB"}

package/dist/functions/{npc.lua → npcs.lua}

@@ -22,11 +22,11 @@ local RaglingVariant = ____isaac_2Dtypescript_2Ddefinitions.RaglingVariant
 local VisVariant = ____isaac_2Dtypescript_2Ddefinitions.VisVariant
 local ____constants = require("constants")
 local EGGY_STATE_FRAME_OF_FINAL_SPIDER = ____constants.EGGY_STATE_FRAME_OF_FINAL_SPIDER
-local ____entity = require("functions.entity")
-local getFilteredNewEntities = ____entity.getFilteredNewEntities
-local ____entitySpecific = require("functions.entitySpecific")
-local getNPCs = ____entitySpecific.getNPCs
-local getProjectiles = ____entitySpecific.getProjectiles
+local ____entities = require("functions.entities")
+local getFilteredNewEntities = ____entities.getFilteredNewEntities
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local getNPCs = ____entitiesSpecific.getNPCs
+local getProjectiles = ____entitiesSpecific.getProjectiles
 --- Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should
 -- not actually keep the doors closed (like Death's scythes).
 function ____exports.isAliveExceptionNPC(self, npc)
@@ -109,15 +109,32 @@ end
 -- 
 -- This function will not include NPCs on an internal blacklist, such as Death's scythes or Big Horn
 -- holes.
-function ____exports.getAliveNPCs(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+-- 
+-- @param entityType Optional. If specified, will only get the NPCs that match the type. Default is
+-- -1, which matches every type.
+-- @param variant Optional. If specified, will only get the NPCs that match the variant. Default is
+-- -1, which matches every variant.
+-- @param subType Optional. If specified, will only get the NPCs that match the sub-type. Default is
+-- -1, which matches every sub-type.
+-- @param ignoreFriendly Optional. Default is false.
+function ____exports.getAliveNPCs(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
     local npcs = getNPCs(
         nil,
-        matchingEntityType,
-        matchingVariant,
-        matchingSubType,
+        entityType,
+        variant,
+        subType,
         ignoreFriendly
     )
     return __TS__ArrayFilter(
@@ -125,4 +142,22 @@ function ____exports.getAliveNPCs(self, matchingEntityType, matchingVariant, mat
         function(____, npc) return not npc:IsDead() and not ____exports.isAliveExceptionNPC(nil, npc) end
     )
 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 = getProjectiles(nil)
+    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
+    local newEntities = getProjectiles(nil)
+    local filteredNewEntities = getFilteredNewEntities(nil, oldEntities, newEntities)
+    return filteredNewEntities
+end
 return ____exports

package/dist/functions/pickups.d.ts

@@ -1,133 +1,18 @@
-import { BatterySubType, Card, CoinSubType, CollectibleType, HeartSubType, KeySubType, PillColor, SackSubType, TrinketType } from "isaac-typescript-definitions";
-/** Helper function to get all of the battery entities in the room. */
-export declare function getBatteries(matchingSubType?: BatterySubType | -1): EntityPickupBattery[];
-/** Helper function to get all of the card entities in the room. */
-export declare function getCards(matchingSubType?: Card | -1): EntityPickupCard[];
+import { CoinSubType } from "isaac-typescript-definitions";
 /**
  * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
  * sub-types.
  */
 export declare function getCoinValue(coinSubType: CoinSubType): int;
-/** Helper function to get all of the coin pickup entities in the room. */
-export declare function getCoins(matchingSubType?: CoinSubType | -1): EntityPickupCoin[];
-/** Helper function to get all of the collectible entities in the room. */
-export declare function getCollectibles(matchingSubType?: CollectibleType | -1): EntityPickupCollectible[];
-/** Helper function to get all of the heart pickup entities in the room. */
-export declare function getHearts(matchingSubType?: HeartSubType | -1): EntityPickupHeart[];
-/** Helper function to get all of the key pickup entities in the room. */
-export declare function getKeys(matchingSubType?: KeySubType | -1): EntityPickupKey[];
-/** Helper function to get all of the pill entities in the room. */
-export declare function getPills(matchingSubType?: PillColor | -1): EntityPickupPill[];
 /** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickupHeart[];
-/** Helper function to get all of the sack (i.e. grab bag) entities in the room. */
-export declare function getSacks(matchingSubType?: SackSubType | -1): EntityPickupSack[];
-/** Helper function to get all of the trinket entities in the room. */
-export declare function getTrinkets(matchingSubType?: TrinketType | -1): EntityPickupTrinket[];
 export declare function isChest(pickup: EntityPickup): boolean;
 export declare function isRedHeart(pickup: EntityPickup): boolean;
 /**
- * Helper function to remove all of the batteries in the room.
+ * Helper function to remove all of the red heart pickup entities in the room.
  *
- * @param batterySubType Optional. If specified, will only remove cards that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of cards.
- * @returns True if one or more cards were removed, false otherwise.
- */
-export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?: int): EntityPickupBattery[];
-/**
- * Helper function to remove all of the cards in the room.
- *
- * @param card Optional. If specified, will only remove cards that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of cards.
- * @returns True if one or more cards were removed, false otherwise.
- */
-export declare function removeAllCards(card?: Card, cap?: int): EntityPickupCard[];
-/**
- * Helper function to remove all of the coins in the room.
- *
- * @param coinSubType Optional. If specified, will only remove coins that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of coins.
- * @returns True if one or more coins were removed, false otherwise.
- */
-export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): EntityPickupCoin[];
-/**
- * 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.
- * @returns True if one or more collectibles were removed, false otherwise.
- */
-export declare function removeAllCollectibles(collectibleType?: CollectibleType, cap?: int): EntityPickupCollectible[];
-/**
- * Helper function to remove all of the hearts in the room.
- *
- * @param heartSubType Optional. If specified, will only remove hearts that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of hearts.
- * @returns True if one or more hearts were removed, false otherwise.
- */
-export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int): EntityPickupHeart[];
-/**
- * Helper function to remove all of the keys in the room.
- *
- * @param keySubType Optional. If specified, will only remove keys that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of keys.
- * @returns True if one or more keys were removed, false otherwise.
- */
-export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): EntityPickupKey[];
-/**
- * Helper function to remove all of the pills in the room.
- *
- * @param pillColor Optional. If specified, will only remove pills that match this color.
- * @param cap Optional. If specified, will only remove the given amount of pills.
- * @returns True if one or more pills were removed, false otherwise.
- */
-export declare function removeAllPills(pillColor?: PillColor, cap?: int): EntityPickupPill[];
-/**
- * Helper function to remove all of the sacks (i.e. grab bags) in the room.
- *
- * @param sackSubType Optional. If specified, will only remove sacks that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of trinkets.
- * @returns True if one or more trinkets were removed, false otherwise.
- */
-export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): EntityPickupSack[];
-/**
- * Helper function to remove all of the trinkets in the room.
- *
- * @param trinketType Optional. If specified, will only remove trinkets that match this trinket
- *                    type.
- * @param cap Optional. If specified, will only remove the given amount of trinkets.
- * @returns True if one or more trinkets were removed, false otherwise.
- */
-export declare function removeAllTrinkets(trinketType?: TrinketType, cap?: int): EntityPickupTrinket[];
-/**
- * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
- */
-export declare function spawnBattery(subType: BatterySubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupBattery;
-export declare function spawnBatteryWithSeed(subType: BatterySubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupBattery;
-/**
- * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
- */
-export declare function spawnCard(subType: Card, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCard;
-export declare function spawnCardWithSeed(subType: Card, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCard;
-/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */
-export declare function spawnCoin(subType: CoinSubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCoin;
-export declare function spawnCoinWithSeed(subType: CoinSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCoin;
-/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10). */
-export declare function spawnHeart(subType: HeartSubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupHeart;
-export declare function spawnHeartWithSeed(subType: HeartSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupHeart;
-/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30). */
-export declare function spawnKey(subType: KeySubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupKey;
-export declare function spawnKeyWithSeed(subType: KeySubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupKey;
-/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70). */
-export declare function spawnPill(pillColor: PillColor, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupPill;
-export declare function spawnPillWithSeed(subType: PillColor, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupPill;
-/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69). */
-export declare function spawnSack(subType: SackSubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupSack;
-export declare function spawnSackWithSeed(subType: SackSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupSack;
-/**
- * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
+ * @returns The red hearts that were removed.
  */
-export declare function spawnTrinket(subType: TrinketType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupTrinket;
-export declare function spawnTrinketWithSeed(subType: TrinketType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupTrinket;
+export declare function removeAllRedHearts(cap?: int): EntityPickupHeart[];
 //# sourceMappingURL=pickups.d.ts.map