isaacscript-common 2.3.2 → 3.1.1

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.")

package/features/extraConsoleCommands/listCommands.lua

@@ -97,45 +97,66 @@ local spawnTrapdoorOrCrawlspace = ____commandsSubroutines.spawnTrapdoorOrCrawlsp
 local warpToRoomType = ____commandsSubroutines.warpToRoomType
 local ____v = require("features.extraConsoleCommands.v")
 local v = ____v.default
+--- Gives a half black heart. Provide a number to give a custom amount of hearts. (You can use
+-- negative numbers to remove hearts.)
 function ____exports.blackHearts(self, params)
     addHeart(nil, params, HealthType.BLACK)
 end
+--- Toggles Chaos Card tears. Useful for killing enemies very fast without using "debug 10".
 function ____exports.chaosCardTears(self)
     v.run.chaosCardTears = not v.run.chaosCardTears
     printEnabled(nil, v.run.chaosCardTears, "Chaos Card tears")
 end
+--- Warps to the Devil Room for the floor. If the Angel Room has already been visited or initialized,
+-- this will uninitialize it and make an Devil Room instead.
 function ____exports.devil(self)
     devilAngel(nil, true)
 end
+--- Gives an eternal heart. Provide a number to give a custom amount of hearts. (You can use negative
+-- numbers to remove hearts.)
 function ____exports.eternalHearts(self, params)
     addHeart(nil, params, HealthType.ETERNAL)
 end
+--- Gives the player a golden bomb.
 function ____exports.goldenBomb(self)
     local player = Isaac.GetPlayer()
     player:AddGoldenBomb()
 end
+--- Gives a golden heart. Provide a number to give a custom amount of hearts. (You can use negative
+-- numbers to remove hearts.)
 function ____exports.goldenHearts(self, params)
     addHeart(nil, params, HealthType.GOLDEN)
 end
+--- Gives the player a golden key.
 function ____exports.goldenKey(self)
     local player = Isaac.GetPlayer()
     player:AddGoldenKey()
 end
+--- Gives a half red heart. Provide a number to give a custom amount of hearts. (You can use negative
+-- numbers to remove hearts.)
 function ____exports.hearts(self, params)
     addHeart(nil, params, HealthType.RED)
 end
+--- Warps to the I AM ERROR room for the floor.
 function ____exports.iAmError(self)
     changeRoom(nil, GridRoom.ERROR)
 end
+--- Sets every NPC in the room to 1 HP.
 function ____exports.oneHP(self)
     for ____, npc in ipairs(getNPCs(nil)) do
         npc.HitPoints = 1
     end
     printConsole(nil, "Set every NPC to 1 HP.")
 end
+--- Gives a half soul heart. Provide a number to give a custom amount of hearts. (You can use
+-- negative numbers to remove hearts.)
 function ____exports.soulHearts(self, params)
     addHeart(nil, params, HealthType.SOUL)
 end
+--- Play the supplied sound effect.
+-- 
+-- For example:
+-- - sound 1 - Plays the 1-Up sound effect.
 function ____exports.sound(self, params)
     local soundEffect = tonumber(params)
     if soundEffect == nil then
@@ -144,11 +165,15 @@ function ____exports.sound(self, params)
     end
     sfxManager:Play(soundEffect)
 end
+--- Warps to the starting room of the floor.
 function ____exports.startingRoom(self)
     local level = game:GetLevel()
     local startingRoomIndex = level:GetStartingRoomIndex()
     changeRoom(nil, startingRoomIndex)
 end
+--- Adds a single charge to the player's specified active item. You must provide the active slot
+-- number. Provide a second number to give a custom amount of charges. (You can use negative numbers
+-- to remove charge.)
 function ____exports.addCharges(self, params)
     if params == "" then
         printConsole(nil, "You must specify a slot number. (Use 0 for the primary slot, 1 for the Schoolbag slot, 2 for the pocket item slot, and 3 for the Dice Bag slot.)")
