isaacscript-common 2.2.0 → 2.3.0

package/features/extraConsoleCommands/commandsDisplay.d.ts

@@ -1,162 +0,0 @@
-/**
- * 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.
- */
-export declare function bombDisplay(): void;
-/** Alias for the "bombDisplay" command. */
-export declare function bombsDisplay(): void;
-/**
- * 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.
- */
-export declare function doorDisplay(): void;
-/** Alias for the "doorDisplay" command. */
-export declare function doorsDisplay(): void;
-/**
- * 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.
- */
-export declare function effectDisplay(): void;
-/** Alias for the "effectDisplay" command. */
-export declare function effectsDisplay(): void;
-/**
- * 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.
- */
-export declare function familiarDisplay(): void;
-/** Alias for the "familiarDisplay" command. */
-export declare function familiarsDisplay(): void;
-/**
- * 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.
- */
-export declare function knifeDisplay(): void;
-/** Alias for the "knifeDisplay" command. */
-export declare function knivesDisplay(): void;
-/**
- * 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.
- */
-export declare function laserDisplay(): void;
-/** Alias for the "laserDisplay" command. */
-export declare function lasersDisplay(): void;
-/**
- * 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.
- */
-export declare function npcDisplay(): void;
-/** Alias for the "npcDisplay" command. */
-export declare function npcsDisplay(): void;
-/**
- * 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.
- */
-export declare function pickupDisplay(): void;
-/** Alias for the "pickupDisplay" command. */
-export declare function pickupsDisplay(): void;
-/**
- * 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.
- */
-export declare function pitDisplay(): void;
-/** Alias for the "pitDisplay" command. */
-export declare function pitsDisplay(): void;
-/**
- * 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.
- */
-export declare function playerDisplay(): void;
-/** Alias for the "playerDisplay" command. */
-export declare function playersDisplay(): void;
-/**
- * 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.
- */
-export declare function poopDisplay(): void;
-/** Alias for the "poopDisplay" command. */
-export declare function poopsDisplay(): void;
-/**
- * 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.
- */
-export declare function pressurePlateDisplay(): void;
-/** Alias for the "pressurePlateDisplay" command. */
-export declare function pressurePlatesDisplay(): void;
-/**
- * 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.
- */
-export declare function projectileDisplay(): void;
-/** Alias for the "projectileDisplay" command. */
-export declare function projectilesDisplay(): void;
-/**
- * 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.
- */
-export declare function rockDisplay(): void;
-/** Alias for the "rockDisplay" command. */
-export declare function rocksDisplay(): void;
-/**
- * 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.
- */
-export declare function slotDisplay(): void;
-/** Alias for the "slotDisplay" command. */
-export declare function slotsDisplay(): void;
-/** Alias for the "spikesDisplay" command. */
-export declare function spikeDisplay(): void;
-/**
- * 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.
- */
-export declare function spikesDisplay(): void;
-/**
- * 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.
- */
-export declare function tearDisplay(): void;
-/** Alias for the "tearDisplay" command. */
-export declare function tearsDisplay(): void;
-/**
- * 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.
- */
-export declare function tntDisplay(): void;
-/** Alias for the "tntDisplay" command. */
-export declare function tntsDisplay(): void;

package/features/extraConsoleCommands/commandsDisplay.lua

