isaacscript-common 6.6.1-dev.2 → 6.6.1-dev.4

package/functions/rng.js

@@ -1,117 +0,0 @@
-import { game } from "../cachedClasses";
-import { SerializationBrand } from "../enums/private/SerializationBrand";
-import { SerializationType } from "../enums/SerializationType";
-import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
-import { getNumbersFromTable, tableHasKeys } from "./table";
-import { isTable } from "./types";
-/**
- * This is the ShiftIdx that Blade recommended after having reviewing the game's internal functions.
- * Any value between 0 and 80 should work equally well.
- * https://www.jstatsoft.org/article/view/v008i14/xorshift.pdf
- */
-const RECOMMENDED_SHIFT_IDX = 35;
-const KEYS = ["seed"];
-const OBJECT_NAME = "RNG";
-export function copyRNG(rng, serializationType = SerializationType.NONE) {
-    switch (serializationType) {
-        case SerializationType.NONE: {
-            if (!isRNG(rng)) {
-                error(`Failed to copy a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`);
-            }
-            const seed = rng.GetSeed();
-            return newRNG(seed);
-        }
-        case SerializationType.SERIALIZE: {
-            if (!isRNG(rng)) {
-                error(`Failed to serialize a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`);
-            }
-            const seed = rng.GetSeed();
-            const rngTable = new LuaTable();
-            rngTable.set("seed", seed);
-            rngTable.set(SerializationBrand.RNG, "");
-            return rngTable;
-        }
-        case SerializationType.DESERIALIZE: {
-            if (!isTable(rng)) {
-                error(`Failed to deserialize a ${OBJECT_NAME} object since the provided object was not a Lua table.`);
-            }
-            const [seedNumber] = getNumbersFromTable(rng, OBJECT_NAME, ...KEYS);
-            const seed = seedNumber;
-            return newRNG(seed);
-        }
-    }
-}
-/**
- * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
- * instead of calling the `Random` function directly since that can return a value of 0 and crash
- * the game.
- */
-export function getRandomSeed() {
-    const randomNumber = Random();
-    const safeRandomNumber = randomNumber === 0 ? 1 : randomNumber;
-    return safeRandomNumber;
-}
-/** Helper function to check if something is an instantiated RNG object. */
-export function isRNG(object) {
-    return isIsaacAPIClassOfType(object, OBJECT_NAME);
-}
-/**
- * Used to determine is the given table is a serialized `RNG` object created by the save data
- * manager and/or the `deepCopy` function.
- */
-export function isSerializedRNG(object) {
-    if (!isTable(object)) {
-        return false;
-    }
-    return tableHasKeys(object, ...KEYS) && object.has(SerializationBrand.RNG);
-}
-/**
- * Helper function to initialize an RNG object using Blade's recommended shift index.
- *
- * @param seed The seed to initialize it with. Default is `getRandomSeed()`.
- */
-export function newRNG(seed = getRandomSeed()) {
-    const rng = RNG();
-    setSeed(rng, seed);
-    return rng;
-}
-export function rngEquals(rng1, rng2) {
-    return isaacAPIClassEquals(rng1, rng2, KEYS);
-}
-/**
- * Helper function to iterate over the provided object and set the seed for all of the values that
- * are RNG objects equal to a particular seed.
- */
-export function setAllRNGToSeed(object, seed) {
-    if (!isTable(object)) {
-        error(`Failed to iterate over the object containing RNG objects since the type of the provided object was: ${typeof object}`);
-    }
-    let setAtLeastOneSeed = false;
-    for (const [_key, value] of pairs(object)) {
-        if (isRNG(value)) {
-            setSeed(value, seed);
-            setAtLeastOneSeed = true;
-        }
-    }
-    if (!setAtLeastOneSeed) {
-        error(`Failed to set all RNG objects to seed ${seed} because the parent object did not contain any RNG objects.`);
-    }
-}
-/**
- * Helper function to iterate over the provided object and set the seed for all of the values that
- * are RNG objects equal to the start seed for the current run.
- */
-export function setAllRNGToStartSeed(object) {
-    const seeds = game.GetSeeds();
-    const startSeed = seeds.GetStartSeed();
-    setAllRNGToSeed(object, startSeed);
-}
-/** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
-export function setSeed(rng, seed) {
-    if (seed === 0) {
-        error("You cannot set an RNG object to a seed of 0, or the game will crash.");
-    }
-    // The game expects seeds in the range of 1 to 4294967295 (1^32 - 1).
-    rng.SetSeed(seed, RECOMMENDED_SHIFT_IDX);
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm5nLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcGFja2FnZXMvaXNhYWNzY3JpcHQtY29tbW9uL3NyYy9mdW5jdGlvbnMvcm5nLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxJQUFJLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUN4QyxPQUFPLEVBQUUsa0JBQWtCLEVBQUUsTUFBTSxxQ0FBcUMsQ0FBQztBQUN6RSxPQUFPLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSw0QkFBNEIsQ0FBQztBQUMvRCxPQUFPLEVBQUUsbUJBQW1CLEVBQUUscUJBQXFCLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUM3RSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsWUFBWSxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQzVELE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFZbEM7Ozs7R0FJRztBQUNILE1BQU0scUJBQXFCLEdBQUcsRUFBRSxDQUFDO0FBRWpDLE1BQU0sSUFBSSxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7QUFDdEIsTUFBTSxXQUFXLEdBQUcsS0FBSyxDQUFDO0FBZ0IxQixNQUFNLFVBQVUsT0FBTyxDQUNyQixHQUF3QixFQUN4QixpQkFBaUIsR0FBRyxpQkFBaUIsQ0FBQyxJQUFJO0lBRTFDLFFBQVEsaUJBQWlCLEVBQUU7UUFDekIsS0FBSyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUMzQixJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxFQUFFO2dCQUNmLEtBQUssQ0FDSCxvQkFBb0IsV0FBVyx3REFBd0QsV0FBVyxTQUFTLENBQzVHLENBQUM7YUFDSDtZQUVELE1BQU0sSUFBSSxHQUFHLEdBQUcsQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUMzQixPQUFPLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUNyQjtRQUVELEtBQUssaUJBQWlCLENBQUMsU0FBUyxDQUFDLENBQUM7WUFDaEMsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsRUFBRTtnQkFDZixLQUFLLENBQ0gseUJBQXlCLFdBQVcsd0RBQXdELFdBQVcsU0FBUyxDQUNqSCxDQUFDO2FBQ0g7WUFFRCxNQUFNLElBQUksR0FBRyxHQUFHLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDM0IsTUFBTSxRQUFRLEdBQUcsSUFBSSxRQUFRLEVBQW1CLENBQUM7WUFDakQsUUFBUSxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7WUFDM0IsUUFBUSxDQUFDLEdBQUcsQ0FBQyxrQkFBa0IsQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDekMsT0FBTyxRQUF5QixDQUFDO1NBQ2xDO1FBRUQsS0FBSyxpQkFBaUIsQ0FBQyxXQUFXLENBQUMsQ0FBQztZQUNsQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFO2dCQUNqQixLQUFLLENBQ0gsMkJBQTJCLFdBQVcsd0RBQXdELENBQy9GLENBQUM7YUFDSDtZQUVELE1BQU0sQ0FBQyxVQUFVLENBQUMsR0FBRyxtQkFBbUIsQ0FDdEMsR0FBZ0MsRUFDaEMsV0FBVyxFQUNYLEdBQUcsSUFBSSxDQUNSLENBQUM7WUFDRixNQUFNLElBQUksR0FBRyxVQUFrQixDQUFDO1lBQ2hDLE9BQU8sTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ3JCO0tBQ0Y7QUFDSCxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxhQUFhO0lBQzNCLE1BQU0sWUFBWSxHQUFHLE1BQU0sRUFBRSxDQUFDO0lBQzlCLE1BQU0sZ0JBQWdCLEdBQUcsWUFBWSxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxZQUFZLENBQUM7SUFDL0QsT0FBTyxnQkFBd0IsQ0FBQztBQUNsQyxDQUFDO0FBRUQsMkVBQTJFO0FBQzNFLE1BQU0sVUFBVSxLQUFLLENBQUMsTUFBZTtJQUNuQyxPQUFPLHFCQUFxQixDQUFDLE1BQU0sRUFBRSxXQUFXLENBQUMsQ0FBQztBQUNwRCxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLGVBQWUsQ0FBQyxNQUFlO0lBQzdDLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUU7UUFDcEIsT0FBTyxLQUFLLENBQUM7S0FDZDtJQUVELE9BQU8sWUFBWSxDQUFDLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxJQUFJLE1BQU0sQ0FBQyxHQUFHLENBQUMsa0JBQWtCLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDN0UsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsTUFBTSxDQUFDLElBQUksR0FBRyxhQUFhLEVBQUU7SUFDM0MsTUFBTSxHQUFHLEdBQUcsR0FBRyxFQUFFLENBQUM7SUFDbEIsT0FBTyxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUNuQixPQUFPLEdBQUcsQ0FBQztBQUNiLENBQUM7QUFFRCxNQUFNLFVBQVUsU0FBUyxDQUFDLElBQVMsRUFBRSxJQUFTO0lBQzVDLE9BQU8sbUJBQW1CLENBQUMsSUFBSSxFQUFFLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztBQUMvQyxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLGVBQWUsQ0FBQyxNQUFlLEVBQUUsSUFBVTtJQUN6RCxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFO1FBQ3BCLEtBQUssQ0FDSCx1R0FBdUcsT0FBTyxNQUFNLEVBQUUsQ0FDdkgsQ0FBQztLQUNIO0lBRUQsSUFBSSxpQkFBaUIsR0FBRyxLQUFLLENBQUM7SUFDOUIsS0FBSyxNQUFNLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxJQUFJLEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBRTtRQUN6QyxJQUFJLEtBQUssQ0FBQyxLQUFLLENBQUMsRUFBRTtZQUNoQixPQUFPLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxDQUFDO1lBQ3JCLGlCQUFpQixHQUFHLElBQUksQ0FBQztTQUMxQjtLQUNGO0lBRUQsSUFBSSxDQUFDLGlCQUFpQixFQUFFO1FBQ3RCLEtBQUssQ0FDSCx5Q0FBeUMsSUFBSSw2REFBNkQsQ0FDM0csQ0FBQztLQUNIO0FBQ0gsQ0FBQztBQUVEOzs7R0FHRztBQUNILE1BQU0sVUFBVSxvQkFBb0IsQ0FBQyxNQUFlO0lBQ2xELE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztJQUM5QixNQUFNLFNBQVMsR0FBRyxLQUFLLENBQUMsWUFBWSxFQUFFLENBQUM7SUFFdkMsZUFBZSxDQUFDLE1BQU0sRUFBRSxTQUFTLENBQUMsQ0FBQztBQUNyQyxDQUFDO0FBRUQsNEZBQTRGO0FBQzVGLE1BQU0sVUFBVSxPQUFPLENBQUMsR0FBUSxFQUFFLElBQVU7SUFDMUMsSUFBSSxJQUFJLEtBQUssQ0FBQyxFQUFFO1FBQ2QsS0FBSyxDQUNILHNFQUFzRSxDQUN2RSxDQUFDO0tBQ0g7SUFFRCxxRUFBcUU7SUFDckUsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUscUJBQXFCLENBQUMsQ0FBQztBQUMzQyxDQUFDIn0=

package/functions/rng.lua

@@ -1,145 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local __TS__TypeOf = ____lualib.__TS__TypeOf
-local ____exports = {}
-local RECOMMENDED_SHIFT_IDX, OBJECT_NAME
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____SerializationBrand = require("enums.private.SerializationBrand")
-local SerializationBrand = ____SerializationBrand.SerializationBrand
-local ____SerializationType = require("enums.SerializationType")
-local SerializationType = ____SerializationType.SerializationType
-local ____isaacAPIClass = require("functions.isaacAPIClass")
-local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
-local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
-local ____table = require("functions.table")
-local getNumbersFromTable = ____table.getNumbersFromTable
-local tableHasKeys = ____table.tableHasKeys
-local ____types = require("functions.types")
-local isTable = ____types.isTable
---- Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
--- instead of calling the `Random` function directly since that can return a value of 0 and crash
--- the game.
-function ____exports.getRandomSeed(self)
-    local randomNumber = Random()
-    local safeRandomNumber = randomNumber == 0 and 1 or randomNumber
-    return safeRandomNumber
-end
---- Helper function to check if something is an instantiated RNG object.
-function ____exports.isRNG(self, object)
-    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
-end
---- Helper function to initialize an RNG object using Blade's recommended shift index.
--- 
--- @param seed The seed to initialize it with. Default is `getRandomSeed()`.
-function ____exports.newRNG(self, seed)
-    if seed == nil then
-        seed = ____exports.getRandomSeed(nil)
-    end
-    local rng = RNG()
-    ____exports.setSeed(nil, rng, seed)
-    return rng
-end
---- Helper function to set a seed to an RNG object using Blade's recommended shift index.
-function ____exports.setSeed(self, rng, seed)
-    if seed == 0 then
-        error("You cannot set an RNG object to a seed of 0, or the game will crash.")
-    end
-    rng:SetSeed(seed, RECOMMENDED_SHIFT_IDX)
-end
-RECOMMENDED_SHIFT_IDX = 35
-local KEYS = {"seed"}
-OBJECT_NAME = "RNG"
---- Helper function to copy an `RNG` object.
--- 
--- @param rng The RNG object to copy. In the case of deserialization, this will actually be a Lua
--- table instead of an instantiated RNG class.
--- @param serializationType Default is `SerializationType.NONE`.
-function ____exports.copyRNG(self, rng, serializationType)
-    if serializationType == nil then
-        serializationType = SerializationType.NONE
-    end
-    repeat
-        local ____switch3 = serializationType
-        local ____cond3 = ____switch3 == SerializationType.NONE
-        if ____cond3 then
-            do
-                if not ____exports.isRNG(nil, rng) then
-                    error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                local seed = rng:GetSeed()
-                return ____exports.newRNG(nil, seed)
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.SERIALIZE
-        if ____cond3 then
-            do
-                if not ____exports.isRNG(nil, rng) then
-                    error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                local seed = rng:GetSeed()
-                local rngTable = {}
-                rngTable.seed = seed
-                rngTable[SerializationBrand.RNG] = ""
-                return rngTable
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
-        if ____cond3 then
-            do
-                if not isTable(nil, rng) then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
-                end
-                local seedNumber = table.unpack(getNumbersFromTable(
-                    nil,
-                    rng,
-                    OBJECT_NAME,
-                    table.unpack(KEYS)
-                ))
-                local seed = seedNumber
-                return ____exports.newRNG(nil, seed)
-            end
-        end
-    until true
-end
---- Used to determine is the given table is a serialized `RNG` object created by the save data
--- manager and/or the `deepCopy` function.
-function ____exports.isSerializedRNG(self, object)
-    if not isTable(nil, object) then
-        return false
-    end
-    return tableHasKeys(
-        nil,
-        object,
-        table.unpack(KEYS)
-    ) and object[SerializationBrand.RNG] ~= nil
-end
-function ____exports.rngEquals(self, rng1, rng2)
-    return isaacAPIClassEquals(nil, rng1, rng2, KEYS)
-end
---- Helper function to iterate over the provided object and set the seed for all of the values that
--- are RNG objects equal to a particular seed.
-function ____exports.setAllRNGToSeed(self, object, seed)
-    if not isTable(nil, object) then
-        error("Failed to iterate over the object containing RNG objects since the type of the provided object was: " .. __TS__TypeOf(object))
-    end
-    local setAtLeastOneSeed = false
-    for _key, value in pairs(object) do
-        if ____exports.isRNG(nil, value) then
-            ____exports.setSeed(nil, value, seed)
-            setAtLeastOneSeed = true
-        end
-    end
-    if not setAtLeastOneSeed then
-        error(("Failed to set all RNG objects to seed " .. tostring(seed)) .. " because the parent object did not contain any RNG objects.")
-    end
-end
---- Helper function to iterate over the provided object and set the seed for all of the values that
--- are RNG objects equal to the start seed for the current run.
-function ____exports.setAllRNGToStartSeed(self, object)
-    local seeds = game:GetSeeds()
-    local startSeed = seeds:GetStartSeed()
-    ____exports.setAllRNGToSeed(nil, object, startSeed)
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZnVuY3Rpb25zL3JuZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7TUFzQk0sdUJBR0E7QUF6Qk4sMEJBQXFCO0FBQVo7QUFDVCwrQkFBbUM7QUFBMUI7QUFDVCw4QkFBa0M7QUFBekI7QUFDVCwwQkFBMkQ7QUFBbEQ7QUFBcUI7QUFDOUIsa0JBQWtEO0FBQXpDO0FBQXFCO0FBQzlCLGtCQUF3QjtBQUFmOzs7O0FBeUZUO0FBQ1EseUJBQWU7QUFDZiw2QkFBbUIsZ0JBQWlCLE1BQUksS0FBSTtBQUNsRCxXQUFPO0FBSFQ7O0FBT0EsaUNBQXNCO0FBQ3BCLFdBQU8sMkJBQXNCLFFBQVE7QUFEdkM7Ozs7QUFxQkEsa0NBQXVCO09BQUE7UUFBQSxPQUFPOztBQUN0QixnQkFBTTtJQUNaLHlCQUFRLEtBQUs7QUFDYixXQUFPO0FBSFQ7O0FBZ0RBLG1DQUF3QixLQUFVO09BQzVCLFFBQVM7UUFDWCxNQUNFOztJQUtKLElBQUksUUFBUSxNQUFNO0FBUnBCO0FBcEpNLHdCQUF3QjtBQUV4QixhQUFPLENBQUM7QUFDUixjQUFjOzs7Ozs7QUFnQnBCLG1DQUNFLEtBQ0E7T0FBQTtRQUFBLG9CQUFvQjs7OzRCQUVaO3lDQUNEOzs7dUJBQ0UsdUJBQU07b0JBQ1QsU0FDRSx1QkFBb0IsZ0JBQVcsNERBQXdELGdCQUFXOztBQUloRyw2QkFBTyxJQUFJO0FBQ2pCLHVCQUFPLHdCQUFPOzs7Z0RBR1g7Ozt1QkFDRSx1QkFBTTtvQkFDVCxTQUNFLDRCQUF5QixnQkFBVyw0REFBd0QsZ0JBQVc7O0FBSXJHLDZCQUFPLElBQUk7QUFDWCxpQ0FBVztBQUNqQix5QkFBYSxPQUFRO0FBQ3JCLHlCQUFhLDBCQUF3QjtBQUNyQyx1QkFBTzs7O2dEQUdKOzs7dUJBQ0UsYUFBUTtvQkFDWCxPQUNFLDhCQUEyQixnQkFBVzs7QUFJckIsc0JBQWQsYUFBYzs7b0JBQ25CO29CQUNBO29CQUNBLGFBQUc7O0FBRUMsNkJBQU87QUFDYix1QkFBTyx3QkFBTzs7OztBQTNDcEI7OztBQW9FQSwyQ0FBZ0M7V0FDekIsYUFBUTtBQUNYLGVBQU87O0FBR1QsV0FBTzs7UUFBYTtRQUFRLGFBQUc7VUFBUyxPQUFXO0FBTHJEO0FBbUJBLHFDQUEwQixNQUFXO0FBQ25DLFdBQU8seUJBQW9CLE1BQU0sTUFBTTtBQUR6Qzs7O0FBUUEsMkNBQWdDLFFBQWlCO1dBQzFDLGFBQVE7UUFDWCxNQUNFLDBHQUF1RyxhQUFPOztBQUk5Ryw4QkFBb0I7QUFDeEIsUUFBWSxNQUFNLFNBQVUsTUFBTTtXQUM1Qix1QkFBTTtZQUNSLHlCQUFRLE9BQU87QUFDZixnQ0FBb0I7OztXQUluQjtRQUNILE9BQ0UscURBQXlDLFVBQUk7O0FBakJuRDs7O0FBMEJBLGdEQUFxQztBQUM3QixrQkFBUSxLQUFLO0FBQ2Isc0JBQVksTUFBTTtJQUV4QixpQ0FBZ0IsUUFBUTtBQUoxQiIsImZpbGUiOiJybmcubHVhIiwic291cmNlUm9vdCI6IiJ9

package/functions/roomData.js

@@ -1,174 +0,0 @@
-import { DoorSlotFlag, } from "isaac-typescript-definitions";
-import { game } from "../cachedClasses";
-import { doorSlotFlagToDoorSlot } from "./doors";
-import { getEnumValues } from "./enums";
-import { hasFlag } from "./flag";
-/**
- * Helper function to get the set of allowed door slots for the room at the supplied grid index.
- * This corresponds to the doors that are enabled in the STB/XML file for the room.
- */
-export function getRoomAllowedDoors(roomGridIndex) {
-    const allowedDoors = new Set();
-    const roomData = getRoomData(roomGridIndex);
-    if (roomData === undefined) {
-        return allowedDoors;
-    }
-    const doorSlotFlags = getEnumValues(DoorSlotFlag);
-    for (const doorSlotFlag of doorSlotFlags) {
-        if (hasFlag(roomData.Doors, doorSlotFlag)) {
-            const doorSlot = doorSlotFlagToDoorSlot(doorSlotFlag);
-            allowedDoors.add(doorSlot);
-        }
-    }
-    return allowedDoors;
-}
-/**
- * Helper function to get the room data for the provided room.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export function getRoomData(roomGridIndex) {
-    const roomDescriptor = getRoomDescriptor(roomGridIndex);
-    return roomDescriptor.Data;
-}
-/**
- * Helper function to get the descriptor for a room.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export function getRoomDescriptor(roomGridIndex) {
-    const level = game.GetLevel();
-    if (roomGridIndex === undefined) {
-        roomGridIndex = getRoomGridIndex();
-    }
-    return level.GetRoomByIdx(roomGridIndex);
-}
-/**
- * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
- * `RoomDescriptor` object that you are retrieving.
- */
-export function getRoomDescriptorReadOnly() {
-    const level = game.GetLevel();
-    return level.GetCurrentRoomDesc();
-}
-/**
- * Helper function to get the grid index of the current room.
- *
- * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
- *   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
- *   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
- * - If the current room is outside of the grid, it will return the index from the
- *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases).
- *
- * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
- * will return the specific 1x1 quadrant that the player entered the room at. For most situations,
- * using the safe grid index is more reliable than this.
- *
- * Data structures that store data per room should use the room's `ListIndex` instead of
- * `SafeGridIndex`, since the former is unique across different dimensions.
- */
-export function getRoomGridIndex() {
-    const level = game.GetLevel();
-    const currentRoomIndex = level.GetCurrentRoomIndex();
-    // Both `RoomDescriptor.GridIndex` and `RoomDescriptor.SafeGridIndex` will always be equal to -1
-    // for rooms outside of the grid. Thus, we revert to using the `Level.GetCurrentRoomIndex` method
-    // for these cases.
-    if (currentRoomIndex < 0) {
-        return currentRoomIndex;
-    }
-    const roomDescriptor = getRoomDescriptorReadOnly();
-    return roomDescriptor.SafeGridIndex;
-}
-/**
- * Helper function to get the list grid index of the provided room, which is equal to the index in
- * the `RoomList.Get` method. In other words, this is equal to the order that the room was created
- * by the floor generation algorithm.
- *
- * Use this as an index for data structures that store data per room, since it is unique across
- * different dimensions.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export function getRoomListIndex(roomGridIndex) {
-    const roomDescriptor = getRoomDescriptor(roomGridIndex);
-    return roomDescriptor.ListIndex;
-}
-/**
- * Helper function to get the name of the room as it appears in the STB/XML data.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room name. Returns "Unknown" if the type was not found.
- */
-export function getRoomName(roomGridIndex) {
-    const roomData = getRoomData(roomGridIndex);
-    return roomData === undefined ? "Unknown" : roomData.Name;
-}
-/**
- * Helper function to get the name of the room as it appears in the STB/XML data.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room name. Returns "Unknown" if the type was not found.
- */
-export function getRoomShape(roomGridIndex) {
-    const roomData = getRoomData(roomGridIndex);
-    return roomData === undefined ? undefined : roomData.Shape;
-}
-/**
- * Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
- * correspond to the first number in the filename of the XML/STB file. For example, a Depths room
- * would have a stage ID of 7.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room stage ID. Returns -1 if the stage ID was not found.
- */
-export function getRoomStageID(roomGridIndex) {
-    const roomData = getRoomData(roomGridIndex);
-    return roomData === undefined ? -1 : roomData.StageID;
-}
-/**
- * Helper function to get the sub-type for a room from the XML/STB data. The room sub-type will
- * correspond to different things depending on what XML/STB file it draws from. For example, in the
- * "00.special rooms.stb" file, an Angel Room with a sub-type of 0 will correspond to a normal Angel
- * Room and a sub-type of 1 will correspond to an Angel Room shop for The Stairway.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room sub-type. Returns -1 if the sub-type was not found.
- */
-export function getRoomSubType(roomGridIndex) {
-    const roomData = getRoomData(roomGridIndex);
-    return roomData === undefined ? -1 : roomData.Subtype;
-}
-/**
- * Helper function for getting the type of the room with the given grid index.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room data type. Returns -1 if the type was not found.
- */
-export function getRoomType(roomGridIndex) {
-    const roomData = getRoomData(roomGridIndex);
-    return roomData === undefined ? -1 : roomData.Type;
-}
-/**
- * Helper function to get the variant for a room from the XML/STB data. You can think of a room
- * variant as its identifier. For example, to go to Basement room #123, you would use a console
- * command of `goto d.123` while on the Basement.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room variant. Returns -1 if the variant was not found.
- */
-export function getRoomVariant(roomGridIndex) {
-    const roomData = getRoomData(roomGridIndex);
-    return roomData === undefined ? -1 : roomData.Variant;
-}
-/**
- * Note that the room visited count will be inaccurate during the period before the PostNewRoom
- * callback has fired (i.e. when entities are initializing and performing their first update). This
- * is because the variable is only incremented immediately before the PostNewRoom callback fires.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export function getRoomVisitedCount(roomGridIndex) {
-    const roomDescriptor = getRoomDescriptor(roomGridIndex);
-    return roomDescriptor.VisitedCount;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm9vbURhdGEuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9pc2FhY3NjcmlwdC1jb21tb24vc3JjL2Z1bmN0aW9ucy9yb29tRGF0YS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBRUwsWUFBWSxHQUliLE1BQU0sOEJBQThCLENBQUM7QUFDdEMsT0FBTyxFQUFFLElBQUksRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBQ3hDLE9BQU8sRUFBRSxzQkFBc0IsRUFBRSxNQUFNLFNBQVMsQ0FBQztBQUNqRCxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQ3hDLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxRQUFRLENBQUM7QUFFakM7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLG1CQUFtQixDQUFDLGFBQW1CO0lBQ3JELE1BQU0sWUFBWSxHQUFHLElBQUksR0FBRyxFQUFZLENBQUM7SUFFekMsTUFBTSxRQUFRLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQzVDLElBQUksUUFBUSxLQUFLLFNBQVMsRUFBRTtRQUMxQixPQUFPLFlBQVksQ0FBQztLQUNyQjtJQUVELE1BQU0sYUFBYSxHQUFHLGFBQWEsQ0FBQyxZQUFZLENBQUMsQ0FBQztJQUNsRCxLQUFLLE1BQU0sWUFBWSxJQUFJLGFBQWEsRUFBRTtRQUN4QyxJQUFJLE9BQU8sQ0FBQyxRQUFRLENBQUMsS0FBSyxFQUFFLFlBQVksQ0FBQyxFQUFFO1lBQ3pDLE1BQU0sUUFBUSxHQUFHLHNCQUFzQixDQUFDLFlBQVksQ0FBQyxDQUFDO1lBQ3RELFlBQVksQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLENBQUM7U0FDNUI7S0FDRjtJQUVELE9BQU8sWUFBWSxDQUFDO0FBQ3RCLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLFdBQVcsQ0FBQyxhQUFtQjtJQUM3QyxNQUFNLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUN4RCxPQUFPLGNBQWMsQ0FBQyxJQUFJLENBQUM7QUFDN0IsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsaUJBQWlCLENBQUMsYUFBbUI7SUFDbkQsTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO0lBRTlCLElBQUksYUFBYSxLQUFLLFNBQVMsRUFBRTtRQUMvQixhQUFhLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQztLQUNwQztJQUVELE9BQU8sS0FBSyxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsQ0FBQztBQUMzQyxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLHlCQUF5QjtJQUN2QyxNQUFNLEtBQUssR0FBRyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDOUIsT0FBTyxLQUFLLENBQUMsa0JBQWtCLEVBQUUsQ0FBQztBQUNwQyxDQUFDO0FBRUQ7Ozs7Ozs7Ozs7Ozs7OztHQWVHO0FBQ0gsTUFBTSxVQUFVLGdCQUFnQjtJQUM5QixNQUFNLEtBQUssR0FBRyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDOUIsTUFBTSxnQkFBZ0IsR0FBRyxLQUFLLENBQUMsbUJBQW1CLEVBQUUsQ0FBQztJQUVyRCxnR0FBZ0c7SUFDaEcsaUdBQWlHO0lBQ2pHLG1CQUFtQjtJQUNuQixJQUFJLGdCQUFnQixHQUFHLENBQUMsRUFBRTtRQUN4QixPQUFPLGdCQUFnQixDQUFDO0tBQ3pCO0lBRUQsTUFBTSxjQUFjLEdBQUcseUJBQXlCLEVBQUUsQ0FBQztJQUNuRCxPQUFPLGNBQWMsQ0FBQyxhQUFhLENBQUM7QUFDdEMsQ0FBQztBQUVEOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sVUFBVSxnQkFBZ0IsQ0FBQyxhQUFtQjtJQUNsRCxNQUFNLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUN4RCxPQUFPLGNBQWMsQ0FBQyxTQUFTLENBQUM7QUFDbEMsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLFdBQVcsQ0FBQyxhQUFtQjtJQUM3QyxNQUFNLFFBQVEsR0FBRyxXQUFXLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDNUMsT0FBTyxRQUFRLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUM7QUFDNUQsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLFlBQVksQ0FBQyxhQUFtQjtJQUM5QyxNQUFNLFFBQVEsR0FBRyxXQUFXLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDNUMsT0FBTyxRQUFRLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUM7QUFDN0QsQ0FBQztBQUVEOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLFVBQVUsY0FBYyxDQUFDLGFBQW1CO0lBQ2hELE1BQU0sUUFBUSxHQUFHLFdBQVcsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUM1QyxPQUFPLFFBQVEsS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDO0FBQ3hELENBQUM7QUFFRDs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sVUFBVSxjQUFjLENBQUMsYUFBbUI7SUFDaEQsTUFBTSxRQUFRLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQzVDLE9BQU8sUUFBUSxLQUFLLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUM7QUFDeEQsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLFdBQVcsQ0FBQyxhQUFtQjtJQUM3QyxNQUFNLFFBQVEsR0FBRyxXQUFXLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDNUMsT0FBTyxRQUFRLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQztBQUNyRCxDQUFDO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILE1BQU0sVUFBVSxjQUFjLENBQUMsYUFBbUI7SUFDaEQsTUFBTSxRQUFRLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQzVDLE9BQU8sUUFBUSxLQUFLLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUM7QUFDeEQsQ0FBQztBQUVEOzs7Ozs7R0FNRztBQUNILE1BQU0sVUFBVSxtQkFBbUIsQ0FBQyxhQUFtQjtJQUNyRCxNQUFNLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUN4RCxPQUFPLGNBQWMsQ0FBQyxZQUFZLENBQUM7QUFDckMsQ0FBQyJ9

package/functions/roomData.lua

@@ -1,162 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local DoorSlotFlag = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlag
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____doors = require("functions.doors")
-local doorSlotFlagToDoorSlot = ____doors.doorSlotFlagToDoorSlot
-local ____enums = require("functions.enums")
-local getEnumValues = ____enums.getEnumValues
-local ____flag = require("functions.flag")
-local hasFlag = ____flag.hasFlag
---- Helper function to get the room data for the provided room.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.getRoomData(self, roomGridIndex)
-    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.Data
-end
---- Helper function to get the descriptor for a room.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.getRoomDescriptor(self, roomGridIndex)
-    local level = game:GetLevel()
-    if roomGridIndex == nil then
-        roomGridIndex = ____exports.getRoomGridIndex(nil)
-    end
-    return level:GetRoomByIdx(roomGridIndex)
-end
---- Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
--- `RoomDescriptor` object that you are retrieving.
-function ____exports.getRoomDescriptorReadOnly(self)
-    local level = game:GetLevel()
-    return level:GetCurrentRoomDesc()
-end
---- Helper function to get the grid index of the current room.
--- 
--- - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
---   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
---   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
--- - If the current room is outside of the grid, it will return the index from the
---   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases).
--- 
--- Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
--- will return the specific 1x1 quadrant that the player entered the room at. For most situations,
--- using the safe grid index is more reliable than this.
--- 
--- Data structures that store data per room should use the room's `ListIndex` instead of
--- `SafeGridIndex`, since the former is unique across different dimensions.
-function ____exports.getRoomGridIndex(self)
-    local level = game:GetLevel()
-    local currentRoomIndex = level:GetCurrentRoomIndex()
-    if currentRoomIndex < 0 then
-        return currentRoomIndex
-    end
-    local roomDescriptor = ____exports.getRoomDescriptorReadOnly(nil)
-    return roomDescriptor.SafeGridIndex
-end
---- Helper function to get the set of allowed door slots for the room at the supplied grid index.
--- This corresponds to the doors that are enabled in the STB/XML file for the room.
-function ____exports.getRoomAllowedDoors(self, roomGridIndex)
-    local allowedDoors = __TS__New(Set)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    if roomData == nil then
-        return allowedDoors
-    end
-    local doorSlotFlags = getEnumValues(nil, DoorSlotFlag)
-    for ____, doorSlotFlag in ipairs(doorSlotFlags) do
-        if hasFlag(nil, roomData.Doors, doorSlotFlag) then
-            local doorSlot = doorSlotFlagToDoorSlot(nil, doorSlotFlag)
-            allowedDoors:add(doorSlot)
-        end
-    end
-    return allowedDoors
-end
---- Helper function to get the list grid index of the provided room, which is equal to the index in
--- the `RoomList.Get` method. In other words, this is equal to the order that the room was created
--- by the floor generation algorithm.
--- 
--- Use this as an index for data structures that store data per room, since it is unique across
--- different dimensions.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.getRoomListIndex(self, roomGridIndex)
-    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.ListIndex
-end
---- Helper function to get the name of the room as it appears in the STB/XML data.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
--- @returns The room name. Returns "Unknown" if the type was not found.
-function ____exports.getRoomName(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and "Unknown" or roomData.Name
-end
---- Helper function to get the name of the room as it appears in the STB/XML data.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
--- @returns The room name. Returns "Unknown" if the type was not found.
-function ____exports.getRoomShape(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    local ____temp_0
-    if roomData == nil then
-        ____temp_0 = nil
-    else
-        ____temp_0 = roomData.Shape
-    end
-    return ____temp_0
-end
---- Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
--- correspond to the first number in the filename of the XML/STB file. For example, a Depths room
--- would have a stage ID of 7.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
--- @returns The room stage ID. Returns -1 if the stage ID was not found.
-function ____exports.getRoomStageID(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.StageID
-end
---- Helper function to get the sub-type for a room from the XML/STB data. The room sub-type will
--- correspond to different things depending on what XML/STB file it draws from. For example, in the
--- "00.special rooms.stb" file, an Angel Room with a sub-type of 0 will correspond to a normal Angel
--- Room and a sub-type of 1 will correspond to an Angel Room shop for The Stairway.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
--- @returns The room sub-type. Returns -1 if the sub-type was not found.
-function ____exports.getRoomSubType(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.Subtype
-end
---- Helper function for getting the type of the room with the given grid index.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
--- @returns The room data type. Returns -1 if the type was not found.
-function ____exports.getRoomType(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.Type
-end
---- Helper function to get the variant for a room from the XML/STB data. You can think of a room
--- variant as its identifier. For example, to go to Basement room #123, you would use a console
--- command of `goto d.123` while on the Basement.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
--- @returns The room variant. Returns -1 if the variant was not found.
-function ____exports.getRoomVariant(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.Variant
-end
---- Note that the room visited count will be inaccurate during the period before the PostNewRoom
--- callback has fired (i.e. when entities are initializing and performing their first update). This
--- is because the variable is only incremented immediately before the PostNewRoom callback fires.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.getRoomVisitedCount(self, roomGridIndex)
-    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.VisitedCount
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZnVuY3Rpb25zL3Jvb21EYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7QUFBQSw2Q0FNTztBQUpMO0FBS0YsMEJBQXFCO0FBQVo7QUFDVCxrQkFBdUM7QUFBOUI7QUFDVCxrQkFBOEI7QUFBckI7QUFDVCxpQkFBd0I7QUFBZjs7OztBQThCVCx1Q0FBNEI7QUFDcEIsMkJBQWlCLG1DQUFrQjtBQUN6QyxXQUFPO0FBRlQ7Ozs7QUFVQSw2Q0FBa0M7QUFDMUIsa0JBQVEsS0FBSztPQUVmO0FBQ0Ysd0JBQWdCOztBQUdsQixXQUFPLE1BQU0sYUFBYTtBQVA1Qjs7O0FBY0E7QUFDUSxrQkFBUSxLQUFLO0FBQ25CLFdBQU8sTUFBTTtBQUZmOzs7Ozs7Ozs7Ozs7Ozs7QUFxQkE7QUFDUSxrQkFBUSxLQUFLO0FBQ2IsNkJBQW1CLE1BQU07T0FLM0IsbUJBQW1CO0FBQ3JCLGVBQU87O0FBR0gsMkJBQWlCO0FBQ3ZCLFdBQU87QUFaVDs7O0FBckVBLCtDQUFvQztBQUM1Qix5QkFBZSxVQUFJO0FBRW5CLHFCQUFXLDZCQUFZO09BQ3pCO0FBQ0YsZUFBTzs7QUFHSCwwQkFBZ0IsbUJBQWM7QUFDcEMsY0FBVyx1QkFBZ0I7V0FDckIsYUFBUSxnQkFBZ0I7QUFDcEIsNkJBQVcsNEJBQXVCO1lBQ3hDLGFBQWEsSUFBSTs7O0FBSXJCLFdBQU87QUFoQlQ7Ozs7Ozs7OztBQThGQSw0Q0FBaUM7QUFDekIsMkJBQWlCLG1DQUFrQjtBQUN6QyxXQUFPO0FBRlQ7Ozs7O0FBV0EsdUNBQTRCO0FBQ3BCLHFCQUFXLDZCQUFZO0FBQzdCLFdBQU8sb0JBQXlCLGFBQVk7QUFGOUM7Ozs7O0FBV0Esd0NBQTZCO0FBQ3JCLHFCQUFXLDZCQUFZO0FBQ3RCO09BQUE7QUFBeUI7O0FBQVk7O0FBQTVDO0FBRkY7Ozs7Ozs7QUFhQSwwQ0FBK0I7QUFDdkIscUJBQVcsNkJBQVk7QUFDN0IsV0FBTyxxQkFBMEIsS0FBSTtBQUZ2Qzs7Ozs7Ozs7QUFjQSwwQ0FBK0I7QUFDdkIscUJBQVcsNkJBQVk7QUFDN0IsV0FBTyxxQkFBMEIsS0FBSTtBQUZ2Qzs7Ozs7QUFXQSx1Q0FBNEI7QUFDcEIscUJBQVcsNkJBQVk7QUFDN0IsV0FBTyxxQkFBMEIsS0FBSTtBQUZ2Qzs7Ozs7OztBQWFBLDBDQUErQjtBQUN2QixxQkFBVyw2QkFBWTtBQUM3QixXQUFPLHFCQUEwQixLQUFJO0FBRnZDOzs7Ozs7QUFZQSwrQ0FBb0M7QUFDNUIsMkJBQWlCLG1DQUFrQjtBQUN6QyxXQUFPO0FBRlQiLCJmaWxlIjoicm9vbURhdGEubHVhIiwic291cmNlUm9vdCI6IiJ9