Skip to main content

Debug Display

Hierarchy​

  • Feature

    ↳ DebugDisplay

Methods​

setPlayerDisplay​

▸ setPlayerDisplay(textCallback): void

If the "togglePlayerDisplay" function is called, text will be drawn on the screen next to each player. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

For example, this would draw the number of the player's collectibles next to their head:

setPlayerDisplay((player) => {
  return `collectible count: ${player.GetCollectibleCount()}`;
});

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(player: EntityPlayer) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:79

setTearDisplay​

▸ setTearDisplay(textCallback): void

If the "toggleTearDisplay" function is called, text will be drawn on the screen next to each tear. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(tear: EntityTear) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:98

setFamiliarDisplay​

▸ setFamiliarDisplay(textCallback): void

If the "toggleFamiliarDisplay" function is called, text will be drawn on the screen next to each familiar. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(familiar: EntityFamiliar) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:115

setBombDisplay​

▸ setBombDisplay(textCallback): void

If the "toggleBombDisplay" function is called, text will be drawn on the screen next to each bomb. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(bomb: EntityBomb) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:134

setPickupDisplay​

▸ setPickupDisplay(textCallback): void

If the "togglePickupDisplay" function is called, text will be drawn on the screen next to each pickup. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(pickup: EntityPickup) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:151

setSlotDisplay​

▸ setSlotDisplay(textCallback): void

If the "toggleSlotDisplay" function is called, text will be drawn on the screen next to each slot. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(slot: Entity) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:170

setLaserDisplay​

▸ setLaserDisplay(textCallback): void

If the "toggleLaserDisplay" function is called, text will be drawn on the screen next to each laser. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(laser: EntityLaser) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:187

setKnifeDisplay​

▸ setKnifeDisplay(textCallback): void

If the "toggleKnifeDisplay" function is called, text will be drawn on the screen next to each knife. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(knife: EntityKnife) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:204

setProjectileDisplay​

▸ setProjectileDisplay(textCallback): void

If the "toggleProjectileDisplay" function is called, text will be drawn on the screen next to each projectile. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(projectile: EntityProjectile) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:221

setEffectDisplay​

▸ setEffectDisplay(textCallback): void

If the "extra console commands" feature is specified, the "effectDisplay" console command will draw text on the screen next to each effect. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(effect: EntityEffect) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:240

setNPCDisplay​

▸ setNPCDisplay(textCallback): void

If the "toggleNPCDisplay" function is called, text will be drawn on the screen next to each NPC. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(npc: EntityNPC) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:259

setRockDisplay​

▸ setRockDisplay(textCallback): void

If the "toggleRockDisplay" function is called, text will be drawn on the screen next to each rock. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(rock: GridEntityRock) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:276

setPitDisplay​

▸ setPitDisplay(textCallback): void

If the "togglePitDisplay" function is called, text will be drawn on the screen next to each pit. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(pit: GridEntityPit) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:293

setSpikesDisplay​

▸ setSpikesDisplay(textCallback): void

If the "toggleSpikesDisplay" function is called, text will be drawn on the screen next to each spikes. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(spikes: GridEntitySpikes) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:310

setTNTDisplay​

▸ setTNTDisplay(textCallback): void

If the "toggleTNTDisplay" function is called, text will be drawn on the screen next to each TNT. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(tnt: GridEntityTNT) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:329

setPoopDisplay​

▸ setPoopDisplay(textCallback): void

If the "togglePoopDisplay" function is called, text will be drawn on the screen next to each poop. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(poop: GridEntityPoop) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:346

setDoorDisplay​

▸ setDoorDisplay(textCallback): void

If the "toggleDoorDisplay" function is called, text will be drawn on the screen next to each door. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(door: GridEntityDoor) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:363

setPressurePlateDisplay​

▸ setPressurePlateDisplay(textCallback): void

If the "togglePressurePlateDisplay" function is called, text will be drawn on the screen next to each pressure plate. Use this function to specify a callback function that returns the string that should be drawn.

Once the function is set, the library will call it automatically on every frame. For this reason, you typically only need to set the function once at the beginning of your mod.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameType
textCallback(pressurePlate: GridEntityPressurePlate) => string

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:380

togglePlayerDisplay​

▸ togglePlayerDisplay(force?): void

Toggles the debug display for players, which will draw text on the screen next to each player.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:420

toggleTearDisplay​

▸ toggleTearDisplay(force?): void

Toggles the debug display for tears, which will draw text on the screen next to each tear.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY. *

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:435

toggleFamiliarDisplay​

▸ toggleFamiliarDisplay(force?): void

Toggles the debug display for familiars, which will draw text on the screen next to each familiar.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:451

toggleBombDisplay​

▸ toggleBombDisplay(force?): void

Toggles the debug display for bombs, which will draw text on the screen next to each bomb.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:466

togglePickupDisplay​

▸ togglePickupDisplay(force?): void

Toggles the debug display for pickups, which will draw text on the screen next to each pickup.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:481

toggleSlotDisplay​

▸ toggleSlotDisplay(force?): void

Toggles the debug display for slots, which will draw text on the screen next to each slot.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:496

toggleLaserDisplay​

▸ toggleLaserDisplay(force?): void

Toggles the debug display for lasers, which will draw text on the screen next to each laser.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:511

toggleKnifeDisplay​

▸ toggleKnifeDisplay(force?): void

Toggles the debug display for knives, which will draw text on the screen next to each knife.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:526

toggleProjectileDisplay​

▸ toggleProjectileDisplay(force?): void

Toggles the debug display for projectiles, which will draw text on the screen next to each projectile.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:542

toggleEffectDisplay​

▸ toggleEffectDisplay(force?): void

Toggles the debug display for effects, which will draw text on the screen next to each effect.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:557

toggleNPCDisplay​

▸ toggleNPCDisplay(force?): void

Toggles the debug display for NPCs, which will draw text on the screen next to each NPC.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:572

toggleRockDisplay​

▸ toggleRockDisplay(force?): void

Toggles the debug display for rocks, which will draw text on the screen next to each rock.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:587

togglePitDisplay​

▸ togglePitDisplay(force?): void

Toggles the debug display for pits, which will draw text on the screen next to each pit.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:602

toggleSpikesDisplay​

▸ toggleSpikesDisplay(force?): void

Toggles the debug display for spikes, which will draw text on the screen next to each spike.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:617

toggleTNTDisplay​

▸ toggleTNTDisplay(force?): void

Toggles the debug display for TNT, which will draw text on the screen next to each TNT.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:632

togglePoopDisplay​

▸ togglePoopDisplay(force?): void

Toggles the debug display for poops, which will draw text on the screen next to each poop.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:647

toggleDoorDisplay​

▸ toggleDoorDisplay(force?): void

Toggles the debug display for doors, which will draw text on the screen next to each door.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:662

togglePressurePlateDisplay​

▸ togglePressurePlateDisplay(force?): void

Toggles the debug display for pressure plates, which will draw text on the screen next to each pressure plate.

In order to use this function, you must upgrade your mod with ISCFeature.DEBUG_DISPLAY.

Parameters​

NameTypeDescription
force?booleanOptional. A boolean that represents the value to force the display to. For example, you can specify true to always make the display turn on, regardless of whether it is already on.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:678