@@ -1,129 +0,0 @@
-local ____exports = {}
-local ____exports = require("features.debugDisplay.exports")
-local toggleBombDisplay = ____exports.toggleBombDisplay
-local toggleDoorDisplay = ____exports.toggleDoorDisplay
-local toggleEffectDisplay = ____exports.toggleEffectDisplay
-local toggleFamiliarDisplay = ____exports.toggleFamiliarDisplay
-local toggleKnifeDisplay = ____exports.toggleKnifeDisplay
-local toggleLaserDisplay = ____exports.toggleLaserDisplay
-local toggleNPCDisplay = ____exports.toggleNPCDisplay
-local togglePickupDisplay = ____exports.togglePickupDisplay
-local togglePitDisplay = ____exports.togglePitDisplay
-local togglePlayerDisplay = ____exports.togglePlayerDisplay
-local togglePoopDisplay = ____exports.togglePoopDisplay
-local togglePressurePlateDisplay = ____exports.togglePressurePlateDisplay
-local toggleProjectileDisplay = ____exports.toggleProjectileDisplay
-local toggleRockDisplay = ____exports.toggleRockDisplay
-local toggleSlotDisplay = ____exports.toggleSlotDisplay
-local toggleSpikesDisplay = ____exports.toggleSpikesDisplay
-local toggleTearDisplay = ____exports.toggleTearDisplay
-local toggleTNTDisplay = ____exports.toggleTNTDisplay
-function ____exports.spikesDisplay(self)
-    toggleSpikesDisplay(nil)
-end
-function ____exports.bombDisplay(self)
-    toggleBombDisplay(nil)
-end
-function ____exports.bombsDisplay(self)
-    ____exports.bombDisplay(nil)
-end
-function ____exports.doorDisplay(self)
-    toggleDoorDisplay(nil)
-end
-function ____exports.doorsDisplay(self)
-    ____exports.doorDisplay(nil)
-end
-function ____exports.effectDisplay(self)
-    toggleEffectDisplay(nil)
-end
-function ____exports.effectsDisplay(self)
-    ____exports.effectDisplay(nil)
-end
-function ____exports.familiarDisplay(self)
-    toggleFamiliarDisplay(nil)
-end
-function ____exports.familiarsDisplay(self)
-    ____exports.familiarDisplay(nil)
-end
-function ____exports.knifeDisplay(self)
-    toggleKnifeDisplay(nil)
-end
-function ____exports.knivesDisplay(self)
-    ____exports.knifeDisplay(nil)
-end
-function ____exports.laserDisplay(self)
-    toggleLaserDisplay(nil)
-end
-function ____exports.lasersDisplay(self)
-    ____exports.laserDisplay(nil)
-end
-function ____exports.npcDisplay(self)
-    toggleNPCDisplay(nil)
-end
-function ____exports.npcsDisplay(self)
-    ____exports.npcDisplay(nil)
-end
-function ____exports.pickupDisplay(self)
-    togglePickupDisplay(nil)
-end
-function ____exports.pickupsDisplay(self)
-    ____exports.pickupDisplay(nil)
-end
-function ____exports.pitDisplay(self)
-    togglePitDisplay(nil)
-end
-function ____exports.pitsDisplay(self)
-    ____exports.pitDisplay(nil)
-end
-function ____exports.playerDisplay(self)
-    togglePlayerDisplay(nil)
-end
-function ____exports.playersDisplay(self)
-    ____exports.playerDisplay(nil)
-end
-function ____exports.poopDisplay(self)
-    togglePoopDisplay(nil)
-end
-function ____exports.poopsDisplay(self)
-    ____exports.poopDisplay(nil)
-end
-function ____exports.pressurePlateDisplay(self)
-    togglePressurePlateDisplay(nil)
-end
-function ____exports.pressurePlatesDisplay(self)
-    ____exports.pressurePlateDisplay(nil)
-end
-function ____exports.projectileDisplay(self)
-    toggleProjectileDisplay(nil)
-end
-function ____exports.projectilesDisplay(self)
-    ____exports.projectileDisplay(nil)
-end
-function ____exports.rockDisplay(self)
-    toggleRockDisplay(nil)
-end
-function ____exports.rocksDisplay(self)
-    ____exports.rockDisplay(nil)
-end
-function ____exports.slotDisplay(self)
-    toggleSlotDisplay(nil)
-end
-function ____exports.slotsDisplay(self)
-    ____exports.slotDisplay(nil)
-end
-function ____exports.spikeDisplay(self)
-    ____exports.spikesDisplay(nil)
-end
-function ____exports.tearDisplay(self)
-    toggleTearDisplay(nil)
-end
-function ____exports.tearsDisplay(self)
-    ____exports.tearDisplay(nil)
-end
-function ____exports.tntDisplay(self)
-    toggleTNTDisplay(nil)
-end
-function ____exports.tntsDisplay(self)
-    ____exports.tntDisplay(nil)
-end
-return ____exports

package/features/extraConsoleCommands/commandsSubroutines.d.ts

@@ -1,9 +0,0 @@
-import { Direction, RoomType } from "isaac-typescript-definitions";
-import { HealthType } from "../../enums/HealthType";
-export declare function addHeart(params: string, healthType: HealthType): void;
-export declare function devilAngel(useDevil: boolean): void;
-export declare function listEntities(params: string, includeBackgroundEffects: boolean): void;
-export declare function listGridEntities(params: string, includeWalls: boolean): void;
-export declare function movePlayer(params: string, direction: Direction): void;
-export declare function spawnTrapdoorOrCrawlspace(trapdoor: boolean): void;
-export declare function warpToRoomType(roomType: RoomType): void;

package/features/extraConsoleCommands/commandsSubroutines.lua

@@ -1,129 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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;