isaacscript-common 6.6.1-dev.1 → 6.6.1-dev.5

package/src/features/extraConsoleCommands/exports.ts

@@ -0,0 +1,78 @@
+import { ModUpgraded } from "../../classes/ModUpgraded";
+import { isVanillaConsoleCommand } from "../../functions/utils";
+import { extraConsoleCommandsInit } from "./init";
+import {
+  extraConsoleCommandsFunctionMap,
+  isExtraConsoleCommandsInitialized,
+} from "./v";
+
+/**
+ * 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 function enableExtraConsoleCommands(mod: ModUpgraded): void {
+  if (isExtraConsoleCommandsInitialized()) {
+    error("The extra console commands are already initialized.");
+  }
+
+  extraConsoleCommandsInit(mod);
+}
+
+/**
+ * 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 function addConsoleCommand(
+  commandName: string,
+  commandFunction: (params: string) => void,
+): void {
+  if (!isExtraConsoleCommandsInitialized()) {
+    error(
+      'The "extraConsoleCommands" feature is not initialized. Before adding extra console commands, you must first enable the feature by invoking the "enableExtraConsoleCommands" function.',
+    );
+  }
+
+  if (isVanillaConsoleCommand(commandName)) {
+    error(
+      `Failed to add a new console command of "${commandName}" because that name already belongs to a vanilla command. You must pick a non-colliding name.`,
+    );
+  }
+
+  if (extraConsoleCommandsFunctionMap.has(commandName)) {
+    error(
+      `Failed to add a new console command of "${commandName}" because there is already an existing custom command by that name. If you want to overwrite a command from the standard library, you can use the "removeExtraConsoleCommand" function.`,
+    );
+  }
+
+  extraConsoleCommandsFunctionMap.set(commandName, commandFunction);
+}
+
+/**
+ * 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 function removeConsoleCommand(commandName: string): void {
+  if (!isExtraConsoleCommandsInitialized()) {
+    error(
+      'The "extraConsoleCommands" feature is not initialized. Before removing console commands, you must first enable the feature by invoking the "enableExtraConsoleCommands" function.',
+    );
+  }
+
+  if (!extraConsoleCommandsFunctionMap.has(commandName)) {
+    error(
+      `Failed to remove the console command of "${commandName}", since it does not already exist in the map.`,
+    );
+  }
+
+  extraConsoleCommandsFunctionMap.delete(commandName);
+}

package/src/features/extraConsoleCommands/init.ts

@@ -0,0 +1,385 @@
+import {
+  CacheFlag,
+  CollectibleType,
+  EntityType,
+  LevelCurse,
+  ModCallback,
+  TearVariant,
+} from "isaac-typescript-definitions";
+import { ModUpgraded } from "../../classes/ModUpgraded";
+import { MAX_SPEED_STAT } from "../../constants";
+import { getMapPartialMatch } from "../../functions/map";
+import { printConsole } from "../../functions/utils";
+import { debugDisplayInit } from "../debugDisplay/debugDisplay";
+import { saveDataManager } from "../saveDataManager/exports";
+import * as commandsDisplay from "./commandsDisplay";
+import * as commands from "./listCommands";
+import v, { extraConsoleCommandsFunctionMap } from "./v";
+
+export function extraConsoleCommandsInit(mod: ModUpgraded): void {
+  saveDataManager("extraConsoleCommands", v, () => false);
+  initMap();
+  initCallbacks(mod);
+  debugDisplayInit(mod);
+}
+
+function initMap() {
+  extraConsoleCommandsFunctionMap.set("1hp", commands.oneHP);
+  extraConsoleCommandsFunctionMap.set("addCharges", commands.addCharges);
+  extraConsoleCommandsFunctionMap.set("angel", commands.angel);
+  extraConsoleCommandsFunctionMap.set("ascent", commands.ascent);
+  extraConsoleCommandsFunctionMap.set("bedroom", commands.bedroom);
+  extraConsoleCommandsFunctionMap.set("bh", commands.bh);
+  extraConsoleCommandsFunctionMap.set("blackhearts", commands.blackHearts);
+  extraConsoleCommandsFunctionMap.set("blackMarket", commands.blackMarket);
+  extraConsoleCommandsFunctionMap.set("bloodCharges", commands.bloodCharges);
+  extraConsoleCommandsFunctionMap.set("bm", commands.bm);
+  extraConsoleCommandsFunctionMap.set("bomb", commands.bomb);
+  extraConsoleCommandsFunctionMap.set(
+    "bombDisplay",
+    commandsDisplay.bombDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "bombsDisplay",
+    commandsDisplay.bombsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("bombs", commands.bombs);
+  extraConsoleCommandsFunctionMap.set("boneHearts", commands.boneHearts);
+  extraConsoleCommandsFunctionMap.set("boss", commands.boss);
+  extraConsoleCommandsFunctionMap.set("bossRush", commands.bossRush);
+  extraConsoleCommandsFunctionMap.set("brokenHearts", commands.brokenHearts);
+  extraConsoleCommandsFunctionMap.set("card", commands.card);
+  extraConsoleCommandsFunctionMap.set("cards", commands.cards);
+  extraConsoleCommandsFunctionMap.set("cc", commands.cc);
+  extraConsoleCommandsFunctionMap.set(
+    "chaosCardTears",
+    commands.chaosCardTears,
+  );
+  extraConsoleCommandsFunctionMap.set("character", commands.characterCommand);
+  extraConsoleCommandsFunctionMap.set("charge", commands.charge);
+  extraConsoleCommandsFunctionMap.set("cleanBedroom", commands.cleanBedroom);
+  extraConsoleCommandsFunctionMap.set("coin", commands.coin);
+  extraConsoleCommandsFunctionMap.set("coins", commands.coins);
+  extraConsoleCommandsFunctionMap.set("crawlSpace", commands.crawlSpace);
+  extraConsoleCommandsFunctionMap.set("d20", commands.d20);
+  extraConsoleCommandsFunctionMap.set("d6", commands.d6);
+  extraConsoleCommandsFunctionMap.set("damage", commands.damage);
+  extraConsoleCommandsFunctionMap.set("dd", commands.dd);
+  extraConsoleCommandsFunctionMap.set("devil", commands.devil);
+  extraConsoleCommandsFunctionMap.set("dirtyBedroom", commands.dirtyBedroom);
+  extraConsoleCommandsFunctionMap.set("disableCurses", commands.disableCurses);
+  extraConsoleCommandsFunctionMap.set(
+    "doorDisplay",
+    commandsDisplay.doorDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "doorsDisplay",
+    commandsDisplay.doorsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("down", commands.down);
+  extraConsoleCommandsFunctionMap.set("dungeon", commands.dungeon);
+  extraConsoleCommandsFunctionMap.set(
+    "effectDisplay",
+    commandsDisplay.effectDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("effects", commands.effects);
+  extraConsoleCommandsFunctionMap.set(
+    "effectsDisplay",
+    commandsDisplay.effectsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("eh", commands.eh);
+  extraConsoleCommandsFunctionMap.set("error", commands.error);
+  extraConsoleCommandsFunctionMap.set("eternalHearts", commands.eternalHearts);
+  extraConsoleCommandsFunctionMap.set(
+    "familiarDisplay",
+    commandsDisplay.familiarDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "familiarsDisplay",
+    commandsDisplay.familiarsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("flight", commands.flight);
+  extraConsoleCommandsFunctionMap.set("fool", commands.fool);
+  extraConsoleCommandsFunctionMap.set("getPosition", commands.getPosition);
+  extraConsoleCommandsFunctionMap.set("gigaBomb", commands.gigaBomb);
+  extraConsoleCommandsFunctionMap.set("goldBomb", commands.goldBomb);
+  extraConsoleCommandsFunctionMap.set("goldHearts", commands.goldHearts);
+  extraConsoleCommandsFunctionMap.set("goldKey", commands.goldKey);
+  extraConsoleCommandsFunctionMap.set("goldenBomb", commands.goldenBomb);
+  extraConsoleCommandsFunctionMap.set("goldenHearts", commands.goldenHearts);
+  extraConsoleCommandsFunctionMap.set("goldenKey", commands.goldenKey);
+  extraConsoleCommandsFunctionMap.set("grid", commands.grid);
+  extraConsoleCommandsFunctionMap.set("grid2", commands.grid2);
+  extraConsoleCommandsFunctionMap.set("gridCosts", commands.gridCosts);
+  extraConsoleCommandsFunctionMap.set("gridEntities", commands.gridEntities);
+  extraConsoleCommandsFunctionMap.set("h", commands.h);
+  extraConsoleCommandsFunctionMap.set("hearts", commands.hearts);
+  extraConsoleCommandsFunctionMap.set("hitboxes", commands.hitboxes);
+  extraConsoleCommandsFunctionMap.set("iAmError", commands.iAmError);
+  extraConsoleCommandsFunctionMap.set("key", commands.key);
+  extraConsoleCommandsFunctionMap.set("keys", commands.keys);
+  extraConsoleCommandsFunctionMap.set(
+    "knifeDisplay",
+    commandsDisplay.knifeDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "knivesDisplay",
+    commandsDisplay.knivesDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "laserDisplay",
+    commandsDisplay.laserDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "lasersDisplay",
+    commandsDisplay.lasersDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("left", commands.left);
+  extraConsoleCommandsFunctionMap.set("library", commands.library);
+  extraConsoleCommandsFunctionMap.set("list", commands.list);
+  extraConsoleCommandsFunctionMap.set("listAll", commands.listAll);
+  extraConsoleCommandsFunctionMap.set("listGrid", commands.listGrid);
+  extraConsoleCommandsFunctionMap.set("listGridAll", commands.listGridAll);
+  extraConsoleCommandsFunctionMap.set("lowHP", commands.lowHP);
+  extraConsoleCommandsFunctionMap.set("luck", commands.luck);
+  extraConsoleCommandsFunctionMap.set("mana", commands.mana);
+  extraConsoleCommandsFunctionMap.set("map", commands.map);
+  extraConsoleCommandsFunctionMap.set("maxHearts", commands.maxHearts);
+  extraConsoleCommandsFunctionMap.set("mh", commands.mh);
+  extraConsoleCommandsFunctionMap.set("miniboss", commands.miniboss);
+  extraConsoleCommandsFunctionMap.set("noCurses", commands.noCurses);
+  extraConsoleCommandsFunctionMap.set("npcDisplay", commandsDisplay.npcDisplay);
+  extraConsoleCommandsFunctionMap.set(
+    "npcsDisplay",
+    commandsDisplay.npcsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "pickupDisplay",
+    commandsDisplay.pickupDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "pickupsDisplay",
+    commandsDisplay.pickupsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("pill", commands.pill);
+  extraConsoleCommandsFunctionMap.set("pills", commands.pills);
+  extraConsoleCommandsFunctionMap.set("pitDisplay", commandsDisplay.pitDisplay);
+  extraConsoleCommandsFunctionMap.set(
+    "pitsDisplay",
+    commandsDisplay.pitsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("planetarium", commands.planetarium);
+  extraConsoleCommandsFunctionMap.set(
+    "playerDisplay",
+    commandsDisplay.playerDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "playersDisplay",
+    commandsDisplay.playersDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("playSound", commands.playSound);
+  extraConsoleCommandsFunctionMap.set("pocket", commands.pocket);
+  extraConsoleCommandsFunctionMap.set(
+    "poopDisplay",
+    commandsDisplay.poopDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("poopMana", commands.poopMana);
+  extraConsoleCommandsFunctionMap.set(
+    "poopsDisplay",
+    commandsDisplay.poopsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("position", commands.positionCommand);
+  extraConsoleCommandsFunctionMap.set(
+    "pressurePlateDisplay",
+    commandsDisplay.pressurePlateDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "pressurePlatesDisplay",
+    commandsDisplay.pressurePlatesDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "projectileDisplay",
+    commandsDisplay.projectileDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "projectilesDisplay",
+    commandsDisplay.projectilesDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("redHearts", commands.redHearts);
+  extraConsoleCommandsFunctionMap.set("rh", commands.rh);
+  extraConsoleCommandsFunctionMap.set("right", commands.right);
+  extraConsoleCommandsFunctionMap.set(
+    "rockDisplay",
+    commandsDisplay.rockDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "rocksDisplay",
+    commandsDisplay.rocksDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("room", commands.roomCommand);
+  extraConsoleCommandsFunctionMap.set("rottenHearts", commands.rottenHearts);
+  extraConsoleCommandsFunctionMap.set("s", commands.s);
+  extraConsoleCommandsFunctionMap.set("sacrifice", commands.sacrifice);
+  extraConsoleCommandsFunctionMap.set("secret", commands.secret);
+  extraConsoleCommandsFunctionMap.set("seedStick", commands.seedStick);
+  extraConsoleCommandsFunctionMap.set("seeds", commands.seedsCommand);
+  extraConsoleCommandsFunctionMap.set("setCharges", commands.setCharges);
+  extraConsoleCommandsFunctionMap.set("setPosition", commands.setPosition);
+  extraConsoleCommandsFunctionMap.set("sh", commands.sh);
+  extraConsoleCommandsFunctionMap.set("shop", commands.shop);
+  extraConsoleCommandsFunctionMap.set(
+    "slotDisplay",
+    commandsDisplay.slotDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "slotsDisplay",
+    commandsDisplay.slotsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("smelt", commands.smelt);
+  extraConsoleCommandsFunctionMap.set("soulCharges", commands.soulCharges);
+  extraConsoleCommandsFunctionMap.set("soulHearts", commands.soulHearts);
+  extraConsoleCommandsFunctionMap.set("sound", commands.sound);
+  extraConsoleCommandsFunctionMap.set("sounds", commands.sounds);
+  extraConsoleCommandsFunctionMap.set("spam", commands.spam);
+  extraConsoleCommandsFunctionMap.set(
+    "spawnGoldenTrinket",
+    commands.spawnGoldenTrinket,
+  );
+  extraConsoleCommandsFunctionMap.set("speed", commands.speed);
+  extraConsoleCommandsFunctionMap.set(
+    "spikeDisplay",
+    commandsDisplay.spikeDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set(
+    "spikesDisplay",
+    commandsDisplay.spikesDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("supersecret", commands.superSecret);
+  extraConsoleCommandsFunctionMap.set("startingRoom", commands.startingRoom);
+  extraConsoleCommandsFunctionMap.set(
+    "tearDisplay",
+    commandsDisplay.tearDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("tears", commands.tears);
+  extraConsoleCommandsFunctionMap.set(
+    "tearsDisplay",
+    commandsDisplay.tearsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("tntDisplay", commandsDisplay.tntDisplay);
+  extraConsoleCommandsFunctionMap.set(
+    "tntsDisplay",
+    commandsDisplay.tntsDisplay,
+  );
+  extraConsoleCommandsFunctionMap.set("trapdoor", commands.trapdoorCommand);
+  extraConsoleCommandsFunctionMap.set("treasure", commands.treasure);
+  extraConsoleCommandsFunctionMap.set("ultraSecret", commands.ultraSecret);
+  extraConsoleCommandsFunctionMap.set("unseed", commands.unseed);
+  extraConsoleCommandsFunctionMap.set("up", commands.up);
+  extraConsoleCommandsFunctionMap.set("warp", commands.warp);
+}
+
+function initCallbacks(mod: ModUpgraded) {
+  mod.AddCallback(ModCallback.POST_UPDATE, postUpdate); // 1
+  mod.AddCallback(
+    ModCallback.EVALUATE_CACHE,
+    evaluateCacheFireDelay,
+    CacheFlag.FIRE_DELAY, // 1 << 1
+  ); // 8
+  mod.AddCallback(
+    ModCallback.EVALUATE_CACHE,
+    evaluateCacheSpeed,
+    CacheFlag.SPEED, // 1 << 4
+  ); // 8
+  mod.AddCallback(
+    ModCallback.EVALUATE_CACHE,
+    evaluateCacheFlying,
+    CacheFlag.FLYING, // 1 << 7
+  );
+  mod.AddCallback(
+    ModCallback.ENTITY_TAKE_DMG,
+    entityTakeDmgPlayer,
+    EntityType.PLAYER,
+  ); // 11
+  mod.AddCallback(ModCallback.POST_CURSE_EVAL, postCurseEval); // 12
+  mod.AddCallback(ModCallback.EXECUTE_CMD, executeCmd); // 22
+  mod.AddCallback(ModCallback.POST_FIRE_TEAR, postFireTear); // 61
+}
+
+// ModCallback.POST_UPDATE (1)
+function postUpdate() {
+  if (v.run.spamBloodRights) {
+    const player = Isaac.GetPlayer();
+    player.UseActiveItem(CollectibleType.BLOOD_RIGHTS);
+  }
+}
+
+// ModCallback.EVALUATE_CACHE (8)
+// CacheFlag.FIRE_DELAY (1 << 1)
+function evaluateCacheFireDelay(player: EntityPlayer) {
+  if (v.run.maxTears) {
+    player.FireDelay = 1; // Equivalent to Soy Milk
+  }
+}
+
+// ModCallback.EVALUATE_CACHE (8)
+// CacheFlag.SPEED (1 << 4)
+function evaluateCacheSpeed(player: EntityPlayer) {
+  if (v.run.maxSpeed) {
+    player.MoveSpeed = MAX_SPEED_STAT;
+  }
+}
+
+// ModCallback.EVALUATE_CACHE (8)
+// CacheFlag.FLYING (1 << 7)
+function evaluateCacheFlying(player: EntityPlayer) {
+  if (v.run.flight) {
+    player.CanFly = true;
+  }
+}
+
+// ModCallback.ENTITY_TAKE_DMG (11)
+// EntityType.PLAYER (1)
+function entityTakeDmgPlayer() {
+  if (v.run.spamBloodRights) {
+    return false;
+  }
+
+  return undefined;
+}
+
+// ModCallback.POST_CURSE_EVAL (12)
+function postCurseEval(curses: int) {
+  return v.persistent.disableCurses ? LevelCurse.NONE : curses;
+}
+
+// ModCallback.EXECUTE_CMD (22)
+function executeCmd(command: string, params: string) {
+  const resultTuple = getMapPartialMatch(
+    command,
+    extraConsoleCommandsFunctionMap,
+  );
+  if (resultTuple === undefined) {
+    printConsole("That is an invalid console command.");
+    return;
+  }
+
+  const [commandName, commandFunction] = resultTuple;
+  printConsole(`Command: ${commandName}`);
+  commandFunction(params);
+}
+
+// ModCallback.POST_FIRE_TEAR (61)
+function postFireTear(tear: EntityTear) {
+  if (v.run.chaosCardTears) {
+    tear.ChangeVariant(TearVariant.CHAOS_CARD);
+  }
+
+  if (v.run.maxDamage) {
+    // If we increase the damage stat too high, then the tears will become bigger than the screen.
+    // Instead, increase the collision damage of the tear.
+    tear.CollisionDamage *= 1000;
+
+    // Change the visual of the tear so that it is more clear that we have debug-damage turned on.
+    tear.ChangeVariant(TearVariant.TOOTH);
+  }
+}