isaacscript-common 1.2.25 → 1.2.29

package/dist/features/runInNFrames.d.ts

@@ -1,4 +1,26 @@
 /// <reference types="isaac-typescript-definitions" />
+/**
+ * Supply a function to run N game frames from now in the PostUpdate callback.
+ *
+ * For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
+ * way.
+ *
+ * Note that this function will not handle saving and quitting. If a player saving and quitting
+ * before the deferred function fires would cause a bug in your mod, then you should handle deferred
+ * functions manually using serializable data.
+ */
+export declare function runInNGameFrames(func: () => void, frames: int): void;
+/**
+ * Supply a function to run N render frames from now in the PostRender callback.
+ *
+ * For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
+ * way.
+ *
+ * Note that this function will not handle saving and quitting. If a player saving and quitting
+ * before the deferred function fires would cause a bug in your mod, then you should handle deferred
+ * functions manually using serializable data.
+ */
+export declare function runInNRenderFrames(func: () => void, frames: int): void;
 /**
  * Supply a function to run on the next PostUpdate callback.
  *
@@ -22,19 +44,17 @@
  * }
  * ```
  *
- * Note that this function will not handle saving and quitting, so if a player saving and quitting
- * before the next PostUpdate frame would cause a bug in your mod, then you should handle deferred
+ * Note that this function will not handle saving and quitting. If a player saving and quitting
+ * before the deferred function fires would cause a bug in your mod, then you should handle deferred
  * functions manually using serializable data.
  */
-export declare function runNextFrame(func: () => void): void;
+export declare function runNextGameFrame(func: () => void): void;
 /**
- * Supply a function to run N frames from now in the PostUpdate callback.
+ * Supply a function to run on the next PostRender callback.
  *
- * For a usage example, see the documentation for the `runNextFrame`, which is used in a similar
+ * For a usage example, see the documentation for the `runNextGameFrame`, which is used in a similar
  * way.
  *
- * Note that this function will not handle saving and quitting, so if a player saving and quitting
- * before the next PostUpdate frame would cause a bug in your mod, then you should handle deferred
- * functions manually using serializable data.
+ * Note that this function will not handle saving and quitting.
  */
-export declare function runInNFrames(func: () => void, frames: int): void;
+export declare function runNextRenderFrame(func: () => void): void;

package/dist/features/runInNFrames.lua

@@ -3,7 +3,7 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArraySplice = ____lualib.__TS__ArraySplice
 local ____exports = {}
-local postUpdate, FEATURE_NAME, initialized, v
+local postUpdate, postRender, checkExecuteQueuedFunctions, v
 local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
 local ____exports = require("features.saveDataManager.exports")
@@ -11,14 +11,21 @@ local saveDataManager = ____exports.saveDataManager
 function postUpdate(self)
     local game = Game()
     local gameFrameCount = game:GetFrameCount()
+    checkExecuteQueuedFunctions(nil, gameFrameCount, v.run.queuedGameFunctionTuples)
+end
+function postRender(self)
+    local isaacFrameCount = Isaac.GetFrameCount()
+    checkExecuteQueuedFunctions(nil, isaacFrameCount, v.run.queuedRenderFunctionTuples)
+end
+function checkExecuteQueuedFunctions(self, frameCount, functionTuples)
     local functionsToFire = {}
     local indexesToRemove = {}
     do
         local i = 0
-        while i < #v.run.queuedFunctionTuples do
-            local functionTuple = v.run.queuedFunctionTuples[i + 1]
+        while i < #functionTuples do
+            local functionTuple = functionTuples[i + 1]
             local frame, func = table.unpack(functionTuple)
-            if gameFrameCount >= frame then
+            if frameCount >= frame then
                 __TS__ArrayPush(functionsToFire, func)
                 __TS__ArrayPush(indexesToRemove, i)
             end
@@ -26,13 +33,22 @@ function postUpdate(self)
         end
     end
     for ____, indexToRemove in ipairs(indexesToRemove) do
-        __TS__ArraySplice(v.run.queuedFunctionTuples, indexToRemove, 1)
+        __TS__ArraySplice(functionTuples, indexToRemove, 1)
     end
     for ____, func in ipairs(functionsToFire) do
         func(nil)
     end
 end
-function ____exports.runInNFrames(self, func, frames)
+local FEATURE_NAME = "run in N frames"
+local initialized = false
+v = {dontSave = true, run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}}}
+function ____exports.runInNFramesInit(self, mod)
+    initialized = true
+    saveDataManager(nil, "runInNFrames", v)
+    mod:AddCallback(ModCallbacks.MC_POST_UPDATE, postUpdate)
+    mod:AddCallback(ModCallbacks.MC_POST_RENDER, postRender)
+end
+function ____exports.runInNGameFrames(self, func, frames)
     if not initialized then
         local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
         error(msg)
