Debug Display
Classes
Section titled “Classes”DebugDisplay
Section titled “DebugDisplay”Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:24
Extends
Section titled “Extends”Feature
Methods
Section titled “Methods”setPlayerDisplay()
Section titled “setPlayerDisplay()”setPlayerDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:99
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
Section titled “Parameters”textCallback
Section titled “textCallback”(player) => string
Returns
Section titled “Returns”void
setTearDisplay()
Section titled “setTearDisplay()”setTearDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:118
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
Section titled “Parameters”textCallback
Section titled “textCallback”(tear) => string
Returns
Section titled “Returns”void
setFamiliarDisplay()
Section titled “setFamiliarDisplay()”setFamiliarDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:135
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
Section titled “Parameters”textCallback
Section titled “textCallback”(familiar) => string
Returns
Section titled “Returns”void
setBombDisplay()
Section titled “setBombDisplay()”setBombDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:154
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
Section titled “Parameters”textCallback
Section titled “textCallback”(bomb) => string
Returns
Section titled “Returns”void
setPickupDisplay()
Section titled “setPickupDisplay()”setPickupDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:171
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
Section titled “Parameters”textCallback
Section titled “textCallback”(pickup) => string
Returns
Section titled “Returns”void
setSlotDisplay()
Section titled “setSlotDisplay()”setSlotDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:190
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
Section titled “Parameters”textCallback
Section titled “textCallback”(slot) => string
Returns
Section titled “Returns”void
setLaserDisplay()
Section titled “setLaserDisplay()”setLaserDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:207
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
Section titled “Parameters”textCallback
Section titled “textCallback”(laser) => string
Returns
Section titled “Returns”void
setKnifeDisplay()
Section titled “setKnifeDisplay()”setKnifeDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:224
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
Section titled “Parameters”textCallback
Section titled “textCallback”(knife) => string
Returns
Section titled “Returns”void
setProjectileDisplay()
Section titled “setProjectileDisplay()”setProjectileDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:241
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
Section titled “Parameters”textCallback
Section titled “textCallback”(projectile) => string
Returns
Section titled “Returns”void
setEffectDisplay()
Section titled “setEffectDisplay()”setEffectDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:260
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
Section titled “Parameters”textCallback
Section titled “textCallback”(effect) => string
Returns
Section titled “Returns”void
setNPCDisplay()
Section titled “setNPCDisplay()”setNPCDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:279
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
Section titled “Parameters”textCallback
Section titled “textCallback”(npc) => string
Returns
Section titled “Returns”void
setRockDisplay()
Section titled “setRockDisplay()”setRockDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:296
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
Section titled “Parameters”textCallback
Section titled “textCallback”(rock) => string
Returns
Section titled “Returns”void
setPitDisplay()
Section titled “setPitDisplay()”setPitDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:313
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
Section titled “Parameters”textCallback
Section titled “textCallback”(pit) => string
Returns
Section titled “Returns”void
setSpikesDisplay()
Section titled “setSpikesDisplay()”setSpikesDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:330
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
Section titled “Parameters”textCallback
Section titled “textCallback”(spikes) => string
Returns
Section titled “Returns”void
setTNTDisplay()
Section titled “setTNTDisplay()”setTNTDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:349
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
Section titled “Parameters”textCallback
Section titled “textCallback”(tnt) => string
Returns
Section titled “Returns”void
setPoopDisplay()
Section titled “setPoopDisplay()”setPoopDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:366
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
Section titled “Parameters”textCallback
Section titled “textCallback”(poop) => string
Returns
Section titled “Returns”void
setDoorDisplay()
Section titled “setDoorDisplay()”setDoorDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:383
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
Section titled “Parameters”textCallback
Section titled “textCallback”(door) => string
Returns
Section titled “Returns”void
setPressurePlateDisplay()
Section titled “setPressurePlateDisplay()”setPressurePlateDisplay(
textCallback):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:400
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
Section titled “Parameters”textCallback
Section titled “textCallback”(pressurePlate) => string
Returns
Section titled “Returns”void
togglePlayerDisplay()
Section titled “togglePlayerDisplay()”togglePlayerDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:417
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleTearDisplay()
Section titled “toggleTearDisplay()”toggleTearDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:432
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleFamiliarDisplay()
Section titled “toggleFamiliarDisplay()”toggleFamiliarDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:448
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleBombDisplay()
Section titled “toggleBombDisplay()”toggleBombDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:463
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
togglePickupDisplay()
Section titled “togglePickupDisplay()”togglePickupDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:478
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleSlotDisplay()
Section titled “toggleSlotDisplay()”toggleSlotDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:493
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleLaserDisplay()
Section titled “toggleLaserDisplay()”toggleLaserDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:508
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleKnifeDisplay()
Section titled “toggleKnifeDisplay()”toggleKnifeDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:523
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleProjectileDisplay()
Section titled “toggleProjectileDisplay()”toggleProjectileDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:539
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleEffectDisplay()
Section titled “toggleEffectDisplay()”toggleEffectDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:554
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleNPCDisplay()
Section titled “toggleNPCDisplay()”toggleNPCDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:569
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleRockDisplay()
Section titled “toggleRockDisplay()”toggleRockDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:584
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
togglePitDisplay()
Section titled “togglePitDisplay()”togglePitDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:599
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleSpikesDisplay()
Section titled “toggleSpikesDisplay()”toggleSpikesDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:614
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleTNTDisplay()
Section titled “toggleTNTDisplay()”toggleTNTDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:629
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
togglePoopDisplay()
Section titled “togglePoopDisplay()”togglePoopDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:644
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
toggleDoorDisplay()
Section titled “toggleDoorDisplay()”toggleDoorDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:659
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void
togglePressurePlateDisplay()
Section titled “togglePressurePlateDisplay()”togglePressurePlateDisplay(
force?):void
Defined in: packages/isaacscript-common/src/classes/features/other/DebugDisplay.ts:675
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
Section titled “Parameters”force?
Section titled “force?”boolean
Optional. 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
Section titled “Returns”void