isaacscript-common 9.18.4 → 9.19.2

package/dist/src/functions/kColor.lua

@@ -0,0 +1,103 @@
+local ____exports = {}
+local OBJECT_NAME
+local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____isaacAPIClass = require("src.functions.isaacAPIClass")
+local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
+local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
+local ____random = require("src.functions.random")
+local getRandom = ____random.getRandom
+local ____rng = require("src.functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+local newRNG = ____rng.newRNG
+local ____table = require("src.functions.table")
+local copyValuesToTable = ____table.copyValuesToTable
+local getNumbersFromTable = ____table.getNumbersFromTable
+local tableHasKeys = ____table.tableHasKeys
+local ____types = require("src.functions.types")
+local isTable = ____types.isTable
+--- Helper function to check if something is an instantiated `KColor` object.
+function ____exports.isKColor(self, object)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
+end
+OBJECT_NAME = "KColor"
+local KEYS = {"Red", "Green", "Blue", "Alpha"}
+--- Helper function to copy a `KColor` Isaac API class.
+function ____exports.copyKColor(self, kColor)
+    if not ____exports.isKColor(nil, kColor) then
+        error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    return KColor(kColor.Red, kColor.Green, kColor.Blue, kColor.Alpha)
+end
+--- Helper function to convert a `SerializedKColor` object to a normal `KColor` object. (This is used
+-- by the save data manager when reading data from the "save#.dat" file.)
+function ____exports.deserializeKColor(self, kColor)
+    if not isTable(nil, kColor) then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+    end
+    local r, g, b, a = table.unpack(getNumbersFromTable(
+        nil,
+        kColor,
+        OBJECT_NAME,
+        table.unpack(KEYS)
+    ))
+    if r == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Red")
+    end
+    if g == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Green")
+    end
+    if b == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Blue")
+    end
+    if a == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Alpha")
+    end
+    return KColor(r, g, b, a)
+end
+--- Helper function to get a random color.
+-- 
+-- @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 alpha Optional. The alpha value to use. Default is 1.
+function ____exports.getRandomKColor(self, seedOrRNG, alpha)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if alpha == nil then
+        alpha = 1
+    end
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
+    local r = getRandom(nil, rng)
+    local g = getRandom(nil, rng)
+    local b = getRandom(nil, rng)
+    return KColor(r, g, b, alpha)
+end
+--- Used to determine is the given table is a serialized `KColor` object created by the save data
+-- manager and/or the `deepCopy` function.
+function ____exports.isSerializedKColor(self, object)
+    if not isTable(nil, object) then
+        return false
+    end
+    return tableHasKeys(
+        nil,
+        object,
+        table.unpack(KEYS)
+    ) and object[SerializationBrand.K_COLOR] ~= nil
+end
+function ____exports.kColorEquals(self, kColor1, kColor2)
+    return isaacAPIClassEquals(nil, kColor1, kColor2, KEYS)
+end
+--- Helper function to convert a `KColor` object to a `SerializedKColor` object. (This is used by the
+-- save data manager when writing data from the "save#.dat" file.)
+function ____exports.serializeKColor(self, kColor)
+    if not ____exports.isKColor(nil, kColor) then
+        error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    local kColorTable = {}
+    copyValuesToTable(nil, kColor, KEYS, kColorTable)
+    kColorTable[SerializationBrand.K_COLOR] = ""
+    return kColorTable
+end
+return ____exports

package/dist/src/functions/language.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"language.d.ts","sourceRoot":"","sources":["../../../src/functions/language.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAGxC"}

package/dist/src/functions/language.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+local ____languageNames = require("src.objects.languageNames")
+local LANGUAGE_NAMES = ____languageNames.LANGUAGE_NAMES
+--- Helper function to convert the language abbreviation from `Options.Language` to the "full"
+-- language name.
+-- 
+-- For example, if the current language is set to Korean, `Options.Language` will be set to "kr",
+-- and this function will return "Korean".
+function ____exports.getLanguageName(self)
+    local languageAbbreviation = Options.Language
+    return LANGUAGE_NAMES[languageAbbreviation]
+end
+return ____exports

package/dist/src/functions/level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"level.d.ts","sourceRoot":"","sources":["../../../src/functions/level.ts"],"names":[],"mappings":"AAMA,wBAAgB,qBAAqB,IAAI,IAAI,CAqB5C"}