@@ -41,21 +57,30 @@ function ____exports.runInNFrames(self, func, frames)
     local gameFrameCount = game:GetFrameCount()
     local functionFireFrame = gameFrameCount + frames
     local tuple = {functionFireFrame, func}
-    __TS__ArrayPush(v.run.queuedFunctionTuples, tuple)
+    __TS__ArrayPush(v.run.queuedGameFunctionTuples, tuple)
 end
-FEATURE_NAME = "run in N frames"
-initialized = false
-v = {dontSave = true, run = {queuedFunctionTuples = {}}}
-function ____exports.runInNFramesInit(self, mod)
-    initialized = true
-    saveDataManager(nil, "runInNFrames", v)
-    mod:AddCallback(ModCallbacks.MC_POST_UPDATE, postUpdate)
+function ____exports.runInNRenderFrames(self, func, frames)
+    if not initialized then
+        local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
+        error(msg)
+    end
+    local isaacFrameCount = Isaac.GetFrameCount()
+    local functionFireFrame = isaacFrameCount + frames
+    local tuple = {functionFireFrame, func}
+    __TS__ArrayPush(v.run.queuedRenderFunctionTuples, tuple)
+end
+function ____exports.runNextGameFrame(self, func)
+    if not initialized then
+        local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
+        error(msg)
+    end
+    ____exports.runInNGameFrames(nil, func, 1)
 end
-function ____exports.runNextFrame(self, func)
+function ____exports.runNextRenderFrame(self, func)
     if not initialized then
         local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
         error(msg)
     end
-    ____exports.runInNFrames(nil, func, 1)
+    ____exports.runInNRenderFrames(nil, func, 1)
 end
 return ____exports

package/dist/features/sirenHelpers.lua

@@ -2,7 +2,7 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
-local postNPCInitSirenHelper, checkReturnFamiliarToPlayer, blacklistEntryExists, v
+local postNPCInitSirenHelper, checkReturnFamiliarToPlayer, blacklistEntryExists, getSirenHelper, v
 local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
 local ____entity = require("functions.entity")
