isaacscript-common 6.2.0 → 6.4.0

package/features/customStage/v.lua

@@ -2,8 +2,12 @@ local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local v = {run = {currentCustomStage = nil, showingStreakText = false, showingBossVersusScreen = false}}
+____exports.default = v
 --- Indexed by custom stage name.
 ____exports.customStagesMap = __TS__New(Map)
 --- Indexed by room variant.
 ____exports.customStageCachedRoomData = __TS__New(Map)
+--- Indexed by entity ID.
+____exports.customBossPNGPaths = __TS__New(Map)
 return ____exports

package/features/customStage/versusScreen.d.ts

@@ -0,0 +1,3 @@
+import { CustomStage } from "../../interfaces/CustomStage";
+export declare function playVersusScreenAnimation(customStage: CustomStage, force?: boolean): void;
+export declare function versusScreenPostRender(): void;

package/features/customStage/versusScreen.lua

@@ -0,0 +1,193 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local ____exports = {}
+local getPlayerPNGPaths, getBossPNGPaths, DEFAULT_CHARACTER, PNG_PATH_PREFIX, PLAYER_PORTRAIT_PNG_PATH_PREFIX
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
+local StageID = ____isaac_2Dtypescript_2Ddefinitions.StageID
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local sfxManager = ____cachedClasses.sfxManager
+local ____array = require("functions.array")
+local arrayRemove = ____array.arrayRemove
+local ____boss = require("functions.boss")
+local getBosses = ____boss.getBosses
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+local ____bossNamePNGFileNames = require("objects.bossNamePNGFileNames")
+local BOSS_NAME_PNG_FILE_NAMES = ____bossNamePNGFileNames.BOSS_NAME_PNG_FILE_NAMES
+local ____bossPortraitPNGFileNames = require("objects.bossPortraitPNGFileNames")
+local BOSS_PORTRAIT_PNG_FILE_NAMES = ____bossPortraitPNGFileNames.BOSS_PORTRAIT_PNG_FILE_NAMES
+local ____playerNamePNGFileNames = require("objects.playerNamePNGFileNames")
+local PLAYER_NAME_PNG_FILE_NAMES = ____playerNamePNGFileNames.PLAYER_NAME_PNG_FILE_NAMES
+local ____playerPortraitPNGFileNames = require("objects.playerPortraitPNGFileNames")
+local PLAYER_PORTRAIT_PNG_FILE_NAMES = ____playerPortraitPNGFileNames.PLAYER_PORTRAIT_PNG_FILE_NAMES
+local ____versusScreenBackgroundColors = require("objects.versusScreenBackgroundColors")
+local VERSUS_SCREEN_BACKGROUND_COLORS = ____versusScreenBackgroundColors.VERSUS_SCREEN_BACKGROUND_COLORS
+local ____versusScreenDirtSpotColors = require("objects.versusScreenDirtSpotColors")
+local VERSUS_SCREEN_DIRT_SPOT_COLORS = ____versusScreenDirtSpotColors.VERSUS_SCREEN_DIRT_SPOT_COLORS
+local ____pause = require("features.pause")
+local pause = ____pause.pause
+local unpause = ____pause.unpause
+local ____customStageConstants = require("features.customStage.customStageConstants")
+local ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = ____customStageConstants.ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH
+local ____v = require("features.customStage.v")
+local v = ____v.default
+local customBossPNGPaths = ____v.customBossPNGPaths
+function getPlayerPNGPaths(self)
+    local player = Isaac.GetPlayer()
+    local character = player:GetPlayerType()
+    local playerNamePNGFileName = PLAYER_NAME_PNG_FILE_NAMES[character]
+    if playerNamePNGFileName == nil then
+        playerNamePNGFileName = PLAYER_NAME_PNG_FILE_NAMES[DEFAULT_CHARACTER]
+    end
+    local playerNamePNGPath = (PNG_PATH_PREFIX .. "/") .. tostring(playerNamePNGFileName)
+    local playerPortraitFileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[character]
+    if playerNamePNGFileName == nil then
+        playerPortraitFileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[DEFAULT_CHARACTER]
+    end
+    local playerPortraitPNGPath = (PLAYER_PORTRAIT_PNG_PATH_PREFIX .. "/") .. tostring(playerPortraitFileName)
+    return {playerNamePNGPath, playerPortraitPNGPath}
+end
+function getBossPNGPaths(self)
+    local bosses = getBosses(nil)
+    local firstBoss = bosses[1]
+    if firstBoss ~= nil then
+        local entityID = getEntityID(nil, firstBoss)
+        local pngPaths = customBossPNGPaths:get(entityID)
+        if pngPaths ~= nil then
+            return pngPaths
+        end
+    end
+    local bossID = firstBoss == nil and 0 or firstBoss:GetBossID()
+    if bossID == 0 then
+        local questionMarkSprite = (PNG_PATH_PREFIX .. "/") .. BOSS_NAME_PNG_FILE_NAMES[BossID.BLUE_BABY]
+        local bossNamePNGPath = questionMarkSprite
+        local bossPortraitPNGPath = questionMarkSprite
+        return {bossNamePNGPath, bossPortraitPNGPath}
+    end
+    local bossNamePNGFileName = BOSS_NAME_PNG_FILE_NAMES[bossID]
+    local bossNamePNGPath = (PNG_PATH_PREFIX .. "/") .. bossNamePNGFileName
+    local bossPortraitPNGFileName = BOSS_PORTRAIT_PNG_FILE_NAMES[bossID]
+    local bossPortraitPNGPath = (PNG_PATH_PREFIX .. "/") .. bossPortraitPNGFileName
+    return {bossNamePNGPath, bossPortraitPNGPath}
+end
+DEFAULT_CHARACTER = PlayerType.ISAAC
+local DEFAULT_STAGE_ID = StageID.BASEMENT
+local VERSUS_SCREEN_ANIMATION_NAME = "Scene"
+--- The layers range from 0 to 13.
+local NUM_VERSUS_SCREEN_ANM2_LAYERS = 14
+local BACKGROUND_ANM2_LAYER = 0
+local BOSS_DIRT_SPOT_ANM2_LAYER = 2
+local PLAYER_DIRT_SPOT_ANM2_LAYER = 3
+local BOSS_PORTRAIT_ANM2_LAYER = 4
+local PLAYER_PORTRAIT_ANM2_LAYER = 5
+local PLAYER_NAME_ANM2_LAYER = 6
+local BOSS_NAME_ANM2_LAYER = 7
+local OVERLAY_ANM2_LAYER = 11
+--- We only need to render either the normal player portrait layer or the alternate player portrait
+-- layer. Rendering both will cause the player not to shake.
+local PLAYER_PORTRAIT_ALT_ANM2_LAYER = 12
+--- These are the non-special layers that we will render last.
+local OTHER_ANM2_LAYERS = arrayRemove(
+    nil,
+    erange(nil, NUM_VERSUS_SCREEN_ANM2_LAYERS),
+    BACKGROUND_ANM2_LAYER,
+    BOSS_DIRT_SPOT_ANM2_LAYER,
+    PLAYER_DIRT_SPOT_ANM2_LAYER,
+    OVERLAY_ANM2_LAYER,
+    PLAYER_PORTRAIT_ALT_ANM2_LAYER
+)
+PNG_PATH_PREFIX = "gfx/ui/boss"
+PLAYER_PORTRAIT_PNG_PATH_PREFIX = "gfx/ui/stage"
+local VANILLA_VERSUS_PLAYBACK_SPEED = 0.5
+local versusScreenSprite = Sprite()
+versusScreenSprite:Load("gfx/ui/boss/versusscreen.anm2", false)
+versusScreenSprite:ReplaceSpritesheet(OVERLAY_ANM2_LAYER, ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/overlay.png")
+versusScreenSprite:LoadGraphics()
+--- Unfortunately, we must split the background layer into an entirely different sprite so that we
+-- can color it with the `Color` property.
+local versusScreenBackgroundSprite = Sprite()
+versusScreenBackgroundSprite:Load("gfx/ui/boss/versusscreen.anm2", true)
+--- Unfortunately, we must split the dirt layer into an entirely different sprite so that we can
+-- color it with the `Color` property.
+local versusScreenDirtSpotSprite = Sprite()
+versusScreenDirtSpotSprite:Load("gfx/ui/boss/versusscreen.anm2", true)
+function ____exports.playVersusScreenAnimation(self, customStage, force)
+    if force == nil then
+        force = false
+    end
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local hud = game:GetHUD()
+    if roomType ~= RoomType.BOSS and not force then
+        return
+    end
+    v.run.showingBossVersusScreen = true
+    pause(nil)
+    hud:SetVisible(false)
+    local playerNamePNGPath, playerPortraitPNGPath = table.unpack(getPlayerPNGPaths(nil))
+    versusScreenSprite:ReplaceSpritesheet(PLAYER_NAME_ANM2_LAYER, playerNamePNGPath)
+    versusScreenSprite:ReplaceSpritesheet(PLAYER_PORTRAIT_ANM2_LAYER, playerPortraitPNGPath)
+    local bossNamePNGPath, bossPortraitPNGPath = table.unpack(getBossPNGPaths(nil))
+    versusScreenSprite:ReplaceSpritesheet(BOSS_NAME_ANM2_LAYER, bossNamePNGPath)
+    versusScreenSprite:ReplaceSpritesheet(BOSS_PORTRAIT_ANM2_LAYER, bossPortraitPNGPath)
+    versusScreenSprite:LoadGraphics()
+    local backgroundColor = VERSUS_SCREEN_BACKGROUND_COLORS[DEFAULT_STAGE_ID]
+    if customStage.versusScreenBackgroundColor ~= nil then
+        local ____customStage_versusScreenBackgroundColor_0 = customStage.versusScreenBackgroundColor
+        local r = ____customStage_versusScreenBackgroundColor_0.r
+        local g = ____customStage_versusScreenBackgroundColor_0.g
+        local b = ____customStage_versusScreenBackgroundColor_0.b
+        backgroundColor = Color(r, g, b)
+    end
+    versusScreenBackgroundSprite.Color = backgroundColor
+    local dirtSpotColor = VERSUS_SCREEN_DIRT_SPOT_COLORS[DEFAULT_STAGE_ID]
+    if customStage.versusScreenDirtSpotColor ~= nil then
+        local ____customStage_versusScreenDirtSpotColor_1 = customStage.versusScreenDirtSpotColor
+        local r = ____customStage_versusScreenDirtSpotColor_1.r
+        local g = ____customStage_versusScreenDirtSpotColor_1.g
+        local b = ____customStage_versusScreenDirtSpotColor_1.b
+        dirtSpotColor = Color(r, g, b)
+    end
+    versusScreenDirtSpotSprite.Color = dirtSpotColor
+    for ____, sprite in ipairs({versusScreenBackgroundSprite, versusScreenDirtSpotSprite, versusScreenSprite}) do
+        sprite:Play(VERSUS_SCREEN_ANIMATION_NAME, true)
+        sprite.PlaybackSpeed = VANILLA_VERSUS_PLAYBACK_SPEED
+    end
+end
+local function finishVersusScreenAnimation(self)
+    local hud = game:GetHUD()
+    v.run.showingBossVersusScreen = false
+    unpause(nil)
+    hud:SetVisible(true)
+    sfxManager:Play(SoundEffect.CASTLE_PORTCULLIS)
+end
+function ____exports.versusScreenPostRender(self)
+    if not v.run.showingBossVersusScreen then
+        return
+    end
+    if versusScreenSprite:IsFinished(VERSUS_SCREEN_ANIMATION_NAME) then
+        finishVersusScreenAnimation(nil)
+        return
+    end
+    local room = game:GetRoom()
+    local centerPos = room:GetCenterPos()
+    local position = Isaac.WorldToRenderPosition(centerPos)
+    versusScreenBackgroundSprite:RenderLayer(BACKGROUND_ANM2_LAYER, position)
+    versusScreenBackgroundSprite:Update()
+    versusScreenSprite:RenderLayer(OVERLAY_ANM2_LAYER, position)
+    versusScreenDirtSpotSprite:RenderLayer(BOSS_DIRT_SPOT_ANM2_LAYER, position)
+    versusScreenDirtSpotSprite:RenderLayer(PLAYER_DIRT_SPOT_ANM2_LAYER, position)
+    versusScreenDirtSpotSprite:Update()
+    for ____, layerID in ipairs(OTHER_ANM2_LAYERS) do
+        versusScreenSprite:RenderLayer(layerID, position)
+    end
+    versusScreenSprite:Update()
+end
+return ____exports

package/features/debugDisplay/debugDisplay.lua

@@ -11,6 +11,7 @@ local saveDataManager = ____exports.saveDataManager
 local ____v = require("features.debugDisplay.v")
 local v = ____v.default
 local debugDisplayTextCallbacks = ____v.debugDisplayTextCallbacks
+local setDebugDisplayEnabled = ____v.setDebugDisplayEnabled
 function renderTextOnEntity(self, entity, text)
     if isReflectionRender(nil) then
         return
@@ -155,6 +156,7 @@ end
 --- The debug display feature is only initialized when the extra console commands feature is
 -- initialized.
 function ____exports.debugDisplayInit(self, mod)
+    setDebugDisplayEnabled(nil)
     saveDataManager(
         nil,
         "debugDisplay",

package/features/debugDisplay/exports.d.ts

@@ -20,197 +20,305 @@
  * After using the "playerDisplay" console command, text will be drawn on each player for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setPlayerDisplay(textCallback: (player: EntityPlayer) => string): void;
 /**
  * After using the "tearDisplay" console command, text will be drawn on each tear for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setTearDisplay(textCallback: (tear: EntityTear) => string): void;
 /**
  * After using the "familiarDisplay" console command, text will be drawn on each familiar for
  * debugging purposes. Use this function to specify a callback function that will returns the string
  * that should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setFamiliarDisplay(textCallback: (familiar: EntityFamiliar) => string): void;
 /**
  * After using the "bombDisplay" console command, text will be drawn on each bomb for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setBombDisplay(textCallback: (bomb: EntityBomb) => string): void;
 /**
  * After using the "pickupDisplay" console command, text will be drawn on each pickup for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setPickupDisplay(textCallback: (pickup: EntityPickup) => string): void;
 /**
  * After using the "slotDisplay" console command, text will be drawn on each slot for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setSlotDisplay(textCallback: (slot: Entity) => string): void;
 /**
  * After using the "laserDisplay" console command, text will be drawn on each laser for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setLaserDisplay(textCallback: (laser: EntityLaser) => string): void;
 /**
  * After using the "knifeDisplay" console command, text will be drawn on each knife for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setKnifeDisplay(textCallback: (knife: EntityKnife) => string): void;
 /**
  * After using the "projectileDisplay" console command, text will be drawn on each projectile for
  * debugging purposes. Use this function to specify a callback function that will returns the string
  * that should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setProjectileDisplay(textCallback: (projectile: EntityProjectile) => string): void;
 /**
  * After using the "effectDisplay" console command, text will be drawn on each effect for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setEffectDisplay(textCallback: (effect: EntityEffect) => string): void;
 /**
  * After using the "npcDisplay" console command, text will be drawn on each NPC for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setNPCDisplay(textCallback: (npc: EntityNPC) => string): void;
 /**
  * After using the "rockDisplay" console command, text will be drawn on each rock for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setRockDisplay(textCallback: (rock: GridEntityRock) => string): void;
 /**
  * After using the "pitDisplay" console command, text will be drawn on each pit for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setPitDisplay(textCallback: (pit: GridEntityPit) => string): void;
 /**
  * After using the "spikesDisplay" console command, text will be drawn on each spikes for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setSpikesDisplay(textCallback: (spikes: GridEntitySpikes) => string): void;
 /**
  * After using the "tntDisplay" console command, text will be drawn on each TNT for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setTNTDisplay(textCallback: (tnt: GridEntityTNT) => string): void;
 /**
  * After using the "poopDisplay" console command, text will be drawn on each poop for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setPoopDisplay(textCallback: (poop: GridEntityPoop) => string): void;
 /**
  * After using the "poopDisplay" console command, text will be drawn on each poop for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
  * should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setDoorDisplay(textCallback: (door: GridEntityDoor) => string): void;
 /**
  * After using the "pressurePlateDisplay" console command, text will be drawn on each pressure plate
  * for debugging purposes. Use this function to specify a callback function that will returns the
  * string that should be drawn.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 export declare function setPressurePlateDisplay(textCallback: (pressurePlate: GridEntityPressurePlate) => string): void;
 /**
  * Toggles the debug display for players. This is the function that runs when you use the
  * "playerDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function togglePlayerDisplay(): void;
 /**
  * Toggles the debug display for tears. This is the function that runs when you use the
  * "tearDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleTearDisplay(): void;
 /**
  * Toggles the debug display for familiars. This is the function that runs when you use the
  * "familiarDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleFamiliarDisplay(): void;
 /**
  * Toggles the debug display for bombs. This is the function that runs when you use the
  * "bombDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleBombDisplay(): void;
 /**
  * Toggles the debug display for pickups. This is the function that runs when you use the
  * "pickupDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function togglePickupDisplay(): void;
 /**
  * Toggles the debug display for slots. This is the function that runs when you use the
  * "slotDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleSlotDisplay(): void;
 /**
  * Toggles the debug display for lasers. This is the function that runs when you use the
  * "laserDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleLaserDisplay(): void;
 /**
  * Toggles the debug display for knives. This is the function that runs when you use the
  * "knifeDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleKnifeDisplay(): void;
 /**
  * Toggles the debug display for projectiles. This is the function that runs when you use the
  * "projectileDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleProjectileDisplay(): void;
 /**
  * Toggles the debug display for effects. This is the function that runs when you use the
  * "effectDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleEffectDisplay(): void;
 /**
  * Toggles the debug display for NPCs. This is the function that runs when you use the "npcDisplay"
  * custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleNPCDisplay(): void;
 /**
  * Toggles the debug display for rocks. This is the function that runs when you use the
  * "rockDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleRockDisplay(): void;
 /**
  * Toggles the debug display for pits. This is the function that runs when you use the "pitDisplay"
  * custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function togglePitDisplay(): void;
 /**
  * Toggles the debug display for spikes. This is the function that runs when you use the
  * "spikesDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleSpikesDisplay(): void;
 /**
  * Toggles the debug display for TNT. This is the function that runs when you use the "tntDisplay"
  * custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleTNTDisplay(): void;
 /**
  * Toggles the debug display for poop. This is the function that runs when you use the "poopDisplay"
  * custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function togglePoopDisplay(): void;
 /**
  * Toggles the debug display for doors. This is the function that runs when you use the
  * "doorDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function toggleDoorDisplay(): void;
 /**
  * Toggles the debug display for pressure plates. This is the function that runs when you use the
  * "pressurePlateDisplay" custom console command.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function togglePressurePlateDisplay(): void;