isaacscript-common 2.3.1 → 3.1.0

package/features/debugDisplay/exports.lua

@@ -4,128 +4,218 @@ local printEnabled = ____utils.printEnabled
 local ____v = require("features.debugDisplay.v")
 local v = ____v.default
 local debugDisplayTextCallbacks = ____v.debugDisplayTextCallbacks
+--- 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.
 function ____exports.setPlayerDisplay(self, textCallback)
     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.
 function ____exports.setTearDisplay(self, textCallback)
     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.
 function ____exports.setFamiliarDisplay(self, textCallback)
     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.
 function ____exports.setBombDisplay(self, textCallback)
     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.
 function ____exports.setPickupDisplay(self, textCallback)
     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.
 function ____exports.setSlotDisplay(self, textCallback)
     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.
 function ____exports.setLaserDisplay(self, textCallback)
     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.
 function ____exports.setKnifeDisplay(self, textCallback)
     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.
 function ____exports.setProjectileDisplay(self, textCallback)
     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.
 function ____exports.setEffectDisplay(self, textCallback)
     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.
 function ____exports.setNPCDisplay(self, textCallback)
     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.
 function ____exports.setRockDisplay(self, textCallback)
     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.
 function ____exports.setPitDisplay(self, textCallback)
     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.
 function ____exports.setSpikesDisplay(self, textCallback)
     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.
 function ____exports.setTNTDisplay(self, textCallback)
     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.
 function ____exports.setPoopDisplay(self, textCallback)
     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.
 function ____exports.setDoorDisplay(self, textCallback)
     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.
 function ____exports.setPressurePlateDisplay(self, textCallback)
     debugDisplayTextCallbacks.pressurePlate = textCallback
 end
+--- Toggles the debug display for players. This is the function that runs when you use the
+-- "playerDisplay" custom console command.
 function ____exports.togglePlayerDisplay(self)
     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.
 function ____exports.toggleTearDisplay(self)
     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.
 function ____exports.toggleFamiliarDisplay(self)
     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.
 function ____exports.toggleBombDisplay(self)
     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.
 function ____exports.togglePickupDisplay(self)
     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.
 function ____exports.toggleSlotDisplay(self)
     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.
 function ____exports.toggleLaserDisplay(self)
     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.
 function ____exports.toggleKnifeDisplay(self)
     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.
 function ____exports.toggleProjectileDisplay(self)
     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.
 function ____exports.toggleEffectDisplay(self)
     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.
 function ____exports.toggleNPCDisplay(self)
     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.
 function ____exports.toggleRockDisplay(self)
     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.
 function ____exports.togglePitDisplay(self)
     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.
 function ____exports.toggleSpikesDisplay(self)
     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.
 function ____exports.toggleTNTDisplay(self)
     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.
 function ____exports.togglePoopDisplay(self)
     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.
 function ____exports.toggleDoorDisplay(self)
     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.
 function ____exports.togglePressurePlateDisplay(self)
     v.run.pressurePlate = not v.run.pressurePlate
     printEnabled(nil, v.run.pressurePlate, "pressure plate display")

package/features/debugDisplay/v.d.ts