@@ -189,14 +214,18 @@ function ____exports.addCharges(self, params)
     local newCharge = currentCharge + chargeNum
     player:SetActiveCharge(newCharge, activeSlot)
 end
+--- Warps to the Angel Room for the floor. If the Devil Room has already been visited or initialized,
+-- this will uninitialize it and make an Angel Room instead.
 function ____exports.angel(self)
     devilAngel(nil, false)
 end
+--- Activates the flags for the Ascent (i.e. Backwards Path).
 function ____exports.ascent(self)
     game:SetStateFlag(GameStateFlag.BACKWARDS_PATH_INIT, true)
     game:SetStateFlag(GameStateFlag.BACKWARDS_PATH, true)
     printConsole(nil, "Set Ascent flags.")
 end
+--- Warps to the first Clean Bedroom or Dirty Bedroom on the floor.
 function ____exports.bedroom(self)
     local cleanBedroomGridIndexes = getRoomGridIndexesForType(nil, RoomType.CLEAN_BEDROOM)
     if #cleanBedroomGridIndexes > 0 then
@@ -210,12 +239,16 @@ function ____exports.bedroom(self)
     end
     printConsole(nil, "There are no Clean Bedrooms or Dirty Bedrooms on this floor.")
 end
+--- Alias for the "blackhearts" command.
 function ____exports.bh(self, params)
     ____exports.blackHearts(nil, params)
 end
+--- Warps to the Black Market for the floor.
 function ____exports.blackMarket(self)
     changeRoom(nil, GridRoom.BLACK_MARKET)
 end
+--- Gives a blood charge. This only affects Bethany. Provide a number to give a custom amount of
+-- charges. (You can use negative numbers to remove charges.)
 function ____exports.bloodCharges(self, params)
     local charges = 1
     if params ~= "" then
@@ -229,9 +262,12 @@ function ____exports.bloodCharges(self, params)
     local player = Isaac.GetPlayer()
     player:AddBloodCharge(charges)
 end
+--- Alias for the "blackMarket" command.
 function ____exports.bm(self)
     ____exports.blackMarket(nil)
 end
+--- Gives a bomb. Provide a number to give a custom amount of bombs. (You can use negative numbers to
+-- remove bombs.)
 function ____exports.bomb(self, params)
     local numBombs = 1
     if params ~= "" then
@@ -245,6 +281,8 @@ function ____exports.bomb(self, params)
     local player = Isaac.GetPlayer()
     player:AddBombs(numBombs)
 end
+--- Gives 99 bombs. Provide a number to give a custom amount of bombs. (You can use negative numbers
+-- to remove bombs.)
 function ____exports.bombs(self, params)
     local numBombs = 99
     if params ~= "" then
@@ -258,18 +296,29 @@ function ____exports.bombs(self, params)
     local player = Isaac.GetPlayer()
     player:AddBombs(numBombs)
 end
+--- Gives a bone heart. Provide a number to give a custom amount of hearts. (You can use negative
+-- numbers to remove hearts.)
 function ____exports.boneHearts(self, params)
     addHeart(nil, params, HealthType.BONE)
 end
+--- Warps to the first Boss Room on the floor.
 function ____exports.boss(self)
     warpToRoomType(nil, RoomType.BOSS)
 end
+--- Warps to the Boss Rush for the floor.
 function ____exports.bossRush(self)
     changeRoom(nil, GridRoom.BOSS_RUSH)
 end
+--- Gives a broken heart. Provide a number to give a custom amount of hearts. (You can use negative
+-- numbers to remove hearts.)
 function ____exports.brokenHearts(self, params)
     addHeart(nil, params, HealthType.BROKEN)
 end
+--- Gives the specified card. Accepts either the card sub-type or the partial name of the card.
+-- 
+-- For example:
+-- - card 5 - Gives The Emperor.
+-- - card spa - Gives 2 of Spades.
 function ____exports.card(self, params)
     if params == "" then
         printConsole(nil, "You must specify a card name or number.")
