isaacscript-common 4.5.1 → 4.6.1

package/constants.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module core/Constants
- */
 import { CollectibleType, ItemPoolType, LevelStage, RoomType } from "isaac-typescript-definitions";
 /**
  * The distance of the laser when Azazel does not have any range up items yet. For more info, see

package/constantsFirstLast.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module Constants (First and Last)
- */
 import { Card, CollectibleType, PillColor, PillEffect, PlayerType, TrinketType } from "isaac-typescript-definitions";
 /** Equal to `CollectibleType.SAD_ONION`. */
 export declare const FIRST_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;

package/features/characterHealthConversion.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Easily create custom characters that have the same health mechanic as Blue Baby (red heart
+ * containers --> soul hearts) or Black Judas (red heart containers --> black hearts).
+ *
+ * @module
+ */
 import { HeartSubType, PlayerType } from "isaac-typescript-definitions";
 export declare type ConversionHeartSubType = HeartSubType.SOUL | HeartSubType.BLACK;
 /**

package/features/characterStats.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Easily create custom characters that have base stats different from that of Isaac.
+ *
+ * @module
+ */
 import { CacheFlag, PlayerType } from "isaac-typescript-definitions";
 /**
  * Helper function to manage the stats for a vanilla or custom character. Call this function once at

package/features/deployJSONRoom.lua

@@ -37,6 +37,7 @@ local removeAllBombs = ____entitySpecific.removeAllBombs
 local removeAllPickups = ____entitySpecific.removeAllPickups
 local ____gridEntity = require("functions.gridEntity")
 local convertXMLGridEntityType = ____gridEntity.convertXMLGridEntityType
+local getAllGridIndexes = ____gridEntity.getAllGridIndexes
 local getGridEntities = ____gridEntity.getGridEntities
 local removeAllGridExcept = ____gridEntity.removeAllGridExcept
 local removeGrid = ____gridEntity.removeGrid
@@ -59,8 +60,6 @@ local setRoomCleared = ____rooms.setRoomCleared
 local setRoomUncleared = ____rooms.setRoomUncleared
 local ____spawnCollectible = require("functions.spawnCollectible")
 local spawnCollectible = ____spawnCollectible.spawnCollectible
-local ____utils = require("functions.utils")
-local erange = ____utils.erange
 local ____runInNFrames = require("features.runInNFrames")
 local runNextGameFrame = ____runInNFrames.runNextGameFrame
 local ____exports = require("features.saveDataManager.exports")
@@ -182,10 +181,9 @@ function removeSpecificNPCs(self)
 end
 function fillRoomWithDecorations(self)
     local room = game:GetRoom()
-    local gridSize = room:GetGridSize()
     local roomListIndex = getRoomListIndex(nil)
     local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
-    for ____, gridIndex in ipairs(erange(nil, gridSize)) do
+    for ____, gridIndex in ipairs(getAllGridIndexes(nil)) do
         do
             local existingGridEntity = room:GetGridEntity(gridIndex)
             if existingGridEntity ~= nil then

package/features/disableAllSound.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module Disable All Sound
- */
 /**
  * Helper function to stop muting all sound effects and music.
  *

package/features/registerHotkey.lua

@@ -30,7 +30,7 @@ hotkeyFunctionMap = __TS__New(Map)
 keyPressedMap = __TS__New(DefaultMap, false)
 ---
 -- @internal
-function ____exports.characterHealthConversionInit(self, mod)
+function ____exports.registerHotkeyInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end
 function ____exports.registerHotkey(self, keyboard, func)

package/functions/array.d.ts

@@ -37,7 +37,7 @@ export declare function arrayRemoveIndex<T>(originalArray: T[] | readonly T[], .
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
 export declare function arrayRemoveIndexInPlace<T>(array: T[], ...indexesToRemove: int[]): boolean;
-export declare function arrayToString<T>(array: T[]): string;
+export declare function arrayToString<T>(array: T[] | readonly T[]): string;
 /**
  * Helper function to combine two or more arrays. Returns a new array that is the composition of all
  * of the specified arrays.
@@ -56,6 +56,30 @@ export declare function combineArrays<T>(...arrays: Array<T[] | readonly T[]>):
 export declare function copyArray<T>(oldArray: T[] | readonly T[], numElements?: int): T[];
 /** Helper function to remove all of the elements in an array in-place. */
 export declare function emptyArray<T>(array: T[]): void;
