isaacscript-common 2.3.2 → 3.0.0

package/callbacks/preBerserkDeath.lua

@@ -30,6 +30,8 @@ function postPEffectUpdateReordered(self, player)
         preBerserkDeathFire(nil, player)
     end
 end
+---
+-- @internal
 function ____exports.preBerserkDeathCallbackInit(self, mod)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)
 end

package/callbacks/preNewLevel.lua

@@ -37,6 +37,8 @@ function postPlayerRender(self, player)
 end
 TRAVELING_TO_NEXT_FLOOR_ANIMATIONS = __TS__New(Set, {"Trapdoor", "LightTravel"})
 firedOnStage = nil
+---
+-- @internal
 function ____exports.preNewLevelCallbackInit(self, mod)
     mod:AddCallback(ModCallback.POST_PLAYER_RENDER, postPlayerRender)
 end

package/callbacks/reorderedCallbacks.lua

@@ -77,15 +77,31 @@ currentStageType = nil
 usedGlowingHourGlass = false
 forceNewLevel = false
 forceNewRoom = false
+---
+-- @internal
 function ____exports.reorderedCallbacksInit(self, mod)
     mod:AddCallback(ModCallback.POST_USE_ITEM, useItemGlowingHourGlass, CollectibleType.GLOWING_HOUR_GLASS)
     mod:AddCallback(ModCallback.POST_GAME_STARTED, postGameStartedVanilla)
     mod:AddCallback(ModCallback.POST_NEW_LEVEL, postNewLevelVanilla)
     mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoomVanilla)
 end
+--- This is a utility function for users of the `ModCallbackCustom.POST_NEW_LEVEL_REORDERED` custom
+-- callback.
+-- 
+-- If some specific cases, mods can change the current level during run initialization on the 0th
+-- frame. However, due to how the callback reordering works, the custom PostNewLevel callback will
+-- never fire on the 0th frame. To get around this, call this function before changing levels to
+-- temporarily force the callback to fire.
 function ____exports.forceNewLevelCallback(self)
     forceNewLevel = true
 end
+--- This is a utility function for users of the `ModCallbackCustom.POST_NEW_ROOM_REORDERED` custom
+-- callback.
+-- 
+-- If some specific cases, mods can change the current room during run initialization on the 0th
+-- frame. However, due to how the callback reordering works, the custom PostNewRoom callback will
+-- never fire on the 0th frame. To get around this, call this function before changing rooms to
+-- temporarily force the callback to fire.
 function ____exports.forceNewRoomCallback(self)
     forceNewRoom = true
 end

package/callbacks/subscriptions/postBombInitLate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postBombInitLateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postBombInitLateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postBombInitLateFire(self, bomb)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postBoneSwing.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postBoneSwingHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postBoneSwingRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postBoneSwingFire(self, boneClub)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postCollectibleInitFirst.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postCollectibleInitFirstHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postCollectibleInitFirstRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postCollectibleInitFirstFire(self, collectible)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postCursedTeleport.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postCursedTeleportHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postCursedTeleportRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postCursedTeleportFire(self, player)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postCustomDoorEnter.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postCustomDoorEnterHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postCustomDoorEnterRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postCustomDoorEnterFire(self, player, effectVariant, doorSlot, direction)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postCustomRevive.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postCustomReviveHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postCustomReviveRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postCustomReviveFire(self, player, revivalType)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postDoorRender.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postDoorRenderHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postDoorRenderRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postDoorRenderFire(self, door)
     local gridEntityVariant = door:GetVariant()
     for ____, ____value in ipairs(subscriptions) do

package/callbacks/subscriptions/postDoorUpdate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postDoorUpdateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postDoorUpdateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postDoorUpdateFire(self, door)
     local gridEntityVariant = door:GetVariant()
     for ____, ____value in ipairs(subscriptions) do

