isaacscript-common 73.1.1 → 75.0.0

package/dist/functions/rng.lua

@@ -0,0 +1,129 @@
+local ____lualib = require("lualib_bundle")
+local __TS__TypeOf = ____lualib.__TS__TypeOf
+local ____exports = {}
+local RECOMMENDED_SHIFT_IDX, OBJECT_NAME
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local ____SerializationBrand = require("enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
+local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
+local ____log = require("functions.log")
+local logError = ____log.logError
+local ____table = require("functions.table")
+local getNumbersFromTable = ____table.getNumbersFromTable
+local tableHasKeys = ____table.tableHasKeys
+local ____types = require("functions.types")
+local isTable = ____types.isTable
+local ____utils = require("functions.utils")
+local assertDefined = ____utils.assertDefined
+--- 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 a new RNG object using Blade's recommended shift index.
+-- 
+-- @param seed Optional. The seed to initialize it with. Default is a random seed.
+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
+        seed = ____exports.getRandomSeed(nil)
+        logError("Failed to set a RNG object to a seed of 0. Using a random value instead.")
+    end
+    rng:SetSeed(seed, RECOMMENDED_SHIFT_IDX)
+end
+RECOMMENDED_SHIFT_IDX = 35
+OBJECT_NAME = "RNG"
+local KEYS = {"seed"}
+--- Helper function to copy an `RNG` Isaac API class.
+function ____exports.copyRNG(self, rng)
+    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
+--- Helper function to convert a `SerializedRNG` object to a normal `RNG` object. (This is used by
+-- the save data manager when reading data from the "save#.dat" file.)
+function ____exports.deserializeRNG(self, rng)
+    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 seed = table.unpack(getNumbersFromTable(
+        nil,
+        rng,
+        OBJECT_NAME,
+        table.unpack(KEYS)
+    ))
+    assertDefined(nil, seed, ("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: seed")
+    return ____exports.newRNG(nil, seed)
+end
+--- Used to determine is the given table is a serialized `RNG` object created by 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 convert a `RNG` object to a `SerializedRNG` object. (This is used by the save
+-- data manager when writing data from the "save#.dat" file.)
+function ____exports.serializeRNG(self, rng)
+    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
+--- 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

package/dist/functions/rockAlt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAMxD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAgB7D"}

package/dist/functions/rockAlt.lua

@@ -0,0 +1,49 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local ____backdropTypeToRockAltType = require("objects.backdropTypeToRockAltType")
+local BACKDROP_TYPE_TO_ROCK_ALT_TYPE = ____backdropTypeToRockAltType.BACKDROP_TYPE_TO_ROCK_ALT_TYPE
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local getNPCs = ____entitiesSpecific.getNPCs
+local ____gridEntities = require("functions.gridEntities")
+local removeEntitiesSpawnedFromGridEntity = ____gridEntities.removeEntitiesSpawnedFromGridEntity
+local ____pickupsSpecific = require("functions.pickupsSpecific")
+local getCoins = ____pickupsSpecific.getCoins
+local getCollectibles = ____pickupsSpecific.getCollectibles
+local getTrinkets = ____pickupsSpecific.getTrinkets
+--- Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
+-- will have.
+-- 
+-- The rock type is based on the backdrop of the room.
+-- 
+-- For example, if you change the backdrop of the starting room of the run to `BackdropType.CAVES`,
+-- and then spawn `GridEntityType.ROCK_ALT`, it will be a mushroom instead of an urn. Additionally,
+-- if it is destroyed, it will generate mushroom-appropriate rewards.
+-- 
+-- On the other hand, if an urn is spawned first before the backdrop is changed to
+-- `BackdropType.CAVES`, the graphic of the urn will not switch to a mushroom. However, when
+-- destroyed, the urn will still generate mushroom-appropriate rewards.
+function ____exports.getRockAltType(self)
+    local room = game:GetRoom()
+    local backdropType = room:GetBackdropType()
+    return BACKDROP_TYPE_TO_ROCK_ALT_TYPE[backdropType]
+end
+--- Helper function to remove all coins, trinkets, and so on that spawned from breaking an urn.
+-- 
+-- The rewards are based on the ones from the wiki:
+-- https://bindingofisaacrebirth.fandom.com/wiki/Rocks#Urns
+function ____exports.removeUrnRewards(self, gridEntity)
+    local coins = getCoins(nil)
+    removeEntitiesSpawnedFromGridEntity(nil, coins, gridEntity)
+    local quarters = getCollectibles(nil, CollectibleType.QUARTER)
+    removeEntitiesSpawnedFromGridEntity(nil, quarters, gridEntity)
+    local swallowedPennies = getTrinkets(nil, TrinketType.SWALLOWED_PENNY)
+    removeEntitiesSpawnedFromGridEntity(nil, swallowedPennies, gridEntity)
+    local spiders = getNPCs(nil, EntityType.SPIDER)
+    removeEntitiesSpawnedFromGridEntity(nil, spiders, gridEntity)
+end
+return ____exports

package/dist/functions/roomData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomData.d.ts","sourceRoot":"","sources":["../../src/functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAMtC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,CAgBtE;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,UAAU,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAAC;AAOzE;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAQrE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,QAAQ,CAAC,cAAc,CAAC,CAGpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAUtC;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGzD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,IAAI,MAAM,CAAC;AAEtC;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAAC;AAOrE;;;;;;;;GAQG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAAC;AAOzE;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC;AAE1C;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,GAAG,SAAS,CAAC;AAOzE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAOrE;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,GAAG,SAAS,CAAC;AAavE;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC;AAEtC;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAOrE;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAG5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,aAAa,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,GAAG,IAAI,CAG1E"}

package/dist/functions/roomData.lua

@@ -0,0 +1,262 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____cachedEnumValues = require("arrays.cachedEnumValues")
+local DOOR_SLOT_FLAG_VALUES = ____cachedEnumValues.DOOR_SLOT_FLAG_VALUES
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local ____doors = require("functions.doors")
+local doorSlotFlagToDoorSlot = ____doors.doorSlotFlagToDoorSlot
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+--- Helper function to get the room data for the current room.
+-- 
+-- You can optionally provide a room grid index as an argument to get the data for that room
+-- instead.
+-- 
+-- (The version of the function without any arguments will not return undefined since the current
+-- room is guaranteed to have data.)
+-- Helper function to get the room data for the current or provided room.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room data for the room or undefined if the provided room does not have any data.
+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, as
+--   demonstrated by entering a Genesis room and entering `l
+--   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console).
+-- 
+-- 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
+    for ____, doorSlotFlag in ipairs(DOOR_SLOT_FLAG_VALUES) 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 current room as it appears in the STB/XML data.
+-- 
+-- You can optionally provide a room grid index as an argument to get the name for that room
+-- instead.
+-- 
+-- (The version of the function without any arguments will not return undefined since the current
+-- room is guaranteed to have data.)
+-- 
+-- If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
+-- Helper function to get the name of the room as it appears in the STB/XML data.
+-- 
+-- If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room name. Returns undefined if the room data was not found.
+function ____exports.getRoomName(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_0
+    if roomData == nil then
+        ____temp_0 = nil
+    else
+        ____temp_0 = roomData.Name
+    end
+    return ____temp_0
+end
+--- Helper function to get the shape of the current room as it appears in the STB/XML data.
+-- 
+-- You can optionally provide a room grid index as an argument to get the shape for that room
+-- instead.
+-- 
+-- (The version of the function without any arguments will not return undefined since the current
+-- room is guaranteed to have data.)
+-- Helper function to get the shape of the room as it appears in the STB/XML data.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room shape. Returns undefined if the room data was not found.
+function ____exports.getRoomShape(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_1
+    if roomData == nil then
+        ____temp_1 = nil
+    else
+        ____temp_1 = roomData.Shape
+    end
+    return ____temp_1
+end
+--- Helper function to get the stage ID for the current room as it appears in the STB/XML 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 `StageID.DEPTHS` (7).
+-- 
+-- You can optionally provide a room grid index as an argument to get the stage ID for that room
+-- instead.
+-- 
+-- (The version of the function without any arguments will not return undefined since the current
+-- room is guaranteed to have data.)
+-- Helper function to get the stage ID for a room as it appears in the STB/XML 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 `StageID.DEPTHS` (7).
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room stage ID. Returns undefined if the room data was not found.
+function ____exports.getRoomStageID(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_2
+    if roomData == nil then
+        ____temp_2 = nil
+    else
+        ____temp_2 = roomData.StageID
+    end
+    return ____temp_2
+end
+--- Helper function to get the sub-type for the current room as it appears in the STB/XML 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 from
+-- The Stairway.
+-- 
+-- You can optionally provide a room grid index as an argument to get the sub-type for that room
+-- instead.
+-- 
+-- (The version of the function without any arguments will not return undefined since the current
+-- room is guaranteed to have data.)
+-- Helper function to get the sub-type for a room as it appears in the STB/XML 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 from
+-- The Stairway.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room sub-type. Returns undefined if the room data was not found.
+function ____exports.getRoomSubType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_3
+    if roomData == nil then
+        ____temp_3 = nil
+    else
+        ____temp_3 = roomData.Subtype
+    end
+    return ____temp_3
+end
+--- Helper function to get the type for the current room as it appears in the STB/XML data.
+-- 
+-- You can optionally provide a room grid index as an argument to get the type for that room
+-- instead.
+-- 
+-- (The version of the function without any arguments will not return undefined since the current
+-- room is guaranteed to have data.)
+-- Helper function to get the type for a room as it appears in the STB/XML data.
+-- 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 type. Returns undefined if the room data was not found.
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room data type. Returns -1 if the room data was not found.
+function ____exports.getRoomType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_4
+    if roomData == nil then
+        ____temp_4 = nil
+    else
+        ____temp_4 = roomData.Type
+    end
+    return ____temp_4
+end
+--- Helper function to get the variant for the current room as it appears in the STB/XML 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.
+-- 
+-- You can optionally provide a room grid index as an argument to get the variant for that room
+-- instead.
+-- 
+-- (The version of the function without any arguments will not return undefined since the current
+-- room is guaranteed to have data.)
+-- Helper function to get the variant for a room as it appears in the STB/XML 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 undefined if the room data 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 `POST_NEW_ROOM`
+-- 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 `POST_NEW_ROOM` 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
+--- Helper function to set the data for a given room. This will change the room type, contents, and
+-- so on.
+function ____exports.setRoomData(self, roomGridIndex, roomData)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    roomDescriptor.Data = roomData
+end
+return ____exports

package/dist/functions/roomGrid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomGrid.d.ts","sourceRoot":"","sources":["../../src/functions/roomGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAU9D;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,CAAC,EAAE,GAAG,EACN,CAAC,EAAE,GAAG,GACL,QAAQ,CAAC,MAAM,CAAC,CAGlB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,GAAG,EACd,SAAS,EAAE,SAAS,GACnB,QAAQ,CAAC,MAAM,CAAC,CAMlB;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,MAAM,GACnB,QAAQ,CAAC,MAAM,CAAC,CAKlB;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,SAAS,GACnB,OAAO,CAIT;AA0BD;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,MAAM,GACf,QAAQ,CAAC,MAAM,CAAC,CAIlB;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAC7C,QAAQ,EAAE,MAAM,GACf,QAAQ,CAAC,MAAM,CAAC,CAIlB"}

package/dist/functions/roomGrid.lua

@@ -0,0 +1,83 @@
+local ____exports = {}
+local isValidGridPositionNormal, isValidGridPositionLRoom
+local ____LRoomShapeToRectangles = require("objects.LRoomShapeToRectangles")
+local L_ROOM_SHAPE_TO_RECTANGLES = ____LRoomShapeToRectangles.L_ROOM_SHAPE_TO_RECTANGLES
+local ____math = require("functions.math")
+local inRectangle = ____math.inRectangle
+local ____roomShape = require("functions.roomShape")
+local getRoomShapeBottomRightPosition = ____roomShape.getRoomShapeBottomRightPosition
+local getRoomShapeTopLeftPosition = ____roomShape.getRoomShapeTopLeftPosition
+local getRoomShapeWidth = ____roomShape.getRoomShapeWidth
+local isLRoomShape = ____roomShape.isLRoomShape
+--- Helper function to convert a grid position `Vector` to a world position `Vector`.
+-- 
+-- For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+function ____exports.gridPositionToWorldPosition(self, gridPosition)
+    local x = (gridPosition.X + 2) * 40
+    local y = (gridPosition.Y + 4) * 40
+    return Vector(x, y)
+end
+function isValidGridPositionNormal(self, gridPosition, roomShape)
+    local topLeft = getRoomShapeTopLeftPosition(nil, roomShape)
+    local bottomRight = getRoomShapeBottomRightPosition(nil, roomShape)
+    return inRectangle(nil, gridPosition, topLeft, bottomRight)
+end
+function isValidGridPositionLRoom(self, gridPosition, roomShape)
+    local rectangles = L_ROOM_SHAPE_TO_RECTANGLES[roomShape]
+    if rectangles == nil then
+        return false
+    end
+    local verticalTopLeft = rectangles.verticalTopLeft
+    local verticalBottomRight = rectangles.verticalBottomRight
+    local horizontalTopLeft = rectangles.horizontalTopLeft
+    local horizontalBottomRight = rectangles.horizontalBottomRight
+    return inRectangle(nil, gridPosition, verticalTopLeft, verticalBottomRight) or inRectangle(nil, gridPosition, horizontalTopLeft, horizontalBottomRight)
+end
+--- Helper function to convert grid coordinates to a world position `Vector`.
+-- 
+-- For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+function ____exports.gridCoordinatesToWorldPosition(self, x, y)
+    local gridPosition = Vector(x, y)
+    return ____exports.gridPositionToWorldPosition(nil, gridPosition)
+end
+--- Helper function to convert a grid index to a grid position.
+-- 
+-- For example, in a 1x1 room, grid index 0 is equal to "Vector(-1, -1) and grid index 16 is equal
+-- to "Vector(0, 0)".
+function ____exports.gridIndexToGridPosition(self, gridIndex, roomShape)
+    local gridWidth = getRoomShapeWidth(nil, roomShape)
+    local x = gridIndex % gridWidth - 1
+    local y = math.floor(gridIndex / gridWidth) - 1
+    return Vector(x, y)
+end
+--- Test if a grid position is actually in the given `RoomShape`.
+-- 
+-- In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+function ____exports.isValidGridPosition(self, gridPosition, roomShape)
+    local ____isLRoomShape_result_0
+    if isLRoomShape(nil, roomShape) then
+        ____isLRoomShape_result_0 = isValidGridPositionLRoom(nil, gridPosition, roomShape)
+    else
+        ____isLRoomShape_result_0 = isValidGridPositionNormal(nil, gridPosition, roomShape)
+    end
+    return ____isLRoomShape_result_0
+end
+--- Helper function to convert a world position `Vector` to a grid position `Vector`.
+-- 
+-- In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+function ____exports.worldPositionToGridPosition(self, worldPos)
+    local x = math.floor(worldPos.X / 40 - 2 + 0.5)
+    local y = math.floor(worldPos.Y / 40 - 4 + 0.5)
+    return Vector(x, y)
+end
+--- Helper function to convert a world position `Vector` to a grid position `Vector`.
+-- 
+-- In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+-- 
+-- This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
+function ____exports.worldPositionToGridPositionFast(self, worldPos)
+    local x = worldPos.X / 40 - 2
+    local y = worldPos.Y / 40 - 4
+    return Vector(x, y)
+end
+return ____exports

package/dist/functions/roomShape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomShape.d.ts","sourceRoot":"","sources":["../../src/functions/roomShape.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAanD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,GACjB,GAAG,GAAG,SAAS,CAIjB;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,SAAS,GACnB,QAAQ,CAAC,MAAM,CAAC,CAElB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,SAAS,GACnB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,SAAS,GACnB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,GACnB,QAAQ,CAAC,MAAM,CAAC,CAElB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE5D;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE3D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE5D;AAED,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE1D;AAED,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE1D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAGrE"}

package/dist/functions/roomShape.lua

@@ -0,0 +1,104 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local ____roomShapeBounds = require("objects.roomShapeBounds")
+local ROOM_SHAPE_BOUNDS = ____roomShapeBounds.ROOM_SHAPE_BOUNDS
+local ____roomShapeCorners = require("objects.roomShapeCorners")
+local ROOM_SHAPE_CORNERS = ____roomShapeCorners.ROOM_SHAPE_CORNERS
+local ____roomShapeLayoutSizes = require("objects.roomShapeLayoutSizes")
+local ROOM_SHAPE_LAYOUT_SIZES = ____roomShapeLayoutSizes.ROOM_SHAPE_LAYOUT_SIZES
+local ____roomShapeToBottomRightPosition = require("objects.roomShapeToBottomRightPosition")
+local ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = ____roomShapeToBottomRightPosition.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION
+local ____roomShapeToDoorSlotsToGridIndexDelta = require("objects.roomShapeToDoorSlotsToGridIndexDelta")
+local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToDoorSlotsToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
+local ____roomShapeToGridWidth = require("objects.roomShapeToGridWidth")
+local ROOM_SHAPE_TO_GRID_WIDTH = ____roomShapeToGridWidth.ROOM_SHAPE_TO_GRID_WIDTH
+local ____roomShapeToTopLeftPosition = require("objects.roomShapeToTopLeftPosition")
+local ROOM_SHAPE_TO_TOP_LEFT_POSITION = ____roomShapeToTopLeftPosition.ROOM_SHAPE_TO_TOP_LEFT_POSITION
+local ____roomShapeVolumes = require("objects.roomShapeVolumes")
+local ROOM_SHAPE_VOLUMES = ____roomShapeVolumes.ROOM_SHAPE_VOLUMES
+local ____LRoomShapesSet = require("sets.LRoomShapesSet")
+local L_ROOM_SHAPES_SET = ____LRoomShapesSet.L_ROOM_SHAPES_SET
+local ____bigRoomShapesSet = require("sets.bigRoomShapesSet")
+local BIG_ROOM_SHAPES_SET = ____bigRoomShapesSet.BIG_ROOM_SHAPES_SET
+local ____narrowRoomShapesSet = require("sets.narrowRoomShapesSet")
+local NARROW_ROOM_SHAPES_SET = ____narrowRoomShapesSet.NARROW_ROOM_SHAPES_SET
+--- Helper function to see if a given room shape will grant a single charge or a double charge to the
+-- player's active item(s).
+-- 
+-- For example, `RoomShape.SHAPE_2x2` will return true.
+function ____exports.isRoomShapeDoubleCharge(self, roomShape)
+    return roomShape >= RoomShape.SHAPE_2x2
+end
+--- Helper function to get the grid index delta that a door out of the given room shape would lead
+-- to. For example, if you went through the bottom door in a room of `RoomShape.SHAPE_1x2`, you
+-- would end up in a room with a grid index that is +26 units from the `SafeGridIndex` of where you
+-- started.
+function ____exports.getGridIndexDelta(self, roomShape, doorSlot)
+    local doorSlotToGridIndexMap = ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
+    return doorSlotToGridIndexMap:get(doorSlot)
+end
+--- Helper function to see if a given room shape will grant a single charge or a double charge to the
+-- player's active item(s).
+-- 
+-- For example, `RoomShape.SHAPE_2x2` will return 2.
+function ____exports.getRoomShapeBottomRightPosition(self, roomShape)
+    return ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION[roomShape]
+end
+--- Helper function to get the grid position of the bottom-right tile of a given room shape.
+-- 
+-- "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
+-- wall would be at "Vector(-1, -1)".)
+function ____exports.getRoomShapeBounds(self, roomShape)
+    return ROOM_SHAPE_BOUNDS[roomShape]
+end
+--- Helper function to get the number of charges that a given room shape will grant to a player upon
+-- clearing it.
+-- 
+-- For example, `RoomShape.SHAPE_2x2` will return 2.
+function ____exports.getRoomShapeCharges(self, roomShape)
+    return ____exports.isRoomShapeDoubleCharge(nil, roomShape) and 2 or 1
+end
+--- Helper function to get the corners that exist in the given room shape.
+-- 
+-- Note that these corner locations are not accurate for the Mother Boss Room and the Home closet
+-- rooms. (Those rooms have custom shapes.)
+function ____exports.getRoomShapeCorners(self, roomShape)
+    return ROOM_SHAPE_CORNERS[roomShape]
+end
+--- Helper function to get the dimensions of a room shape's layout. This is NOT the size of the
+-- room's actual contents! For that, use the `getRoomShapeBounds` function.
+-- 
+-- For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
+function ____exports.getRoomShapeLayoutSize(self, roomShape)
+    return ROOM_SHAPE_LAYOUT_SIZES[roomShape]
+end
+--- Helper function to get the grid position of the top-left tile of a given room shape.
+-- 
+-- "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
+-- wall would be at "Vector(-1, -1)".)
+function ____exports.getRoomShapeTopLeftPosition(self, roomShape)
+    return ROOM_SHAPE_TO_TOP_LEFT_POSITION[roomShape]
+end
+--- Helper function to get the volume of a room shape, which is the amount of tiles that are inside
+-- the room.
+-- 
+-- (This cannot be directly calculated from the bounds since L rooms are a special case.)
+function ____exports.getRoomShapeVolume(self, roomShape)
+    return ROOM_SHAPE_VOLUMES[roomShape]
+end
+function ____exports.getRoomShapeWidth(self, roomShape)
+    return ROOM_SHAPE_TO_GRID_WIDTH[roomShape]
+end
+--- Helper function to detect if the provided room shape is big. Specifically, this is all 1x2 rooms,
+-- 2x2 rooms, and L rooms.
+function ____exports.isBigRoomShape(self, roomShape)
+    return BIG_ROOM_SHAPES_SET:has(roomShape)
+end
+function ____exports.isLRoomShape(self, roomShape)
+    return L_ROOM_SHAPES_SET:has(roomShape)
+end
+function ____exports.isNarrowRoom(self, roomShape)
+    return NARROW_ROOM_SHAPES_SET:has(roomShape)
+end
+return ____exports

package/dist/functions/roomShapeWalls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomShapeWalls.d.ts","sourceRoot":"","sources":["../../src/functions/roomShapeWalls.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,SAAS,EAAE,MAAM,8BAA8B,CAAC;AA+EjE;;;;;;GAMG;AACH,wBAAgB,sCAAsC,CACpD,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,GAAG,CAAC,CAsLlB;AA8CD;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAmB9D"}