isaacscript-common 4.6.0 → 4.7.1

package/features/runInNFrames.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Supply a function to run N game frames from now in the PostUpdate callback.
+ * Supply a function to run N game frames from now in the `POST_UPDATE` callback.
  *
  * For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
  * way.
@@ -11,7 +11,7 @@
  */
 export declare function runInNGameFrames(func: () => void, gameFrames: int): void;
 /**
- * Supply a function to run N render frames from now in the PostRender callback.
+ * Supply a function to run N render frames from now in the `POST_RENDER` callback.
  *
  * For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
  * way.
@@ -22,7 +22,7 @@ export declare function runInNGameFrames(func: () => void, gameFrames: int): voi
  */
 export declare function runInNRenderFrames(func: () => void, renderFrames: int): void;
 /**
- * Supply a function to run on the next PostUpdate callback.
+ * Supply a function to run on the next `POST_UPDATE` callback.
  *
  * For example:
  *
@@ -51,7 +51,7 @@ export declare function runInNRenderFrames(func: () => void, renderFrames: int):
  */
 export declare function runNextGameFrame(func: () => void): void;
 /**
- * Supply a function to run on the next PostRender callback.
+ * Supply a function to run on the next `POST_RENDER` callback.
  *
  * For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
  * way.
@@ -59,3 +59,37 @@ export declare function runNextGameFrame(func: () => void): void;
  * Note that this function will not handle saving and quitting.
  */
 export declare function runNextRenderFrame(func: () => void): void;
+/**
+ * Supply a function to be repeatedly run on an interval of N game frames in the `POST_UPDATE`
+ * callback. The function will continue to be fired until `false` is returned from the function.
+ *
+ * This is similar to the `setInterval` vanilla JavaScript function, except there is no
+ * corresponding `clearInterval` function. (Instead, the return value from the supplied function is
+ * used to stop the interval.)
+ *
+ * Note that this function will not handle saving and quitting. You must manually restart any
+ * intervals if the player saves and quits in the middle of a run.
+ *
+ * @param func The function to repeatedly run on an interval.
+ * @param gameFrames The amount of game frames to wait between each run.
+ * @param runImmediately Whether or not to execute the function right now before waiting for the
+ *                       interval.
+ */
+export declare function setIntervalGameFrames(func: () => boolean, gameFrames: int, runImmediately: boolean): void;
+/**
+ * Supply a function to be repeatedly run on an interval of N render frames in the `POST_RENDER`
+ * callback. The function will continue to be fired until `false` is returned from the function.
+ *
+ * This is similar to the `setInterval` vanilla JavaScript function, except there is no
+ * corresponding `clearInterval` function. (Instead, the return value from the supplied function is
+ * used to stop the interval.)
+ *
+ * Note that this function will not handle saving and quitting. You must manually restart any
+ * intervals if the player saves and quits in the middle of a run.
+ *
+ * @param func The function to repeatedly run on an interval.
+ * @param renderFrames The amount of game frames to wait between each run.
+ * @param runImmediately Whether or not to execute the function right now before waiting for the
+ *                       interval.
+ */
+export declare function setIntervalRenderFrames(func: () => boolean, renderFrames: int, runImmediately: boolean): void;

package/features/runInNFrames.lua

@@ -1,46 +1,67 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
-local __TS__ArraySplice = ____lualib.__TS__ArraySplice
 local ____exports = {}
-local postUpdate, postRender, checkExecuteQueuedFunctions, v
+local postUpdate, postRender, checkExecuteQueuedFunctions, checkExecuteIntervalFunctions, getFunctionsThatShouldFireOnThisFrame, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____array = require("functions.array")
+local arrayRemoveIndexInPlace = ____array.arrayRemoveIndexInPlace
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 function postUpdate(self)
     local gameFrameCount = game:GetFrameCount()
     checkExecuteQueuedFunctions(nil, gameFrameCount, v.run.queuedGameFunctionTuples)
+    checkExecuteIntervalFunctions(nil, gameFrameCount, v.run.intervalGameFunctionTuples)
 end
 function postRender(self)
     local renderFrameCount = Isaac.GetFrameCount()
     checkExecuteQueuedFunctions(nil, renderFrameCount, v.run.queuedRenderFunctionTuples)