package/dist/src/functions/level.lua

@@ -0,0 +1,30 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____levelGrid = require("src.functions.levelGrid")
+local isDoorSlotValidAtGridIndexForRedRoom = ____levelGrid.isDoorSlotValidAtGridIndexForRedRoom
+local ____rooms = require("src.functions.rooms")
+local getNumRooms = ____rooms.getNumRooms
+local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
+function ____exports.fillLevelWithRedRooms(self)
+    local level = game:GetLevel()
+    local numRoomsInGrid
+    repeat
+        do
+            local roomsInGrid = getRoomsInsideGrid(nil)
+            numRoomsInGrid = #roomsInGrid
+            for ____, roomDescriptor in ipairs(roomsInGrid) do
+                for ____, doorSlot in ipairs(getEnumValues(nil, DoorSlot)) do
+                    if isDoorSlotValidAtGridIndexForRedRoom(nil, doorSlot, roomDescriptor.GridIndex) then
+                        level:MakeRedRoomDoor(roomDescriptor.GridIndex, doorSlot)
+                    end
+                end
+            end
+        end
+    until not (numRoomsInGrid ~= getNumRooms(nil))
+end
+return ____exports

package/dist/src/functions/levelGrid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEL,QAAQ,EAKR,SAAS,EACT,QAAQ,EACT,MAAM,8BAA8B,CAAC;AA8BtC;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAK7E;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,CACnD,aAAa,CAAC,EAAE,GAAG,GAClB,GAAG,EAAE,CAKP;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,0BAA0B,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAerE;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,GAAG,EAAE,CAG7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,GAErC,CAAC,qBAAqB,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,CAAC,GACvE,SAAS,CAOZ;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,GAClB,KAAK,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC,CA8CjD;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,IAAI,KAAK,CACnD;IAAC,qBAAqB,EAAE,GAAG;IAAE,QAAQ,EAAE,QAAQ;IAAE,gBAAgB,EAAE,GAAG;CAAC,CACxE,CA2BA;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAgBpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,EAAE,CAWzE;AAED;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAiBpB;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAEpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAapB;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,CACxD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAiBpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAKtD;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAGT;AAED,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAqBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM7D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAmD/D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAKtE"}

package/dist/src/functions/levelGrid.lua

