Grid Entities Specific
Functions
getCrawlSpaces
▸ getCrawlSpaces(crawlSpaceVariant?): readonly GridEntity[]
Helper function to get all of the grid entities of type GridEntityType.CRAWL_SPACE (18) in the
room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
crawlSpaceVariant | -1 | CrawlSpaceVariant | -1 | Optional. If specified, will only get the crawl spaces that match the variant. Default is -1, which matches every variant. |
Returns
readonly GridEntity[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:26
getPits
▸ getPits(pitVariant?): readonly GridEntityPit[]
Helper function to get all of the GridEntityPit in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
pitVariant | -1 | PitVariant | -1 | Optional. If specified, will only get the pits that match the variant. Default is -1, which matches every variant. |
Returns
readonly GridEntityPit[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:45
getPoops
▸ getPoops(poopVariant?): readonly GridEntityPoop[]
Helper function to get all of the GridEntityPoop in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
poopVariant | -1 | PoopGridEntityVariant | -1 | Optional. If specified, will only get the poops that match the variant. Default is -1, which matches every variant. |
Returns
readonly GridEntityPoop[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:68
getPressurePlates
▸ getPressurePlates(pressurePlateVariant?): readonly GridEntityPressurePlate[]
Helper function to get all of the GridEntityPressurePlate in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
pressurePlateVariant | -1 | PressurePlateVariant | -1 | Optional. If specified, will only get the pressure plates that match the variant. Default is -1, which matches every variant. |
Returns
readonly GridEntityPressurePlate[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:91
getRocks
▸ getRocks(variant?): readonly GridEntityRock[]
Helper function to get all of the GridEntityRock in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
variant | number | -1 | Optional. If specified, will only get the rocks that match the variant. Default is -1, which matches every variant. Note that this is not the same thing as the RockVariant enum, since that only applies to GridEntityType.ROCK, and other types of grid entities can be the GridEntityRock class. |
Returns
readonly GridEntityRock[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:119
getSpikes
▸ getSpikes(variant?): readonly GridEntitySpikes[]
Helper function to get all of the GridEntitySpikes in the room.
Parameters
| Name | Type | Default value |
|---|---|---|
variant | number | -1 |
Returns
readonly GridEntitySpikes[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:135
getTNT
▸ getTNT(variant?): readonly GridEntityTNT[]
Helper function to get all of the GridEntityTNT in the room.
Parameters
| Name | Type | Default value |
|---|---|---|
variant | number | -1 |
Returns
readonly GridEntityTNT[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:151
getTeleporters
▸ getTeleporters(variant?): readonly GridEntity[]
Helper function to get all of the grid entities of type GridEntityType.TELEPORTER (23) in the
room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
variant | number | -1 | Optional. If specified, will only get the teleporters that match the variant. Default is -1, which matches every variant. |
Returns
readonly GridEntity[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:173
getTrapdoors
▸ getTrapdoors(trapdoorVariant?): readonly GridEntity[]
Helper function to get all of the grid entities of type GridEntityType.TRAPDOOR (17) in the
room. Specify a specific trapdoor variant to select only trapdoors of that variant.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
trapdoorVariant | -1 | TrapdoorVariant | -1 | Optional. If specified, will only get the trapdoors that match the variant. Default is -1, which matches every variant. |
Returns
readonly GridEntity[]
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:188
removeAllCrawlSpaces
▸ removeAllCrawlSpaces(crawlSpaceVariant?, updateRoom?, cap?): readonly GridEntity[]
Helper function to remove all of the GridEntityType.CRAWL_SPACE (18) in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
crawlSpaceVariant | -1 | CrawlSpaceVariant | -1 | Optional. If specified, will only remove the crawl spaces that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the crawl spaces are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of crawl spaces. |
Returns
readonly GridEntity[]
The crawl spaces that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:209
removeAllPits
▸ removeAllPits(pitVariant?, updateRoom?, cap?): readonly GridEntityPit[]
Helper function to remove all of the GridEntityPit in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
pitVariant | -1 | PitVariant | -1 | Optional. If specified, will only remove the pits that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the pits are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of pits. |
Returns
readonly GridEntityPit[]
The pits that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:232
removeAllPoops
▸ removeAllPoops(poopVariant?, updateRoom?, cap?): readonly GridEntityPoop[]
Helper function to remove all of the GridEntityPoop in the room.
Note that poops can either be an entity or a grid entity, depending on the situation. This function will only remove the grid entity poops.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
poopVariant | -1 | PoopGridEntityVariant | -1 | Optional. If specified, will only remove the poops that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the poops are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of poops. |
Returns
readonly GridEntityPoop[]
The poops that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:255
removeAllPressurePlates
▸ removeAllPressurePlates(pressurePlateVariant?, updateRoom?, cap?): readonly GridEntityPressurePlate[]
Helper function to remove all of the GridEntityPressurePlate in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
pressurePlateVariant | -1 | PressurePlateVariant | -1 | Optional. If specified, will only remove the pressure plates that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the pressure plates are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of pressure plates. |
Returns
readonly GridEntityPressurePlate[]
The pressure plates that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:275
removeAllRocks
▸ removeAllRocks(variant?, updateRoom?, cap?): readonly GridEntityRock[]
Helper function to remove all of the GridEntityRock in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
variant | number | -1 | Optional. If specified, will only remove the rocks that match this variant. Default is -1, which matches every variant. Note that this is not the same thing as the RockVariant enum, since that only applies to GridEntityType.ROCK, and other types of grid entities can be the GridEntityRock class. |
updateRoom | boolean | false | Optional. Whether to update the room after the rocks are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of rocks. |
Returns
readonly GridEntityRock[]
The rocks that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:297
removeAllSpikes
▸ removeAllSpikes(variant?, updateRoom?, cap?): readonly GridEntitySpikes[]
Helper function to remove all of the GridEntitySpikes in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
variant | number | -1 | Optional. If specified, will only remove the spikes that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the spikes are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of spikes. |
Returns
readonly GridEntitySpikes[]
The spikes that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:317
removeAllTNT
▸ removeAllTNT(variant?, updateRoom?, cap?): readonly GridEntityTNT[]
Helper function to remove all of the GridEntityTNT in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
variant | number | -1 | Optional. If specified, will only remove the TNTs that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the TNTs are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of TNTs. |
Returns
readonly GridEntityTNT[]
The TNTs that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:337
removeAllTeleporters
▸ removeAllTeleporters(variant?, updateRoom?, cap?): readonly GridEntity[]
Helper function to remove all of the GridEntityType.TELEPORTER (23) in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
variant | number | -1 | Optional. If specified, will only remove the teleporters that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the teleporters are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of teleporters. |
Returns
readonly GridEntity[]
The teleporters that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:357
removeAllTrapdoors
▸ removeAllTrapdoors(trapdoorVariant?, updateRoom?, cap?): readonly GridEntity[]
Helper function to remove all of the GridEntityType.TRAPDOOR (17) in the room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
trapdoorVariant | -1 | TrapdoorVariant | -1 | Optional. If specified, will only remove the trapdoors that match this variant. Default is -1, which matches every variant. |
updateRoom | boolean | false | Optional. Whether to update the room after the trapdoors are removed. Default is false. For more information, see the description of the removeGridEntities helper function. |
cap? | int | undefined | Optional. If specified, will only remove the given amount of trapdoors. |
Returns
readonly GridEntity[]
The trapdoors that were removed.
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:377
spawnCrawlSpace
▸ spawnCrawlSpace(gridIndexOrPosition): GridEntity | undefined
Helper function to spawn a GridEntityType.CRAWL_SPACE (18).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntity | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:387
spawnCrawlSpaceWithVariant
▸ spawnCrawlSpaceWithVariant(crawlSpaceVariant, gridIndexOrPosition): GridEntity | undefined
Helper function to spawn a GridEntityType.CRAWL_SPACE (18) with a specific variant.
Parameters
| Name | Type |
|---|---|
crawlSpaceVariant | CrawlSpaceVariant |
gridIndexOrPosition | int | Vector |
Returns
GridEntity | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:397
spawnDoor
▸ spawnDoor(gridIndexOrPosition): GridEntityDoor | undefined
Helper function to spawn a GridEntityType.PIT (7) with a specific variant.
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntityDoor | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:409
spawnDoorWithVariant
▸ spawnDoorWithVariant(doorVariant, gridIndexOrPosition): GridEntityDoor | undefined
Helper function to spawn a GridEntityType.DOOR (16).
Parameters
| Name | Type |
|---|---|
doorVariant | DoorVariant |
gridIndexOrPosition | int | Vector |
Returns
GridEntityDoor | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:416
spawnPit
▸ spawnPit(gridIndexOrPosition): GridEntityPit | undefined
Helper function to spawn a GridEntityType.DOOR (16) with a specific variant.
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntityPit | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:436
spawnPitWithVariant
▸ spawnPitWithVariant(pitVariant, gridIndexOrPosition): GridEntityPit | undefined
Helper function to spawn a GridEntityType.PIT (7) with a specific variant.
Parameters
| Name | Type |
|---|---|
pitVariant | PitVariant |
gridIndexOrPosition | int | Vector |
Returns
GridEntityPit | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:443
spawnPoop
▸ spawnPoop(gridIndexOrPosition): GridEntityPoop | undefined
Helper function to spawn a GridEntityType.POOP (14).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntityPoop | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:463
spawnPoopWithVariant
▸ spawnPoopWithVariant(poopVariant, gridIndexOrPosition): GridEntityPoop | undefined
Helper function to spawn a GridEntityType.POOP (14) with a specific variant.
Parameters
| Name | Type |
|---|---|
poopVariant | PoopGridEntityVariant |
gridIndexOrPosition | int | Vector |
Returns
GridEntityPoop | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:473
spawnPressurePlate
▸ spawnPressurePlate(gridIndexOrPosition): GridEntityPressurePlate | undefined
Helper function to spawn a GridEntityType.PRESSURE_PLATE (20).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntityPressurePlate | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:493
spawnPressurePlateWithVariant
▸ spawnPressurePlateWithVariant(pressurePlateVariant, gridIndexOrPosition): GridEntityPressurePlate | undefined
Helper function to spawn a GridEntityType.PRESSURE_PLATE (20) with a specific variant.
Parameters
| Name | Type |
|---|---|
pressurePlateVariant | PressurePlateVariant |
gridIndexOrPosition | int | Vector |
Returns
GridEntityPressurePlate | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:503
spawnRock
▸ spawnRock(gridIndexOrPosition): GridEntityRock | undefined
Helper function to spawn a GridEntityType.ROCK (2).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntityRock | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:523
spawnRockWithVariant
▸ spawnRockWithVariant(rockVariant, gridIndexOrPosition): GridEntityRock | undefined
Helper function to spawn a GridEntityType.ROCK (2) with a specific variant.
Parameters
| Name | Type |
|---|---|
rockVariant | RockVariant |
gridIndexOrPosition | int | Vector |
Returns
GridEntityRock | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:530
spawnSpikes
▸ spawnSpikes(gridIndexOrPosition): GridEntitySpikes | undefined
Helper function to spawn a GridEntityType.SPIKES (8).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntitySpikes | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:550
spawnSpikesWithVariant
▸ spawnSpikesWithVariant(variant, gridIndexOrPosition): GridEntitySpikes | undefined
Helper function to spawn a GridEntityType.SPIKES (8) with a specific variant.
Parameters
| Name | Type |
|---|---|
variant | int |
gridIndexOrPosition | int | Vector |
Returns
GridEntitySpikes | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:557
spawnTNT
▸ spawnTNT(gridIndexOrPosition): GridEntityTNT | undefined
Helper function to spawn a GridEntityType.TNT (12).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntityTNT | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:577
spawnTNTWithVariant
▸ spawnTNTWithVariant(variant, gridIndexOrPosition): GridEntityTNT | undefined
Helper function to spawn a GridEntityType.TNT (12) with a specific variant.
Parameters
| Name | Type |
|---|---|
variant | int |
gridIndexOrPosition | int | Vector |
Returns
GridEntityTNT | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:584
spawnTeleporter
▸ spawnTeleporter(gridIndexOrPosition): GridEntity | undefined
Helper function to spawn a GridEntityType.TELEPORTER (23).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntity | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:604
spawnTeleporterWithVariant
▸ spawnTeleporterWithVariant(variant, gridIndexOrPosition): GridEntity | undefined
Helper function to spawn a GridEntityType.TELEPORTER (23) with a specific variant.
Parameters
| Name | Type |
|---|---|
variant | int |
gridIndexOrPosition | int | Vector |
Returns
GridEntity | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:611
spawnTrapdoor
▸ spawnTrapdoor(gridIndexOrPosition): GridEntity | undefined
Helper function to spawn a GridEntityType.TRAPDOOR (17).
Parameters
| Name | Type |
|---|---|
gridIndexOrPosition | int | Vector |
Returns
GridEntity | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:623
spawnTrapdoorWithVariant
▸ spawnTrapdoorWithVariant(trapdoorVariant, gridIndexOrPosition): GridEntity | undefined
Helper function to spawn a GridEntityType.TRAPDOOR (17) with a specific variant.
Parameters
| Name | Type |
|---|---|
trapdoorVariant | TrapdoorVariant |
gridIndexOrPosition | int | Vector |
Returns
GridEntity | undefined
Defined in
packages/isaacscript-common/src/functions/gridEntitiesSpecific.ts:633