+    checkExecuteIntervalFunctions(nil, renderFrameCount, v.run.intervalRenderFunctionTuples)
 end
 function checkExecuteQueuedFunctions(self, frameCount, functionTuples)
-    local functionsToFire = {}
-    local indexesToRemove = {}
+    local firingFunctions = getFunctionsThatShouldFireOnThisFrame(nil, frameCount, functionTuples)
+    for ____, ____value in ipairs(firingFunctions) do
+        local i = ____value[1]
+        local func = ____value[2]
+        func(nil)
+        arrayRemoveIndexInPlace(nil, functionTuples, i)
+    end
+end
+function checkExecuteIntervalFunctions(self, frameCount, functionTuples)
+    local firingFunctions = getFunctionsThatShouldFireOnThisFrame(nil, frameCount, functionTuples)
+    for ____, ____value in ipairs(firingFunctions) do
+        local i = ____value[1]
+        local func = ____value[2]
+        local numIntervalFrames = ____value[3]
+        local returnValue = func(nil)
+        arrayRemoveIndexInPlace(nil, functionTuples, i)
+        if numIntervalFrames ~= nil and returnValue == false then
+            local nextFireFrame = frameCount + numIntervalFrames
+            local tuple = {nextFireFrame, func, numIntervalFrames}
+            functionTuples[#functionTuples + 1] = tuple
+        end
+    end
+end
+function getFunctionsThatShouldFireOnThisFrame(self, frameCount, functionTuples)
+    local firingFunctionTuples = {}
     __TS__ArrayForEach(
         functionTuples,
         function(____, functionTuple, i)
-            local frame, func = table.unpack(functionTuple)
-            if frameCount >= frame then
-                functionsToFire[#functionsToFire + 1] = func
-                indexesToRemove[#indexesToRemove + 1] = i
+            local frameCountToFire, func, numIntervalFrames = table.unpack(functionTuple)
+            if frameCount >= frameCountToFire then
+                local firingFunctionTuple = {i, func, numIntervalFrames}
+                firingFunctionTuples[#firingFunctionTuples + 1] = firingFunctionTuple
             end
         end
     )
-    for ____, indexToRemove in ipairs(indexesToRemove) do
-        __TS__ArraySplice(functionTuples, indexToRemove, 1)
-    end
-    for ____, func in ipairs(functionsToFire) do
-        func(nil)
-    end
+    return firingFunctionTuples
 end
 local FEATURE_NAME = "runInNFrames"
-v = {run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}}}
+v = {run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}, intervalGameFunctionTuples = {}, intervalRenderFunctionTuples = {}}}
 ---
 -- @internal
 function ____exports.runInNFramesInit(self, mod)
@@ -53,7 +74,7 @@ function ____exports.runInNFramesInit(self, mod)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end
---- Supply a function to run N game frames from now in the PostUpdate callback.
+--- Supply a function to run N game frames from now in the `POST_UPDATE` callback.
 -- 
 -- For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
 -- way.