+/**
+ * Helper function to get all possible combinations of the given array. This includes the
+ * combination of an empty array.
+ *
+ * For example, if this function is provided an array containing 1, 2, and 3, then it will return an
+ * array containing the following arrays:
+ *
+ * - []
+ * - [1]
+ * - [2]
+ * - [3]
+ * - [1, 2]
+ * - [1, 3]
+ * - [2, 3]
+ * - [1, 2, 3]
+ *
+ * From: https://github.com/firstandthird/combinations/blob/master/index.js
+ *
+ * @param array The array to get the combinations of.
+ * @param min Optional. The minimum number of elements to include in each combination. Default is 1.
+ * @param max Optional. The maximum number of elements to include in each combination. Default is
+ *            the length of the array.
+ */
+export declare function getArrayCombinations<T>(array: T[] | readonly T[], min?: int, max?: int): ReadonlyArray<readonly T[]>;
 /**
  * Helper function to get an array containing the indexes of an array.
  *
@@ -141,4 +165,9 @@ export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seedO
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
 export declare function shuffleArrayInPlace<T>(array: T[], seedOrRNG?: Seed | RNG): void;
+/** Helper function to sum every value in an array together. */
 export declare function sumArray(array: number[] | readonly number[]): number;
+/**
+ * Helper function to swap two different array elements. (The elements will be swapped in-place.)
+ */
+export declare function swapArrayElements<T>(array: T[], i: number, j: number): void;

package/functions/array.lua

@@ -8,6 +8,9 @@ local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArraySlice = ____lualib.__TS__ArraySlice
+local __TS__ArrayConcat = ____lualib.__TS__ArrayConcat
+local __TS__ArrayUnshift = ____lualib.__TS__ArrayUnshift
 local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayReduce = ____lualib.__TS__ArrayReduce
@@ -50,16 +53,20 @@ function ____exports.shuffleArrayInPlace(self, array, seedOrRNG)
         seedOrRNG = getRandomSeed(nil)
     end
     local currentIndex = #array
-    local randomIndex
     local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     while currentIndex > 0 do
         currentIndex = currentIndex - 1
-        randomIndex = ____exports.getRandomArrayIndex(nil, array, rng)
-        local ____temp_0 = {array[randomIndex + 1], array[currentIndex + 1]}
-        array[currentIndex + 1] = ____temp_0[1]
-        array[randomIndex + 1] = ____temp_0[2]
+        local randomIndex = ____exports.getRandomArrayIndex(nil, array, rng)
+        ____exports.swapArrayElements(nil, array, currentIndex, randomIndex)
     end
 end
+--- Helper function to swap two different array elements. (The elements will be swapped in-place.)
+function ____exports.swapArrayElements(self, array, i, j)
+    local value1 = array[i + 1]
+    local value2 = array[j + 1]
+    array[i + 1] = value2
+    array[j + 1] = value1
+end
 --- Helper function for determining if two arrays contain the exact same elements. Note that this
 -- only performs a shallow comparison.
 function ____exports.arrayEquals(self, array1, array2)
