isaacscript-common 2.3.0 → 3.0.0

package/features/extraConsoleCommands/listCommands.d.ts

@@ -0,0 +1,349 @@
+/**
+ * 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.)
+ */
+export declare function addCharges(params: string): void;
+/**
+ * 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.
+ */
+export declare function angel(): void;
+/** Activates the flags for the Ascent (i.e. Backwards Path). */
+export declare function ascent(): void;
+/** Warps to the first Clean Bedroom or Dirty Bedroom on the floor. */
+export declare function bedroom(): void;
+/** Alias for the "blackhearts" command. */
+export declare function bh(params: string): void;
+/**
+ * Gives a half black heart. Provide a number to give a custom amount of hearts. (You can use
+ * negative numbers to remove hearts.)
+ */
+export declare function blackHearts(params: string): void;
+/** Warps to the Black Market for the floor. */
+export declare function blackMarket(): void;
+/**
+ * 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.)
+ */
+export declare function bloodCharges(params: string): void;
+/** Alias for the "blackMarket" command. */
+export declare function bm(): void;
+/**
+ * Gives a bomb. Provide a number to give a custom amount of bombs. (You can use negative numbers to
+ * remove bombs.)
+ */
+export declare function bomb(params: string): void;
+/**
+ * Gives 99 bombs. Provide a number to give a custom amount of bombs. (You can use negative numbers
+ * to remove bombs.)
+ */
+export declare function bombs(params: string): void;
+/**
+ * Gives a bone heart. Provide a number to give a custom amount of hearts. (You can use negative
+ * numbers to remove hearts.)
+ */
+export declare function boneHearts(params: string): void;
+/** Warps to the first Boss Room on the floor. */
+export declare function boss(): void;
+/** Warps to the Boss Rush for the floor. */
+export declare function bossRush(): void;
+/**
+ * Gives a broken heart. Provide a number to give a custom amount of hearts. (You can use negative
+ * numbers to remove hearts.)
+ */
+export declare function brokenHearts(params: string): void;
+/**
+ * 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.
+ */
+export declare function card(params: string): void;
+/** Spawns every card on the ground, starting at the top-left-most tile. */
+export declare function cards(): void;
+/** Alias for the "chaosCardTears" command. */
+export declare function cc(): void;
+/** Toggles Chaos Card tears. Useful for killing enemies very fast without using "debug 10". */
+export declare function chaosCardTears(): void;
+/**
+ * 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.
+ */
+export declare function characterCommand(params: string): void;
+/** Alias for the "addCharges" command. */
+export declare function charge(params: string): void;
+/** Warps to the first Clean Bedroom on the floor. */
+export declare function cleanBedroom(): void;
+/**
+ * Gives a coin. Provide a number to give a custom amount of coins. (You can use negative numbers to
+ * remove coins.)
+ */
+export declare function coin(params: string): void;
+/**
+ * Gives 999 coins. Provide a number to give a custom amount of coins. (You can use negative numbers
+ * to remove coins.)
+ */
+export declare function coins(params: string): void;
+/** Creates a crawlspace next to the player. */
+export declare function crawlspace(): void;
+/** Uses the D20. */
+export declare function d20(): void;
+/** Uses the D6. */
+export declare function d6(): void;
+/** Toggles extremely high-damage tears. */
+export declare function damage(): void;
+/** Alias for the "devil" command. */
+export declare function dd(): void;
+/**
+ * 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.
+ */
+export declare function devil(): void;
+/** Warps to the first Dirty Bedroom on the floor. */
+export declare function dirtyBedroom(): void;
+/** Toggles whether or not curses can appear. */
+export declare function disableCurses(): void;
+/** Moves the player 0.5 units down. Provide a number to move a custom amount of units. */
+export declare function down(params: string): void;
+/** Warps to the Dungeon (i.e. Crawlspace) for the floor. */
+export declare function dungeon(): void;
+/** Logs the player's current temporary effects to the "log.txt" file. */
+export declare function effects(): void;
+/** Alias for the "eternalHearts" command. */
+export declare function eh(params: string): void;
+/** Alias for the "iAmError" command. */
+export declare function error(): void;
+/**
+ * Gives an eternal heart. Provide a number to give a custom amount of hearts. (You can use negative
+ * numbers to remove hearts.)
+ */
+export declare function eternalHearts(params: string): void;
+/** Alias for the "startingRoom" command. */
+export declare function fool(): void;
+/** Prints the current position of all players. */
+export declare function getPosition(): void;
+/**
+ * Gives a Giga Bomb. Provide a number to give a custom amount of Giga Bombs. (You can use negative
+ * numbers to remove bombs.)
+ */
+export declare function gigaBomb(params: string): void;
+/** Alias for the "goldenBomb" command. */
+export declare function goldBomb(): void;
+/** Alias for the "goldenHearts" command. */
+export declare function goldHearts(params: string): void;
+/** Alias for the "goldenKey" command. */
+export declare function goldKey(): void;
+/** Gives the player a golden bomb. */
+export declare function goldenBomb(): void;
+/**
+ * Gives a golden heart. Provide a number to give a custom amount of hearts. (You can use negative
+ * numbers to remove hearts.)
+ */
+export declare function goldenHearts(params: string): void;
+/** Gives the player a golden key. */
+export declare function goldenKey(): void;
+/** Alias for the "debug 2" command. */
+export declare function grid(): void;
+/** Alias for the "debug 11" command. */
+export declare function grid2(): void;
+/** Spawns every grid entity, starting at the top-left-most tile. */
+export declare function gridEntities(): void;
+/** Alias for the "hearts" command. */
+export declare function h(params: string): void;
+/**
+ * Gives a half red heart. Provide a number to give a custom amount of hearts. (You can use negative
+ * numbers to remove hearts.)
+ */
+export declare function hearts(params: string): void;
+/** Alias for the "debug 6" command. */
+export declare function hitboxes(): void;
+/** Warps to the I AM ERROR room for the floor. */
+export declare function iAmError(): void;
+/**
+ * Gives a key. Provide a number to give a custom amount of key. (You can use negative numbers to
+ * remove keys.)
+ */
+export declare function key(params: string): void;
+/**
+ * Gives 99 keys. Provide a number to give a custom amount of coins. (You can use negative numbers
+ * to remove keys.)
+ */
+export declare function keys(params: string): void;
+/** Moves the player 0.5 units left. Provide a number to move a custom amount of units. */
+export declare function left(params: string): void;
+/** Warps to the first Library on the floor. */
+export declare function library(): void;
+/**
+ * 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.
+ */
+export declare function list(params: string): void;
+/**
+ * Logs the entities in the room to the "log.txt" file. Provide a number to only log that specific
+ * `EntityType`.
+ */
+export declare function listAll(params: string): void;
+/**
+ * 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.
+ */
+export declare function listGrid(params: string): void;
+/**
+ * Logs the grid entities in the room to the "log.txt" file. Provide a number to only log that
+ * specific `GridEntityType`.
+ */
+export declare function listGridAll(params: string): void;
+/** Alias for the "1hp" command. */
+export declare function lowHP(): void;
+/** Alias for "debug 9". */
+export declare function luck(): void;
+/** Completely reveals the entire map, including the Ultra Secret Room. */
+export declare function map(): void;
+/**
+ * Gives a heart container. Provide a number to give a custom amount of heart containers. (You can
+ * use negative numbers to remove heart containers.)
+ */
+export declare function maxHearts(params: string): void;
+/** Alias for the "maxHearts" command. */
+export declare function mh(params: string): void;
+/** Warps to the first Miniboss Room on the floor. */
+export declare function miniboss(): void;
+/** Alias for the "disableCurses" command. */
+export declare function noCurses(): void;
+/** Sets every NPC in the room to 1 HP. */
+export declare function oneHP(): void;
+/**
+ * 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.
+ */
+export declare function pill(params: string): void;
+/** Spawns every pill on the ground, starting at the top-left-most tile. */
+export declare function pills(): void;
+/** Warps to the first Planetarium on the floor. */
+export declare function planetarium(): void;
+/** Alias for the "sound" command. */
+export declare function playSound(params: string): void;
+/** Sets the player's pocket item to the specified collectible type. */
+export declare function pocket(params: string): void;
+/**
+ * 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.)
+ */
+export declare function poopMana(params: string): void;
+/** Alias for the "getPosition" command. */
+export declare function positionCommand(): void;
+/** Alias for the "hearts" command. */
+export declare function redHearts(params: string): void;
+/** Alias for the "redHearts" command. */
+export declare function rh(params: string): void;
+/** Moves the player 0.5 units right. Provide a number to move a custom amount of units. */
+export declare function right(params: string): void;
+/** Logs information about the room to the "log.txt" file. */
+export declare function roomCommand(): void;
+/**
+ * Gives a rotten heart. Provide a number to give a custom amount of hearts. (You can use negative
+ * numbers to remove hearts.)
+ */
+export declare function rottenHearts(params: string): void;
+/**
+ * Alias for the "stage" command.
+ *
+ * For example:
+ * - s 3 - Warps to Caves 1.
+ * - s 1c - Warps to Downpour 1.
+ */
+export declare function s(params: string): void;
+/** Warps to the first Sacrifice Room on the floor. */
+export declare function sacrifice(): void;
+/** Warps to the first Secret Room on the floor. */
+export declare function secret(): void;
+/** Changes to a seeded run, using the seed of the current run. */
+export declare function seedStick(): void;
+/** Logs all of the current run's seed effects to the "log.txt" file. */
+export declare function seedsCommand(): void;
+/**
+ * Sets a charge to the player's specified active item. You must provide the active slot number and
+ * the number of charges to set.
+ */
+export declare function setCharges(params: string): void;
+/**
+ * Moves the first player to the specified position.
+ *
+ * For example:
+ * - setPosition 100 50
+ */
+export declare function setPosition(params: string): void;
+/** Alias for the "soulHearts" command. */
+export declare function sh(params: string): void;
+/** Warps to the first shop on the floor. */
+export declare function shop(): void;
+/** Uses the Smelter to smelt the current player's trinket. */
+export declare function smelt(): void;
+/**
+ * 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.)
+ */
+export declare function soulCharges(params: string): void;
+/**
+ * Gives a half soul heart. Provide a number to give a custom amount of hearts. (You can use
+ * negative numbers to remove hearts.)
+ */
+export declare function soulHearts(params: string): void;
+/**
+ * Play the supplied sound effect.
+ *
+ * For example:
+ * - sound 1 - Plays the 1-Up sound effect.
+ */
+export declare function sound(params: string): void;
+/** Logs all of the currently playing sound effects to the "log.txt" file. */
+export declare function sounds(): void;
+/**
+ * Toggles spamming Blood Rights on every frame. Useful for killing enemies very fast without using
+ * "debug 10".
+ */
+export declare function spam(): void;
+/** Spawns a golden version of the specified trinket type. */
+export declare function spawnGoldenTrinket(params: string): void;
+/** Toggles maximum movement speed and flight. */
+export declare function speed(): void;
+/** Warps to the starting room of the floor. */
+export declare function startingRoom(): void;
+/** Warps to the first Super Secret Room on the floor. */
+export declare function superSecret(): void;
+/** Toggles extremely high tears stat (e.g. fire rate), equivalent of that to soy milk. */
+export declare function tears(): void;
+/** Creates a trapdoor next to the player. */
+export declare function trapdoorCommand(): void;
+/** Warps to the first Treasure Room on the floor. */
+export declare function treasure(): void;
+/** Warps to the first Ultra Secret Room on the floor. */
+export declare function ultraSecret(): void;
+/** Moves the player 0.5 units up. Provide a number to move a custom amount of units. */
+export declare function up(params: string): void;
+/**
+ * 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.
+ */
+export declare function warp(params: string): void;