isaacscript-common 6.2.1 → 6.3.0

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;

package/features/debugDisplay/exports.lua

@@ -4,219 +4,364 @@ local printEnabled = ____utils.printEnabled
 local ____v = require("features.debugDisplay.v")
 local v = ____v.default
 local debugDisplayTextCallbacks = ____v.debugDisplayTextCallbacks
+local errorIfDebugDisplayNotInitialized = ____v.errorIfDebugDisplayNotInitialized
 --- 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.
 function ____exports.setPlayerDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.player = textCallback
 end
 --- 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.
 function ____exports.setTearDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.tear = textCallback
 end
 --- 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.
 function ____exports.setFamiliarDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.familiar = textCallback
 end
 --- 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.
 function ____exports.setBombDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.bomb = textCallback
 end
 --- 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.
 function ____exports.setPickupDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.pickup = textCallback
 end
 --- 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.
 function ____exports.setSlotDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.slot = textCallback
 end
 --- 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.
 function ____exports.setLaserDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.laser = textCallback
 end
 --- 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.
 function ____exports.setKnifeDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.knife = textCallback
 end
 --- 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.
 function ____exports.setProjectileDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.projectile = textCallback
 end
 --- 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.
 function ____exports.setEffectDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.effect = textCallback
 end
 --- 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.
 function ____exports.setNPCDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.npc = textCallback
 end
 --- 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.
 function ____exports.setRockDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.rock = textCallback
 end
 --- 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.
 function ____exports.setPitDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.pit = textCallback
 end
 --- 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.
 function ____exports.setSpikesDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.spikes = textCallback
 end
 --- 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.
 function ____exports.setTNTDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.tnt = textCallback
 end
 --- 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.
 function ____exports.setPoopDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.poop = textCallback
 end
 --- 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.
 function ____exports.setDoorDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.door = textCallback
 end
 --- 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.
 function ____exports.setPressurePlateDisplay(self, textCallback)
+    errorIfDebugDisplayNotInitialized(nil)
     debugDisplayTextCallbacks.pressurePlate = textCallback
 end
 --- 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.
 function ____exports.togglePlayerDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.player = not v.run.player
     printEnabled(nil, v.run.player, "player display")
 end
 --- 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.
 function ____exports.toggleTearDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.tear = not v.run.tear
     printEnabled(nil, v.run.tear, "tear display")
 end
 --- 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.
 function ____exports.toggleFamiliarDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.familiar = not v.run.familiar
     printEnabled(nil, v.run.familiar, "familiar display")
 end
 --- 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.
 function ____exports.toggleBombDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.bomb = not v.run.bomb
     printEnabled(nil, v.run.bomb, "bomb display")
 end
 --- 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.
 function ____exports.togglePickupDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.pickup = not v.run.pickup
     printEnabled(nil, v.run.pickup, "pickup display")
 end
 --- 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.
 function ____exports.toggleSlotDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.slot = not v.run.slot
     printEnabled(nil, v.run.slot, "slot display")
 end
 --- 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.
 function ____exports.toggleLaserDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.laser = not v.run.laser
     printEnabled(nil, v.run.laser, "laser display")
 end
 --- 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.
 function ____exports.toggleKnifeDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.knife = not v.run.knife
     printEnabled(nil, v.run.knife, "knife display")
 end
 --- 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.
 function ____exports.toggleProjectileDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.projectile = not v.run.projectile
     printEnabled(nil, v.run.projectile, "projectile display")
 end
 --- 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.
 function ____exports.toggleEffectDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.effect = not v.run.effect
     printEnabled(nil, v.run.effect, "effect display")
 end
 --- 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.
 function ____exports.toggleNPCDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.npc = not v.run.npc
     printEnabled(nil, v.run.npc, "NPC display")
 end
 --- 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.
 function ____exports.toggleRockDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.rock = not v.run.rock
     printEnabled(nil, v.run.rock, "rock display")
 end
 --- 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.
 function ____exports.togglePitDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.pit = not v.run.pit
     printEnabled(nil, v.run.pit, "pit display")
 end
 --- 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.
 function ____exports.toggleSpikesDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.spikes = not v.run.spikes
     printEnabled(nil, v.run.spikes, "spikes display")
 end
 --- 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.
 function ____exports.toggleTNTDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.tnt = not v.run.tnt
     printEnabled(nil, v.run.tnt, "TNT display")
 end
 --- 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.
 function ____exports.togglePoopDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.poop = not v.run.poop
     printEnabled(nil, v.run.poop, "poop display")
 end
 --- 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.
 function ____exports.toggleDoorDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.door = not v.run.door
     printEnabled(nil, v.run.door, "door display")
 end
 --- 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.
 function ____exports.togglePressurePlateDisplay(self)
+    errorIfDebugDisplayNotInitialized(nil)
     v.run.pressurePlate = not v.run.pressurePlate
     printEnabled(nil, v.run.pressurePlate, "pressure plate display")
 end

package/features/debugDisplay/v.d.ts

@@ -1,3 +1,5 @@
+export declare function setDebugDisplayEnabled(): void;
+export declare function errorIfDebugDisplayNotInitialized(): void;
 declare const v: {
     run: {
         player: boolean;