@@ -0,0 +1,404 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local Map = ____lualib.Map
+local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local ____exports = {}
+local ADJACENT_ROOM_GRID_INDEX_DELTAS
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
+local DownpourRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.DownpourRoomSubType
+local LevelStateFlag = ____isaac_2Dtypescript_2Ddefinitions.LevelStateFlag
+local MinesRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.MinesRoomSubType
+local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("src.core.constants")
+local ALL_DISPLAY_FLAGS = ____constants.ALL_DISPLAY_FLAGS
+local LEVEL_GRID_ROW_WIDTH = ____constants.LEVEL_GRID_ROW_WIDTH
+local MAX_LEVEL_GRID_INDEX = ____constants.MAX_LEVEL_GRID_INDEX
+local ____roomShapeToDoorSlotsToGridIndexDelta = require("src.objects.roomShapeToDoorSlotsToGridIndexDelta")
+local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToDoorSlotsToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
+local ____array = require("src.functions.array")
+local getRandomArrayElement = ____array.getRandomArrayElement
+local ____doors = require("src.functions.doors")
+local doorSlotToDoorSlotFlag = ____doors.doorSlotToDoorSlotFlag
+local ____flag = require("src.functions.flag")
+local addFlag = ____flag.addFlag
+local hasFlag = ____flag.hasFlag
+local removeFlag = ____flag.removeFlag
+local ____rng = require("src.functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+local newRNG = ____rng.newRNG
+local ____roomData = require("src.functions.roomData")
+local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
+local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomShape = ____roomData.getRoomShape
+local ____rooms = require("src.functions.rooms")
+local getRooms = ____rooms.getRooms
+local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
+local ____roomShape = require("src.functions.roomShape")
+local getGridIndexDelta = ____roomShape.getGridIndexDelta
+local ____types = require("src.functions.types")
+local asNumber = ____types.asNumber
+--- Helper function to get only the adjacent room grid indexes that exist (i.e. have room data).
+-- 
+-- This is just a filtering of the results of the `getAdjacentExistingRoomGridIndexes` function. See
+-- that function for more information.
+function ____exports.getAdjacentExistingRoomGridIndexes(self, roomGridIndex)
+    local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
+    return __TS__ArrayFilter(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) ~= nil end
+    )
+end
+--- Helper function to get all of the room grid indexes that are adjacent to a given room grid index
+-- (even if those room grid indexes do not have any rooms in them).
+-- 
+-- Adjacent room grid indexes that are outside of the grid will not be included in the returned
+-- array.
+-- 
+-- If a room grid index is provided that is outside of the grid, then an empty array will be
+-- returned.
+-- 
+-- Note that this function does not take the shape of the room into account; it only looks at a
+-- single room grid index.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getAdjacentRoomGridIndexes(self, roomGridIndex)
+    local roomGridIndexToUse = roomGridIndex == nil and getRoomGridIndex(nil) or roomGridIndex
+    if not ____exports.isRoomInsideGrid(nil, roomGridIndexToUse) then
+        return {}
+    end
+    local adjacentRoomGridIndexes = __TS__ArrayMap(
+        ADJACENT_ROOM_GRID_INDEX_DELTAS,
+        function(____, delta) return roomGridIndexToUse + delta end
+    )
+    return __TS__ArrayFilter(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return ____exports.isRoomInsideGrid(nil, adjacentRoomGridIndex) end
+    )
+end
+--- Helper function to iterate through the possible doors for a room and see if any of them would be
+-- a valid spot to insert a brand new room on the floor. (Any potential new rooms cannot be
+-- connected to any other existing rooms on the floor.)
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns A array of tuples of `DoorSlot` and room grid index.
+function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if not ____exports.isRoomInsideGrid(nil, roomDescriptor.SafeGridIndex) then
+        return {}
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return {}
+    end
+    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeAdjacentNonExistingGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+    local roomCandidates = {}
+    for ____, ____value in __TS__Iterator(doorSlotToRoomGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local adjacentRoomGridIndex = ____value[2]
+        do
+            local doorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
+            if not hasFlag(nil, roomData.Doors, doorSlotFlag) then
+                goto __continue17
+            end
+            if not ____exports.isDeadEnd(nil, adjacentRoomGridIndex) then
+                goto __continue17
+            end
+            roomCandidates[#roomCandidates + 1] = {doorSlot, adjacentRoomGridIndex}
+        end
+        ::__continue17::
+    end
+    return roomCandidates
+end
+--- Helper function to search through all of the rooms on the floor for a spot to insert a brand new
+-- room.
+-- 
+-- @returns A array of tuples containing the adjacent room grid index, the `DoorSlot`, and the new
+-- room grid index.
+function ____exports.getNewRoomCandidatesForLevel(self)
+    local rooms = getRoomsInsideGrid(nil)
+    local normalRooms = __TS__ArrayFilter(
+        rooms,
+        function(____, room) return room.Data ~= nil and room.Data.Type == RoomType.DEFAULT and room.Data.Subtype ~= asNumber(nil, DownpourRoomSubType.MIRROR) and room.Data.Subtype ~= asNumber(nil, MinesRoomSubType.MINESHAFT_ENTRANCE) end
+    )
+    local newRoomCandidates = {}
+    for ____, room in ipairs(normalRooms) do
+        local newRoomCandidatesBesideRoom = ____exports.getNewRoomCandidatesBesideRoom(nil, room.SafeGridIndex)
+        for ____, ____value in ipairs(newRoomCandidatesBesideRoom) do
+            local doorSlot = ____value[1]
+            local newRoomGridIndex = ____value[2]
+            newRoomCandidates[#newRoomCandidates + 1] = {room.SafeGridIndex, doorSlot, newRoomGridIndex}
+        end
+    end
+    return newRoomCandidates
+end
+--- Helper function to get only the adjacent room grid indexes for a room shape that exist (i.e. have
+-- room data).
+-- 
+-- This is just a filtering of the results of the `getRoomShapeAdjacentGridIndexes` function. See
+-- that function for more information.
+function ____exports.getRoomShapeAdjacentExistingGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeAdjacentGridIndexes = ____exports.getRoomShapeAdjacentGridIndexes(nil, safeRoomGridIndex, roomShape)
+    for ____, ____value in __TS__Iterator(roomShapeAdjacentGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local roomGridIndex = ____value[2]
+        local roomData = getRoomData(nil, roomGridIndex)
+        if roomData == nil then
+            roomShapeAdjacentGridIndexes:delete(doorSlot)
+        end
+    end
+    return roomShapeAdjacentGridIndexes
+end
+--- Helper function to get the room grid index delta that each hypothetical door in a given room
+-- shape would go to.
+-- 
+-- This is used by the `getRoomShapeAdjacentGridIndexes` function.
+-- 
+-- @returns A map of `DoorSlot` to the corresponding room grid index delta.
+function ____exports.getRoomShapeAdjacentGridIndexDeltas(self, roomShape)
+    return ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
+end
+--- Helper function to get the room grid index that each hypothetical door in a given room shape
+-- would go to. (This will not include room grid indexes that are outside of the grid.)
+-- 
+-- @param safeRoomGridIndex This must be the room safe grid index (i.e. the top-left room grid index
+-- for the respective room).
+-- @param roomShape The shape of the room.
+-- @returns A map of `DoorSlot` to the corresponding room grid index.
+function ____exports.getRoomShapeAdjacentGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeAdjacentGridIndexDeltas = ____exports.getRoomShapeAdjacentGridIndexDeltas(nil, roomShape)
+    local adjacentGridIndexes = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(roomShapeAdjacentGridIndexDeltas:entries()) do
+        local doorSlot = ____value[1]
+        local delta = ____value[2]
+        local roomGridIndex = safeRoomGridIndex + delta
+        if ____exports.isRoomInsideGrid(nil, roomGridIndex) then
+            adjacentGridIndexes:set(doorSlot, roomGridIndex)
+        end
+    end
+    return adjacentGridIndexes
+end
+--- Helper function to get only the adjacent room grid indexes for a room shape that do not exist
+-- (i.e. do not have room data).
+-- 
+-- This is just a filtering of the results of the `getRoomShapeAdjacentGridIndexes` function. See
+-- that function for more information.
+function ____exports.getRoomShapeAdjacentNonExistingGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeAdjacentGridIndexes = ____exports.getRoomShapeAdjacentGridIndexes(nil, safeRoomGridIndex, roomShape)
+    for ____, ____value in __TS__Iterator(roomShapeAdjacentGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local roomGridIndex = ____value[2]
+        local roomData = getRoomData(nil, roomGridIndex)
+        if roomData ~= nil then
+            roomShapeAdjacentGridIndexes:delete(doorSlot)
+        end
+    end
+    return roomShapeAdjacentGridIndexes
+end
+--- Helper function to check if the given room grid index is a dead end. Specifically, this is
+-- defined as having only one adjacent room that exists.
+-- 
+-- Note that this function does not take the shape of the room into account; it only looks at a
+-- single room grid index.
+-- 
+-- This function does not care if the given room grid index actually exists, so you can use it to
+-- check if a hypothetical room would be a dead end.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isDeadEnd(self, roomGridIndex)
+    local adjacentExistingRoomGridIndexes = ____exports.getAdjacentExistingRoomGridIndexes(nil, roomGridIndex)
+    return #adjacentExistingRoomGridIndexes == 1
+end
+--- Helper function to determine if a given room grid index is inside of the normal 13x13 level grid.
+-- 
+-- For example, Devil Rooms and the Mega Satan room are not considered to be inside the grid.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isRoomInsideGrid(self, roomGridIndex)
+    if roomGridIndex == nil then
+        roomGridIndex = getRoomGridIndex(nil)
+    end
+    return roomGridIndex >= 0 and roomGridIndex <= MAX_LEVEL_GRID_INDEX
+end
+--- Helper function to check if a room exists at the given room grid index. (A room will exist if it
+-- has non-undefined data in the room descriptor.)
+function ____exports.roomExists(self, roomGridIndex)
+    local roomData = getRoomData(nil, roomGridIndex)
+    return roomData ~= nil
+end
+local LEFT = -1
+local UP = -LEVEL_GRID_ROW_WIDTH
+local RIGHT = 1
+local DOWN = LEVEL_GRID_ROW_WIDTH
+ADJACENT_ROOM_GRID_INDEX_DELTAS = {LEFT, UP, RIGHT, DOWN}
+--- Helper function to get only the adjacent room grid indexes that do not exist (i.e. do not have
+-- room data).
+-- 
+-- This is just a filtering of the results of the `getAdjacentExistingRoomGridIndexes` function. See
+-- that function for more information.
+function ____exports.getAdjacentNonExistingRoomGridIndexes(self, roomGridIndex)
+    local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
+    return __TS__ArrayFilter(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) == nil end
+    )
+end
+--- Helper function to get the room safe grid index for every room on the entire floor.
+function ____exports.getAllRoomGridIndexes(self)
+    local rooms = getRooms(nil)
+    return __TS__ArrayMap(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
+    )
+end
+--- Helper function to pick a random valid spot on the floor to insert a brand new room. Note that
+-- some floors will not have any valid spots. If this is the case, this function will return
+-- undefined.
+-- 
+-- @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()`.
+-- @returns Either a tuple of adjacent room grid index, `DoorSlot`, and new room grid index, or
+-- undefined.
+function ____exports.getNewRoomCandidate(self, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    local newRoomCandidatesForLevel = ____exports.getNewRoomCandidatesForLevel(nil)
+    if #newRoomCandidatesForLevel == 0 then
+        return nil
+    end
+    return getRandomArrayElement(nil, newRoomCandidatesForLevel, seedOrRNG)
+end
+--- Helper function to get the grid indexes of all the rooms connected to the given room index,
+-- taking the shape of the room into account. (This will only include rooms with valid data.)
+-- 
+-- Returns an empty map if the provided room grid index is out of bounds or has no associated room
+-- data.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns A map of `DoorSlot` to the corresponding room grid index.
+function ____exports.getRoomAdjacentGridIndexes(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if not ____exports.isRoomInsideGrid(nil, roomDescriptor.SafeGridIndex) then
+        return __TS__New(Map)
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return __TS__New(Map)
+    end
+    return ____exports.getRoomShapeAdjacentExistingGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+end
+--- Helper function to get an array of all of the safe grid indexes for rooms that match the
+-- specified room type.
+-- 
+-- This function only searches through rooms in the current dimension.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get the combined grid
+-- indexes for N room types.
+function ____exports.getRoomGridIndexesForType(self, ...)
+    local roomTypesSet = __TS__New(Set, {...})
+    local rooms = getRoomsInsideGrid(nil)
+    local matchingRooms = __TS__ArrayFilter(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypesSet:has(roomDescriptor.Data.Type) end
+    )
+    return __TS__ArrayMap(
+        matchingRooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
+    )
+end
+function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
+    local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
+    return allowedDoors:has(doorSlot)
+end
+function ____exports.isDoorSlotValidAtGridIndexForRedRoom(self, doorSlot, roomGridIndex)
+    local doorSlotValidAtGridIndex = ____exports.isDoorSlotValidAtGridIndex(nil, doorSlot, roomGridIndex)
+    if not doorSlotValidAtGridIndex then
+        return false
+    end
+    local roomShape = getRoomShape(nil, roomGridIndex)
+    if roomShape == nil then
+        return false
+    end
+    local delta = getGridIndexDelta(nil, roomShape, doorSlot)
+    if delta == nil then
+        return false
+    end
+    local redRoomGridIndex = roomGridIndex + delta
+    return not ____exports.roomExists(nil, redRoomGridIndex) and ____exports.isRoomInsideGrid(nil, redRoomGridIndex)
+end
+--- Helper function to detect if the provided room was created by the Red Key item. Under the hood,
+-- this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isRedKeyRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+end
+--- Helper function to generate a new room on the floor at a valid dead end attached to a normal
+-- room.
+-- 
+-- Under the hood, this function uses the `Level.MakeRedRoomDoor` method to create the room.
+-- 
+-- The newly created room will have data corresponding to the game's randomly generated red room. If
+-- you want to modify this, use the `setRoomData` helper function.
+-- 
+-- @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 `Level.GetDungeonPlacementSeed`.
+-- @returns The room grid index of the new room or undefined if the floor had no valid dead ends to
+-- place a room.
+function ____exports.newRoom(self, seedOrRNG)
+    local level = game:GetLevel()
+    if seedOrRNG == nil then
+        seedOrRNG = level:GetDungeonPlacementSeed()
+    end
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
+    local newRoomCandidate = ____exports.getNewRoomCandidate(nil, rng)
+    if newRoomCandidate == nil then
+        return nil
+    end
+    local adjacentRoomGridIndex, doorSlot, newRoomGridIndex = table.unpack(newRoomCandidate)
+    level:MakeRedRoomDoor(adjacentRoomGridIndex, doorSlot)
+    local roomDescriptor = getRoomDescriptor(nil, newRoomGridIndex)
+    roomDescriptor.Flags = removeFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+    local roomData = roomDescriptor.Data
+    if roomData ~= nil then
+        local hasFullMap = level:GetStateFlag(LevelStateFlag.FULL_MAP_EFFECT)
+        local hasCompass = level:GetStateFlag(LevelStateFlag.COMPASS_EFFECT)
+        local hasBlueMap = level:GetStateFlag(LevelStateFlag.BLUE_MAP_EFFECT)
+        local roomType = roomData.Type
+        local isSecretRoom = roomType == RoomType.SECRET or roomType == RoomType.SUPER_SECRET
+        if hasFullMap then
+            roomDescriptor.DisplayFlags = ALL_DISPLAY_FLAGS
+        elseif not isSecretRoom and hasCompass then
+            roomDescriptor.DisplayFlags = addFlag(nil, DisplayFlag.VISIBLE, DisplayFlag.SHOW_ICON)
+        elseif isSecretRoom and hasBlueMap then
+            roomDescriptor.DisplayFlags = addFlag(nil, DisplayFlag.VISIBLE, DisplayFlag.SHOW_ICON)
+        end
+    end
+    return newRoomGridIndex
+end
+--- Helper function to get the coordinates of a given grid index. The floor is represented by a 13x13
+-- grid.
+-- 
+-- - Since the starting room is in the center, the starting room grid index of 84 is equal to
+--   coordinates of (6, 6).
+-- - The top-left grid index of 0 is equal to coordinates of: (12, 0)
+-- - The top-right grid index of 12 is equal to coordinates of: (0, 0)
+-- - The bottom-left grid index of 156 is equal to coordinates of: (0, 12)
+-- - The bottom-right grid index of 168 is equal to coordinates of: (12, 12)
+function ____exports.roomGridIndexToXY(self, roomGridIndex)
+    local x = roomGridIndex % LEVEL_GRID_ROW_WIDTH
+    local y = math.floor(roomGridIndex / LEVEL_GRID_ROW_WIDTH)
+    return {x, y}
+end
+return ____exports

package/dist/src/functions/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../src/functions/log.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EAKV,cAAc,EAGd,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAkBtC;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,EAKX,kBAAkB,SAAI,GACrB,MAAM,CAiBR;AAED;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAGrC;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAG3D;AAED,wBAAgB,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,IAAI,CAS7E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAI3C;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAGhD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAI1C;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,UAAU,EACrD,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC3B,WAAW,SAAK,GACf,IAAI,CAmBN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAiBxC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAI9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAkBzC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAazD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CA0B3D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAoB1D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAC/C,IAAI,CAEN;AAED,sEAAsE;AACtE,wBAAgB,OAAO,IAAI,IAAI,CA4B9B;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAiBrC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAUzE;AAED,gFAAgF;AAChF,wBAAgB,SAAS,IAAI,IAAI,CAQhC;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,YAAY,SAAI,GAAG,IAAI,CA2ClE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,CAAC,EACtC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,IAAI,CA0BN;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAEvE;AAED,gGAAgG;AAChG,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAEpE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAsBnD;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI,CAG7D"}