@@ -69,7 +90,7 @@ function ____exports.runInNGameFrames(self, func, gameFrames)
     local ____v_run_queuedGameFunctionTuples_0 = v.run.queuedGameFunctionTuples
     ____v_run_queuedGameFunctionTuples_0[#____v_run_queuedGameFunctionTuples_0 + 1] = tuple
 end
---- Supply a function to run N render frames from now in the PostRender callback.
+--- Supply a function to run N render frames from now in the `POST_RENDER` callback.
 -- 
 -- For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
 -- way.
@@ -85,7 +106,7 @@ function ____exports.runInNRenderFrames(self, func, renderFrames)
     local ____v_run_queuedRenderFunctionTuples_1 = v.run.queuedRenderFunctionTuples
     ____v_run_queuedRenderFunctionTuples_1[#____v_run_queuedRenderFunctionTuples_1 + 1] = tuple
 end
---- Supply a function to run on the next PostUpdate callback.
+--- Supply a function to run on the next `POST_UPDATE` callback.
 -- 
 -- For example:
 -- 
@@ -115,7 +136,7 @@ function ____exports.runNextGameFrame(self, func)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     ____exports.runInNGameFrames(nil, func, 1)
 end
---- Supply a function to run on the next PostRender callback.
+--- Supply a function to run on the next `POST_RENDER` callback.
 -- 
 -- For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
 -- way.
@@ -125,4 +146,54 @@ function ____exports.runNextRenderFrame(self, func)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     ____exports.runInNRenderFrames(nil, func, 1)
 end
+--- Supply a function to be repeatedly run on an interval of N game frames in the `POST_UPDATE`
+-- callback. The function will continue to be fired until `false` is returned from the function.
+-- 
+-- This is similar to the `setInterval` vanilla JavaScript function, except there is no
+-- corresponding `clearInterval` function. (Instead, the return value from the supplied function is
+-- used to stop the interval.)
+-- 
+-- Note that this function will not handle saving and quitting. You must manually restart any
+-- intervals if the player saves and quits in the middle of a run.
+-- 
+-- @param func The function to repeatedly run on an interval.
+-- @param gameFrames The amount of game frames to wait between each run.
+-- @param runImmediately Whether or not to execute the function right now before waiting for the
+-- interval.
+function ____exports.setIntervalGameFrames(self, func, gameFrames, runImmediately)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local gameFrameCount = game:GetFrameCount()
+    local functionFireFrame = gameFrameCount + gameFrames
+    local tuple = {functionFireFrame, func, gameFrames}
+    local ____v_run_intervalGameFunctionTuples_2 = v.run.intervalGameFunctionTuples
+    ____v_run_intervalGameFunctionTuples_2[#____v_run_intervalGameFunctionTuples_2 + 1] = tuple
+    if runImmediately then
+        func(nil)
+    end
+end
+--- Supply a function to be repeatedly run on an interval of N render frames in the `POST_RENDER`
+-- callback. The function will continue to be fired until `false` is returned from the function.
+-- 
+-- This is similar to the `setInterval` vanilla JavaScript function, except there is no
+-- corresponding `clearInterval` function. (Instead, the return value from the supplied function is
+-- used to stop the interval.)
+-- 
+-- Note that this function will not handle saving and quitting. You must manually restart any
+-- intervals if the player saves and quits in the middle of a run.
+-- 
+-- @param func The function to repeatedly run on an interval.
+-- @param renderFrames The amount of game frames to wait between each run.
+-- @param runImmediately Whether or not to execute the function right now before waiting for the
+-- interval.
+function ____exports.setIntervalRenderFrames(self, func, renderFrames, runImmediately)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local renderFrameCount = Isaac.GetFrameCount()
+    local functionFireFrame = renderFrameCount + renderFrames
+    local tuple = {functionFireFrame, func, renderFrames}
+    local ____v_run_intervalGameFunctionTuples_3 = v.run.intervalGameFunctionTuples
+    ____v_run_intervalGameFunctionTuples_3[#____v_run_intervalGameFunctionTuples_3 + 1] = tuple
+    if runImmediately then
+        func(nil)
+    end
+end
 return ____exports

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/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/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/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.
  *

package/functions/set.lua

@@ -2,10 +2,12 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__New = ____lualib.__TS__New
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__Spread = ____lualib.__TS__Spread
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local ____exports = {}
 local ____array = require("functions.array")
+local getArrayCombinations = ____array.getArrayCombinations
 local getRandomArrayElement = ____array.getRandomArrayElement
 local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
@@ -80,4 +82,26 @@ function ____exports.getRandomSetElement(self, set, seedOrRNG, exceptions)
     local array = ____exports.getSortedSetValues(nil, set)
     return getRandomArrayElement(nil, array, seedOrRNG, exceptions)
 end
+--- 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]
+function ____exports.getSetCombinations(self, set)
+    local values = ____exports.getSortedSetValues(nil, set)
+    local combinations = getArrayCombinations(nil, values)
+    return __TS__ArrayMap(
+        combinations,
+        function(____, array) return __TS__New(Set, array) end
+    )
+end
 return ____exports

package/functions/vector.d.ts

@@ -2,7 +2,7 @@
 import { Direction } from "isaac-typescript-definitions";
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedVector = LuaTable<string, unknown> & {
-    readonly __serializedVectorBrand: unique symbol;
+    readonly __serializedVectorBrand: symbol;
 };
 interface CopyVectorReturn {
     [SerializationType.NONE]: Vector;

package/index.d.ts

@@ -26,7 +26,7 @@ export { anyPlayerUsingPony, isPlayerUsingPony, } from "./features/ponyDetection
 export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
 export { registerHotkey, unregisterHotkey } from "./features/registerHotkey";
 export { getRoomClearGameFrame, getRoomClearRoomFrame, } from "./features/roomClearFrame";
-export { runInNGameFrames, runInNRenderFrames, runNextGameFrame, runNextRenderFrame, } from "./features/runInNFrames";
+export { runInNGameFrames, runInNRenderFrames, runNextGameFrame, runNextRenderFrame, setIntervalGameFrames, setIntervalRenderFrames, } from "./features/runInNFrames";
 export * from "./features/saveDataManager/exports";
 export { hasSirenStolenFamiliar, setFamiliarNoSirenSteal, } from "./features/sirenHelpers";
 export { getStageHistory, hasVisitedStage } from "./features/stageHistory";

package/index.lua

@@ -210,10 +210,14 @@ do
     local runInNRenderFrames = ____runInNFrames.runInNRenderFrames
     local runNextGameFrame = ____runInNFrames.runNextGameFrame
     local runNextRenderFrame = ____runInNFrames.runNextRenderFrame
+    local setIntervalGameFrames = ____runInNFrames.setIntervalGameFrames
+    local setIntervalRenderFrames = ____runInNFrames.setIntervalRenderFrames
     ____exports.runInNGameFrames = runInNGameFrames
     ____exports.runInNRenderFrames = runInNRenderFrames
     ____exports.runNextGameFrame = runNextGameFrame
     ____exports.runNextRenderFrame = runNextRenderFrame
+    ____exports.setIntervalGameFrames = setIntervalGameFrames
+    ____exports.setIntervalRenderFrames = setIntervalRenderFrames
 end
 do
     local ____export = require("features.saveDataManager.exports")

package/objects/doorSlotToDoorSlotFlag.d.ts

@@ -0,0 +1,4 @@
+import { DoorSlot, DoorSlotFlag } from "isaac-typescript-definitions";
+export declare const DOOR_SLOT_TO_DOOR_SLOT_FLAG: {
+    readonly [key in DoorSlot]: DoorSlotFlag;
+};

package/objects/doorSlotToDoorSlotFlag.lua

@@ -0,0 +1,17 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local DoorSlotFlag = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlag
+local DoorSlotFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlagZero
+____exports.DOOR_SLOT_TO_DOOR_SLOT_FLAG = {
+    [DoorSlot.NO_DOOR_SLOT] = DoorSlotFlagZero,
+    [DoorSlot.LEFT_0] = DoorSlotFlag.LEFT_0,
+    [DoorSlot.UP_0] = DoorSlotFlag.UP_0,
+    [DoorSlot.RIGHT_0] = DoorSlotFlag.RIGHT_0,
+    [DoorSlot.DOWN_0] = DoorSlotFlag.DOWN_0,
+    [DoorSlot.LEFT_1] = DoorSlotFlag.LEFT_1,
+    [DoorSlot.UP_1] = DoorSlotFlag.UP_1,
+    [DoorSlot.RIGHT_1] = DoorSlotFlag.RIGHT_1,
+    [DoorSlot.DOWN_1] = DoorSlotFlag.DOWN_1
+}
+return ____exports

package/objects/roomShapeBounds.d.ts

@@ -4,5 +4,5 @@ import { RoomShape } from "isaac-typescript-definitions";
  * rooms use the same bounds as a 2x2 room.
  */
 export declare const ROOM_SHAPE_BOUNDS: {
-    readonly [key in RoomShape]: Vector;
+    readonly [key in RoomShape]: readonly [width: int, height: int];
 };

package/objects/roomShapeBounds.lua

@@ -6,17 +6,17 @@ local NARROW_CONTENTS_HEIGHT = ____roomShapeVolumes.NARROW_CONTENTS_HEIGHT
 local NARROW_CONTENTS_WIDTH = ____roomShapeVolumes.NARROW_CONTENTS_WIDTH
 local ONE_BY_ONE_CONTENTS_HEIGHT = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_HEIGHT
 local ONE_BY_ONE_CONTENTS_WIDTH = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_WIDTH
-local TWO_BY_TWO_BOUNDS = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
+local TWO_BY_TWO_BOUNDS = {ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2}
 --- The size of a room shape's contents. This does not include the tiles that the walls are on. L
 -- rooms use the same bounds as a 2x2 room.
 ____exports.ROOM_SHAPE_BOUNDS = {
-    [RoomShape.SHAPE_1x1] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT),
-    [RoomShape.IH] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, NARROW_CONTENTS_HEIGHT),
-    [RoomShape.IV] = Vector(NARROW_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT),
-    [RoomShape.SHAPE_1x2] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2),
-    [RoomShape.IIV] = Vector(NARROW_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2),
-    [RoomShape.SHAPE_2x1] = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT),
-    [RoomShape.IIH] = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, NARROW_CONTENTS_HEIGHT),
+    [RoomShape.SHAPE_1x1] = {ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT},
+    [RoomShape.IH] = {ONE_BY_ONE_CONTENTS_WIDTH, NARROW_CONTENTS_HEIGHT},
+    [RoomShape.IV] = {NARROW_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT},
+    [RoomShape.SHAPE_1x2] = {ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2},
+    [RoomShape.IIV] = {NARROW_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2},
+    [RoomShape.SHAPE_2x1] = {ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT},
+    [RoomShape.IIH] = {ONE_BY_ONE_CONTENTS_WIDTH * 2, NARROW_CONTENTS_HEIGHT},
     [RoomShape.SHAPE_2x2] = TWO_BY_TWO_BOUNDS,
     [RoomShape.LTL] = TWO_BY_TWO_BOUNDS,
     [RoomShape.LTR] = TWO_BY_TWO_BOUNDS,

