Log Entities
Functions
logAllEntities
▸ logAllEntities(this, includeBackgroundEffects, entityTypeFilter?): void
Helper function for printing out every entity (or filtered entity) in the current room.
Parameters
| Name | Type |
|---|---|
this | void |
includeBackgroundEffects | boolean |
entityTypeFilter? | EntityType |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:35
logAllGridEntities
▸ logAllGridEntities(this, includeWalls?, gridEntityTypeFilter?): void
Helper function for printing out every grid entity (or filtered grid entity) in the current room.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
this | void | undefined | - |
includeWalls | boolean | false | Optional. Whether oto log the walls. Default is false. |
gridEntityTypeFilter? | GridEntityType | undefined | Optional. If specified, will only log the given GridEntityType. Default is undefined. |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:91
logEntities
▸ logEntities(this, entities): void
Helper function for logging an array of specific entities.
Parameters
| Name | Type |
|---|---|
this | void |
entities | readonly Entity[] |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:145
logEntity
▸ logEntity(this, entity): void
Helper function to log information about a specific entity.
Parameters
| Name | Type |
|---|---|
this | void |
entity | Entity |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:152
logGridEntities
▸ logGridEntities(this, gridEntities): void
Helper function for logging an array of specific grid entities.
Parameters
| Name | Type |
|---|---|
this | void |
gridEntities | readonly GridEntity[] |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:298
logGridEntity
▸ logGridEntity(this, gridEntity): void
Helper function for log information about a specific grid entity.
Parameters
| Name | Type |
|---|---|
this | void |
gridEntity | GridEntity |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:308
logPtrHash
▸ logPtrHash(this, ptrHash): void
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
| Name | Type |
|---|---|
this | void |
ptrHash | PtrHash |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:378
logPtrHashes
▸ logPtrHashes(this, ptrHashes): void
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
| Name | Type |
|---|---|
this | void |
ptrHashes | readonly PtrHash[] |
Returns
void
Defined in
packages/isaacscript-common/src/functions/logEntities.ts:392