isaacscript-common 2.3.0 → 2.3.1

package/features/debugDisplay/exports.d.ts

@@ -0,0 +1,199 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * 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 declare function setPlayerDisplay(textCallback: (player: EntityPlayer) => string): void;
+/**
+ * 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 declare function setTearDisplay(textCallback: (tear: EntityTear) => string): void;
+/**
+ * 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 declare function setFamiliarDisplay(textCallback: (familiar: EntityFamiliar) => string): void;
+/**
+ * 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 declare function setBombDisplay(textCallback: (bomb: EntityBomb) => string): void;
+/**
+ * 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 declare function setPickupDisplay(textCallback: (pickup: EntityPickup) => string): void;
+/**
+ * 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 declare function setSlotDisplay(textCallback: (slot: Entity) => string): void;
+/**
+ * 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 declare function setLaserDisplay(textCallback: (laser: EntityLaser) => string): void;
+/**
+ * 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 declare function setKnifeDisplay(textCallback: (knife: EntityKnife) => string): void;
+/**
+ * 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 declare function setProjectileDisplay(textCallback: (projectile: EntityProjectile) => string): void;
+/**
+ * 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 declare function setEffectDisplay(textCallback: (effect: EntityEffect) => string): void;
+/**
+ * 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 declare function setNPCDisplay(textCallback: (npc: EntityNPC) => string): void;
+/**
+ * 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 declare function setRockDisplay(textCallback: (rock: GridEntityRock) => string): void;
+/**
+ * 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 declare function setPitDisplay(textCallback: (pit: GridEntityPit) => string): void;
+/**
+ * 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 declare function setSpikesDisplay(textCallback: (spikes: GridEntitySpikes) => string): void;
+/**
+ * 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 declare function setTNTDisplay(textCallback: (tnt: GridEntityTNT) => string): void;
+/**
+ * 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 declare function setPoopDisplay(textCallback: (poop: GridEntityPoop) => string): void;
+/**
+ * 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 declare function setDoorDisplay(textCallback: (door: GridEntityDoor) => string): void;
+/**
+ * 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 declare function setPressurePlateDisplay(textCallback: (pressurePlate: GridEntityPressurePlate) => string): void;
+/**
+ * Toggles the debug display for players. This is the function that runs when you use the
+ * "playerDisplay" custom console command.
+ */
+export declare function togglePlayerDisplay(): void;
+/**
+ * Toggles the debug display for tears. This is the function that runs when you use the
+ * "tearDisplay" custom console command.
+ */
+export declare function toggleTearDisplay(): void;
+/**
+ * Toggles the debug display for familiars. This is the function that runs when you use the
+ * "familiarDisplay" custom console command.
+ */
+export declare function toggleFamiliarDisplay(): void;
+/**
+ * Toggles the debug display for bombs. This is the function that runs when you use the
+ * "bombDisplay" custom console command.
+ */
+export declare function toggleBombDisplay(): void;
+/**
+ * Toggles the debug display for pickups. This is the function that runs when you use the
+ * "pickupDisplay" custom console command.
+ */
+export declare function togglePickupDisplay(): void;
+/**
+ * Toggles the debug display for slots. This is the function that runs when you use the
+ * "slotDisplay" custom console command.
+ */
+export declare function toggleSlotDisplay(): void;
+/**
+ * Toggles the debug display for lasers. This is the function that runs when you use the
+ * "laserDisplay" custom console command.
+ */
+export declare function toggleLaserDisplay(): void;
+/**
+ * Toggles the debug display for knives. This is the function that runs when you use the
+ * "knifeDisplay" custom console command.
+ */
+export declare function toggleKnifeDisplay(): void;
+/**
+ * Toggles the debug display for projectiles. This is the function that runs when you use the
+ * "projectileDisplay" custom console command.
+ */
+export declare function toggleProjectileDisplay(): void;
+/**
+ * Toggles the debug display for effects. This is the function that runs when you use the
+ * "effectDisplay" custom console command.
+ */
+export declare function toggleEffectDisplay(): void;
+/**
+ * Toggles the debug display for NPCs. This is the function that runs when you use the "npcDisplay"
+ * custom console command.
+ */
+export declare function toggleNPCDisplay(): void;
+/**
+ * Toggles the debug display for rocks. This is the function that runs when you use the
+ * "rockDisplay" custom console command.
+ */
+export declare function toggleRockDisplay(): void;
+/**
+ * Toggles the debug display for pits. This is the function that runs when you use the "pitDisplay"
+ * custom console command.
+ */
+export declare function togglePitDisplay(): void;
+/**
+ * Toggles the debug display for spikes. This is the function that runs when you use the
+ * "spikesDisplay" custom console command.
+ */
+export declare function toggleSpikesDisplay(): void;
+/**
+ * Toggles the debug display for TNT. This is the function that runs when you use the "tntDisplay"
+ * custom console command.
+ */
+export declare function toggleTNTDisplay(): void;
+/**
+ * Toggles the debug display for poop. This is the function that runs when you use the "poopDisplay"
+ * custom console command.
+ */
+export declare function togglePoopDisplay(): void;
+/**
+ * Toggles the debug display for doors. This is the function that runs when you use the
+ * "doorDisplay" custom console command.
+ */
+export declare function toggleDoorDisplay(): void;
+/**
+ * Toggles the debug display for pressure plates. This is the function that runs when you use the
+ * "pressurePlateDisplay" custom console command.
+ */
+export declare function togglePressurePlateDisplay(): void;

