Pickups Specific

Functions

getBatteries()

getBatteries(batterySubType?): readonly EntityPickupBattery[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:24

Helper function to get all of the battery entities in the room.

Parameters

batterySubType?

-1 | BatterySubType

Optional. If specified, will only get the batteries that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupBattery[]

---

getBombPickups()

getBombPickups(bombSubType?): readonly EntityPickupBomb[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:40

Helper function to get all of the bomb entities in the room. (Specifically, this refers to bomb pickups, not the EntityBomb class.)

Parameters

bombSubType?

-1 | BombSubType

Optional. If specified, will only get the bombs that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupBomb[]

---

getCards()

getCards(cardType?): readonly EntityPickupCard[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:52

Helper function to get all of the card entities in the room.

Parameters

cardType?

CardType | -1

Optional. If specified, will only get the cards that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupCard[]

---

getChests()

getChests(subType?): readonly EntityPickup[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:65

Helper function to get all of the chest entities in the room. Specifically, this is all of the pickups with a variant in the CHEST_PICKUP_VARIANTS constant.

Parameters

subType?

number = -1

Optional. If specified, will only get the chests that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickup[]

---

getCoins()

getCoins(coinSubType?): readonly EntityPickupCoin[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:82

Helper function to get all of the coin pickup entities in the room.

Parameters

coinSubType?

-1 | CoinSubType

Optional. If specified, will only get the coins that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupCoin[]

---

getCollectibles()

getCollectibles(collectibleType?): readonly EntityPickupCollectible[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:94

Helper function to get all of the collectible entities in the room.

Parameters

collectibleType?

CollectibleType | -1

Optional. If specified, will only get the collectibles that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupCollectible[]

---

getHearts()

getHearts(heartSubType?): readonly EntityPickupHeart[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:109

Helper function to get all of the heart pickup entities in the room.

Parameters

heartSubType?

-1 | HeartSubType

Optional. If specified, will only get the hearts that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupHeart[]

---

getKeys()

getKeys(keySubType?): readonly EntityPickupKey[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:121

Helper function to get all of the key pickup entities in the room.

Parameters

keySubType?

-1 | KeySubType

Optional. If specified, will only get the keys that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupKey[]

---

getPills()

getPills(pillColor?): readonly EntityPickupPill[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:133

Helper function to get all of the pill entities in the room.

Parameters

pillColor?

PillColor | -1

Optional. If specified, will only get the pills that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupPill[]

---

getSacks()

getSacks(sackSubType?): readonly EntityPickupSack[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:145

Helper function to get all of the sack (i.e. grab bag) entities in the room.

Parameters

sackSubType?

-1 | SackSubType

Optional. If specified, will only get the sacks that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupSack[]

---

getTrinkets()

getTrinkets(trinketType?): readonly EntityPickupTrinket[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:157

Helper function to get all of the trinket entities in the room.

Parameters

trinketType?

TrinketType | -1

Optional. If specified, will only get the trinkets that match the sub-type. Default is -1, which matches every sub-type.

Returns

readonly EntityPickupTrinket[]

---

removeAllBatteries()

removeAllBatteries(batterySubType?, cap?): readonly EntityPickupBattery[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:174

Helper function to remove all of the batteries in the room.

Parameters

batterySubType?

-1 | BatterySubType

Optional. If specified, will only remove the batteries that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of cards.

Returns

readonly EntityPickupBattery[]

The batteries that were removed.

---

removeAllBombPickups()

removeAllBombPickups(bombSubType?, cap?): readonly EntityPickupBomb[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:194

Helper function to remove all of the bomb pickups in the room. (Specifically, this refers to bomb pickups, not the EntityBomb class.)

Parameters

bombSubType?

-1 | BombSubType

Optional. If specified, will only remove bombs that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of bombs.

Returns

readonly EntityPickupBomb[]

The bombs that were removed.

---

removeAllCards()

removeAllCards(cardType?, cap?): readonly EntityPickupCard[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:213

Helper function to remove all of the cards in the room.

Parameters

cardType?

CardType | -1

Optional. If specified, will only remove cards that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of cards.

Returns

readonly EntityPickupCard[]

The cards that were removed.

---

removeAllChests()

removeAllChests(subType?, cap?): readonly EntityPickup[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:233

Helper function to remove all of the chests in the room. Specifically, this is all of the pickups with a variant in the CHEST_PICKUP_VARIANTS constant.

Parameters

subType?

number = -1

Optional. If specified, will only remove chests that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of chests.

Returns

readonly EntityPickup[]

The chests that were removed.

---

removeAllCoins()

removeAllCoins(coinSubType?, cap?): readonly EntityPickupCoin[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:249

Helper function to remove all of the coins in the room.

Parameters

coinSubType?

CoinSubType

Optional. If specified, will only remove coins that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of coins.

Returns

readonly EntityPickupCoin[]

The coins that were removed.

---

removeAllCollectibles()

removeAllCollectibles(collectibleType?, cap?): readonly EntityPickupCollectible[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:268

Helper function to remove all of the collectibles in the room.

Parameters

collectibleType?

CollectibleType

Optional. If specified, will only remove collectibles that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of collectibles.

Returns

readonly EntityPickupCollectible[]

The collectibles that were removed.

---

removeAllHearts()

removeAllHearts(heartSubType?, cap?): readonly EntityPickupHeart[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:287

Helper function to remove all of the heart pickup entities in the room.

Parameters

heartSubType?

HeartSubType

Optional. If specified, will only remove hearts that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of hearts.

Returns

readonly EntityPickupHeart[]

The hearts that were removed.

---

removeAllKeys()

removeAllKeys(keySubType?, cap?): readonly EntityPickupKey[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:306

Helper function to remove all of the keys in the room.

Parameters

keySubType?

KeySubType

Optional. If specified, will only remove keys that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of keys.

Returns

readonly EntityPickupKey[]

The keys that were removed.

---

removeAllPills()

removeAllPills(pillColor?, cap?): readonly EntityPickupPill[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:325

Helper function to remove all of the pills in the room.

Parameters

pillColor?

PillColor

Optional. If specified, will only remove pills that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of pills.

Returns

readonly EntityPickupPill[]

The pills that were removed.

---

removeAllSacks()

removeAllSacks(sackSubType?, cap?): readonly EntityPickupSack[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:344

Helper function to remove all of the sacks (i.e. grab bags) in the room.

Parameters

sackSubType?

SackSubType

Optional. If specified, will only remove sacks that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of sacks.

Returns

readonly EntityPickupSack[]

The sacks that were removed.

---

removeAllTrinkets()

removeAllTrinkets(trinketType?, cap?): readonly EntityPickupTrinket[]

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:363

Helper function to remove all of the trinkets in the room.

Parameters

trinketType?

TrinketType

Optional. If specified, will only remove trinkets that match this sub-type. Default is -1, which matches every sub-type.

cap?

int

Optional. If specified, will only remove the given amount of trinkets.

Returns

readonly EntityPickupTrinket[]

The trinkets that were removed.

---

spawnBattery()

spawnBattery(batterySubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupBattery

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:377

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.LIL_BATTERY (90).

Parameters

batterySubType

BatterySubType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupBattery

---

spawnBatteryWithSeed()

spawnBatteryWithSeed(batterySubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupBattery

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:398

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.LIL_BATTERY (90) and a specific seed.

Parameters

batterySubType

BatterySubType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupBattery

---

spawnBombPickup()

spawnBombPickup(bombSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupBomb

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:415

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.BOMB (40).

Parameters

bombSubType

BombSubType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupBomb

---

spawnBombPickupWithSeed()

spawnBombPickupWithSeed(bombSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupBomb

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:436

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.BOMB (40) and a specific seed.

Parameters

bombSubType

BombSubType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupBomb

---

spawnCard()

spawnCard(cardType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupCard

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:453

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.CARD (300).

Parameters

cardType

CardType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupCard

---

spawnCardWithSeed()

spawnCardWithSeed(cardType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupCard

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:474

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.CARD (300) and a specific seed.

Parameters

cardType

CardType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupCard

---

spawnCoin()

spawnCoin(coinSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupCoin

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:485

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.COIN (20).

Parameters

coinSubType

CoinSubType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupCoin

---

spawnCoinWithSeed()

spawnCoinWithSeed(coinSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupCoin

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:506

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.COIN (20) and a specific seed.

Parameters

coinSubType

CoinSubType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupCoin

---

spawnHeart()

spawnHeart(heartSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupHeart

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:523

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.HEART (10).

Parameters

heartSubType

HeartSubType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupHeart

---

spawnHeartWithSeed()

spawnHeartWithSeed(heartSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupHeart

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:540

Parameters

heartSubType

HeartSubType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupHeart

---

spawnKey()

spawnKey(keySubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupKey

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:557

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.KEY (30).

Parameters

keySubType

KeySubType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupKey

---

spawnKeyWithSeed()

spawnKeyWithSeed(keySubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupKey

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:578

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.KEY (30) and a specific seed.

Parameters

keySubType

KeySubType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupKey

---

spawnPill()

spawnPill(pillColor, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupPill

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:595

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.PILL (70).

Parameters

pillColor

PillColor

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupPill

---

spawnPillWithSeed()

spawnPillWithSeed(pillColor, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupPill

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:616

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.PILL (70) and a specific seed.

Parameters

pillColor

PillColor

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupPill

---

spawnSack()

spawnSack(sackSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupSack

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:633

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.SACK (69).

Parameters

sackSubType

SackSubType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupSack

---

spawnSackWithSeed()

spawnSackWithSeed(sackSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupSack

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:654

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.SACK (69) and a specific seed.

Parameters

sackSubType

SackSubType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupSack

---

spawnTrinket()

spawnTrinket(trinketType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupTrinket

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:673

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.TRINKET (350).

Parameters

trinketType

TrinketType

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickupTrinket

---

spawnTrinketWithSeed()

spawnTrinketWithSeed(trinketType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupTrinket

Defined in: packages/isaacscript-common/src/functions/pickupsSpecific.ts:694

Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.TRINKET (350) and a specific seed.

Parameters

trinketType

TrinketType

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickupTrinket