isaacscript-common 2.2.0 → 2.3.0

package/src/features/debugDisplay/exports.ts

@@ -0,0 +1,368 @@
+/* eslint-disable sort-exports/sort-exports */
+
+import { printEnabled } from "../../functions/utils";
+import v, { debugDisplayTextCallbacks } from "./v";
+
+// -------------
+// Set Functions
+// -------------
+
+/**
+ * After using the "playerDisplay" console command, text will be drawn on each player for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setPlayerDisplay(
+  textCallback: (player: EntityPlayer) => string,
+): void {
+  debugDisplayTextCallbacks.player = textCallback;
+}
+
+/**
+ * After using the "tearDisplay" console command, text will be drawn on each tear for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setTearDisplay(
+  textCallback: (tear: EntityTear) => string,
+): void {
+  debugDisplayTextCallbacks.tear = textCallback;
+}
+
+/**
+ * After using the "familiarDisplay" console command, text will be drawn on each familiar for
+ * debugging purposes. Use this function to specify a callback function that will returns the string
+ * that should be drawn.
+ */
+export function setFamiliarDisplay(
+  textCallback: (familiar: EntityFamiliar) => string,
+): void {
+  debugDisplayTextCallbacks.familiar = textCallback;
+}
+
+/**
+ * After using the "bombDisplay" console command, text will be drawn on each bomb for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setBombDisplay(
+  textCallback: (bomb: EntityBomb) => string,
+): void {
+  debugDisplayTextCallbacks.bomb = textCallback;
+}
+
+/**
+ * After using the "pickupDisplay" console command, text will be drawn on each pickup for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setPickupDisplay(
+  textCallback: (pickup: EntityPickup) => string,
+): void {
+  debugDisplayTextCallbacks.pickup = textCallback;
+}
+
+/**
+ * After using the "slotDisplay" console command, text will be drawn on each slot for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setSlotDisplay(textCallback: (slot: Entity) => string): void {
+  debugDisplayTextCallbacks.slot = textCallback;
+}
+
+/**
+ * After using the "laserDisplay" console command, text will be drawn on each laser for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setLaserDisplay(
+  textCallback: (laser: EntityLaser) => string,
+): void {
+  debugDisplayTextCallbacks.laser = textCallback;
+}
+
+/**
+ * After using the "knifeDisplay" console command, text will be drawn on each knife for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setKnifeDisplay(
+  textCallback: (knife: EntityKnife) => string,
+): void {
+  debugDisplayTextCallbacks.knife = textCallback;
+}
+
+/**
+ * After using the "projectileDisplay" console command, text will be drawn on each projectile for
+ * debugging purposes. Use this function to specify a callback function that will returns the string
+ * that should be drawn.
+ */
+export function setProjectileDisplay(
+  textCallback: (projectile: EntityProjectile) => string,
+): void {
+  debugDisplayTextCallbacks.projectile = textCallback;
+}
+
+/**
+ * After using the "effectDisplay" console command, text will be drawn on each effect for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setEffectDisplay(
+  textCallback: (effect: EntityEffect) => string,
+): void {
+  debugDisplayTextCallbacks.effect = textCallback;
+}
+
+/**
+ * After using the "npcDisplay" console command, text will be drawn on each NPC for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setNPCDisplay(textCallback: (npc: EntityNPC) => string): void {
+  debugDisplayTextCallbacks.npc = textCallback;
+}
+
+/**
+ * After using the "rockDisplay" console command, text will be drawn on each rock for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setRockDisplay(
+  textCallback: (rock: GridEntityRock) => string,
+): void {
+  debugDisplayTextCallbacks.rock = textCallback;
+}
+
+/**
+ * After using the "pitDisplay" console command, text will be drawn on each pit for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setPitDisplay(
+  textCallback: (pit: GridEntityPit) => string,
+): void {
+  debugDisplayTextCallbacks.pit = textCallback;
+}
+
+/**
+ * After using the "spikesDisplay" console command, text will be drawn on each spikes for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setSpikesDisplay(
+  textCallback: (spikes: GridEntitySpikes) => string,
+): void {
+  debugDisplayTextCallbacks.spikes = textCallback;
+}
+
+/**
+ * After using the "tntDisplay" console command, text will be drawn on each TNT for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setTNTDisplay(
+  textCallback: (tnt: GridEntityTNT) => string,
+): void {
+  debugDisplayTextCallbacks.tnt = textCallback;
+}
+
+/**
+ * After using the "poopDisplay" console command, text will be drawn on each poop for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setPoopDisplay(
+  textCallback: (poop: GridEntityPoop) => string,
+): void {
+  debugDisplayTextCallbacks.poop = textCallback;
+}
+
+/**
+ * After using the "poopDisplay" console command, text will be drawn on each poop for debugging
+ * purposes. Use this function to specify a callback function that will returns the string that
+ * should be drawn.
+ */
+export function setDoorDisplay(
+  textCallback: (door: GridEntityDoor) => string,
+): void {
+  debugDisplayTextCallbacks.door = textCallback;
+}
+
+/**
+ * After using the "pressurePlateDisplay" console command, text will be drawn on each pressure plate
+ * for debugging purposes. Use this function to specify a callback function that will returns the
+ * string that should be drawn.
+ */
+export function setPressurePlateDisplay(
+  textCallback: (pressurePlate: GridEntityPressurePlate) => string,
+): void {
+  debugDisplayTextCallbacks.pressurePlate = textCallback;
+}
+
+// ----------------
+// Toggle Functions
+// ----------------
+
+/**
+ * Toggles the debug display for players. This is the function that runs when you use the
+ * "playerDisplay" custom console command.
+ */
+export function togglePlayerDisplay(): void {
+  v.run.player = !v.run.player;
+  printEnabled(v.run.player, "player display");
+}
+
+/**
+ * Toggles the debug display for tears. This is the function that runs when you use the
+ * "tearDisplay" custom console command.
+ */
+export function toggleTearDisplay(): void {
+  v.run.tear = !v.run.tear;
+  printEnabled(v.run.tear, "tear display");
+}
+
+/**
+ * Toggles the debug display for familiars. This is the function that runs when you use the
+ * "familiarDisplay" custom console command.
+ */
+export function toggleFamiliarDisplay(): void {
+  v.run.familiar = !v.run.familiar;
+  printEnabled(v.run.familiar, "familiar display");
+}
+
+/**
+ * Toggles the debug display for bombs. This is the function that runs when you use the
+ * "bombDisplay" custom console command.
+ */
+export function toggleBombDisplay(): void {
+  v.run.bomb = !v.run.bomb;
+  printEnabled(v.run.bomb, "bomb display");
+}
+
+/**
+ * Toggles the debug display for pickups. This is the function that runs when you use the
+ * "pickupDisplay" custom console command.
+ */
+export function togglePickupDisplay(): void {
+  v.run.pickup = !v.run.pickup;
+  printEnabled(v.run.pickup, "pickup display");
+}
+
+/**
+ * Toggles the debug display for slots. This is the function that runs when you use the
+ * "slotDisplay" custom console command.
+ */
+export function toggleSlotDisplay(): void {
+  v.run.slot = !v.run.slot;
+  printEnabled(v.run.slot, "slot display");
+}
+
+/**
+ * Toggles the debug display for lasers. This is the function that runs when you use the
+ * "laserDisplay" custom console command.
+ */
+export function toggleLaserDisplay(): void {
+  v.run.laser = !v.run.laser;
+  printEnabled(v.run.laser, "laser display");
+}
+
+/**
+ * Toggles the debug display for knives. This is the function that runs when you use the
+ * "knifeDisplay" custom console command.
+ */
+export function toggleKnifeDisplay(): void {
+  v.run.knife = !v.run.knife;
+  printEnabled(v.run.knife, "knife display");
+}
+
+/**
+ * Toggles the debug display for projectiles. This is the function that runs when you use the
+ * "projectileDisplay" custom console command.
+ */
+export function toggleProjectileDisplay(): void {
+  v.run.projectile = !v.run.projectile;
+  printEnabled(v.run.projectile, "projectile display");
+}
+
+/**
+ * Toggles the debug display for effects. This is the function that runs when you use the
+ * "effectDisplay" custom console command.
+ */
+export function toggleEffectDisplay(): void {
+  v.run.effect = !v.run.effect;
+  printEnabled(v.run.effect, "effect display");
+}
+
+/**
+ * Toggles the debug display for NPCs. This is the function that runs when you use the "npcDisplay"
+ * custom console command.
+ */
+export function toggleNPCDisplay(): void {
+  v.run.npc = !v.run.npc;
+  printEnabled(v.run.npc, "NPC display");
+}
+
+/**
+ * Toggles the debug display for rocks. This is the function that runs when you use the
+ * "rockDisplay" custom console command.
+ */
+export function toggleRockDisplay(): void {
+  v.run.rock = !v.run.rock;
+  printEnabled(v.run.rock, "rock display");
+}
+
+/**
+ * Toggles the debug display for pits. This is the function that runs when you use the "pitDisplay"
+ * custom console command.
+ */
+export function togglePitDisplay(): void {
+  v.run.pit = !v.run.pit;
+  printEnabled(v.run.pit, "pit display");
+}
+
+/**
+ * Toggles the debug display for spikes. This is the function that runs when you use the
+ * "spikesDisplay" custom console command.
+ */
+export function toggleSpikesDisplay(): void {
+  v.run.spikes = !v.run.spikes;
+  printEnabled(v.run.spikes, "spikes display");
+}
+
+/**
+ * Toggles the debug display for TNT. This is the function that runs when you use the "tntDisplay"
+ * custom console command.
+ */
+export function toggleTNTDisplay(): void {
+  v.run.tnt = !v.run.tnt;
+  printEnabled(v.run.tnt, "TNT display");
+}
+
+/**
+ * Toggles the debug display for poop. This is the function that runs when you use the "poopDisplay"
+ * custom console command.
+ */
+export function togglePoopDisplay(): void {
+  v.run.poop = !v.run.poop;
+  printEnabled(v.run.poop, "poop display");
+}
+
+/**
+ * Toggles the debug display for doors. This is the function that runs when you use the
+ * "doorDisplay" custom console command.
+ */
+export function toggleDoorDisplay(): void {
+  v.run.door = !v.run.door;
+  printEnabled(v.run.door, "door display");
+}
+
+/**
+ * Toggles the debug display for pressure plates. This is the function that runs when you use the
+ * "pressurePlateDisplay" custom console command.
+ */
+export function togglePressurePlateDisplay(): void {
+  v.run.pressurePlate = !v.run.pressurePlate;
+  printEnabled(v.run.pressurePlate, "pressure plate display");
+}