package/callbacks/subscriptions/postEffectInitLate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postEffectInitLateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postEffectInitLateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postEffectInitLateFire(self, effect)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postEffectStateChanged.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postEffectStateChangedHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postEffectStateChangedRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postEffectStateChangedFire(self, effect, previousState, currentState)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postEsauJr.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postEsauJrHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postEsauJrRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postEsauJrFire(self, player)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postFamiliarInitLate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postFamiliarInitLateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postFamiliarInitLateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postFamiliarInitLateFire(self, familiar)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postFamiliarStateChanged.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postFamiliarStateChangedHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postFamiliarStateChangedRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postFamiliarStateChangedFire(self, familiar, previousState, currentState)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postFirstEsauJr.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postFirstEsauJrHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postFirstEsauJrRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postFirstEsauJrFire(self, player)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postFirstFlip.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postFirstFlipHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postFirstFlipRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postFirstFlipFire(self, player)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postFlip.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postFlipHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postFlipRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postFlipFire(self, player)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postGameStartedReordered.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGameStartedReorderedHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGameStartedReorderedRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGameStartedReorderedFire(self, isContinued)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postGreedModeWave.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGreedModeWaveHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGreedModeWaveRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGreedModeWaveFire(self, oldWave, newWave)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postGridEntityBroken.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGridEntityBrokenHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGridEntityBrokenRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGridEntityBrokenFire(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
     local gridEntityVariant = gridEntity:GetVariant()

package/callbacks/subscriptions/postGridEntityCollision.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGridEntityCollisionHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGridEntityCollisionRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGridEntityCollisionFire(self, gridEntity, entity)
     local gridEntityType = gridEntity:GetType()
     local gridEntityVariant = gridEntity:GetVariant()

package/callbacks/subscriptions/postGridEntityInit.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGridEntityInitHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGridEntityInitRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGridEntityInitFire(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
     local gridEntityVariant = gridEntity:GetVariant()

package/callbacks/subscriptions/postGridEntityRemove.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGridEntityRemoveHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGridEntityRemoveRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGridEntityRemoveFire(self, gridIndex, gridEntityType, gridEntityVariant)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postGridEntityRender.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGridEntityRenderHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGridEntityRenderRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGridEntityRenderFire(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
     local gridEntityVariant = gridEntity:GetVariant()

package/callbacks/subscriptions/postGridEntityStateChanged.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGridEntityStateChangedHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGridEntityStateChangedRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGridEntityStateChangedFire(self, gridEntity, oldState, newState)
     local gridEntityType = gridEntity:GetType()
     local gridEntityVariant = gridEntity:GetVariant()

package/callbacks/subscriptions/postGridEntityUpdate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postGridEntityUpdateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postGridEntityUpdateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postGridEntityUpdateFire(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
     local gridEntityVariant = gridEntity:GetVariant()

package/callbacks/subscriptions/postHolyMantleRemoved.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postHolyMantleRemovedHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postHolyMantleRemovedRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postHolyMantleRemovedFire(self, player, oldNumHolyMantles, newNumHolyMantles)
     local character = player:GetPlayerType()
     for ____, ____value in ipairs(subscriptions) do

package/callbacks/subscriptions/postItemDischarged.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postItemDischargeHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postItemDischargeRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postItemDischargeFire(self, player, collectibleType, activeSlot)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postItemPickup.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postItemPickupHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postItemPickupRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postItemPickupFire(self, player, pickingUpItem)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postKnifeInitLate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postKnifeInitLateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postKnifeInitLateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postKnifeInitLateFire(self, knife)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postLaserInitLate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postLaserInitLateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postLaserInitLateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postLaserInitLateFire(self, laser)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]

package/callbacks/subscriptions/postNPCInitLate.lua

@@ -1,12 +1,18 @@
 local ____exports = {}
 local subscriptions = {}
+---
+-- @internal
 function ____exports.postNPCInitLateHasSubscriptions(self)
     return #subscriptions > 0
 end
+---
+-- @internal
 function ____exports.postNPCInitLateRegister(self, ...)
     local args = {...}
     subscriptions[#subscriptions + 1] = args
 end
+---
+-- @internal
 function ____exports.postNPCInitLateFire(self, npc)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]