Entities Specific

Functions

getBombs()

getBombs(bombVariant?, subType?): readonly EntityBomb[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:35

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

For example:

// Make all of the bombs in the room invisible.
for (const bomb of getBombs()) {
  bomb.Visible = false;
}

Parameters

bombVariant?

-1 | BombVariant

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

subType?

number = -1

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

Returns

readonly EntityBomb[]

getEffects()

getEffects(effectVariant?, subType?): readonly EntityEffect[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:69

Helper function to get all of the effects in the room.

For example:

// Make all of the effects in the room invisible.
for (const effect of getEffects()) {
  effect.Visible = false;
}

Parameters

effectVariant?

-1 | EffectVariant

Optional. If specified, will only get the effects that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

Returns

readonly EntityEffect[]

getFamiliars()

getFamiliars(familiarVariant?, subType?): readonly EntityFamiliar[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:103

Helper function to get all of the familiars in the room.

For example:

// Make all of the familiars in the room invisible.
for (const familiar of getFamiliars()) {
  familiar.Visible = false;
}

Parameters

familiarVariant?

-1 | FamiliarVariant

Optional. If specified, will only get the familiars that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

Returns

readonly EntityFamiliar[]

getKnives()

getKnives(knifeVariant?, subType?): readonly EntityKnife[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:137

Helper function to get all of the knives in the room.

For example:

// Make all of the knives in the room invisible.
for (const knife of getKnives()) {
  knife.Visible = false;
}

Parameters

knifeVariant?

-1 | KnifeVariant

Optional. If specified, will only get the knives that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

Returns

readonly EntityKnife[]

getLasers()

getLasers(laserVariant?, subType?): readonly EntityLaser[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:171

Helper function to get all of the lasers in the room.

For example:

// Make all of the lasers in the room invisible.
for (const laser of getLasers()) {
  laser.Visible = false;
}

Parameters

laserVariant?

-1 | LaserVariant

Optional. If specified, will only get the lasers that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

Returns

readonly EntityLaser[]

getNPCs()

getNPCs(entityType?, variant?, subType?, ignoreFriendly?): readonly EntityNPC[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:201

Helper function to get all of the NPCs in the room.

Parameters

entityType?

-1 | EntityType

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

variant?

number = -1

Optional. If specified, will only get the NPCs that match the variant. Default is -1, which matches every entity type.

subType?

number = -1

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

ignoreFriendly?

boolean = false

Optional. If set to true, it will exclude friendly NPCs from being returned. Default is false. Will only be taken into account if the entityType is specified.

Returns

readonly EntityNPC[]

getPickups()

getPickups(pickupVariant?, subType?): readonly EntityPickup[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:237

Helper function to get all of the pickups in the room.

For example:

// Make all of the pickups in the room invisible.
for (const pickup of getPickups()) {
  pickup.Visible = false;
}

Parameters

pickupVariant?

-1 | PickupVariant

Optional. If specified, will only get the pickups that match the variant. Default is -1, which matches every entity type.

subType?

number = -1

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

Returns

readonly EntityPickup[]

getProjectiles()

getProjectiles(projectileVariant?, subType?): readonly EntityProjectile[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:271

Helper function to get all of the projectiles in the room.

For example:

// Make all of the projectiles in the room invisible.
for (const projectile of getProjectiles()) {
  projectile.Visible = false;
}

Parameters

projectileVariant?

-1 | ProjectileVariant

Optional. If specified, will only get the projectiles that match the variant. Default is -1, which matches every entity type.

subType?

number = -1

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

Returns

readonly EntityProjectile[]

getSlots()

getSlots(slotVariant?, subType?): readonly EntitySlot[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:309

Helper function to get all of the slots in the room.

For example:

// Make all of the slots in the room invisible.
for (const slot of getSlots()) {
  slot.Visible = false;
}

Parameters

slotVariant?

-1 | SlotVariant

Optional. If specified, will only get the slots that match the variant. Default is -1, which matches every entity type.

subType?

number = -1

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

Returns

readonly EntitySlot[]

getTears()

getTears(tearVariant?, subType?): readonly EntityTear[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:335

Helper function to get all of the tears in the room.

For example:

// Make all of the tears in the room invisible.
for (const tear of getTears()) {
  tear.Visible = false;
}

Parameters

tearVariant?

-1 | TearVariant

Optional. If specified, will only get the tears that match the variant. Default is -1, which matches every entity type.

subType?

number = -1

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

Returns

readonly EntityTear[]

removeAllBombs()

removeAllBombs(bombVariant?, subType?, cap?): readonly EntityBomb[]

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

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

Parameters

bombVariant?

-1 | BombVariant

Optional. If specified, will only remove the bombs that match the variant. Default is -1, which matches every variant.

subType?

number = -1

Optional. If specified, will only remove the bombs that match the 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 EntityBomb[]

An array of the bombs that were removed.

removeAllEffects()

removeAllEffects(effectVariant?, subType?, cap?): readonly EntityEffect[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:382

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

Parameters

effectVariant?

-1 | EffectVariant

Optional. If specified, will only remove the effects that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

cap?

int

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

Returns

readonly EntityEffect[]

An array of the effects that were removed.

removeAllFamiliars()

removeAllFamiliars(familiarVariant?, subType?, cap?): readonly EntityFamiliar[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:401

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

Parameters

familiarVariant?

-1 | FamiliarVariant

Optional. If specified, will only remove the familiars that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

cap?

int

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

Returns

readonly EntityFamiliar[]

An array of the familiars that were removed.

removeAllKnives()

removeAllKnives(knifeVariant?, subType?, cap?): readonly EntityKnife[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:420

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

Parameters

knifeVariant?

-1 | KnifeVariant

Optional. If specified, will only remove the knives that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

cap?

int

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

Returns

readonly EntityKnife[]

An array of the knives that were removed.

removeAllLasers()

removeAllLasers(laserVariant?, subType?, cap?): readonly EntityLaser[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:439

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

Parameters

laserVariant?

-1 | LaserVariant

Optional. If specified, will only remove the lasers that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

cap?

int

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

Returns

readonly EntityLaser[]

An array of the lasers that were removed.

removeAllNPCs()

removeAllNPCs(entityType?, variant?, subType?, cap?): readonly EntityNPC[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:460

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

Parameters

entityType?

-1 | EntityType

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

variant?

number = -1

Optional. If specified, will only remove the NPCs that match the variant. Default is -1, which matches every variant.

subType?

number = -1

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

cap?

int

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

Returns

readonly EntityNPC[]

An array of the NPCs that were removed.

removeAllPickups()

removeAllPickups(pickupVariant?, subType?, cap?): readonly EntityPickup[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:480

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

Parameters

pickupVariant?

-1 | PickupVariant

Optional. If specified, will only remove pickups that match this variant. Default is -1, which matches every variant.

subType?

number = -1

Optional. If specified, will only remove pickups 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 pickups.

Returns

readonly EntityPickup[]

An array of the pickups that were removed.

removeAllProjectiles()

removeAllProjectiles(projectileVariant?, subType?, cap?): readonly EntityProjectile[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:499

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

Parameters

projectileVariant?

-1 | ProjectileVariant

Optional. If specified, will only remove projectiles that match this variant. Default is -1, which matches every variant.

subType?

number = -1

Optional. If specified, will only remove projectiles 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 projectiles.

Returns

readonly EntityProjectile[]

An array of the projectiles that were removed.

removeAllSlots()

removeAllSlots(slotVariant?, subType?, cap?): readonly Entity[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:518

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

Parameters

slotVariant?

-1 | SlotVariant

Optional. If specified, will only remove slots that match this variant. Default is -1, which matches every variant.

subType?

number = -1

Optional. If specified, will only remove slots 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 slots.

Returns

readonly Entity[]

An array of the slots that were removed.

removeAllTears()

removeAllTears(tearVariant?, subType?, cap?): readonly EntityTear[]

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:537

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

Parameters

tearVariant?

-1 | TearVariant

Optional. If specified, will only remove tears that match this variant. Default is -1, which matches every variant.

subType?

number = -1

Optional. If specified, will only remove tears 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 tears.

Returns

readonly EntityTear[]

An array of the tears that were removed.

spawnBomb()

spawnBomb(bombVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityBomb

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:547

Helper function to spawn a EntityType.BOMB (4).

Parameters

bombVariant

BombVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityBomb

spawnBombWithSeed()

spawnBombWithSeed(bombVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityBomb

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:572

Helper function to spawn a EntityType.BOMB (4) with a specific seed.

Parameters

bombVariant

BombVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityBomb

spawnEffect()

spawnEffect(effectVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityEffect

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:591

Helper function to spawn a EntityType.EFFECT (1000).

Parameters

effectVariant

EffectVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityEffect

spawnEffectWithSeed()

spawnEffectWithSeed(effectVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityEffect

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

Helper function to spawn a EntityType.EFFECT (1000) with a specific seed.

Parameters

effectVariant

EffectVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityEffect

spawnFamiliar()

spawnFamiliar(familiarVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityFamiliar

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:640

Helper function to spawn a EntityType.FAMILIAR (3).

If you are trying to implement a custom familiar, you probably want to use the checkFamiliarFromCollectibles helper function instead.

Parameters

familiarVariant

FamiliarVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityFamiliar

spawnFamiliarWithSeed()

spawnFamiliarWithSeed(familiarVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityFamiliar

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:665

Helper function to spawn a EntityType.FAMILIAR (3) with a specific seed.

Parameters

familiarVariant

FamiliarVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityFamiliar

spawnKnife()

spawnKnife(knifeVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityKnife

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:684

Helper function to spawn a EntityType.KNIFE (8).

Parameters

knifeVariant

KnifeVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityKnife

spawnKnifeWithSeed()

spawnKnifeWithSeed(knifeVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityKnife

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:709

Helper function to spawn a EntityType.KNIFE (8) with a specific seed.

Parameters

knifeVariant

KnifeVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityKnife

spawnLaser()

spawnLaser(laserVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityLaser

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:728

Helper function to spawn a EntityType.LASER (7).

Parameters

laserVariant

LaserVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityLaser

spawnLaserWithSeed()

spawnLaserWithSeed(laserVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityLaser

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:753

Helper function to spawn a EntityType.LASER (7) with a specific seed.

Parameters

laserVariant

LaserVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityLaser

spawnNPC()

spawnNPC(entityType, variant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityNPC

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:777

Helper function to spawn an NPC.

Note that if you pass a non-NPC EntityType to this function, it will cause a run-time error, since the Entity.ToNPC method will return undefined.

Parameters

entityType

EntityType

variant

int

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityNPC

spawnNPCWithSeed()

spawnNPCWithSeed(entityType, variant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityNPC

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:808

Helper function to spawn an NPC with a specific seed.

Note that if you pass a non-NPC EntityType to this function, it will cause a run-time error, since the Entity.ToNPC method will return undefined.

Parameters

entityType

EntityType

variant

int

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityNPC

spawnPickup()

spawnPickup(pickupVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickup

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:829

Helper function to spawn a EntityType.PICKUP (5).

Parameters

pickupVariant

PickupVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityPickup

spawnPickupWithSeed()

spawnPickupWithSeed(pickupVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickup

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:854

Helper function to spawn a EntityType.PICKUP (5) with a specific seed.

Parameters

pickupVariant

PickupVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityPickup

spawnProjectile()

spawnProjectile(projectileVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityProjectile

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:873

Helper function to spawn a EntityType.PROJECTILE (9).

Parameters

projectileVariant

ProjectileVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityProjectile

spawnProjectileWithSeed()

spawnProjectileWithSeed(projectileVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityProjectile

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:898

Helper function to spawn a EntityType.PROJECTILE (9) with a specific seed.

Parameters

projectileVariant

ProjectileVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityProjectile

spawnSlot()

spawnSlot(slotVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntitySlot

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:917

Helper function to spawn a EntityType.SLOT (6).

Parameters

slotVariant

SlotVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntitySlot

spawnSlotWithSeed()

spawnSlotWithSeed(slotVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntitySlot

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:937

Helper function to spawn a EntityType.SLOT (6) with a specific seed.

Parameters

slotVariant

SlotVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntitySlot

spawnTear()

spawnTear(tearVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityTear

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:956

Helper function to spawn a EntityType.TEAR (2).

Parameters

tearVariant

TearVariant

subType

int

positionOrGridIndex

int | Vector

velocity?

Vector = VectorZero

spawner?

Entity

seedOrRNG?

RNG | Seed

Returns

EntityTear

spawnTearWithSeed()

spawnTearWithSeed(tearVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityTear

Defined in: packages/isaacscript-common/src/functions/entitiesSpecific.ts:981

Helper function to spawn a EntityType.EntityType (2) with a specific seed.

Parameters

tearVariant

TearVariant

subType

int

positionOrGridIndex

int | Vector

seedOrRNG

RNG | Seed

velocity?

Vector = VectorZero

spawner?

Entity

Returns

EntityTear