isaacscript-common 2.3.0 → 3.0.0

package/features/extraConsoleCommands/commandsSubroutines.lua

@@ -0,0 +1,129 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____HealthType = require("enums.HealthType")
+local HealthType = ____HealthType.HealthType
+local ____direction = require("functions.direction")
+local directionToVector = ____direction.directionToVector
+local ____gridEntity = require("functions.gridEntity")
+local spawnGridWithVariant = ____gridEntity.spawnGridWithVariant
+local ____log = require("functions.log")
+local logEntities = ____log.logEntities
+local logGridEntities = ____log.logGridEntities
+local ____playerHealth = require("functions.playerHealth")
+local addPlayerHealthType = ____playerHealth.addPlayerHealthType
+local ____roomData = require("functions.roomData")
+local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
+local ____rooms = require("functions.rooms")
+local changeRoom = ____rooms.changeRoom
+local getRoomGridIndexesForType = ____rooms.getRoomGridIndexesForType
+local ____utils = require("functions.utils")
+local printConsole = ____utils.printConsole
+local ____roomTypeNames = require("objects.roomTypeNames")
+local DEFAULT_ROOM_TYPE_NAME = ____roomTypeNames.DEFAULT_ROOM_TYPE_NAME
+local ROOM_TYPE_NAMES = ____roomTypeNames.ROOM_TYPE_NAMES
+local DEFAULT_MOVE_UNITS = 0.5
+function ____exports.addHeart(self, params, healthType)
+    local numHearts = healthType == HealthType.MAX_HEARTS and 2 or 1
+    if params ~= "" then
+        local num = tonumber(params)
+        if num == nil then
+            printConsole(nil, "That is an invalid amount of hearts to add.")
+            return
+        end
+        numHearts = num
+    end
+    local player = Isaac.GetPlayer()
+    addPlayerHealthType(nil, player, healthType, numHearts)
+end
+function ____exports.devilAngel(self, useDevil)
+    local level = game:GetLevel()
+    local devilAngelRoomData = getRoomData(nil, GridRoom.DEVIL)
+    if devilAngelRoomData ~= nil then
+        local roomType = devilAngelRoomData.Type
+        local conflictingType = useDevil and RoomType.ANGEL or RoomType.DEVIL
+        if roomType == conflictingType then
+            local roomDescriptor = getRoomDescriptor(nil, GridRoom.DEVIL)
+            roomDescriptor.Data = nil
+        end
+    end
+    if useDevil then
+        level:InitializeDevilAngelRoom(false, true)
+    else
+        level:InitializeDevilAngelRoom(true, false)
+    end
+    changeRoom(nil, GridRoom.DEVIL)
+end
+function ____exports.listEntities(self, params, includeBackgroundEffects)
+    local entityTypeFilter
+    if params ~= "" then
+        entityTypeFilter = tonumber(params)
+        if entityTypeFilter == nil then
+            printConsole(nil, "That is an invalid entity type to filter by.")
+            return
+        end
+    end
+    logEntities(includeBackgroundEffects, entityTypeFilter)
+    printConsole(nil, "Logged the entities in the room to the \"log.txt\" file.")
+end
+function ____exports.listGridEntities(self, params, includeWalls)
+    local gridEntityTypeFilter
+    if params ~= "" then
+        gridEntityTypeFilter = tonumber(params)
+        if gridEntityTypeFilter == nil then
+            printConsole(nil, "That is an invalid grid entity type to filter by.")
+            return
+        end
+    end
+    logGridEntities(includeWalls, gridEntityTypeFilter)
+    printConsole(nil, "Logged the grid entities in the room to the \"log.txt\" file.")
+end
+function ____exports.movePlayer(self, params, direction)
+    local amount = DEFAULT_MOVE_UNITS
+    if params ~= "" then
+        local num = tonumber(params)
+        if num == nil then
+            printConsole(nil, "That is an invalid amount of units to move.")
+            return
+        end
+        amount = num
+    end
+    local player = Isaac.GetPlayer()
+    local vector = directionToVector(nil, direction)
+    local modifiedVector = vector * amount
+    player.Position = player.Position + modifiedVector
+end
+function ____exports.spawnTrapdoorOrCrawlspace(self, trapdoor)
+    local room = game:GetRoom()
+    local player = Isaac.GetPlayer()
+    local position = room:FindFreeTilePosition(player.Position, 0)
+    local gridIndex = room:GetGridIndex(position)
+    local gridEntityType = trapdoor and GridEntityType.TRAPDOOR or GridEntityType.CRAWL_SPACE
+    spawnGridWithVariant(nil, gridEntityType, 0, gridIndex)
+end
+function ____exports.warpToRoomType(self, roomType)
+    local roomTypeName = ROOM_TYPE_NAMES[roomType]
+    if roomTypeName == nil or roomTypeName == DEFAULT_ROOM_TYPE_NAME then
+        printConsole(
+            nil,
+            "Invalid room type: " .. tostring(roomType)
+        )
+    end
+    local gridIndexes = getRoomGridIndexesForType(nil, roomType)
+    local firstGridIndex = gridIndexes[1]
+    if firstGridIndex == nil then
+        printConsole(nil, ("There are no " .. roomTypeName) .. "s on this floor.")
+        return
+    end
+    changeRoom(nil, firstGridIndex)
+    printConsole(
+        nil,
+        ((("Warped to room type: " .. roomTypeName) .. " (") .. tostring(roomType)) .. ")"
+    )
+end
+return ____exports

