isaacscript-common 2.3.2 → 3.0.0

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

package/features/extraConsoleCommands/init.lua

@@ -73,6 +73,9 @@ function postFireTear(self, tear)
 end
 commandFunctionsMap = __TS__New(Map)
 initialized = false
+--- Enables extra console commands which are useful for debugging. See [the
+-- docs](https://isaacscript.github.io/isaacscript-common/features/extraConsoleCommands_listCommands)
+-- for the specific commands that are added.
 function ____exports.enableExtraConsoleCommands(self, mod)
     initialized = true
     saveDataManager(nil, "extraConsoleCommands", v, featureEnabled)
@@ -85,6 +88,13 @@ function ____exports.enableExtraConsoleCommands(self, mod)
     mod:AddCallback(ModCallback.EXECUTE_CMD, executeCmd)
     mod:AddCallback(ModCallback.POST_FIRE_TEAR, postFireTear)
 end
+--- Helper function to add a custom console command.
+-- 
+-- The standard library comes with many existing console commands that are useful for debugging, but
+-- you can also add your own commands that are useful for your particular mod. It's easier to add
+-- commands to the existing command system than to add logic manually to the ExecuteCmd callback.
+-- 
+-- Before using this function, you must first invoke `enableExtraConsoleCommands`.
 function ____exports.addConsoleCommand(self, commandName, commandFunction)
     if not initialized then
         error("Before adding extra console commands, you must first enable the feature by invoking the \"enableExtraConsoleCommands\" function.")
@@ -94,6 +104,12 @@ function ____exports.addConsoleCommand(self, commandName, commandFunction)
     end
     commandFunctionsMap:set(commandName, commandFunction)
 end
+--- Helper function to remove a custom console command.
+-- 
+-- The standard library comes with many existing console commands that are useful for debugging. If
+-- you want to disable one of them, use this function.
+-- 
+-- Before using this function, you must first invoke `enableExtraConsoleCommands`.
 function ____exports.removeConsoleCommand(self, commandName)
     if not initialized then
         error("Before removing console commands, you must first enable the feature by invoking the \"enableExtraConsoleCommands\" function.")