@@ -301,6 +350,7 @@ function ____exports.card(self, params)
         ((("Gave card: " .. cardName) .. " (") .. tostring(cardNum)) .. ")"
     )
 end
+--- Spawns every card on the ground, starting at the top-left-most tile.
 function ____exports.cards(self)
     local cardType = 1
     do
@@ -322,9 +372,16 @@ function ____exports.cards(self)
         end
     end
 end
+--- Alias for the "chaosCardTears" command.
 function ____exports.cc(self)
     ____exports.chaosCardTears(nil)
 end
+--- Restart as the specified character. Accepts either the character sub-type or the partial name of
+-- the character.
+-- 
+-- For example:
+-- - character 2 - Restarts as Cain.
+-- - character ta - Restarts as Tainted Azazel.
 function ____exports.characterCommand(self, params)
     if params == "" then
         printConsole(nil, "You must specify a character name or number.")
@@ -356,12 +413,16 @@ function ____exports.characterCommand(self, params)
         ((("Restarting as character: " .. characterName) .. " (") .. tostring(character)) .. ")"
     )
 end
+--- Alias for the "addCharges" command.
 function ____exports.charge(self, params)
     ____exports.addCharges(nil, params)
 end
+--- Warps to the first Clean Bedroom on the floor.
 function ____exports.cleanBedroom(self)
     warpToRoomType(nil, RoomType.CLEAN_BEDROOM)
 end
+--- Gives a coin. Provide a number to give a custom amount of coins. (You can use negative numbers to
+-- remove coins.)
 function ____exports.coin(self, params)
     local numCoins = 1
     if params ~= "" then
@@ -375,6 +436,8 @@ function ____exports.coin(self, params)
     local player = Isaac.GetPlayer()
     player:AddCoins(numCoins)
 end
+--- Gives 999 coins. Provide a number to give a custom amount of coins. (You can use negative numbers
+-- to remove coins.)
 function ____exports.coins(self, params)
     local numCoins = 999
     if params ~= "" then
@@ -388,51 +451,65 @@ function ____exports.coins(self, params)
     local player = Isaac.GetPlayer()
     player:AddCoins(numCoins)
 end
+--- Creates a crawlspace next to the player.
 function ____exports.crawlspace(self)
     spawnTrapdoorOrCrawlspace(nil, false)
 end
+--- Uses the D20.
 function ____exports.d20(self)
     local player = Isaac.GetPlayer()
     useActiveItemTemp(nil, player, CollectibleType.D20)
 end
+--- Uses the D6.
 function ____exports.d6(self)
     local player = Isaac.GetPlayer()
     useActiveItemTemp(nil, player, CollectibleType.D6)
 end
+--- Toggles extremely high-damage tears.
 function ____exports.damage(self)
     v.run.maxDamage = not v.run.maxDamage
     printEnabled(nil, v.run.maxDamage, "debug damage")
 end
+--- Alias for the "devil" command.
 function ____exports.dd(self)
     ____exports.devil(nil)
 end
+--- Warps to the first Dirty Bedroom on the floor.
 function ____exports.dirtyBedroom(self)
     warpToRoomType(nil, RoomType.DIRTY_BEDROOM)
 end
+--- Toggles whether or not curses can appear.
 function ____exports.disableCurses(self)
     v.persistent.disableCurses = not v.persistent.disableCurses
     printEnabled(nil, not v.persistent.disableCurses, "curses")
 end
+--- Moves the player 0.5 units down. Provide a number to move a custom amount of units.
 function ____exports.down(self, params)
     movePlayer(nil, params, Direction.DOWN)
 end
+--- Warps to the Dungeon (i.e. Crawlspace) for the floor.
 function ____exports.dungeon(self)
     changeRoom(nil, GridRoom.DUNGEON)
 end
+--- Logs the player's current temporary effects to the "log.txt" file.
 function ____exports.effects(self)
     local player = Isaac.GetPlayer()
     logEffects(player)
     printConsole(nil, "Logged the player's effects to the \"log.txt\" file.")
 end