package/features/debugDisplay/exports.lua

@@ -0,0 +1,133 @@
+local ____exports = {}
+local ____utils = require("functions.utils")
+local printEnabled = ____utils.printEnabled
+local ____v = require("features.debugDisplay.v")
+local v = ____v.default
+local debugDisplayTextCallbacks = ____v.debugDisplayTextCallbacks
+function ____exports.setPlayerDisplay(self, textCallback)
+    debugDisplayTextCallbacks.player = textCallback
+end
+function ____exports.setTearDisplay(self, textCallback)
+    debugDisplayTextCallbacks.tear = textCallback
+end
+function ____exports.setFamiliarDisplay(self, textCallback)
+    debugDisplayTextCallbacks.familiar = textCallback
+end
+function ____exports.setBombDisplay(self, textCallback)
+    debugDisplayTextCallbacks.bomb = textCallback
+end
+function ____exports.setPickupDisplay(self, textCallback)
+    debugDisplayTextCallbacks.pickup = textCallback
+end
+function ____exports.setSlotDisplay(self, textCallback)
+    debugDisplayTextCallbacks.slot = textCallback
+end
+function ____exports.setLaserDisplay(self, textCallback)
+    debugDisplayTextCallbacks.laser = textCallback
+end
+function ____exports.setKnifeDisplay(self, textCallback)
+    debugDisplayTextCallbacks.knife = textCallback
+end
+function ____exports.setProjectileDisplay(self, textCallback)
+    debugDisplayTextCallbacks.projectile = textCallback
+end
+function ____exports.setEffectDisplay(self, textCallback)
+    debugDisplayTextCallbacks.effect = textCallback
+end
+function ____exports.setNPCDisplay(self, textCallback)
+    debugDisplayTextCallbacks.npc = textCallback
+end
+function ____exports.setRockDisplay(self, textCallback)
+    debugDisplayTextCallbacks.rock = textCallback
+end
+function ____exports.setPitDisplay(self, textCallback)
+    debugDisplayTextCallbacks.pit = textCallback
+end
+function ____exports.setSpikesDisplay(self, textCallback)
+    debugDisplayTextCallbacks.spikes = textCallback
+end
+function ____exports.setTNTDisplay(self, textCallback)
+    debugDisplayTextCallbacks.tnt = textCallback
+end
+function ____exports.setPoopDisplay(self, textCallback)
+    debugDisplayTextCallbacks.poop = textCallback
+end
+function ____exports.setDoorDisplay(self, textCallback)
+    debugDisplayTextCallbacks.door = textCallback
+end
+function ____exports.setPressurePlateDisplay(self, textCallback)
+    debugDisplayTextCallbacks.pressurePlate = textCallback
+end
+function ____exports.togglePlayerDisplay(self)
+    v.run.player = not v.run.player
+    printEnabled(nil, v.run.player, "player display")
+end
+function ____exports.toggleTearDisplay(self)
+    v.run.tear = not v.run.tear
+    printEnabled(nil, v.run.tear, "tear display")
+end
+function ____exports.toggleFamiliarDisplay(self)
+    v.run.familiar = not v.run.familiar
+    printEnabled(nil, v.run.familiar, "familiar display")
+end
+function ____exports.toggleBombDisplay(self)
+    v.run.bomb = not v.run.bomb
+    printEnabled(nil, v.run.bomb, "bomb display")
+end
+function ____exports.togglePickupDisplay(self)
+    v.run.pickup = not v.run.pickup
+    printEnabled(nil, v.run.pickup, "pickup display")
+end
+function ____exports.toggleSlotDisplay(self)
+    v.run.slot = not v.run.slot
+    printEnabled(nil, v.run.slot, "slot display")
+end
+function ____exports.toggleLaserDisplay(self)
+    v.run.laser = not v.run.laser
+    printEnabled(nil, v.run.laser, "laser display")
+end
+function ____exports.toggleKnifeDisplay(self)
+    v.run.knife = not v.run.knife
+    printEnabled(nil, v.run.knife, "knife display")
+end
+function ____exports.toggleProjectileDisplay(self)
+    v.run.projectile = not v.run.projectile
+    printEnabled(nil, v.run.projectile, "projectile display")
+end
+function ____exports.toggleEffectDisplay(self)
+    v.run.effect = not v.run.effect
+    printEnabled(nil, v.run.effect, "effect display")
+end
+function ____exports.toggleNPCDisplay(self)
+    v.run.npc = not v.run.npc
+    printEnabled(nil, v.run.npc, "NPC display")
+end
+function ____exports.toggleRockDisplay(self)
+    v.run.rock = not v.run.rock
+    printEnabled(nil, v.run.rock, "rock display")
+end
+function ____exports.togglePitDisplay(self)
+    v.run.pit = not v.run.pit
+    printEnabled(nil, v.run.pit, "pit display")
+end
+function ____exports.toggleSpikesDisplay(self)
+    v.run.spikes = not v.run.spikes
+    printEnabled(nil, v.run.spikes, "spikes display")
+end
+function ____exports.toggleTNTDisplay(self)
+    v.run.tnt = not v.run.tnt
+    printEnabled(nil, v.run.tnt, "TNT display")
+end
+function ____exports.togglePoopDisplay(self)
+    v.run.poop = not v.run.poop
+    printEnabled(nil, v.run.poop, "poop display")
+end
+function ____exports.toggleDoorDisplay(self)
+    v.run.door = not v.run.door
+    printEnabled(nil, v.run.door, "door display")
+end
+function ____exports.togglePressurePlateDisplay(self)
+    v.run.pressurePlate = not v.run.pressurePlate
+    printEnabled(nil, v.run.pressurePlate, "pressure plate display")
+end
+return ____exports