package/objects/roomShapeLayoutSizes.d.ts

@@ -6,5 +6,5 @@ import { RoomShape } from "isaac-typescript-definitions";
  * For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
  */
 export declare const ROOM_SHAPE_LAYOUT_SIZES: {
-    readonly [key in RoomShape]: Vector;
+    readonly [key in RoomShape]: readonly [width: int, height: int];
 };

package/objects/roomShapeLayoutSizes.lua

@@ -4,10 +4,10 @@ local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local ____roomShapeVolumes = require("objects.roomShapeVolumes")
 local ONE_BY_ONE_CONTENTS_HEIGHT = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_HEIGHT
 local ONE_BY_ONE_CONTENTS_WIDTH = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_WIDTH
-local ONE_BY_ONE_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT)
-local TWO_BY_ONE_VERTICAL_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
-local TWO_BY_ONE_HORIZONTAL_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT)
-local TWO_BY_TWO_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
+local ONE_BY_ONE_LAYOUT_SIZE = {ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT}
+local TWO_BY_ONE_VERTICAL_LAYOUT_SIZE = {ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2}
+local TWO_BY_ONE_HORIZONTAL_LAYOUT_SIZE = {ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT}
+local TWO_BY_TWO_LAYOUT_SIZE = {ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2}
 --- The dimensions of a room shape's layout. This is NOT the size of the room's actual contents! For
 -- that, use `ROOM_SHAPE_BOUNDS`.
 -- 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.6.0",
