isaacscript-common 6.1.1 → 6.3.0

package/features/customStage/util.lua

@@ -0,0 +1,51 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local ____exports = {}
+local getTotalWeightOfCustomStageRooms, getCustomStageRoomWithChosenWeight
+local ____array = require("functions.array")
+local sumArray = ____array.sumArray
+local ____log = require("functions.log")
+local log = ____log.log
+local ____random = require("functions.random")
+local getRandomFloat = ____random.getRandomFloat
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+function getTotalWeightOfCustomStageRooms(self, roomsMetadata)
+    local weights = __TS__ArrayMap(
+        roomsMetadata,
+        function(____, roomMetadata) return roomMetadata.weight end
+    )
+    return sumArray(nil, weights)
+end
+function getCustomStageRoomWithChosenWeight(self, roomsMetadata, chosenWeight)
+    for ____, roomMetadata in ipairs(roomsMetadata) do
+        if chosenWeight < roomMetadata.weight then
+            return roomMetadata
+        end
+        chosenWeight = chosenWeight - roomMetadata.weight
+    end
+    error("Failed to get a custom stage room with chosen weight: " .. tostring(chosenWeight))
+end
+--- Helper function to get a random custom stage room from an array of custom stage rooms.
+-- 
+-- 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
+function ____exports.getRandomCustomStageRoom(self, roomsMetadata, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if verbose == nil then
+        verbose = false
+    end
+    local totalWeight = getTotalWeightOfCustomStageRooms(nil, roomsMetadata)
+    if verbose then
+        log("Total weight of the custom stage rooms provided: " .. tostring(totalWeight))
+    end
+    local chosenWeight = getRandomFloat(nil, 0, totalWeight, seedOrRNG)
+    if verbose then
+        log("Randomly chose weight for custom stage room: " .. tostring(chosenWeight))
+    end
+    return getCustomStageRoomWithChosenWeight(nil, roomsMetadata, chosenWeight)
+end
+return ____exports

package/features/customStage/v.d.ts

@@ -1,2 +1,13 @@
+/// <reference types="isaac-typescript-definitions" />
 import { CustomStage } from "../../interfaces/CustomStage";
+declare const v: {
+    run: {
+        currentCustomStage: CustomStage | null;
+        showingBossVersusScreen: boolean;
+    };
+};
+export default v;
+/** Indexed by custom stage name. */
 export declare const customStagesMap: Map<string, CustomStage>;
+/** Indexed by room variant. */
+export declare const customStageCachedRoomData: Map<number, Readonly<RoomConfig>>;

package/features/customStage/v.lua

@@ -2,5 +2,10 @@ local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local v = {run = {currentCustomStage = nil, showingBossVersusScreen = false}}
+____exports.default = v
+--- Indexed by custom stage name.
 ____exports.customStagesMap = __TS__New(Map)
+--- Indexed by room variant.
+____exports.customStageCachedRoomData = __TS__New(Map)
 return ____exports

package/features/debugDisplay/debugDisplay.lua

@@ -11,6 +11,7 @@ local saveDataManager = ____exports.saveDataManager
 local ____v = require("features.debugDisplay.v")
 local v = ____v.default
 local debugDisplayTextCallbacks = ____v.debugDisplayTextCallbacks
+local setDebugDisplayEnabled = ____v.setDebugDisplayEnabled
 function renderTextOnEntity(self, entity, text)
     if isReflectionRender(nil) then
         return
@@ -155,6 +156,7 @@ end
 --- The debug display feature is only initialized when the extra console commands feature is
 -- initialized.
 function ____exports.debugDisplayInit(self, mod)
+    setDebugDisplayEnabled(nil)
     saveDataManager(
         nil,
         "debugDisplay",

package/features/debugDisplay/exports.d.ts

@@ -20,197 +20,305 @@
  * 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this console command to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 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.
+ *
+ * Note that you have to run the `enableExtraConsoleCommands` function once at the beginning of your
+ * mod in order for this feature to work.
  */
 export declare function togglePressurePlateDisplay(): void;