+--- Alias for the "eternalHearts" command.
 function ____exports.eh(self, params)
     ____exports.eternalHearts(nil, params)
 end
+--- Alias for the "iAmError" command.
 function ____exports.error(self)
     ____exports.iAmError(nil)
 end
+--- Alias for the "startingRoom" command.
 function ____exports.fool(self)
     ____exports.startingRoom(nil)
 end
+--- Prints the current position of all players.
 function ____exports.getPosition(self)
     for ____, player in ipairs(getPlayers(nil)) do
         local playerName = getPlayerName(nil, player)
@@ -442,6 +519,8 @@ function ____exports.getPosition(self)
         )
     end
 end
+--- Gives a Giga Bomb. Provide a number to give a custom amount of Giga Bombs. (You can use negative
+-- numbers to remove bombs.)
 function ____exports.gigaBomb(self, params)
     local numBombs = 1
     if params ~= "" then
@@ -455,21 +534,27 @@ function ____exports.gigaBomb(self, params)
     local player = Isaac.GetPlayer()
     player:AddGigaBombs(numBombs)
 end
+--- Alias for the "goldenBomb" command.
 function ____exports.goldBomb(self)
     ____exports.goldenBomb(nil)
 end
+--- Alias for the "goldenHearts" command.
 function ____exports.goldHearts(self, params)
     ____exports.goldenHearts(nil, params)
 end
+--- Alias for the "goldenKey" command.
 function ____exports.goldKey(self)
     ____exports.goldenKey(nil)
 end
+--- Alias for the "debug 2" command.
 function ____exports.grid(self)
     Isaac.ExecuteCommand("debug 2")
 end
+--- Alias for the "debug 11" command.
 function ____exports.grid2(self)
     Isaac.ExecuteCommand("debug 11")
 end
+--- Spawns every grid entity, starting at the top-left-most tile.
 function ____exports.gridEntities(self)
     local gridEntityTypes = getEnumValues(nil, GridEntityType)
     local gridEntityTypeIndex = -1
@@ -493,12 +578,16 @@ function ____exports.gridEntities(self)
         end
     end
 end
+--- Alias for the "hearts" command.
 function ____exports.h(self, params)
     ____exports.hearts(nil, params)
 end
+--- Alias for the "debug 6" command.
 function ____exports.hitboxes(self)
     Isaac.ExecuteCommand("debug 6")
 end
+--- Gives a key. Provide a number to give a custom amount of key. (You can use negative numbers to
+-- remove keys.)
 function ____exports.key(self, params)
     local numKeys = 1
     if params ~= "" then
@@ -512,6 +601,8 @@ function ____exports.key(self, params)
     local player = Isaac.GetPlayer()
     player:AddKeys(numKeys)
 end
+--- Gives 99 keys. Provide a number to give a custom amount of coins. (You can use negative numbers
+-- to remove keys.)
 function ____exports.keys(self, params)
     local numKeys = 99
     if params ~= "" then
@@ -525,30 +616,49 @@ function ____exports.keys(self, params)
     local player = Isaac.GetPlayer()
     player:AddKeys(numKeys)
 end
+--- Moves the player 0.5 units left. Provide a number to move a custom amount of units.
 function ____exports.left(self, params)
     movePlayer(nil, params, Direction.LEFT)
 end
+--- Warps to the first Library on the floor.
 function ____exports.library(self)
     warpToRoomType(nil, RoomType.LIBRARY)
 end
+--- Logs the entities in the room to the "log.txt" file. Provide a number to only log that specific
+-- `EntityType`.
+-- 
+-- By default, this command will exclude background effects. If that is not desired, use the
+-- "listAll" command instead.
 function ____exports.list(self, params)
     listEntities(nil, params, false)
 end
+--- Logs the entities in the room to the "log.txt" file. Provide a number to only log that specific
+-- `EntityType`.
 function ____exports.listAll(self, params)
     listEntities(nil, params, true)
 end