+  "version": "4.7.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.14"
+    "isaac-typescript-definitions": "^3.0.15"
   }
 }

package/types/CollectibleIndex.d.ts

@@ -12,5 +12,5 @@
  * This type is branded for extra type safety.
  */
 export declare type CollectibleIndex = string & {
-    readonly __collectibleIndexBrand: unique symbol;
+    readonly __collectibleIndexBrand: symbol;
 };

package/types/PlayerIndex.d.ts

@@ -12,5 +12,5 @@
  * This type is branded for extra type safety.
  */
 export declare type PlayerIndex = int & {
-    readonly __playerIndexBrand: unique symbol;
+    readonly __playerIndexBrand: symbol;
 };

package/types/private/IsaacAPIClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type IsaacAPIClass = LuaTable<string, unknown> & {
-    readonly __isaacAPIClassBrand: unique symbol;
+    readonly __isaacAPIClassBrand: symbol;
 };

package/types/private/SerializedIsaacAPIClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type SerializedIsaacAPIClass = LuaTable<string, unknown> & {
-    readonly __serializedIsaacAPIClassBrand: unique symbol;
+    readonly __serializedIsaacAPIClassBrand: symbol;
 };

package/types/private/TSTLClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type TSTLClass = LuaTable<AnyNotNil, unknown> & {
-    readonly __tstlClassBrand: unique symbol;
+    readonly __tstlClassBrand: symbol;
 };