@@ -1,4 +1,21 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 declare const v: {
     run: {
         player: boolean;

package/features/deployJSONRoom.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { JSONRoom } from "../interfaces/JSONRoom";
 /**
  * Helper function to deconstruct a vanilla room and set up a custom room in its place.

package/features/deployJSONRoom.lua

@@ -94,6 +94,14 @@ function respawnPersistentEntities(self)
         )
     end
 end
+--- Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
+-- this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
+-- (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
+-- effects (1000), doors, and walls.
+-- 
+-- @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
+-- decoration, which prevents vanilla entities in the room from
+-- respawning the next time that the player enters. Default is false.
 function ____exports.emptyRoom(self, fillWithDecorations)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     local roomListIndex = getRoomListIndex(nil)
@@ -415,10 +423,33 @@ v = {level = {
         function() return {} end
     )
 }}
+---
+-- @internal
 function ____exports.deployJSONRoomInit(self, mod)
     saveDataManager(nil, "deployJSONRoom", v)
     mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
 end
+--- Helper function to deconstruct a vanilla room and set up a custom room in its place.
+-- Specifically, this will clear the current room of all entities and grid entities, and then spawn
+-- all of the entries and grid entities in the provided JSON room.
+-- 
+-- This function is meant to be used in the PostNewRoom callback.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- 
+-- import customRooms from "./customRooms";
+-- 
+-- const firstJSONRoom = customRooms.rooms.room[0];
+-- deployJSONRoom(firstJSONRoom);
+-- ```
+-- 
+-- @param jsonRoom The JSON room to deploy. *
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+-- what the function is doing. Default is false.
 function ____exports.deployJSONRoom(self, jsonRoom, seedOrRNG, verbose)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
@@ -445,6 +476,31 @@ function ____exports.deployJSONRoom(self, jsonRoom, seedOrRNG, verbose)
     fixPitGraphics(nil)
     fillRoomWithDecorations(nil)
 end
+--- Helper function to deconstruct a vanilla room and set up a custom room in its place.
+-- Specifically, this will clear the current room of all entities and grid entities, and then spawn
+-- all of the entries and grid entities in one of the provided JSON rooms.
+-- 
+-- This function is meant to be used in the PostNewRoom callback.
+-- 
+-- Note that this function does not simply choose a random element in the provided array; it will
+-- properly account for each room weight using the algorithm from:
+-- https://stackoverflow.com/questions/1761626/weighted-random-numbers
+-- 
+-- For example:
+-- 
+-- ```ts
+-- import customRooms from "./customRooms";
+-- 
+-- const jsonRooms = customRooms.rooms.room;
+-- deployRandomJSONRoom(jsonRooms);
+-- ```
+-- 
+-- @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be
+-- something like.
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+-- what the function is doing. Default is false.
 function ____exports.deployRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)

package/features/disableInputs.lua

@@ -49,17 +49,31 @@ v = {run = {
     disableInputsWithWhitelistMap = __TS__New(Map),
     enableInputsWithBlacklistMap = __TS__New(Map)
 }}
+---
+-- @internal
 function ____exports.disableInputsInit(self, mod)
     saveDataManager(nil, "disableInputs", v)
     mod:AddCallback(ModCallback.INPUT_ACTION, isActionPressed, InputHook.IS_ACTION_PRESSED)
     mod:AddCallback(ModCallback.INPUT_ACTION, isActionTriggered, InputHook.IS_ACTION_TRIGGERED)
     mod:AddCallback(ModCallback.INPUT_ACTION, getActionValue, InputHook.GET_ACTION_VALUE)
 end
+--- Helper function to enable all inputs. Use this function to set things back to normal after having
+-- used one of the other helper functions to disable inputs.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
 function ____exports.enableAllInputs(self, key)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     v.run.disableInputsWithWhitelistMap:delete(key)
     v.run.enableInputsWithBlacklistMap:delete(key)
 end
+--- Helper function to disable all inputs. This is useful because `EntityPlayer.ControlsEnabled` can
+-- be changed by the game under certain conditions.
+-- 
+-- Use the `enableAllInputs` helper function to set things back to normal.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
 function ____exports.disableAllInputs(self, key)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     v.run.disableInputsWithWhitelistMap:set(
@@ -68,20 +82,51 @@ function ____exports.disableAllInputs(self, key)
     )
     v.run.enableInputsWithBlacklistMap:delete(key)
 end
+--- Helper function to enable all inputs besides the ones provided. This is useful because
+-- `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
+-- 
+-- Use the `enableAllInputs` helper function to set things back to normal.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
+-- @param blacklist A set of ButtonActions to disallow.
 function ____exports.enableAllInputsExceptFor(self, key, blacklist)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     v.run.disableInputsWithWhitelistMap:delete(key)
     v.run.enableInputsWithBlacklistMap:set(key, blacklist)
 end
+--- Helper function to disable all inputs besides the ones provided. This is useful because
+-- `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
+-- 
+-- Use the `enableAllInputs` helper function to set things back to normal.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
+-- @param whitelist A set of ButtonActions to allow.
 function ____exports.disableAllInputsExceptFor(self, key, whitelist)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     v.run.disableInputsWithWhitelistMap:set(key, whitelist)
     v.run.enableInputsWithBlacklistMap:delete(key)
 end
+--- Helper function to disable only the inputs used for moving the character (or moving the cursor in
+-- the UI). This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under
+-- certain conditions.
+-- 
+-- Use the `enableAllInputs` helper function to set things back to normal.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
 function ____exports.disableMovementInputs(self, key)
     local moveActions = getMoveActions(nil)
     ____exports.enableAllInputsExceptFor(nil, key, moveActions)
 end
+--- Helper function to disable only the inputs used for shooting tears. This is useful because
+-- `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
+-- 
+-- Use the `enableAllInputs` helper function to set things back to normal.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
 function ____exports.disableShootingInputs(self, key)
     local shootActions = getShootActions(nil)
     ____exports.enableAllInputsExceptFor(nil, key, shootActions)

package/features/disableSound.lua

@@ -22,10 +22,18 @@ end
 local FEATURE_NAME = "sound disabler"
 local musicWasEnabled = false
 v = {run = {disableSoundSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.disableSoundsInit(self, mod)
     saveDataManager(nil, "disableSounds", v)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end
+--- Helper function to stop muting all sound effects and music.
+-- 
+-- Use this function to set things back to normal after having used `disableAllSounds`.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
 function ____exports.enableAllSound(self, key)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     if not v.run.disableSoundSet:has(key) then
@@ -37,6 +45,12 @@ function ____exports.enableAllSound(self, key)
     end
     stopAllSoundEffects(nil)
 end
+--- Helper function to disable all sound effects and music (by constantly musting them).
+-- 
+-- Use the `enableAllSounds` helper function to set things back to normal.
+-- 
+-- @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+-- that multiple mod features can work in tandem.
 function ____exports.disableAllSound(self, key)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     if v.run.disableSoundSet.size == 0 then

package/features/extraConsoleCommands/commandsDisplay.lua

@@ -18,111 +18,201 @@ local toggleSlotDisplay = ____exports.toggleSlotDisplay
 local toggleSpikesDisplay = ____exports.toggleSpikesDisplay
 local toggleTearDisplay = ____exports.toggleTearDisplay
 local toggleTNTDisplay = ____exports.toggleTNTDisplay
+--- Toggles custom text to appear next to every spikes. Useful for debugging.
+-- 
+-- By default, the grid entity ID will be displayed. Use the `setSpikesDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.spikesDisplay(self)
     toggleSpikesDisplay(nil)
 end
+--- Toggles custom text to appear next to every bomb. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setBombDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.bombDisplay(self)
     toggleBombDisplay(nil)
 end
+--- Alias for the "bombDisplay" command.
 function ____exports.bombsDisplay(self)
     ____exports.bombDisplay(nil)
 end
+--- Toggles custom text to appear next to every door. Useful for debugging.
+-- 
+-- By default, the grid entity ID will be displayed. Use the `setDoorDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.doorDisplay(self)
     toggleDoorDisplay(nil)
 end
+--- Alias for the "doorDisplay" command.
 function ____exports.doorsDisplay(self)
     ____exports.doorDisplay(nil)
 end
+--- Toggles custom text to appear next to every effect. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setEffectDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.effectDisplay(self)
     toggleEffectDisplay(nil)
 end
+--- Alias for the "effectDisplay" command.
 function ____exports.effectsDisplay(self)
     ____exports.effectDisplay(nil)
 end
+--- Toggles custom text to appear next to every familiar. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setFamiliarDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.familiarDisplay(self)
     toggleFamiliarDisplay(nil)
 end
+--- Alias for the "familiarDisplay" command.
 function ____exports.familiarsDisplay(self)
     ____exports.familiarDisplay(nil)
 end
+--- Toggles custom text to appear next to every knife. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setKnifeDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.knifeDisplay(self)
     toggleKnifeDisplay(nil)
 end
+--- Alias for the "knifeDisplay" command.
 function ____exports.knivesDisplay(self)
     ____exports.knifeDisplay(nil)
 end
+--- Toggles custom text to appear next to every laser. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setLaserDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.laserDisplay(self)
     toggleLaserDisplay(nil)
 end
+--- Alias for the "laserDisplay" command.
 function ____exports.lasersDisplay(self)
     ____exports.laserDisplay(nil)
 end
+--- Toggles custom text to appear next to every NPC. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setNPCDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.npcDisplay(self)
     toggleNPCDisplay(nil)
 end
+--- Alias for the "npcDisplay" command.
 function ____exports.npcsDisplay(self)
     ____exports.npcDisplay(nil)
 end
+--- Toggles custom text to appear next to every pickup. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setPickupDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.pickupDisplay(self)
     togglePickupDisplay(nil)
 end
+--- Alias for the "pickupDisplay" command.
 function ____exports.pickupsDisplay(self)
     ____exports.pickupDisplay(nil)
 end
+--- Toggles custom text to appear next to every pit. Useful for debugging.
+-- 
+-- By default, the grid entity ID will be displayed. Use the `setPitDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.pitDisplay(self)
     togglePitDisplay(nil)
 end
+--- Alias for the "pitDisplay" command.
 function ____exports.pitsDisplay(self)
     ____exports.pitDisplay(nil)
 end
+--- Toggles custom text to appear next to every player. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setPlayerDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.playerDisplay(self)
     togglePlayerDisplay(nil)
 end
+--- Alias for the "playerDisplay" command.
 function ____exports.playersDisplay(self)
     ____exports.playerDisplay(nil)
 end
+--- Toggles custom text to appear next to every poop. Useful for debugging.
+-- 
+-- By default, the grid entity ID will be displayed. Use the `setPoopDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.poopDisplay(self)
     togglePoopDisplay(nil)
 end
+--- Alias for the "poopDisplay" command.
 function ____exports.poopsDisplay(self)
     ____exports.poopDisplay(nil)
 end
+--- Toggles custom text to appear next to every pressure plate. Useful for debugging.
+-- 
+-- By default, the grid entity ID will be displayed. Use the `setPressurePlateDisplay` helper
+-- function to assign the text that you want to appear.
 function ____exports.pressurePlateDisplay(self)
     togglePressurePlateDisplay(nil)
 end
+--- Alias for the "pressurePlateDisplay" command.
 function ____exports.pressurePlatesDisplay(self)
     ____exports.pressurePlateDisplay(nil)
 end
+--- Toggles custom text to appear next to every projectile. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setProjectileDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.projectileDisplay(self)
     toggleProjectileDisplay(nil)
 end
+--- Alias for the "projectileDisplay" command.
 function ____exports.projectilesDisplay(self)
     ____exports.projectileDisplay(nil)
 end
+--- Toggles custom text to appear next to every rock. Useful for debugging.
+-- 
+-- By default, the grid entity ID will be displayed. Use the `setRockDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.rockDisplay(self)
     toggleRockDisplay(nil)
 end
+--- Alias for the "rockDisplay" command.
 function ____exports.rocksDisplay(self)
     ____exports.rockDisplay(nil)
 end
+--- Toggles custom text to appear next to every slot. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setSlotDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.slotDisplay(self)
     toggleSlotDisplay(nil)
 end
+--- Alias for the "slotDisplay" command.
 function ____exports.slotsDisplay(self)
     ____exports.slotDisplay(nil)
 end
+--- Alias for the "spikesDisplay" command.
 function ____exports.spikeDisplay(self)
     ____exports.spikesDisplay(nil)
 end
+--- Toggles custom text to appear next to every tear. Useful for debugging.
+-- 
+-- By default, the entity ID will be displayed. Use the `setTearDisplay` helper function to assign
+-- the text that you want to appear.
 function ____exports.tearDisplay(self)
     toggleTearDisplay(nil)
 end
+--- Alias for the "tearDisplay" command.
 function ____exports.tearsDisplay(self)
     ____exports.tearDisplay(nil)
 end
+--- Toggles custom text to appear next to every TNT. Useful for debugging.
+-- 
+-- By default, the grid entity ID will be displayed. Use the `setTNTDisplay` helper function to
+-- assign the text that you want to appear.
 function ____exports.tntDisplay(self)
     toggleTNTDisplay(nil)
 end
+--- Alias for the "tntDisplay" command.
 function ____exports.tntsDisplay(self)
     ____exports.tntDisplay(nil)
 end