Entities Specific
Functions
getBombs
▸ getBombs(bombVariant?, subType?): readonly EntityBomb[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
bombVariant | -1 | BombVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:35
getEffects
▸ getEffects(effectVariant?, subType?): readonly EntityEffect[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
effectVariant | -1 | EffectVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:69
getFamiliars
▸ getFamiliars(familiarVariant?, subType?): readonly EntityFamiliar[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
familiarVariant | -1 | FamiliarVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:103
getKnives
▸ getKnives(knifeVariant?, subType?): readonly EntityKnife[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
knifeVariant | -1 | KnifeVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:137
getLasers
▸ getLasers(laserVariant?, subType?): readonly EntityLaser[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
laserVariant | -1 | LaserVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:171
getNPCs
▸ getNPCs(entityType?, variant?, subType?, ignoreFriendly?): readonly EntityNPC[]
Helper function to get all of the NPCs in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
entityType | -1 | EntityType | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:201
getPickups
▸ getPickups(pickupVariant?, subType?): readonly EntityPickup[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
pickupVariant | -1 | PickupVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:237
getProjectiles
▸ getProjectiles(projectileVariant?, subType?): readonly EntityProjectile[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
projectileVariant | -1 | ProjectileVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:271
getSlots
▸ getSlots(slotVariant?, subType?): readonly EntitySlot[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
slotVariant | -1 | SlotVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:309
getTears
▸ getTears(tearVariant?, subType?): readonly EntityTear[]
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
| Name | Type | Default value | Description |
|---|---|---|---|
tearVariant | -1 | TearVariant | -1 | 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[]
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:335
removeAllBombs
▸ removeAllBombs(bombVariant?, subType?, cap?): readonly EntityBomb[]
Helper function to remove all of the bombs in the room. (Specifically, this refers to the
EntityBomb class, not bomb pickups.)
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
bombVariant | -1 | BombVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of bombs. |
Returns
readonly EntityBomb[]
An array of the bombs that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:363
removeAllEffects
▸ removeAllEffects(effectVariant?, subType?, cap?): readonly EntityEffect[]
Helper function to remove all of the effects in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
effectVariant | -1 | EffectVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of effects. |
Returns
readonly EntityEffect[]
An array of the effects that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:382
removeAllFamiliars
▸ removeAllFamiliars(familiarVariant?, subType?, cap?): readonly EntityFamiliar[]
Helper function to remove all of the familiars in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
familiarVariant | -1 | FamiliarVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of familiars. |
Returns
readonly EntityFamiliar[]
An array of the familiars that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:401
removeAllKnives
▸ removeAllKnives(knifeVariant?, subType?, cap?): readonly EntityKnife[]
Helper function to remove all of the knives in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
knifeVariant | -1 | KnifeVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of knives. |
Returns
readonly EntityKnife[]
An array of the knives that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:420
removeAllLasers
▸ removeAllLasers(laserVariant?, subType?, cap?): readonly EntityLaser[]
Helper function to remove all of the lasers in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
laserVariant | -1 | LaserVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of lasers. |
Returns
readonly EntityLaser[]
An array of the lasers that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:439
removeAllNPCs
▸ removeAllNPCs(entityType?, variant?, subType?, cap?): readonly EntityNPC[]
Helper function to remove all of the NPCs in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
entityType | -1 | EntityType | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of NPCs. |
Returns
readonly EntityNPC[]
An array of the NPCs that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:460
removeAllPickups
▸ removeAllPickups(pickupVariant?, subType?, cap?): readonly EntityPickup[]
Helper function to remove all of the pickups in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
pickupVariant | -1 | PickupVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of pickups. |
Returns
readonly EntityPickup[]
An array of the pickups that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:480
removeAllProjectiles
▸ removeAllProjectiles(projectileVariant?, subType?, cap?): readonly EntityProjectile[]
Helper function to remove all of the projectiles in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
projectileVariant | -1 | ProjectileVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of projectiles. |
Returns
readonly EntityProjectile[]
An array of the projectiles that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:499
removeAllSlots
▸ removeAllSlots(slotVariant?, subType?, cap?): readonly Entity[]
Helper function to remove all of the slots in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
slotVariant | -1 | SlotVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of slots. |
Returns
readonly Entity[]
An array of the slots that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:518
removeAllTears
▸ removeAllTears(tearVariant?, subType?, cap?): readonly EntityTear[]
Helper function to remove all of the tears in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
tearVariant | -1 | TearVariant | -1 | 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 | undefined | Optional. If specified, will only remove the given amount of tears. |
Returns
readonly EntityTear[]
An array of the tears that were removed.
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:537
spawnBomb
▸ spawnBomb(bombVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityBomb
Helper function to spawn a EntityType.BOMB (4).
Parameters
| Name | Type | Default value |
|---|---|---|
bombVariant | BombVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityBomb
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:547
spawnBombWithSeed
▸ spawnBombWithSeed(bombVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityBomb
Helper function to spawn a EntityType.BOMB (4) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
bombVariant | BombVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityBomb
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:572
spawnEffect
▸ spawnEffect(effectVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityEffect
Helper function to spawn a EntityType.EFFECT (1000).
Parameters
| Name | Type | Default value |
|---|---|---|
effectVariant | EffectVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityEffect
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:591
spawnEffectWithSeed
▸ spawnEffectWithSeed(effectVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityEffect
Helper function to spawn a EntityType.EFFECT (1000) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
effectVariant | EffectVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityEffect
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:616
spawnFamiliar
▸ spawnFamiliar(familiarVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityFamiliar
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
| Name | Type | Default value |
|---|---|---|
familiarVariant | FamiliarVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityFamiliar
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:640
spawnFamiliarWithSeed
▸ spawnFamiliarWithSeed(familiarVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityFamiliar
Helper function to spawn a EntityType.FAMILIAR (3) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
familiarVariant | FamiliarVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityFamiliar
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:665
spawnKnife
▸ spawnKnife(knifeVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityKnife
Helper function to spawn a EntityType.KNIFE (8).
Parameters
| Name | Type | Default value |
|---|---|---|
knifeVariant | KnifeVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityKnife
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:684
spawnKnifeWithSeed
▸ spawnKnifeWithSeed(knifeVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityKnife
Helper function to spawn a EntityType.KNIFE (8) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
knifeVariant | KnifeVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityKnife
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:709
spawnLaser
▸ spawnLaser(laserVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityLaser
Helper function to spawn a EntityType.LASER (7).
Parameters
| Name | Type | Default value |
|---|---|---|
laserVariant | LaserVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityLaser
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:728
spawnLaserWithSeed
▸ spawnLaserWithSeed(laserVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityLaser
Helper function to spawn a EntityType.LASER (7) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
laserVariant | LaserVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityLaser
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:753
spawnNPC
▸ spawnNPC(entityType, variant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityNPC
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
| Name | Type | Default value |
|---|---|---|
entityType | EntityType | undefined |
variant | int | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityNPC
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:777
spawnNPCWithSeed
▸ spawnNPCWithSeed(entityType, variant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityNPC
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
| Name | Type | Default value |
|---|---|---|
entityType | EntityType | undefined |
variant | int | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityNPC
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:808
spawnPickup
▸ spawnPickup(pickupVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityPickup
Helper function to spawn a EntityType.PICKUP (5).
Parameters
| Name | Type | Default value |
|---|---|---|
pickupVariant | PickupVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityPickup
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:829
spawnPickupWithSeed
▸ spawnPickupWithSeed(pickupVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityPickup
Helper function to spawn a EntityType.PICKUP (5) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
pickupVariant | PickupVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityPickup
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:854
spawnProjectile
▸ spawnProjectile(projectileVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityProjectile
Helper function to spawn a EntityType.PROJECTILE (9).
Parameters
| Name | Type | Default value |
|---|---|---|
projectileVariant | ProjectileVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityProjectile
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:873
spawnProjectileWithSeed
▸ spawnProjectileWithSeed(projectileVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityProjectile
Helper function to spawn a EntityType.PROJECTILE (9) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
projectileVariant | ProjectileVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityProjectile
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:898
spawnSlot
▸ spawnSlot(slotVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntitySlot
Helper function to spawn a EntityType.SLOT (6).
Parameters
| Name | Type | Default value |
|---|---|---|
slotVariant | SlotVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntitySlot
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:917
spawnSlotWithSeed
▸ spawnSlotWithSeed(slotVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntitySlot
Helper function to spawn a EntityType.SLOT (6) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
slotVariant | SlotVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntitySlot
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:937
spawnTear
▸ spawnTear(tearVariant, subType, positionOrGridIndex, velocity?, spawner?, seedOrRNG?): EntityTear
Helper function to spawn a EntityType.TEAR (2).
Parameters
| Name | Type | Default value |
|---|---|---|
tearVariant | TearVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
seedOrRNG | undefined | RNG | Seed | undefined |
Returns
EntityTear
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:956
spawnTearWithSeed
▸ spawnTearWithSeed(tearVariant, subType, positionOrGridIndex, seedOrRNG, velocity?, spawner?): EntityTear
Helper function to spawn a EntityType.EntityType (2) with a specific seed.
Parameters
| Name | Type | Default value |
|---|---|---|
tearVariant | TearVariant | undefined |
subType | int | undefined |
positionOrGridIndex | int | Vector | undefined |
seedOrRNG | RNG | Seed | undefined |
velocity | Vector | VectorZero |
spawner | undefined | Entity | undefined |
Returns
EntityTear
Defined in
packages/isaacscript-common/src/functions/entitiesSpecific.ts:981