package/features/debugDisplay/v.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="isaac-typescript-definitions" />
+declare const v: {
+    run: {
+        player: boolean;
+        tear: boolean;
+        familiar: boolean;
+        bomb: boolean;
+        pickup: boolean;
+        slot: boolean;
+        laser: boolean;
+        knife: boolean;
+        projectile: boolean;
+        effect: boolean;
+        npc: boolean;
+        rock: boolean;
+        pit: boolean;
+        spikes: boolean;
+        tnt: boolean;
+        poop: boolean;
+        door: boolean;
+        pressurePlate: boolean;
+    };
+};
+export default v;
+export declare const debugDisplayTextCallbacks: {
+    player: (player: EntityPlayer) => string;
+    tear: (tear: EntityTear) => string;
+    familiar: (familiar: EntityFamiliar) => string;
+    bomb: (bomb: EntityBomb) => string;
+    pickup: (pickup: EntityPickup) => string;
+    slot: (familiar: Entity) => string;
+    laser: (laser: EntityLaser) => string;
+    knife: (knife: EntityKnife) => string;
+    projectile: (projectile: EntityProjectile) => string;
+    effect: (effect: EntityEffect) => string;
+    npc: (effect: EntityNPC) => string;
+    rock: (rock: GridEntityRock) => string;
+    pit: (pit: GridEntityPit) => string;
+    spikes: (spikes: GridEntitySpikes) => string;
+    tnt: (tnt: GridEntityTNT) => string;
+    poop: (poop: GridEntityPoop) => string;
+    door: (door: GridEntityDoor) => string;
+    pressurePlate: (pressurePlate: GridEntityPressurePlate) => string;
+};