@@ -38,6 +38,16 @@ function blacklistEntryExists(self, incomingFamiliarVariant, incomingFamiliarSub
     end
     return false
 end
+function getSirenHelper(self, familiar)
+    local familiarHash = GetPtrHash(familiar)
+    local sirenHelpers = getEntities(nil, EntityType.ENTITY_SIREN_HELPER)
+    for ____, sirenHelper in ipairs(sirenHelpers) do
+        if sirenHelper.Target ~= nil and GetPtrHash(sirenHelper.Target) == familiarHash then
+            return sirenHelper
+        end
+    end
+    return nil
+end
 local FEATURE_NAME = "siren helpers"
 local initialized = false
 v = {run = {familiarBlacklist = {}}}
@@ -56,16 +66,6 @@ function ____exports.setFamiliarNoSirenSteal(self, familiarVariant, familiarSubT
     end
     __TS__ArrayPush(v.run.familiarBlacklist, {familiarVariant, familiarSubType})
 end
-local function getSirenHelper(self, familiar)
-    local familiarHash = GetPtrHash(familiar)
-    local sirenHelpers = getEntities(nil, EntityType.ENTITY_SIREN_HELPER)
-    for ____, sirenHelper in ipairs(sirenHelpers) do
-        if sirenHelper.Target ~= nil and GetPtrHash(sirenHelper.Target) == familiarHash then
-            return sirenHelper
-        end
-    end
-    return nil
-end
 function ____exports.hasSirenStolenFamiliar(self, familiar)
     return getSirenHelper(nil, familiar) ~= nil
 end

package/dist/functions/flying.lua

@@ -18,6 +18,7 @@ local FLYING_CHARACTERS = __TS__New(Set, {
     PlayerType.PLAYER_THESOUL_B
 })
 local FLYING_TRINKETS = __TS__New(Set, {TrinketType.TRINKET_BAT_WING, TrinketType.TRINKET_AZAZELS_STUMP})
+local FLYING_NULL_ITEMS = {NullItemID.ID_REVERSE_SUN, NullItemID.ID_SPIRIT_SHACKLES_SOUL}
 function ____exports.getFlyingCollectibles(self, pruneConditionalItems)
     local collectiblesWithFlyingCacheFlag = getCollectiblesForCacheFlag(nil, CacheFlag.CACHE_FLYING)
     local collectiblesWithAllCacheFlag = getCollectiblesForCacheFlag(nil, CacheFlag.CACHE_ALL)
@@ -47,6 +48,11 @@ function ____exports.hasFlyingTemporaryEffect(self, player)
             return true
         end
     end
+    for ____, nullItemID in ipairs(FLYING_NULL_ITEMS) do
+        if effects:HasNullEffect(nullItemID) then
+            return true
+        end
+    end
     return false
 end
 function ____exports.isFlyingCharacter(self, player)

package/dist/functions/rooms.d.ts

@@ -43,8 +43,11 @@ export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
  * 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.
  */
-export declare function getRoomGridIndexesForType(roomType: RoomType): int[];
+export declare function getRoomGridIndexesForType(...roomTypes: RoomType[]): int[];
 /**
  * Helper function to get the item pool type for the current room. For example, this returns
  * `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.

package/dist/functions/rooms.lua

@@ -1,6 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local Set = ____lualib.Set
@@ -132,11 +133,12 @@ function ____exports.getRoomDataType(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and -1 or roomData.Type
 end
-function ____exports.getRoomGridIndexesForType(self, roomType)
+function ____exports.getRoomGridIndexesForType(self, ...)
+    local roomTypes = {...}
     local rooms = ____exports.getRooms(nil)
     local matchingRooms = __TS__ArrayFilter(
         rooms,
-        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomDescriptor.Data.Type == roomType end
+        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and __TS__ArrayIncludes(roomTypes, roomDescriptor.Data.Type) end
     )
     return __TS__ArrayMap(
         matchingRooms,

package/dist/functions/sound.d.ts

@@ -0,0 +1 @@
+export declare function stopAllSoundEffects(): void;

package/dist/functions/sound.lua

@@ -0,0 +1,11 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local ____util = require("functions.util")
+local getEnumValues = ____util.getEnumValues
+function ____exports.stopAllSoundEffects(self)
+    local sfxManager = SFXManager()
+    for ____, soundEffect in ipairs(getEnumValues(nil, SoundEffect)) do
+        sfxManager:Stop(soundEffect)
+    end
+end
+return ____exports

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export { disableAllInputs, disableAllInputsExceptFor, disableMovementInputs, dis
 export { forgottenSwitch } from "./features/forgottenSwitch";
 export { getCollectibleItemPoolType } from "./features/getCollectibleItemPoolType";
 export { preventCollectibleRotate } from "./features/preventCollectibleRotate";
-export { runInNFrames, runNextFrame } from "./features/runInNFrames";
+export { runInNGameFrames, runInNRenderFrames, runNextGameFrame, runNextRenderFrame, } from "./features/runInNFrames";
 export * from "./features/saveDataManager/exports";
 export { hasSirenStolenFamiliar, setFamiliarNoSirenSteal, } from "./features/sirenHelpers";
 export * from "./functions/array";
@@ -45,6 +45,7 @@ export * from "./functions/revive";
 export * from "./functions/rooms";
 export * from "./functions/seeds";
 export * from "./functions/set";
+export * from "./functions/sound";
 export * from "./functions/spawnCollectible";
 export * from "./functions/sprite";
 export * from "./functions/stage";

package/dist/index.lua

@@ -56,10 +56,14 @@ do
 end
 do
     local ____runInNFrames = require("features.runInNFrames")
-    local runInNFrames = ____runInNFrames.runInNFrames
-    local runNextFrame = ____runInNFrames.runNextFrame
-    ____exports.runInNFrames = runInNFrames
-    ____exports.runNextFrame = runNextFrame
+    local runInNGameFrames = ____runInNFrames.runInNGameFrames
+    local runInNRenderFrames = ____runInNFrames.runInNRenderFrames
+    local runNextGameFrame = ____runInNFrames.runNextGameFrame
+    local runNextRenderFrame = ____runInNFrames.runNextRenderFrame
+    ____exports.runInNGameFrames = runInNGameFrames
+    ____exports.runInNRenderFrames = runInNRenderFrames
+    ____exports.runNextGameFrame = runNextGameFrame
+    ____exports.runNextRenderFrame = runNextRenderFrame
 end
 do
     local ____export = require("features.saveDataManager.exports")
@@ -366,6 +370,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.sound")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.spawnCollectible")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.25",
+  "version": "1.2.29",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.0",
-    "isaac-typescript-definitions": "^1.0.338",
+    "isaac-typescript-definitions": "^1.0.339",
     "isaacscript-lint": "^1.0.79",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.11",