@@ -201,6 +208,77 @@ end
 function ____exports.emptyArray(self, array)
     __TS__ArraySplice(array, 0, #array)
 end
+--- Helper function to get all possible combinations of the given array. This includes the
+-- combination of an empty array.
+-- 
+-- For example, if this function is provided an array containing 1, 2, and 3, then it will return an
+-- array containing the following arrays:
+-- 
+-- - []
+-- - [1]
+-- - [2]
+-- - [3]
+-- - [1, 2]
+-- - [1, 3]
+-- - [2, 3]
+-- - [1, 2, 3]
+-- 
+-- From: https://github.com/firstandthird/combinations/blob/master/index.js
+-- 
+-- @param array The array to get the combinations of.
+-- @param min Optional. The minimum number of elements to include in each combination. Default is 1.
+-- @param max Optional. The maximum number of elements to include in each combination. Default is
+-- the length of the array.
+function ____exports.getArrayCombinations(self, array, min, max)
+    if min == nil or min <= 0 then
+        min = 1
+    end
+    if max == nil or max <= 0 then
+        max = #array
+    end
+    local addCombinations
+    addCombinations = function(____, n, src, got, all)
+        if n == 0 then
+            if #got > 0 then
+                all[#all + 1] = got
+            end
+            return
+        end
+        do
+            local j = 0
+            while j < #src do
+                local value = src[j + 1]
+                addCombinations(
+                    nil,
+                    n - 1,
+                    __TS__ArraySlice(src, j + 1),
+                    __TS__ArrayConcat(got, {value}),
+                    all
+                )
+                j = j + 1
+            end
+        end
+    end
+    local all = {}
+    do
+        local i = min
+        while i < #array do
+            addCombinations(
+                nil,
+                i,
+                array,
+                {},
+                all
+            )
+            i = i + 1
+        end
+    end
+    if #array == max then
+        all[#all + 1] = array
+    end
+    __TS__ArrayUnshift(all, {})
+    return all
+end
 --- Helper function to get an array containing the indexes of an array.
 -- 
 -- For example, an array of `["Apple", "Banana"]` would return an array of `[0, 1]`.
@@ -351,6 +429,7 @@ function ____exports.shuffleArray(self, originalArray, seedOrRNG)
     ____exports.shuffleArrayInPlace(nil, array, seedOrRNG)
     return array
 end
+--- Helper function to sum every value in an array together.
 function ____exports.sumArray(self, array)
     return __TS__ArrayReduce(
         array,

package/functions/bitwise.d.ts

@@ -1,4 +1,21 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/** Helper function to convert a set of flags to a single `BitFlags` object. */
+export declare function arrayToBitFlags<T extends BitFlag | BitFlag128>(array: T[] | readonly T[]): BitFlags<T>;
+/** Helper function to convert an array of bits to the resulting decimal number. */
+export declare function convertBinaryToDecimal(bits: int[]): number;
+/** Helper function to convert a number to an array of bits. */
+export declare function convertDecimalToBinary(number: number): int[];
+/**
+ * Helper function to count the number of bits that are set to 1 in a binary representation of a
+ * number.
+ */
 export declare function countSetBits(n: int): int;
+/** Helper function to get the value of a specific but in a binary representation of a number. */
 export declare function getKBitOfN(k: int, n: int): int;
+/** Helper function to get the number of bits in a binary representation of a number. */
 export declare function getNumBitsOfN(n: int): int;
+/** Helper function to convert a set of flags to a single `BitFlags` object. */
+export declare function setToBitFlags<T extends BitFlag | BitFlag128>(set: Set<T> | ReadonlySet<T>): BitFlags<T>;

package/functions/bitwise.lua

@@ -1,4 +1,35 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ParseInt = ____lualib.__TS__ParseInt
+local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
+local ____flag = require("functions.flag")
+local addFlag = ____flag.addFlag
+--- Helper function to convert a set of flags to a single `BitFlags` object.
+function ____exports.arrayToBitFlags(self, array)
+    local flags = 0
+    for ____, flag in ipairs(array) do
+        flags = addFlag(nil, flags, flag)
+    end
+    return flags
+end
+--- Helper function to convert an array of bits to the resulting decimal number.
+function ____exports.convertBinaryToDecimal(self, bits)
+    local bitsString = table.concat(bits, "")
+    return __TS__ParseInt(bitsString, 2)
+end
+--- Helper function to convert a number to an array of bits.
+function ____exports.convertDecimalToBinary(self, number)
+    local bits = {}
+    local i = 0
+    while number > 0 do
+        bits[i + 1] = number % 2
+        number = math.floor(number / 2)
+        i = i + 1
+    end
+    return bits
+end
+--- Helper function to count the number of bits that are set to 1 in a binary representation of a
+-- number.
 function ____exports.countSetBits(self, n)
     local count = 0
     while n > 0 do
@@ -7,9 +38,11 @@ function ____exports.countSetBits(self, n)
     end
     return count
 end
+--- Helper function to get the value of a specific but in a binary representation of a number.
 function ____exports.getKBitOfN(self, k, n)
     return n >> k & 1
 end
+--- Helper function to get the number of bits in a binary representation of a number.
 function ____exports.getNumBitsOfN(self, n)
     local numBits = 0
     while n > 0 do
@@ -18,4 +51,12 @@ function ____exports.getNumBitsOfN(self, n)
     end
     return numBits
 end
+--- Helper function to convert a set of flags to a single `BitFlags` object.
+function ____exports.setToBitFlags(self, set)
+    local flags = 0
+    for ____, flag in __TS__Iterator(set:values()) do
+        flags = addFlag(nil, flags, flag)
+    end
+    return flags
+end
 return ____exports

package/functions/color.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedColor = LuaTable<string, unknown> & {
-    readonly __serializedColorBrand: unique symbol;
+    readonly __serializedColorBrand: symbol;
 };
 interface CopyColorReturn {
     [SerializationType.NONE]: Color;

package/functions/doors.d.ts

@@ -7,6 +7,7 @@ export declare function closeAllDoors(): void;
 export declare function closeDoorFast(door: GridEntityDoor): void;
 export declare function doorSlotFlagToDoorSlot(doorSlotFlag: DoorSlotFlag): DoorSlot;
 export declare function doorSlotToDirection(doorSlot: DoorSlot): Direction;
+export declare function doorSlotToDoorSlotFlag(doorSlot: DoorSlot): DoorSlotFlag;
 export declare function getAngelRoomDoor(): GridEntityDoor | undefined;
 export declare function getDevilRoomDoor(): GridEntityDoor | undefined;
 /**
@@ -30,6 +31,11 @@ export declare function getDoorEnterPosition(door: GridEntityDoor): Vector;
  * amount of units.
  */
 export declare function getDoorEnterPositionOffset(doorSlot: DoorSlot): Vector;
+/**
+ * Helper function to convert an array of door slots or a set of door slots to the resulting bit
+ * flag number.
+ */
+export declare function getDoorSlotFlags(doorSlots: DoorSlot[] | readonly DoorSlot[] | Set<DoorSlot> | ReadonlySet<DoorSlot>): BitFlags<DoorSlotFlag>;
 /** Helper function to get the possible door slots that can exist for a given room shape. */
 export declare function getDoorSlotsForRoomShape(roomShape: RoomShape): ReadonlySet<DoorSlot>;
 /**

package/functions/doors.lua

@@ -1,5 +1,7 @@
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
@@ -18,14 +20,20 @@ local DEFAULT_DOOR_SLOT = ____doorSlotFlagToDoorSlot.DEFAULT_DOOR_SLOT
 local DOOR_SLOT_FLAG_TO_DOOR_SLOT = ____doorSlotFlagToDoorSlot.DOOR_SLOT_FLAG_TO_DOOR_SLOT
 local ____doorSlotToDirection = require("objects.doorSlotToDirection")
 local DOOR_SLOT_TO_DIRECTION = ____doorSlotToDirection.DOOR_SLOT_TO_DIRECTION
+local ____doorSlotToDoorSlotFlag = require("objects.doorSlotToDoorSlotFlag")
+local DOOR_SLOT_TO_DOOR_SLOT_FLAG = ____doorSlotToDoorSlotFlag.DOOR_SLOT_TO_DOOR_SLOT_FLAG
 local ____oppositeDoorSlots = require("objects.oppositeDoorSlots")
 local OPPOSITE_DOOR_SLOTS = ____oppositeDoorSlots.OPPOSITE_DOOR_SLOTS
 local ____roomShapeToDoorSlots = require("objects.roomShapeToDoorSlots")
 local ROOM_SHAPE_TO_DOOR_SLOTS = ____roomShapeToDoorSlots.ROOM_SHAPE_TO_DOOR_SLOTS
+local ____bitwise = require("functions.bitwise")
+local arrayToBitFlags = ____bitwise.arrayToBitFlags
 local ____direction = require("functions.direction")
 local directionToVector = ____direction.directionToVector
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
+local ____tstlClass = require("functions.tstlClass")
+local isTSTLSet = ____tstlClass.isTSTLSet
 function ____exports.doorSlotToDirection(self, doorSlot)
     return DOOR_SLOT_TO_DIRECTION[doorSlot]
 end
@@ -52,13 +60,13 @@ function ____exports.getDoors(self, ...)
         do
             local door = room:GetDoor(doorSlot)
             if door == nil then
-                goto __continue15
+                goto __continue18
             end
             if roomTypesSet.size == 0 or roomTypesSet:has(door.TargetRoomType) then
                 doors[#doors + 1] = door
             end
         end
-        ::__continue15::
+        ::__continue18::
     end
     return doors
 end
@@ -101,6 +109,9 @@ function ____exports.doorSlotFlagToDoorSlot(self, doorSlotFlag)
     local doorSlot = DOOR_SLOT_FLAG_TO_DOOR_SLOT[doorSlotFlag]
     return doorSlot == nil and DEFAULT_DOOR_SLOT or doorSlot
 end
+function ____exports.doorSlotToDoorSlotFlag(self, doorSlot)
+    return DOOR_SLOT_TO_DOOR_SLOT_FLAG[doorSlot]
+end
 function ____exports.getAngelRoomDoor(self)
     local angelRoomDoors = ____exports.getDoors(nil, RoomType.ANGEL)
     local ____temp_0
@@ -142,6 +153,16 @@ function ____exports.getDoorEnterPosition(self, door)
     local offset = ____exports.getDoorEnterPositionOffset(nil, door.Slot)
     return door.Position + offset
 end
+--- Helper function to convert an array of door slots or a set of door slots to the resulting bit
+-- flag number.
+function ____exports.getDoorSlotFlags(self, doorSlots)
+    local doorSlotArray = isTSTLSet(nil, doorSlots) and ({__TS__Spread(doorSlots:values())}) or doorSlots
+    local doorSlotFlagArray = __TS__ArrayMap(
+        doorSlotArray,
+        function(____, doorSlot) return ____exports.doorSlotToDoorSlotFlag(nil, doorSlot) end
+    )
+    return arrayToBitFlags(nil, doorSlotFlagArray)
+end
 --- Helper function to get the possible door slots that can exist for a given room shape.
 function ____exports.getDoorSlotsForRoomShape(self, roomShape)
     return ROOM_SHAPE_TO_DOOR_SLOTS[roomShape]

package/functions/gridEntity.d.ts

@@ -5,6 +5,12 @@ import { GridEntityType, GridEntityXMLType } from "isaac-typescript-definitions"
  * 1000.0 in a room XML file, but `GridEntityType.ROCK` is equal to 2.
  */
 export declare function convertXMLGridEntityType(gridEntityXMLType: GridEntityXMLType, gridEntityXMLVariant: int): [GridEntityType, int] | undefined;
+/**
+ * Helper function to get every legal grid index for the current room.
+ *
+ * Under the hood, this uses the `Room.GetGridSize` method.
+ */
+export declare function getAllGridIndexes(): int[];
 /**
  * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
  * entity is on.
@@ -79,6 +85,9 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  * Helper function to all grid entities in the room except for ones matching the grid entity types
  * provided.
  *
+ * Note that this function will automatically update the room. (This means that you can spawn new
+ * grid entities on the same tile on the same frame, if needed.)
+ *
  * For example:
  *
  * ```ts
@@ -95,6 +104,9 @@ export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.
  *
+ * Note that this function will automatically update the room. (This means that you can spawn new
+ * grid entities on the same tile on the same frame, if needed.)
+ *
  * For example:
  *
  * ```ts

package/functions/gridEntity.lua

@@ -32,11 +32,18 @@ local ____utils = require("functions.utils")
 local erange = ____utils.erange
 local ____vector = require("functions.vector")
 local isVector = ____vector.isVector
-function getAllGridEntities(self)
+--- Helper function to get every legal grid index for the current room.
+-- 
+-- Under the hood, this uses the `Room.GetGridSize` method.
+function ____exports.getAllGridIndexes(self)
     local room = game:GetRoom()
     local gridSize = room:GetGridSize()
+    return erange(nil, gridSize)
+end
+function getAllGridEntities(self)
+    local room = game:GetRoom()
     local gridEntities = {}
-    for ____, gridIndex in ipairs(erange(nil, gridSize)) do
+    for ____, gridIndex in ipairs(____exports.getAllGridIndexes(nil)) do
         local gridEntity = room:GetGridEntity(gridIndex)
         if gridEntity ~= nil then
             gridEntities[#gridEntities + 1] = gridEntity
@@ -277,6 +284,9 @@ end
 --- Helper function to all grid entities in the room except for ones matching the grid entity types
 -- provided.
 -- 
+-- Note that this function will automatically update the room. (This means that you can spawn new
+-- grid entities on the same tile on the same frame, if needed.)
+-- 
 -- For example:
 -- 
 -- ```ts
@@ -307,6 +317,9 @@ end
 --- Helper function to remove all of the grid entities in the room that match the grid entity types
 -- provided.
 -- 
+-- Note that this function will automatically update the room. (This means that you can spawn new
+-- grid entities on the same tile on the same frame, if needed.)
+-- 
 -- For example:
 -- 
 -- ```ts

package/functions/kColor.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedKColor = LuaTable<string, unknown> & {
-    readonly __serializedKColorBrand: unique symbol;
+    readonly __serializedKColorBrand: symbol;
 };
 interface CopyKColorReturn {
     [SerializationType.NONE]: KColor;

package/functions/log.d.ts

@@ -11,7 +11,7 @@ export declare function getDebugPrependString(msg: string, numParentFunctions?:
  * function will also prepend the function name and the line number before the string.
  */
 export declare function log(this: void, msg: string): void;
-export declare function logArray<T>(this: void, array: T[]): void;
+export declare function logArray<T>(this: void, array: T[] | readonly T[]): void;
 export declare function logColor(this: void, color: Color): void;
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
 export declare function logDamageFlags(this: void, flags: DamageFlag | BitFlags<DamageFlag>): void;
@@ -56,7 +56,7 @@ export declare function logRoom(this: void): void;
  * particular run.
  */
 export declare function logSeedEffects(this: void): void;
-export declare function logSet(this: void, set: Set<AnyNotNil>): void;
+export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void;
 /** Helper function for logging every sound effect that is currently playing. */
 export declare function logSounds(this: void): void;
 /**

package/functions/rng.d.ts

@@ -3,7 +3,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedRNG = LuaTable<string, unknown> & {
-    readonly __serializedRNGBrand: unique symbol;
+    readonly __serializedRNGBrand: symbol;
 };
 interface CopyRNGReturn {
     [SerializationType.NONE]: RNG;

package/functions/rng.lua

@@ -1,6 +1,5 @@
 local ____lualib = require("lualib_bundle")
 local __TS__TypeOf = ____lualib.__TS__TypeOf
-local __TS__ObjectValues = ____lualib.__TS__ObjectValues
 local ____exports = {}
 local RECOMMENDED_SHIFT_IDX, OBJECT_NAME
 local ____cachedClasses = require("cachedClasses")
@@ -123,11 +122,16 @@ 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
-    for ____, value in ipairs(__TS__ObjectValues(table)) do
+    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.

package/functions/roomShape.d.ts

@@ -17,14 +17,14 @@ export declare function getRoomShapeBottomRightPosition(roomShape: RoomShape): V
  * Helper function to get the bounds of a room shape, which are a box representing its contents.
  * This does not include the tiles that the walls are on. L rooms use the same bounds as a 2x2 room.
  */
-export declare function getRoomShapeBounds(roomShape: RoomShape): Vector;
+export declare function getRoomShapeBounds(roomShape: RoomShape): readonly [width: int, height: int];
 /**
  * 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.
  */
-export declare function getRoomShapeLayoutSize(roomShape: RoomShape): Vector;
+export declare function getRoomShapeLayoutSize(roomShape: RoomShape): readonly [width: int, height: int];
 /**
  * Helper function to get the grid position of the top-left tile of a given room shape.
  *

package/functions/rooms.d.ts

@@ -9,6 +9,7 @@ export declare function changeRoom(roomGridIndex: int): void;
  * Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
  */
 export declare function getAllDimensions(): Dimension[];
+/** Helper function to get the grid index for every room on the entire floor. */
 export declare function getAllRoomGridIndexes(): int[];
 /**
  * Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,

package/functions/rooms.lua

@@ -123,6 +123,7 @@ end
 function ____exports.getAllDimensions(self)
     return erange(nil, NUM_DIMENSIONS)
 end
+--- Helper function to get the grid index for every room on the entire floor.
 function ____exports.getAllRoomGridIndexes(self)
     local rooms = ____exports.getRooms(nil)
     return __TS__ArrayMap(

package/functions/set.d.ts

@@ -31,6 +31,23 @@ export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: A
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
 export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;
+/**
+ * Helper function to get all possible combinations of the given set. This includes the combination
+ * of an empty set.
+ *
+ * For example, if this function is provided a set containing 1, 2, and 3, then it will return an
+ * array containing the following sets:
+ *
+ * - []
+ * - [1]
+ * - [2]
+ * - [3]
+ * - [1, 2]
+ * - [1, 3]
+ * - [2, 3]
+ * - [1, 2, 3]
+ */
+export declare function getSetCombinations<T>(set: Set<T> | ReadonlySet<T>): ReadonlyArray<ReadonlySet<T>>;
 /**
  * Helper function to get a sorted array based on the contents of a set.
  *