Log Entities
Functions
Section titled “Functions”logAllEntities()
Section titled “logAllEntities()”logAllEntities(
this,includeBackgroundEffects,entityTypeFilter?):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:35
Helper function for printing out every entity (or filtered entity) in the current room.
Parameters
Section titled “Parameters”void
includeBackgroundEffects
Section titled “includeBackgroundEffects”boolean
entityTypeFilter?
Section titled “entityTypeFilter?”EntityType
Returns
Section titled “Returns”void
logAllGridEntities()
Section titled “logAllGridEntities()”logAllGridEntities(
this,includeWalls?,gridEntityTypeFilter?):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:91
Helper function for printing out every grid entity (or filtered grid entity) in the current room.
Parameters
Section titled “Parameters”void
includeWalls?
Section titled “includeWalls?”boolean = false
Optional. Whether oto log the walls. Default is false.
gridEntityTypeFilter?
Section titled “gridEntityTypeFilter?”GridEntityType
Optional. If specified, will only log the given GridEntityType.
Default is undefined.
Returns
Section titled “Returns”void
logEntities()
Section titled “logEntities()”logEntities(
this,entities):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:145
Helper function for logging an array of specific entities.
Parameters
Section titled “Parameters”void
entities
Section titled “entities”readonly Entity[]
Returns
Section titled “Returns”void
logEntity()
Section titled “logEntity()”logEntity(
this,entity):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:152
Helper function to log information about a specific entity.
Parameters
Section titled “Parameters”void
entity
Section titled “entity”Entity
Returns
Section titled “Returns”void
logGridEntities()
Section titled “logGridEntities()”logGridEntities(
this,gridEntities):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:158
Helper function for logging an array of specific grid entities.
Parameters
Section titled “Parameters”void
gridEntities
Section titled “gridEntities”readonly GridEntity[]
Returns
Section titled “Returns”void
logGridEntity()
Section titled “logGridEntity()”logGridEntity(
this,gridEntity):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:168
Helper function for log information about a specific grid entity.
Parameters
Section titled “Parameters”void
gridEntity
Section titled “gridEntity”GridEntity
Returns
Section titled “Returns”void
logPtrHash()
Section titled “logPtrHash()”logPtrHash(
this,ptrHash):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:177
Helper function to log information about the entity that corresponding to a pointer hash. (Only use this when debugging, since retrieving the corresponding entity is expensive.)
Parameters
Section titled “Parameters”void
ptrHash
Section titled “ptrHash”PtrHash
Returns
Section titled “Returns”void
logPtrHashes()
Section titled “logPtrHashes()”logPtrHashes(
this,ptrHashes):void
Defined in: packages/isaacscript-common/src/functions/logEntities.ts:191
Helper function to log information about the entity that corresponding to one or more pointer hashes. (Only use this when debugging, since retrieving the corresponding entity is expensive.)
Parameters
Section titled “Parameters”void
ptrHashes
Section titled “ptrHashes”readonly PtrHash[]
Returns
Section titled “Returns”void