package/features/extraConsoleCommands/init.d.ts

@@ -0,0 +1,26 @@
+import { ModUpgraded } from "../../classes/ModUpgraded";
+/**
+ * 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.
+ */
+export declare function enableExtraConsoleCommands(mod: ModUpgraded): void;
+/**
+ * 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`.
+ */
+export declare function addConsoleCommand(commandName: string, commandFunction: (params: string) => void): void;
+/**
+ * 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`.
+ */
+export declare function removeConsoleCommand(commandName: string): void;

package/features/extraConsoleCommands/init.lua

@@ -0,0 +1,265 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local featureEnabled, postUpdate, evaluateCacheFireDelay, evaluateCacheSpeed, entityTakeDmgPlayer, postCurseEval, executeCmd, postFireTear, commandFunctionsMap, initialized
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local LevelCurse = ____isaac_2Dtypescript_2Ddefinitions.LevelCurse
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local TearVariant = ____isaac_2Dtypescript_2Ddefinitions.TearVariant
+local ____constants = require("constants")
+local MAX_SPEED_STAT = ____constants.MAX_SPEED_STAT
+local ____map = require("functions.map")
+local getMapPartialMatch = ____map.getMapPartialMatch
+local ____utils = require("functions.utils")
+local printConsole = ____utils.printConsole
+local ____debugDisplay = require("features.debugDisplay.debugDisplay")
+local debugDisplayInit = ____debugDisplay.debugDisplayInit
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+local commandsDisplay = require("features.extraConsoleCommands.commandsDisplay")
+local commands = require("features.extraConsoleCommands.listCommands")
+local ____v = require("features.extraConsoleCommands.v")
+local v = ____v.default
+function featureEnabled(self)
+    return initialized
+end
+function postUpdate(self)
+    if v.run.spamBloodRights then
+        local player = Isaac.GetPlayer()
+        player:UseActiveItem(CollectibleType.BLOOD_RIGHTS)
+    end
+end
+function evaluateCacheFireDelay(self, player)
+    if v.run.maxTears then
+        player.FireDelay = 1
+    end
+end
+function evaluateCacheSpeed(self, player)
+    if v.run.maxSpeed then
+        player.MoveSpeed = MAX_SPEED_STAT
+    end
+end
+function entityTakeDmgPlayer(self)
+    if v.run.spamBloodRights then
+        return false
+    end
+    return nil
+end
+function postCurseEval(self, curses)
+    return v.persistent.disableCurses and LevelCurse.NONE or curses
+end
+function executeCmd(self, command, params)
+    local resultTuple = getMapPartialMatch(nil, command, commandFunctionsMap)
+    if resultTuple == nil then
+        printConsole(nil, "That is an invalid console command.")
+        return
+    end
+    local commandName, commandFunction = table.unpack(resultTuple)
+    printConsole(nil, "Command: " .. commandName)
+    commandFunction(nil, params)
+end
+function postFireTear(self, tear)
+    if v.run.chaosCardTears then
+        tear:ChangeVariant(TearVariant.CHAOS_CARD)
+    end
+    if v.run.maxDamage then
+        tear.CollisionDamage = tear.CollisionDamage * 1000
+        tear:ChangeVariant(TearVariant.TOOTH)
+    end
+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)
+    debugDisplayInit(nil, mod)
+    mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
+    mod:AddCallback(ModCallback.EVALUATE_CACHE, evaluateCacheFireDelay, CacheFlag.FIRE_DELAY)
+    mod:AddCallback(ModCallback.EVALUATE_CACHE, evaluateCacheSpeed, CacheFlag.SPEED)
+    mod:AddCallback(ModCallback.ENTITY_TAKE_DMG, entityTakeDmgPlayer, EntityType.PLAYER)
+    mod:AddCallback(ModCallback.POST_CURSE_EVAL, postCurseEval)
+    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.")
+    end
+    if commandFunctionsMap:has(commandName) then
+        error(("You cannot add a new console command of \"" .. commandName) .. "\" because there is already an existing command by that name. If you want to overwrite a command from the standard library, you can use the \"removeExtraConsoleCommand\" function.")
+    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.")
+    end
+    if not commandFunctionsMap:has(commandName) then
+        error(("The console command of \"" .. commandName) .. "\" does not exist, so you cannot remove it.")
+    end
+    commandFunctionsMap:delete(commandName)
+end
+commandFunctionsMap:set("1hp", commands.oneHP)
+commandFunctionsMap:set("addCharges", commands.addCharges)
+commandFunctionsMap:set("angel", commands.angel)
+commandFunctionsMap:set("ascent", commands.ascent)
+commandFunctionsMap:set("bedroom", commands.bedroom)
+commandFunctionsMap:set("bh", commands.bh)
+commandFunctionsMap:set("blackhearts", commands.blackHearts)
+commandFunctionsMap:set("blackMarket", commands.blackMarket)
+commandFunctionsMap:set("bloodCharges", commands.bloodCharges)
+commandFunctionsMap:set("bm", commands.bm)
+commandFunctionsMap:set("bomb", commands.bomb)
+commandFunctionsMap:set("bombDisplay", commandsDisplay.bombDisplay)
+commandFunctionsMap:set("bombsDisplay", commandsDisplay.bombsDisplay)
+commandFunctionsMap:set("bombs", commands.bombs)
+commandFunctionsMap:set("boneHearts", commands.boneHearts)
+commandFunctionsMap:set("boss", commands.boss)
+commandFunctionsMap:set("bossRush", commands.bossRush)
+commandFunctionsMap:set("brokenHearts", commands.brokenHearts)
+commandFunctionsMap:set("card", commands.card)
+commandFunctionsMap:set("cards", commands.cards)
+commandFunctionsMap:set("cc", commands.cc)
+commandFunctionsMap:set("chaosCardTears", commands.chaosCardTears)
+commandFunctionsMap:set("character", commands.characterCommand)
+commandFunctionsMap:set("charge", commands.charge)
+commandFunctionsMap:set("cleanBedroom", commands.cleanBedroom)
+commandFunctionsMap:set("coin", commands.coin)
+commandFunctionsMap:set("coins", commands.coins)
+commandFunctionsMap:set("crawlspace", commands.crawlspace)
+commandFunctionsMap:set("d20", commands.d20)
+commandFunctionsMap:set("d6", commands.d6)
+commandFunctionsMap:set("damage", commands.damage)
+commandFunctionsMap:set("dd", commands.dd)
+commandFunctionsMap:set("devil", commands.devil)
+commandFunctionsMap:set("dirtyBedroom", commands.dirtyBedroom)
+commandFunctionsMap:set("disableCurses", commands.disableCurses)
+commandFunctionsMap:set("doorDisplay", commandsDisplay.doorDisplay)
+commandFunctionsMap:set("doorsDisplay", commandsDisplay.doorsDisplay)
+commandFunctionsMap:set("down", commands.down)
+commandFunctionsMap:set("dungeon", commands.dungeon)
+commandFunctionsMap:set("effectDisplay", commandsDisplay.effectDisplay)
+commandFunctionsMap:set("effects", commands.effects)
+commandFunctionsMap:set("effectsDisplay", commandsDisplay.effectsDisplay)
+commandFunctionsMap:set("eh", commands.eh)
+commandFunctionsMap:set("error", commands.error)
+commandFunctionsMap:set("eternalHearts", commands.eternalHearts)
+commandFunctionsMap:set("familiarDisplay", commandsDisplay.familiarDisplay)
+commandFunctionsMap:set("familiarsDisplay", commandsDisplay.familiarsDisplay)
+commandFunctionsMap:set("fool", commands.fool)
+commandFunctionsMap:set("getPosition", commands.getPosition)
+commandFunctionsMap:set("gigaBomb", commands.gigaBomb)
+commandFunctionsMap:set("goldBomb", commands.goldBomb)
+commandFunctionsMap:set("goldHearts", commands.goldHearts)
+commandFunctionsMap:set("goldKey", commands.goldKey)
+commandFunctionsMap:set("goldenBomb", commands.goldenBomb)
+commandFunctionsMap:set("goldenHearts", commands.goldenHearts)
+commandFunctionsMap:set("goldenKey", commands.goldenKey)
+commandFunctionsMap:set("grid", commands.grid)
+commandFunctionsMap:set("grid2", commands.grid2)
+commandFunctionsMap:set("gridEntities", commands.gridEntities)
+commandFunctionsMap:set("h", commands.h)
+commandFunctionsMap:set("hearts", commands.hearts)
+commandFunctionsMap:set("hitboxes", commands.hitboxes)
+commandFunctionsMap:set("iAmError", commands.iAmError)
+commandFunctionsMap:set("key", commands.key)
+commandFunctionsMap:set("keys", commands.keys)
+commandFunctionsMap:set("knifeDisplay", commandsDisplay.knifeDisplay)
+commandFunctionsMap:set("knivesDisplay", commandsDisplay.knivesDisplay)
+commandFunctionsMap:set("laserDisplay", commandsDisplay.laserDisplay)
+commandFunctionsMap:set("lasersDisplay", commandsDisplay.lasersDisplay)
+commandFunctionsMap:set("left", commands.left)
+commandFunctionsMap:set("library", commands.library)
+commandFunctionsMap:set("list", commands.list)
+commandFunctionsMap:set("listAll", commands.listAll)
+commandFunctionsMap:set("listGrid", commands.listGrid)
+commandFunctionsMap:set("listGridAll", commands.listGridAll)
+commandFunctionsMap:set("lowHP", commands.lowHP)
+commandFunctionsMap:set("luck", commands.luck)
+commandFunctionsMap:set("map", commands.map)
+commandFunctionsMap:set("maxHearts", commands.maxHearts)
+commandFunctionsMap:set("mh", commands.mh)
+commandFunctionsMap:set("miniboss", commands.miniboss)
+commandFunctionsMap:set("noCurses", commands.noCurses)
+commandFunctionsMap:set("npcDisplay", commandsDisplay.npcDisplay)
+commandFunctionsMap:set("npcsDisplay", commandsDisplay.npcsDisplay)
+commandFunctionsMap:set("pickupDisplay", commandsDisplay.pickupDisplay)
+commandFunctionsMap:set("pickupsDisplay", commandsDisplay.pickupsDisplay)
+commandFunctionsMap:set("pill", commands.pill)
+commandFunctionsMap:set("pills", commands.pills)
+commandFunctionsMap:set("pitDisplay", commandsDisplay.pitDisplay)
+commandFunctionsMap:set("pitsDisplay", commandsDisplay.pitsDisplay)
+commandFunctionsMap:set("planetarium", commands.planetarium)
+commandFunctionsMap:set("playerDisplay", commandsDisplay.playerDisplay)
+commandFunctionsMap:set("playersDisplay", commandsDisplay.playersDisplay)
+commandFunctionsMap:set("playSound", commands.playSound)
+commandFunctionsMap:set("pocket", commands.pocket)
+commandFunctionsMap:set("poopDisplay", commandsDisplay.poopDisplay)
+commandFunctionsMap:set("poopMana", commands.poopMana)
+commandFunctionsMap:set("poopsDisplay", commandsDisplay.poopsDisplay)
+commandFunctionsMap:set("position", commands.positionCommand)
+commandFunctionsMap:set("pressurePlateDisplay", commandsDisplay.pressurePlateDisplay)
+commandFunctionsMap:set("pressurePlatesDisplay", commandsDisplay.pressurePlatesDisplay)
+commandFunctionsMap:set("projectileDisplay", commandsDisplay.projectileDisplay)
+commandFunctionsMap:set("projectilesDisplay", commandsDisplay.projectilesDisplay)
+commandFunctionsMap:set("redHearts", commands.redHearts)
+commandFunctionsMap:set("rh", commands.rh)
+commandFunctionsMap:set("right", commands.right)
+commandFunctionsMap:set("rockDisplay", commandsDisplay.rockDisplay)
+commandFunctionsMap:set("rocksDisplay", commandsDisplay.rocksDisplay)
+commandFunctionsMap:set("room", commands.roomCommand)
+commandFunctionsMap:set("rottenHearts", commands.rottenHearts)
+commandFunctionsMap:set("s", commands.s)
+commandFunctionsMap:set("sacrifice", commands.sacrifice)
+commandFunctionsMap:set("secret", commands.secret)
+commandFunctionsMap:set("seedStick", commands.seedStick)
+commandFunctionsMap:set("seeds", commands.seedsCommand)
+commandFunctionsMap:set("setCharges", commands.setCharges)
+commandFunctionsMap:set("setPosition", commands.setPosition)
+commandFunctionsMap:set("sh", commands.sh)
+commandFunctionsMap:set("shop", commands.shop)
+commandFunctionsMap:set("slotDisplay", commandsDisplay.slotDisplay)
+commandFunctionsMap:set("slotsDisplay", commandsDisplay.slotsDisplay)
+commandFunctionsMap:set("smelt", commands.smelt)
+commandFunctionsMap:set("soulCharges", commands.soulCharges)
+commandFunctionsMap:set("soulHearts", commands.soulHearts)
+commandFunctionsMap:set("sound", commands.sound)
+commandFunctionsMap:set("sounds", commands.sounds)
+commandFunctionsMap:set("spam", commands.spam)
+commandFunctionsMap:set("spawnGoldenTrinket", commands.spawnGoldenTrinket)
+commandFunctionsMap:set("speed", commands.speed)
+commandFunctionsMap:set("spikeDisplay", commandsDisplay.spikeDisplay)
+commandFunctionsMap:set("spikesDisplay", commandsDisplay.spikesDisplay)
+commandFunctionsMap:set("supersecret", commands.superSecret)
+commandFunctionsMap:set("startingRoom", commands.startingRoom)
+commandFunctionsMap:set("tearDisplay", commandsDisplay.tearDisplay)
+commandFunctionsMap:set("tears", commands.tears)
+commandFunctionsMap:set("tearsDisplay", commandsDisplay.tearsDisplay)
+commandFunctionsMap:set("tntDisplay", commandsDisplay.tntDisplay)
+commandFunctionsMap:set("tntsDisplay", commandsDisplay.tntsDisplay)
+commandFunctionsMap:set("trapdoor", commands.trapdoorCommand)
+commandFunctionsMap:set("treasure", commands.treasure)
+commandFunctionsMap:set("ultraSecret", commands.ultraSecret)
+commandFunctionsMap:set("up", commands.up)
+commandFunctionsMap:set("warp", commands.warp)
+return ____exports