+--- Logs the grid entities in the room to the "log.txt" file. Provide a number to only log that
+-- specific `GridEntityType`.
+-- 
+-- By default, this command will exclude walls. If that is not desired, use the "listGridAll"
+-- command instead.
 function ____exports.listGrid(self, params)
     listGridEntities(nil, params, false)
 end
+--- Logs the grid entities in the room to the "log.txt" file. Provide a number to only log that
+-- specific `GridEntityType`.
 function ____exports.listGridAll(self, params)
     listGridEntities(nil, params, true)
 end
+--- Alias for the "1hp" command.
 function ____exports.lowHP(self)
     ____exports.oneHP(nil)
 end
+--- Alias for "debug 9".
 function ____exports.luck(self)
     Isaac.ExecuteCommand("debug 9")
 end
+--- Completely reveals the entire map, including the Ultra Secret Room.
 function ____exports.map(self)
     local level = game:GetLevel()
     local displayFlags = addFlag(nil, DisplayFlag.VISIBLE, DisplayFlag.SHADOW, DisplayFlag.SHOW_ICON)
@@ -558,18 +668,30 @@ function ____exports.map(self)
     end
     level:UpdateVisibility()
 end
+--- Gives a heart container. Provide a number to give a custom amount of heart containers. (You can
+-- use negative numbers to remove heart containers.)
 function ____exports.maxHearts(self, params)
     addHeart(nil, params, HealthType.MAX_HEARTS)
 end
+--- Alias for the "maxHearts" command.
 function ____exports.mh(self, params)
     ____exports.maxHearts(nil, params)
 end
+--- Warps to the first Miniboss Room on the floor.
 function ____exports.miniboss(self)
     warpToRoomType(nil, RoomType.MINI_BOSS)
 end
+--- Alias for the "disableCurses" command.
 function ____exports.noCurses(self)
     ____exports.disableCurses(nil)
 end
+--- Gives a pill with the specified pill effect. Accepts either the effect ID or the partial name of
+-- the effect.
+-- 
+-- For example:
+-- 
+-- - `pill 5` - Gives a "Full Health" pill.
+-- - `pill suns` - Gives a "Feels like I'm walking on sunshine" pill.
 function ____exports.pill(self, params)
     if params == "" then
         printConsole(nil, "You must specify a pill name or number.")
@@ -601,6 +723,7 @@ function ____exports.pill(self, params)
         ((("Gave pill: " .. pillEffectName) .. " (") .. tostring(pillEffect)) .. ")"
     )
 end