package/features/debugDisplay/v.lua

@@ -0,0 +1,54 @@
+local ____exports = {}
+local defaultEntityDisplayCallback, defaultGridEntityDisplayCallback
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
+local ____gridEntity = require("functions.gridEntity")
+local getGridEntityID = ____gridEntity.getGridEntityID
+function defaultEntityDisplayCallback(self, entity)
+    return getEntityID(nil, entity)
+end
+function defaultGridEntityDisplayCallback(self, gridEntity)
+    return getGridEntityID(nil, gridEntity)
+end
+local v = {run = {
+    player = false,
+    tear = false,
+    familiar = false,
+    bomb = false,
+    pickup = false,
+    slot = false,
+    laser = false,
+    knife = false,
+    projectile = false,
+    effect = false,
+    npc = false,
+    rock = false,
+    pit = false,
+    spikes = false,
+    tnt = false,
+    poop = false,
+    door = false,
+    pressurePlate = false
+}}
+____exports.default = v
+____exports.debugDisplayTextCallbacks = {
+    player = defaultEntityDisplayCallback,
+    tear = defaultEntityDisplayCallback,
+    familiar = defaultEntityDisplayCallback,
+    bomb = defaultEntityDisplayCallback,
+    pickup = defaultEntityDisplayCallback,
+    slot = defaultEntityDisplayCallback,
+    laser = defaultEntityDisplayCallback,
+    knife = defaultEntityDisplayCallback,
+    projectile = defaultEntityDisplayCallback,
+    effect = defaultEntityDisplayCallback,
+    npc = defaultEntityDisplayCallback,
+    rock = defaultGridEntityDisplayCallback,
+    pit = defaultGridEntityDisplayCallback,
+    spikes = defaultGridEntityDisplayCallback,
+    tnt = defaultGridEntityDisplayCallback,
+    poop = defaultGridEntityDisplayCallback,
+    door = defaultGridEntityDisplayCallback,
+    pressurePlate = defaultGridEntityDisplayCallback
+}
+return ____exports

package/features/deployJSONRoom.d.ts

@@ -0,0 +1,65 @@
+/// <reference types="isaac-typescript-definitions" />
+import { JSONRoom } from "../interfaces/JSONRoom";
+/**
+ * Helper function to deconstruct a vanilla room and set up a custom room in its place.
+ * Specifically, this will clear the current room of all entities and grid entities, and then spawn
+ * all of the entries and grid entities in the provided JSON room.
+ *
+ * This function is meant to be used in the PostNewRoom callback.
+ *
+ * For example:
+ *
+ * ```ts
+ *
+ * import customRooms from "./customRooms";
+ *
+ * const firstJSONRoom = customRooms.rooms.room[0];
+ * deployJSONRoom(firstJSONRoom);
+ * ```
+ *
+ * @param jsonRoom The JSON room to deploy. *
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+ *                what the function is doing. Default is false.
+ */
+export declare function deployJSONRoom(jsonRoom: JSONRoom, seedOrRNG?: Seed | RNG, verbose?: boolean): void;
+/**
+ * Helper function to deconstruct a vanilla room and set up a custom room in its place.
+ * Specifically, this will clear the current room of all entities and grid entities, and then spawn
+ * all of the entries and grid entities in one of the provided JSON rooms.
+ *
+ * This function is meant to be used in the PostNewRoom callback.
+ *
+ * Note that this function does not simply choose a random element in the provided array; it will
+ * properly account for each room weight using the algorithm from:
+ * https://stackoverflow.com/questions/1761626/weighted-random-numbers
+ *
+ * For example:
+ *
+ * ```ts
+ * import customRooms from "./customRooms";
+ *
+ * const jsonRooms = customRooms.rooms.room;
+ * deployRandomJSONRoom(jsonRooms);
+ * ```
+ *
+ * @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be
+ *                  something like.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+ *                what the function is doing. Default is false.
+ */
+export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
+/**
+ * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
+ * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
+ * (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
+ * effects (1000), doors, and walls.
+ *
+ * @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
+ *                            decoration, which prevents vanilla entities in the room from
+ *                            respawning the next time that the player enters. Default is false.
+ */
+export declare function emptyRoom(fillWithDecorations: boolean): void;