isaacscript-common 14.2.0 → 15.0.1

package/dist/src/classes/features/other/CustomHotkeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomHotkeys.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomHotkeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,8BAA8B,CAAC;AAIrE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,aAAc,SAAQ,OAAO;IACxC;;;OAGG;IACH,OAAO,CAAC,uBAAuB,CAAmC;IAElE;;;OAGG;IACH,OAAO,CAAC,wBAAwB,CAG5B;IAEJ,OAAO,CAAC,aAAa,CAA4C;IAYjE,OAAO,CAAC,UAAU,CAiBhB;IAEF,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;;;;;;;OAeG;IAEI,oBAAoB,CACzB,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,EACtC,WAAW,EAAE,MAAM,IAAI,GACtB,IAAI;IAUP;;;;;;;;;;;OAWG;IAEI,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,IAAI,GAAG,IAAI;IAUnE;;;;;;;OAOG;IAEI,sBAAsB,CAAC,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,GAAG,IAAI;IAU3E;;;;;;;OAOG;IAEI,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CAS7C"}

package/dist/src/classes/features/other/CustomHotkeys.lua

@@ -0,0 +1,82 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Keyboard = ____isaac_2Dtypescript_2Ddefinitions.Keyboard
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____input = require("src.functions.input")
+local isKeyboardPressed = ____input.isKeyboardPressed
+local ____DefaultMap = require("src.classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+____exports.CustomHotkeys = __TS__Class()
+local CustomHotkeys = ____exports.CustomHotkeys
+CustomHotkeys.name = "CustomHotkeys"
+__TS__ClassExtends(CustomHotkeys, Feature)
+function CustomHotkeys.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.staticHotkeyFunctionMap = __TS__New(Map)
+    self.dynamicHotkeyFunctionMap = __TS__New(Map)
+    self.keyPressedMap = __TS__New(DefaultMap, false)
+    self.postRender = function()
+        for ____, ____value in __TS__Iterator(self.staticHotkeyFunctionMap:entries()) do
+            local keyboard = ____value[1]
+            local triggerFunc = ____value[2]
+            self:checkIfTriggered(keyboard, triggerFunc)
+        end
+        for ____, ____value in __TS__Iterator(self.dynamicHotkeyFunctionMap:entries()) do
+            local keyboardFunc = ____value[1]
+            local triggerFunc = ____value[2]
+            local keyboard = keyboardFunc(nil)
+            if keyboard ~= nil then
+                self:checkIfTriggered(keyboard, triggerFunc)
+            end
+        end
+    end
+    self.callbacksUsed = {{ModCallback.POST_RENDER, {self.postRender}}}
+end
+function CustomHotkeys.prototype.checkIfTriggered(self, keyboard, triggerFunc)
+    local isPressed = isKeyboardPressed(nil, keyboard)
+    local wasPreviouslyPressed = self.keyPressedMap:getAndSetDefault(keyboard)
+    self.keyPressedMap:set(keyboard, isPressed)
+    if isPressed and not wasPreviouslyPressed then
+        triggerFunc(nil)
+    end
+end
+function CustomHotkeys.prototype.setConditionalHotkey(self, getKeyFunc, triggerFunc)
+    if self.dynamicHotkeyFunctionMap:has(getKeyFunc) then
+        error("Failed to register a hotkey due to a custom hotkey already being defined for the submitted function.")
+    end
+    self.dynamicHotkeyFunctionMap:set(getKeyFunc, triggerFunc)
+end
+function CustomHotkeys.prototype.setHotkey(self, keyboard, triggerFunc)
+    if self.staticHotkeyFunctionMap:has(keyboard) then
+        error(((("Failed to register a hotkey due to a hotkey already being defined for: Keyboard." .. tostring(Keyboard[keyboard])) .. " (") .. tostring(keyboard)) .. ")")
+    end
+    self.staticHotkeyFunctionMap:set(keyboard, triggerFunc)
+end
+function CustomHotkeys.prototype.unsetConditionalHotkey(self, getKeyFunc)
+    if not self.dynamicHotkeyFunctionMap:has(getKeyFunc) then
+        error("Failed to unregister a hotkey since there is no existing hotkey defined for the submitted function.")
+    end
+    self.dynamicHotkeyFunctionMap:delete(getKeyFunc)
+end
+function CustomHotkeys.prototype.unsetHotkey(self, keyboard)
+    if not self.staticHotkeyFunctionMap:has(keyboard) then
+        error(((("Failed to unregister a hotkey since there is no existing hotkey defined for: Keyboard." .. tostring(Keyboard[keyboard])) .. " (") .. tostring(keyboard)) .. ")")
+    end
+    self.staticHotkeyFunctionMap:delete(keyboard)
+end
+__TS__Decorate({Exported}, CustomHotkeys.prototype, "setConditionalHotkey", true)
+__TS__Decorate({Exported}, CustomHotkeys.prototype, "setHotkey", true)
+__TS__Decorate({Exported}, CustomHotkeys.prototype, "unsetConditionalHotkey", true)
+__TS__Decorate({Exported}, CustomHotkeys.prototype, "unsetHotkey", true)
+return ____exports

package/dist/src/classes/features/other/CustomItemPools.d.ts

@@ -0,0 +1,61 @@
+import { CollectibleType, ItemPoolType } from "isaac-typescript-definitions";
+import { WeightedArray } from "../../../types/WeightedArray";
+import { Feature } from "../../private/Feature";
+export declare class CustomItemPools extends Feature {
+    private customItemPoolMap;
+    private postGameStartedReordered;
+    /**
+     * Helper function to register a custom item pool. Use this function once when your mod first
+     * loads to declare the items that you want to be in the item pools. Then, in the middle of a run,
+     * you can use `getCustomItemPoolCollectible`.
+     *
+     * For example:
+     *
+     * ```ts
+     * const ItemPoolTypeCustom = {
+     *   FOO = 0 as ItemPoolType,
+     * } as const;
+     *
+     * const FOO_ITEM_POOL = [
+     *   [CollectibleType.SAD_ONION, 1],
+     *   [CollectibleType.INNER_EYE, 0.5],
+     * ];
+     *
+     * registerCustomItemPool(ItemPoolTypeCustom.FOO, FOO_ITEM_POOL);
+     * ```
+     *
+     * Note that custom item pools do not currently support partial weight decrementation on sight.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_ITEM_POOLS`.
+     *
+     * @param itemPoolTypeCustom An integer that identifies what kind of item pool you are creating.
+     *                           It should correspond to a local `ItemPoolTypeCustom` enum in your
+     *                           mod. The integer can be any unique value and can safely overlap with
+     *                           the vanilla item pool type values (or values chosen by other mods).
+     * @param collectibles An array of weighted collectible tuples that represent the item pool that
+     *                     you are creating. The first element in he tuple is the `CollectibleType`,
+     *                     and the second element in the tuple is the float that represents the weight
+     *                     of the collectible.
+     */
+    registerCustomItemPool(itemPoolTypeCustom: ItemPoolType, collectibles: WeightedArray<CollectibleType>): void;
+    /**
+     * Helper function to get a new collectible from a custom item pool created with the
+     * `registerCustomItemPool` function. This function has the same format as the
+     * `ItemPool.GetCollectible` method.
+     *
+     * By default, a collectible will not be removed from the pool once it is selected, unless the
+     * `decrease` argument is set to true (similar to how a vanilla item pool works).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_ITEM_POOLS`.
+     *
+     * @param itemPoolTypeCustom An integer representing the custom item pool to use.
+     * @param decrease Optional. Whether or not to remove the selected collectible from the item pool.
+     *                 Default is true.
+     * @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 defaultItem Optional. The collectible to return if the item pool is depleted. Default is
+     *                    `CollectibleType.NULL`.
+     */
+    getCustomItemPoolCollectible(itemPoolTypeCustom: ItemPoolType, decrease?: boolean, seedOrRNG?: Seed | RNG, defaultItem?: CollectibleType): CollectibleType;
+}
+//# sourceMappingURL=CustomItemPools.d.ts.map

package/dist/src/classes/features/other/CustomItemPools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomItemPools.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomItemPools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAO7E,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,eAAgB,SAAQ,OAAO;IAQ1C,OAAO,CAAC,iBAAiB,CAGrB;IAeJ,OAAO,CAAC,wBAAwB,CAM9B;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IAEI,sBAAsB,CAC3B,kBAAkB,EAAE,YAAY,EAChC,YAAY,EAAE,aAAa,CAAC,eAAe,CAAC,GAC3C,IAAI;IAUP;;;;;;;;;;;;;;;;;OAiBG;IAEI,4BAA4B,CACjC,kBAAkB,EAAE,YAAY,EAChC,QAAQ,UAAQ,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,WAAW,kBAAuB,GACjC,eAAe;CAuBnB"}

package/dist/src/classes/features/other/CustomItemPools.lua

@@ -0,0 +1,72 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____array = require("src.functions.array")
+local arrayRemoveIndexInPlace = ____array.arrayRemoveIndexInPlace
+local ____map = require("src.functions.map")
+local copyMap = ____map.copyMap
+local ____rng = require("src.functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local ____weighted = require("src.functions.weighted")
+local getRandomIndexFromWeightedArray = ____weighted.getRandomIndexFromWeightedArray
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+____exports.CustomItemPools = __TS__Class()
+local CustomItemPools = ____exports.CustomItemPools
+CustomItemPools.name = "CustomItemPools"
+__TS__ClassExtends(CustomItemPools, Feature)
+function CustomItemPools.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.v = {run = {customItemPools = __TS__New(Map)}}
+    self.customItemPoolMap = __TS__New(Map)
+    self.postGameStartedReordered = function(____, isContinued)
+        if isContinued then
+            return
+        end
+        self.v.run.customItemPools = copyMap(nil, self.customItemPoolMap)
+    end
+    self.customCallbacksUsed = {{ModCallbackCustom.POST_GAME_STARTED_REORDERED, {self.postGameStartedReordered}}}
+end
+function CustomItemPools.prototype.registerCustomItemPool(self, itemPoolTypeCustom, collectibles)
+    if self.customItemPoolMap:has(itemPoolTypeCustom) then
+        error(("Failed to register a custom item pool since the provided type of " .. tostring(itemPoolTypeCustom)) .. " was already registered.")
+    end
+    self.customItemPoolMap:set(itemPoolTypeCustom, collectibles)
+end
+function CustomItemPools.prototype.getCustomItemPoolCollectible(self, itemPoolTypeCustom, decrease, seedOrRNG, defaultItem)
+    if decrease == nil then
+        decrease = false
+    end
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if defaultItem == nil then
+        defaultItem = CollectibleType.NULL
+    end
+    local customItemPool = self.v.run.customItemPools:get(itemPoolTypeCustom)
+    if customItemPool == nil then
+        error("Failed to find the custom item pool of: " .. tostring(itemPoolTypeCustom))
+    end
+    if #customItemPool == 0 then
+        return defaultItem
+    end
+    local randomIndex = getRandomIndexFromWeightedArray(nil, customItemPool, seedOrRNG)
+    local tuple = customItemPool[randomIndex + 1]
+    if decrease then
+        arrayRemoveIndexInPlace(nil, customItemPool, randomIndex)
+    end
+    return tuple[1]
+end
+__TS__Decorate({Exported}, CustomItemPools.prototype, "registerCustomItemPool", true)
+__TS__Decorate({Exported}, CustomItemPools.prototype, "getCustomItemPoolCollectible", true)
+return ____exports

package/dist/src/classes/features/other/CustomPickups.d.ts

@@ -0,0 +1,36 @@
+import { PickupVariant } from "isaac-typescript-definitions";
+import { Feature } from "../../private/Feature";
+export declare class CustomPickups extends Feature {
+    /** Indexed by entity ID. */
+    private customPickupFunctionsMap;
+    private prePickupCollision;
+    private postEffectRenderPickupEffect;
+    /**
+     * Helper function to register a custom pickup with the IsaacScript standard library. Use this
+     * feature for custom pickups that are intended to be picked up by the player, like bombs and
+     * keys.
+     *
+     * When IsaacScript detects that a player should be collecting the custom pickup, then the pickup
+     * will be immediately removed, and an effect showing the pickup's respective `Collect` animation
+     * will be spawned. (This emulates how a normal vanilla pickup would work.) After that, the
+     * provided `collectFunc` will be fired. In this function, you will probably want to play a sound
+     * corresponding to what kind of pickup it is (e.g. `SoundEffect.KEY_PICKUP_GAUNTLET`), as well as
+     * do things like adding something to the player's inventory.
+     *
+     * Note that when you specify your custom pickup in the "entities2.xml" file, it should have a
+     * type of "5" and be associated with an anm2 file that has a "Collect" animation.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_PICKUPS`.
+     *
+     * @param pickupVariantCustom The variant for the corresponding custom pickup.
+     * @param subType The sub-type for the corresponding custom pickup.
+     * @param collectFunc The function to run when the player collects this pickup.
+     * @param collisionFunc Optional. The function to run when a player collides with the pickup.
+     *                      Default is a function that always returns true, meaning that the player
+     *                      will always immediately collect the pickup when they collide with it.
+     *                      Specify this function if your pickup should only be able to be collected
+     *                      under certain conditions.
+     */
+    registerCustomPickup(pickupVariantCustom: PickupVariant, subType: int, collectFunc: (this: void, player: EntityPlayer) => void, collisionFunc?: (this: void, player: EntityPlayer) => boolean): void;
+}
+//# sourceMappingURL=CustomPickups.d.ts.map

package/dist/src/classes/features/other/CustomPickups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomPickups.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomPickups.ts"],"names":[],"mappings":"AAIA,OAAO,EAIL,aAAa,EACd,MAAM,8BAA8B,CAAC;AAStC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAkBhD,qBAAa,aAAc,SAAQ,OAAO;IACxC,4BAA4B;IAC5B,OAAO,CAAC,wBAAwB,CAA4C;IAgB5E,OAAO,CAAC,kBAAkB,CAqCxB;IAKF,OAAO,CAAC,4BAA4B,CASlC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEI,oBAAoB,CACzB,mBAAmB,EAAE,aAAa,EAClC,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,EACvD,aAAa,GAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,KAAK,OAAoB,GACxE,IAAI;CAYR"}

package/dist/src/classes/features/other/CustomPickups.lua

@@ -0,0 +1,84 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____LadderSubTypeCustom = require("src.enums.LadderSubTypeCustom")
+local LadderSubTypeCustom = ____LadderSubTypeCustom.LadderSubTypeCustom
+local ____entities = require("src.functions.entities")
+local getEntityID = ____entities.getEntityID
+local getEntityIDFromConstituents = ____entities.getEntityIDFromConstituents
+local ____entitiesSpecific = require("src.functions.entitiesSpecific")
+local spawnEffect = ____entitiesSpecific.spawnEffect
+local ____types = require("src.functions.types")
+local asNumber = ____types.asNumber
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+--- Normally, we would make a custom entity to represent a fading-away pickup, but we don't want to
+-- interfere with the "entities2.xml" file in end-user mods. Thus, we must select a vanilla effect
+-- to masquerade as a backdrop effect.
+-- 
+-- We arbitrarily choose a ladder for this purpose because it will not automatically despawn after
+-- time passes, like most other effects.
+local PICKUP_EFFECT_VARIANT = EffectVariant.LADDER
+local PICKUP_EFFECT_SUB_TYPE = LadderSubTypeCustom.CUSTOM_PICKUP
+____exports.CustomPickups = __TS__Class()
+local CustomPickups = ____exports.CustomPickups
+CustomPickups.name = "CustomPickups"
+__TS__ClassExtends(CustomPickups, Feature)
+function CustomPickups.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.customPickupFunctionsMap = __TS__New(Map)
+    self.prePickupCollision = function(____, pickup, collider)
+        local entityID = getEntityID(nil, pickup)
+        local customPickupFunctions = self.customPickupFunctionsMap:get(entityID)
+        if customPickupFunctions == nil then
+            return nil
+        end
+        local player = collider:ToPlayer()
+        if player == nil then
+            return nil
+        end
+        local shouldPickup = customPickupFunctions.collisionFunc(player)
+        if not shouldPickup then
+            return nil
+        end
+        pickup:Remove()
+        local pickupSprite = pickup:GetSprite()
+        local fileName = pickupSprite:GetFilename()
+        local effect = spawnEffect(nil, PICKUP_EFFECT_VARIANT, PICKUP_EFFECT_SUB_TYPE, pickup.Position)
+        local effectSprite = effect:GetSprite()
+        effectSprite:Load(fileName, true)
+        effectSprite:Play("Collect", true)
+        customPickupFunctions.collectFunc(player)
+        return nil
+    end
+    self.postEffectRenderPickupEffect = function(____, effect)
+        if effect.SubType ~= asNumber(nil, PICKUP_EFFECT_SUB_TYPE) then
+            return
+        end
+        local sprite = effect:GetSprite()
+        if sprite:IsFinished("Collect") then
+            effect:Remove()
+        end
+    end
+    self.callbacksUsed = {{ModCallback.PRE_PICKUP_COLLISION, {self.prePickupCollision}}, {ModCallback.POST_EFFECT_RENDER, {self.postEffectRenderPickupEffect, PICKUP_EFFECT_VARIANT}}}
+end
+function CustomPickups.prototype.registerCustomPickup(self, pickupVariantCustom, subType, collectFunc, collisionFunc)
+    if collisionFunc == nil then
+        collisionFunc = function() return true end
+    end
+    local entityID = getEntityIDFromConstituents(nil, EntityType.PICKUP, pickupVariantCustom, subType)
+    local customPickupFunctions = {collectFunc = collectFunc, collisionFunc = collisionFunc}
+    self.customPickupFunctionsMap:set(entityID, customPickupFunctions)
+end
+__TS__Decorate({Exported}, CustomPickups.prototype, "registerCustomPickup", true)
+return ____exports

package/dist/src/classes/features/other/CustomStages.d.ts

@@ -0,0 +1,48 @@
+import { Feature } from "../../private/Feature";
+export declare class CustomStages extends Feature {
+    /** Indexed by custom stage name. */
+    private customStagesMap;
+    /** Indexed by room variant. */
+    private customStageCachedRoomData;
+    private customGridEntities;
+    private customTrapdoors;
+    private disableAllSound;
+    private gameReorderedCallbacks;
+    private pause;
+    private runInNFrames;
+    private initCustomStageMetadata;
+    private initRoomTypeMap;
+    private initCustomTrapdoorDestination;
+    private goToCustomStage;
+    private postRender;
+    private postCurseEval;
+    private getShaderParams;
+    private postGridEntityBrokenRockAlt;
+    private postGridEntityInit;
+    private postNewRoomReordered;
+    /** Pick a custom room for each vanilla room. */
+    private setStageRoomsData;
+    /**
+     * Helper function to warp to a custom stage/level.
+     *
+     * Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation
+     * for
+     * more details: https://isaacscript.github.io/main/custom-stages/
+     *
+     * @param name The name of the custom stage, corresponding to what is in the "tsconfig.json" file.
+     * @param firstFloor Optional. Whether to go to the first floor or the second floor. For example,
+     *                   if you have a custom stage emulating Caves, then the first floor would be
+     *                   Caves 1, and the second floor would be Caves 2. Default is true.
+     * @param streakText Optional. Whether to show the streak text at the top of the screen that
+     *                   announces the name of the level. Default is true.
+     * @param verbose Optional. Whether to log additional information about the rooms that are chosen.
+     *                Default is false.
+     */
+    setCustomStage(name: string, firstFloor?: boolean, streakText?: boolean, verbose?: boolean): void;
+    /**
+     * Helper function to disable the custom stage. This is typically called before taking the player
+     * to a vanilla floor.
+     */
+    disableCustomStage(): void;
+}
+//# sourceMappingURL=CustomStages.d.ts.map

package/dist/src/classes/features/other/CustomStages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomStages.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomStages.ts"],"names":[],"mappings":"AAsCA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAoChD,qBAAa,YAAa,SAAQ,OAAO;IA8BvC,oCAAoC;IACpC,OAAO,CAAC,eAAe,CAAkC;IAEzD,+BAA+B;IAC/B,OAAO,CAAC,yBAAyB,CAAwC;IAEzE,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,sBAAsB,CAAyB;IACvD,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,YAAY,CAAe;IA+CnC,OAAO,CAAC,uBAAuB;IAc/B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,6BAA6B;IAOrC,OAAO,CAAC,eAAe,CAMrB;IAGF,OAAO,CAAC,UAAU,CAQhB;IAGF,OAAO,CAAC,aAAa,CAcnB;IAGF,OAAO,CAAC,eAAe,CAUrB;IAIF,OAAO,CAAC,2BAA2B,CAejC;IAGF,OAAO,CAAC,kBAAkB,CAqBxB;IAGF,OAAO,CAAC,oBAAoB,CAe1B;IAEF,gDAAgD;IAChD,OAAO,CAAC,iBAAiB;IA+FzB;;;;;;;;;;;;;;;OAeG;IAEI,cAAc,CACnB,IAAI,EAAE,MAAM,EACZ,UAAU,UAAO,EACjB,UAAU,UAAO,EACjB,OAAO,UAAQ,GACd,IAAI;IAoEP;;;OAGG;IAEI,kBAAkB,IAAI,IAAI;CAGlC"}