+--- Spawns every pill on the ground, starting at the top-left-most tile.
 function ____exports.pills(self)
     local pillColors = __TS__ArrayFilter(
         getEnumValues(nil, PillColor),
@@ -627,12 +750,15 @@ function ____exports.pills(self)
         end
     end
 end
+--- Warps to the first Planetarium on the floor.
 function ____exports.planetarium(self)
     warpToRoomType(nil, RoomType.PLANETARIUM)
 end
+--- Alias for the "sound" command.
 function ____exports.playSound(self, params)
     ____exports.sound(nil, params)
 end
+--- Sets the player's pocket item to the specified collectible type.
 function ____exports.pocket(self, params)
     if params == "" then
         printConsole(nil, "You must supply a collectible type to put as the pocket item.")
@@ -650,6 +776,8 @@ function ____exports.pocket(self, params)
     local player = Isaac.GetPlayer()
     player:SetPocketActiveItem(collectibleType, ActiveSlot.POCKET)
 end
+--- Gives a poop mana charge. This only affects Tainted Blue Baby. Provide a number to give a custom
+-- amount of charges. (You can use negative numbers to remove charges.)
 function ____exports.poopMana(self, params)
     local charges = 1
     if params ~= "" then
@@ -663,24 +791,36 @@ function ____exports.poopMana(self, params)
     local player = Isaac.GetPlayer()
     player:AddPoopMana(charges)
 end
+--- Alias for the "getPosition" command.
 function ____exports.positionCommand(self)
     ____exports.getPosition(nil)
 end
+--- Alias for the "hearts" command.
 function ____exports.redHearts(self, params)
     ____exports.hearts(nil, params)
 end
+--- Alias for the "redHearts" command.
 function ____exports.rh(self, params)
     ____exports.redHearts(nil, params)
 end
+--- Moves the player 0.5 units right. Provide a number to move a custom amount of units.
 function ____exports.right(self, params)
     movePlayer(nil, params, Direction.RIGHT)
 end
+--- Logs information about the room to the "log.txt" file.
 function ____exports.roomCommand(self)
     logRoom()
 end
+--- Gives a rotten heart. Provide a number to give a custom amount of hearts. (You can use negative
+-- numbers to remove hearts.)
 function ____exports.rottenHearts(self, params)
     addHeart(nil, params, HealthType.ROTTEN)
 end
+--- Alias for the "stage" command.
+-- 
+-- For example:
+-- - s 3 - Warps to Caves 1.
+-- - s 1c - Warps to Downpour 1.
 function ____exports.s(self, params)
     if params == "" then
         printConsole(nil, "You must specify a stage number.")
@@ -713,21 +853,27 @@ function ____exports.s(self, params)
     end
     Isaac.ExecuteCommand(("stage " .. tostring(stage)) .. stageTypeLetter)
 end
+--- Warps to the first Sacrifice Room on the floor.
 function ____exports.sacrifice(self)
     warpToRoomType(nil, RoomType.SACRIFICE)
 end
+--- Warps to the first Secret Room on the floor.
 function ____exports.secret(self)
     warpToRoomType(nil, RoomType.SECRET)
 end
+--- Changes to a seeded run, using the seed of the current run.
 function ____exports.seedStick(self)
     local seeds = game:GetSeeds()
     local startSeedString = seeds:GetStartSeedString()
     Isaac.ExecuteCommand("seed " .. startSeedString)
 end
+--- Logs all of the current run's seed effects to the "log.txt" file.
 function ____exports.seedsCommand(self)
     logSeedEffects()
     printConsole(nil, "Logged the seed effects to the \"log.txt\" file.")
 end
+--- Sets a charge to the player's specified active item. You must provide the active slot number and
+-- the number of charges to set.
 function ____exports.setCharges(self, params)
     if params == "" then
         printConsole(nil, "You must specify a slot number and a charge amount. (Use 0 for the primary slot, 1 for the Schoolbag slot, 2 for the pocket item slot, and 3 for the Dice Bag slot.)")
@@ -777,6 +923,10 @@ function ____exports.setCharges(self, params)
     local player = Isaac.GetPlayer()
     player:SetActiveCharge(chargeNum, activeSlot)
 end
+--- Moves the first player to the specified position.
+-- 
+-- For example:
+-- - setPosition 100 50
 function ____exports.setPosition(self, params)
     if params == "" then
         printConsole(nil, "You must specify a position. (e.g. \"setPosition 100 50\")")
@@ -808,16 +958,21 @@ function ____exports.setPosition(self, params)
     local position = Vector(x, y)
     player.Position = position
 end
+--- Alias for the "soulHearts" command.
 function ____exports.sh(self, params)
     ____exports.soulHearts(nil, params)
 end
+--- Warps to the first shop on the floor.
 function ____exports.shop(self)
     warpToRoomType(nil, RoomType.SHOP)
 end
+--- Uses the Smelter to smelt the current player's trinket.
 function ____exports.smelt(self)
     local player = Isaac.GetPlayer()
     useActiveItemTemp(nil, player, CollectibleType.SMELTER)
 end
+--- Gives a soul charge. This only affects Tainted Bethany. Provide a number to give a custom amount
+-- of charges. (You can use negative numbers to remove charges.)
 function ____exports.soulCharges(self, params)
     local charges = 1
     if params ~= "" then
@@ -831,14 +986,18 @@ function ____exports.soulCharges(self, params)
     local player = Isaac.GetPlayer()
     player:AddSoulCharge(charges)
 end
+--- Logs all of the currently playing sound effects to the "log.txt" file.
 function ____exports.sounds(self)
     logSounds()
     printConsole(nil, "Logged the currently playing sound effects to the \"log.txt\" file.")
 end
+--- Toggles spamming Blood Rights on every frame. Useful for killing enemies very fast without using
+-- "debug 10".
 function ____exports.spam(self)
     v.run.spamBloodRights = not v.run.spamBloodRights
     printEnabled(nil, v.run.maxSpeed, "spamming Blood Rights")
 end
+--- Spawns a golden version of the specified trinket type.
 function ____exports.spawnGoldenTrinket(self, params)
     if params == "" then
         printConsole(nil, "You must specify the number corresponding to the trinket type.")
@@ -854,6 +1013,7 @@ function ____exports.spawnGoldenTrinket(self, params)
     local centerPos = room:GetCenterPos()
     spawnTrinket(nil, goldenTrinketType, centerPos)
 end
+--- Toggles maximum movement speed and flight.
 function ____exports.speed(self)
     local player = Isaac.GetPlayer()
     v.run.maxSpeed = not v.run.maxSpeed
@@ -871,9 +1031,11 @@ function ____exports.speed(self)
     player:EvaluateItems()
     printEnabled(nil, v.run.maxSpeed, "max speed")
 end
+--- Warps to the first Super Secret Room on the floor.
 function ____exports.superSecret(self)
     warpToRoomType(nil, RoomType.SUPER_SECRET)
 end
+--- Toggles extremely high tears stat (e.g. fire rate), equivalent of that to soy milk.
 function ____exports.tears(self)
     v.run.maxTears = not v.run.maxTears
     local player = Isaac.GetPlayer()
@@ -881,18 +1043,28 @@ function ____exports.tears(self)
     player:EvaluateItems()
     printEnabled(nil, v.run.maxDamage, "debug tear-rate")
 end
+--- Creates a trapdoor next to the player.
 function ____exports.trapdoorCommand(self)
     spawnTrapdoorOrCrawlspace(nil, true)
 end
+--- Warps to the first Treasure Room on the floor.
 function ____exports.treasure(self)
     warpToRoomType(nil, RoomType.TREASURE)
 end
+--- Warps to the first Ultra Secret Room on the floor.
 function ____exports.ultraSecret(self)
     warpToRoomType(nil, RoomType.ULTRA_SECRET)
 end
+--- Moves the player 0.5 units up. Provide a number to move a custom amount of units.
 function ____exports.up(self, params)
     movePlayer(nil, params, Direction.UP)
 end
+--- Warps to the specified room type. Accepts either the room type number or the partial name of the
+-- room type.
+-- 
+-- For example:
+-- - warp 5 - Warps to the first Boss Room on the floor, if any.
+-- - warp tr - Warps to the first Treasure Room on the floor, if any.
 function ____exports.warp(self, params)
     if params == "" then
         printConsole(nil, "You must specify a room type name or number.")

package/features/fadeInRemover.lua

@@ -25,6 +25,8 @@ local FEATURE_NAME = "fade-in remover"
 FADE_IN_SPEED = 1
 enabled = false
 v = {run = {removedFadeIn = false}}
+---
+-- @internal
 function ____exports.fadeInRemoverInit(self, mod)
     saveDataManager(
         nil,
@@ -34,10 +36,18 @@ function ____exports.fadeInRemoverInit(self, mod)
     )
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end
+--- Removes the fade-in that occurs at the beginning of a run. If this behavior is desired, call this
+-- function once at the beginning of your mod.
+-- 
+-- This is useful for debugging, when you are resetting the game often.
+-- 
+-- You can restore the vanilla behavior with the `restoreFadeIn` function.
 function ____exports.removeFadeIn(self)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     enabled = true
 end
+--- Disables the fade-in remover. Only useful if you have previously called the `removeFadeIn`
+-- function.
 function ____exports.restoreFadeIn(self)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     enabled = false