package/src/features/debugDisplay/v.ts

@@ -0,0 +1,65 @@
+import { getEntityID } from "../../functions/entity";
+import { getGridEntityID } from "../../functions/gridEntity";
+
+const v = {
+  run: {
+    player: false, // 1
+    tear: false, // 2
+    familiar: false, // 3
+    bomb: false, // 4
+    pickup: false, // 5
+    slot: false, // 6
+    laser: false, // 7
+    knife: false, // 8
+    projectile: false, // 9
+    effect: false, // 1000
+    npc: false,
+
+    rock: false, // 2, 3, 4, 5, 6, 22, 24, 25, 26, 27
+    pit: false, // 7
+    spikes: false, // 8, 9
+    tnt: false, // 12
+    poop: false, // 14
+    door: false, // 16
+    pressurePlate: false, // 20
+  },
+};
+export default v;
+
+export const debugDisplayTextCallbacks = {
+  player: defaultEntityDisplayCallback as (player: EntityPlayer) => string, // 1
+  tear: defaultEntityDisplayCallback as (tear: EntityTear) => string, // 2
+  familiar: defaultEntityDisplayCallback as (
+    familiar: EntityFamiliar,
+  ) => string, // 3
+  bomb: defaultEntityDisplayCallback as (bomb: EntityBomb) => string, // 4
+  pickup: defaultEntityDisplayCallback as (pickup: EntityPickup) => string, // 5
+  slot: defaultEntityDisplayCallback as (familiar: Entity) => string, // 6
+  laser: defaultEntityDisplayCallback as (laser: EntityLaser) => string, // 7
+  knife: defaultEntityDisplayCallback as (knife: EntityKnife) => string, // 8
+  projectile: defaultEntityDisplayCallback as (
+    projectile: EntityProjectile,
+  ) => string, // 9
+  effect: defaultEntityDisplayCallback as (effect: EntityEffect) => string, // 1000
+  npc: defaultEntityDisplayCallback as (effect: EntityNPC) => string,
+
+  rock: defaultGridEntityDisplayCallback as (rock: GridEntityRock) => string, // 2, 3, 4, 5, 6, 22, 24, 25, 26, 27
+  pit: defaultGridEntityDisplayCallback as (pit: GridEntityPit) => string, // 7
+  spikes: defaultGridEntityDisplayCallback as (
+    spikes: GridEntitySpikes,
+  ) => string, // 8, 9
+  tnt: defaultGridEntityDisplayCallback as (tnt: GridEntityTNT) => string, // 12
+  poop: defaultGridEntityDisplayCallback as (poop: GridEntityPoop) => string, // 14
+  door: defaultGridEntityDisplayCallback as (door: GridEntityDoor) => string, // 16
+  pressurePlate: defaultGridEntityDisplayCallback as (
+    pressurePlate: GridEntityPressurePlate,
+  ) => string, // 20
+};
+
+function defaultEntityDisplayCallback(entity: Entity) {
+  return getEntityID(entity);
+}
+
+function defaultGridEntityDisplayCallback(gridEntity: GridEntity) {
+  return getGridEntityID(gridEntity);
+}