Pickups Specific
Functions
getBatteries
▸ getBatteries(batterySubType?): readonly EntityPickupBattery[]
Helper function to get all of the battery entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
batterySubType | -1 | BatterySubType | -1 | Optional. If specified, will only get the batteries that match the sub-type. Default is -1, which matches every sub-type. |
Returns
readonly EntityPickupBattery[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:24
getBombPickups
▸ getBombPickups(bombSubType?): readonly EntityPickupBomb[]
Helper function to get all of the bomb entities in the room. (Specifically, this refers to bomb
pickups, not the EntityBomb class.)
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
bombSubType | -1 | BombSubType | -1 | Optional. If specified, will only get the bombs that match the sub-type. Default is -1, which matches every sub-type. |
Returns
readonly EntityPickupBomb[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:40
getCards
▸ getCards(cardType?): readonly EntityPickupCard[]
Helper function to get all of the card entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
cardType | CardType | -1 | -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[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:52
getChests
▸ getChests(subType?): readonly EntityPickup[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
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[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:65
getCoins
▸ getCoins(coinSubType?): readonly EntityPickupCoin[]
Helper function to get all of the coin pickup entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
coinSubType | -1 | CoinSubType | -1 | Optional. If specified, will only get the coins that match the sub-type. Default is -1, which matches every sub-type. |
Returns
readonly EntityPickupCoin[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:82
getCollectibles
▸ getCollectibles(collectibleType?): readonly EntityPickupCollectible[]
Helper function to get all of the collectible entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
collectibleType | CollectibleType | -1 | -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[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:94
getHearts
▸ getHearts(heartSubType?): readonly EntityPickupHeart[]
Helper function to get all of the heart pickup entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
heartSubType | -1 | HeartSubType | -1 | Optional. If specified, will only get the hearts that match the sub-type. Default is -1, which matches every sub-type. |
Returns
readonly EntityPickupHeart[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:109
getKeys
▸ getKeys(keySubType?): readonly EntityPickupKey[]
Helper function to get all of the key pickup entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
keySubType | -1 | KeySubType | -1 | Optional. If specified, will only get the keys that match the sub-type. Default is -1, which matches every sub-type. |
Returns
readonly EntityPickupKey[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:121
getPills
▸ getPills(pillColor?): readonly EntityPickupPill[]
Helper function to get all of the pill entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
pillColor | PillColor | -1 | -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[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:133
getSacks
▸ getSacks(sackSubType?): readonly EntityPickupSack[]
Helper function to get all of the sack (i.e. grab bag) entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
sackSubType | -1 | SackSubType | -1 | Optional. If specified, will only get the sacks that match the sub-type. Default is -1, which matches every sub-type. |
Returns
readonly EntityPickupSack[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:145
getTrinkets
▸ getTrinkets(trinketType?): readonly EntityPickupTrinket[]
Helper function to get all of the trinket entities in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
trinketType | TrinketType | -1 | -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[]
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:157
removeAllBatteries
▸ removeAllBatteries(batterySubType?, cap?): readonly EntityPickupBattery[]
Helper function to remove all of the batteries in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
batterySubType | -1 | BatterySubType | -1 | Optional. If specified, will only remove the batteries that match this sub-type. Default is -1, which matches every sub-type. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of cards. |
Returns
readonly EntityPickupBattery[]
The batteries that were removed.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:174
removeAllBombPickups
▸ removeAllBombPickups(bombSubType?, cap?): readonly EntityPickupBomb[]
Helper function to remove all of the bomb pickups in the room. (Specifically, this refers to bomb
pickups, not the EntityBomb class.)
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
bombSubType | -1 | BombSubType | -1 | Optional. If specified, will only remove bombs that match this sub-type. Default is -1, which matches every sub-type. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of bombs. |
Returns
readonly EntityPickupBomb[]
The bombs that were removed.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:194
removeAllCards
▸ removeAllCards(cardType?, cap?): readonly EntityPickupCard[]
Helper function to remove all of the cards in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
cardType | CardType | -1 | -1 | Optional. If specified, will only remove cards that match this sub-type. Default is -1, which matches every sub-type. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of cards. |
Returns
readonly EntityPickupCard[]
The cards that were removed.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:213
removeAllChests
▸ removeAllChests(subType?, cap?): readonly EntityPickup[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
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 | undefined | Optional. If specified, will only remove the given amount of chests. |
Returns
readonly EntityPickup[]
The chests that were removed.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:233
removeAllCoins
▸ removeAllCoins(coinSubType?, cap?): readonly EntityPickupCoin[]
Helper function to remove all of the coins in the room.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:249
removeAllCollectibles
▸ removeAllCollectibles(collectibleType?, cap?): readonly EntityPickupCollectible[]
Helper function to remove all of the collectibles in the room.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:268
removeAllHearts
▸ removeAllHearts(heartSubType?, cap?): readonly EntityPickupHeart[]
Helper function to remove all of the heart pickup entities in the room.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:287
removeAllKeys
▸ removeAllKeys(keySubType?, cap?): readonly EntityPickupKey[]
Helper function to remove all of the keys in the room.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:306
removeAllPills
▸ removeAllPills(pillColor?, cap?): readonly EntityPickupPill[]
Helper function to remove all of the pills in the room.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:325
removeAllSacks
▸ removeAllSacks(sackSubType?, cap?): readonly EntityPickupSack[]
Helper function to remove all of the sacks (i.e. grab bags) in the room.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:344
removeAllTrinkets
▸ removeAllTrinkets(trinketType?, cap?): readonly EntityPickupTrinket[]
Helper function to remove all of the trinkets in the room.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:363
spawnBattery
▸ spawnBattery(batterySubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupBattery
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.LIL_BATTERY (90).
Parameters
| Name | Type | Default value |
|---|---|---|
batterySubType | BatterySubType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupBattery
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:377
spawnBatteryWithSeed
▸ spawnBatteryWithSeed(batterySubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupBattery
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.LIL_BATTERY (90)
and a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
batterySubType | BatterySubType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupBattery
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:398
spawnBombPickup
▸ spawnBombPickup(bombSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupBomb
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.BOMB (40).
Parameters
| Name | Type | Default value |
|---|---|---|
bombSubType | BombSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupBomb
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:415
spawnBombPickupWithSeed
▸ spawnBombPickupWithSeed(bombSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupBomb
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.BOMB (40) and a
specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
bombSubType | BombSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupBomb
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:436
spawnCard
▸ spawnCard(cardType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupCard
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.CARD (300).
Parameters
| Name | Type | Default value |
|---|---|---|
cardType | CardType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupCard
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:453
spawnCardWithSeed
▸ spawnCardWithSeed(cardType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupCard
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.CARD (300) and a
specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
cardType | CardType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupCard
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:474
spawnCoin
▸ spawnCoin(coinSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupCoin
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.COIN (20).
Parameters
| Name | Type | Default value |
|---|---|---|
coinSubType | CoinSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupCoin
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:485
spawnCoinWithSeed
▸ spawnCoinWithSeed(coinSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupCoin
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.COIN (20) and a
specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
coinSubType | CoinSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupCoin
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:506
spawnHeart
▸ spawnHeart(heartSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupHeart
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.HEART (10).
Parameters
| Name | Type | Default value |
|---|---|---|
heartSubType | HeartSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupHeart
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:523
spawnHeartWithSeed
▸ spawnHeartWithSeed(heartSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupHeart
Parameters
| Name | Type | Default value |
|---|---|---|
heartSubType | HeartSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupHeart
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:540
spawnKey
▸ spawnKey(keySubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupKey
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.KEY (30).
Parameters
| Name | Type | Default value |
|---|---|---|
keySubType | KeySubType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupKey
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:557
spawnKeyWithSeed
▸ spawnKeyWithSeed(keySubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupKey
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.KEY (30) and a
specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
keySubType | KeySubType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupKey
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:578
spawnPill
▸ spawnPill(pillColor, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupPill
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.PILL (70).
Parameters
| Name | Type | Default value |
|---|---|---|
pillColor | PillColor | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupPill
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:595
spawnPillWithSeed
▸ spawnPillWithSeed(pillColor, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupPill
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.PILL (70) and a
specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
pillColor | PillColor | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupPill
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:616
spawnSack
▸ spawnSack(sackSubType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupSack
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.SACK (69).
Parameters
| Name | Type | Default value |
|---|---|---|
sackSubType | SackSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupSack
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:633
spawnSackWithSeed
▸ spawnSackWithSeed(sackSubType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupSack
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.SACK (69) and a
specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
sackSubType | SackSubType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupSack
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:654
spawnTrinket
▸ spawnTrinket(trinketType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickupTrinket
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.TRINKET (350).
Parameters
| Name | Type | Default value |
|---|---|---|
trinketType | TrinketType | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickupTrinket
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:673
spawnTrinketWithSeed
▸ spawnTrinketWithSeed(trinketType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickupTrinket
Helper function to spawn a EntityType.PICKUP (5) with variant PickupVariant.TRINKET (350) and
a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
trinketType | TrinketType | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickupTrinket
Defined in
packages/isaacscript-common/src/functions/pickupsSpecific.ts:694