isaacscript-common 2.3.1 → 3.1.0

package/cachedClasses.d.ts

@@ -1,10 +1,12 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * A cached version of the class returned from the `Game()` constructor.
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *
- * Caching the results of a this constructor is safe, but caching other classes (like `Level` or
+ * Caching the results of this constructor is safe, but caching other classes (like `Level` or
  * `Room`) is not safe and can lead to the game crashing in certain situations.
  */
 export declare const game: Game;
@@ -13,7 +15,7 @@ export declare const game: Game;
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *
- * Caching the results of a this constructor is safe, but caching other classes (like `Level` or
+ * Caching the results of this constructor is safe, but caching other classes (like `Level` or
  * `Room`) is not safe and can lead to the game crashing in certain situations.
  */
 export declare const itemConfig: import("isaac-typescript-definitions/types/ItemConfig").ItemConfig;
@@ -22,7 +24,7 @@ export declare const itemConfig: import("isaac-typescript-definitions/types/Item
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *
- * Caching the results of a this constructor is safe, but caching other classes (like `Level` or
+ * Caching the results of this constructor is safe, but caching other classes (like `Level` or
  * `Room`) is not safe and can lead to the game crashing in certain situations.
  */
 export declare const musicManager: MusicManager;
@@ -31,7 +33,7 @@ export declare const musicManager: MusicManager;
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *
- * Caching the results of a this constructor is safe, but caching other classes (like `Level` or
+ * Caching the results of this constructor is safe, but caching other classes (like `Level` or
  * `Room`) is not safe and can lead to the game crashing in certain situations.
  */
 export declare const sfxManager: SFXManager;

package/cachedClasses.lua

@@ -1,6 +1,30 @@
 local ____exports = {}
+--- A cached version of the class returned from the `Game()` constructor.
+-- 
+-- Use this instead of invoking the constructor again for a miniscule performance increase.
+-- 
+-- Caching the results of this constructor is safe, but caching other classes (like `Level` or
+-- `Room`) is not safe and can lead to the game crashing in certain situations.
 ____exports.game = Game()
+--- A cached version of the class returned from the `Isaac.GetItemConfig()` constructor.
+-- 
+-- Use this instead of invoking the constructor again for a miniscule performance increase.
+-- 
+-- Caching the results of this constructor is safe, but caching other classes (like `Level` or
+-- `Room`) is not safe and can lead to the game crashing in certain situations.
 ____exports.itemConfig = Isaac.GetItemConfig()
+--- A cached version of the class returned from the `MusicManager()` constructor.
+-- 
+-- Use this instead of invoking the constructor again for a miniscule performance increase.
+-- 
+-- Caching the results of this constructor is safe, but caching other classes (like `Level` or
+-- `Room`) is not safe and can lead to the game crashing in certain situations.
 ____exports.musicManager = MusicManager()
+--- A cached version of the class returned from the `SFXManager()` constructor.
+-- 
+-- Use this instead of invoking the constructor again for a miniscule performance increase.
+-- 
+-- Caching the results of this constructor is safe, but caching other classes (like `Level` or
+-- `Room`) is not safe and can lead to the game crashing in certain situations.
 ____exports.sfxManager = SFXManager()
 return ____exports

package/callbacks/customRevive.lua

@@ -134,6 +134,8 @@ CustomReviveState[CustomReviveState.WAITING_FOR_ROOM_TRANSITION] = "WAITING_FOR_
 CustomReviveState.WAITING_FOR_ITEM_ANIMATION = 2
 CustomReviveState[CustomReviveState.WAITING_FOR_ITEM_ANIMATION] = "WAITING_FOR_ITEM_ANIMATION"
 v = {run = {state = CustomReviveState.DISABLED, revivalType = nil, dyingPlayerIndex = nil}}
+---
+-- @internal
 function ____exports.customReviveCallbacksInit(self, mod)
     saveDataManager(nil, "customRevive", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)

package/callbacks/itemPickup.lua

@@ -57,6 +57,8 @@ v = {run = {playersPickingUpItemMap = __TS__New(
     DefaultMap,
     function() return newPickingUpItem(nil) end
 )}}
+---
+-- @internal
 function ____exports.itemPickupCallbacksInit(self, mod)
     saveDataManager(nil, "itemPickup", v, hasSubscriptions)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)

package/callbacks/postBombInitLate.lua

@@ -24,6 +24,8 @@ function postBombUpdate(self, bomb)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postBombInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postBombInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_BOMB_UPDATE, postBombUpdate)

package/callbacks/postBoneSwing.lua

@@ -41,6 +41,8 @@ function boneClubAnimationChanged(self, boneClub, animation)
 end
 BONE_SWING_ANIMATIONS = __TS__New(Set, {"Swing", "Swing2", "Spin"})
 v = {room = {boneClubAnimations = __TS__New(Map)}}
+---
+-- @internal
 function ____exports.postBoneSwingCallbackInit(self, mod)
     saveDataManager(nil, "postBoneSwing", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_KNIFE_RENDER, postKnifeRender)

package/callbacks/postCollectibleInitFirst.lua

@@ -25,6 +25,8 @@ function postPickupInitCollectible(self, collectible)
     postCollectibleInitFirstFire(nil, collectible)
 end
 v = {run = {seenCollectibles = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postCollectibleInitFirstCallbackInit(self, mod)
     saveDataManager(nil, "postCollectibleInitFirst", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_PICKUP_INIT, postPickupInitCollectible, PickupVariant.COLLECTIBLE)

package/callbacks/postCursedTeleport.lua

@@ -111,6 +111,8 @@ v = {
     run = {playersDamageFrameMap = __TS__New(Map)},
     level = {numSacrifices = 0}
 }
+---
+-- @internal
 function ____exports.postCursedTeleportCallbackInit(self, mod)
     saveDataManager(nil, "postCursedTeleport", v, hasSubscriptions)
     mod:AddCallback(ModCallback.ENTITY_TAKE_DMG, entityTakeDmgPlayer, EntityType.PLAYER)

package/callbacks/postCustomDoorEnter.lua

@@ -155,9 +155,34 @@ v = {room = {
     customDoors = __TS__New(Map),
     customDoorSlots = __TS__New(Set)
 }}
+---
+-- @internal
 function ____exports.postCustomDoorEnterCallbackInit(self)
     saveDataManager(nil, "postCustomDoorEnter", v, hasSubscriptions)
 end
+--- `isaacscript-common` provides custom doors that can be spawned where any wall segment is. If you
+-- use this feature, you must first call this initialization function at the beginning of your mod.
+-- 
+-- Each kind of custom door that you create must have an entry in the "content/entities2.xml" file,
+-- like so:
+-- 
+-- ```xml
+-- <entity id="1000" name="Foo Custom Door" anm2path="grid/door_foo.anm2" />
+-- ```
+-- 
+-- (Custom door entities must have an id of "1000", which corresponds to an effect. If you do not
+-- specify the variant, then the game will automatically assign it.)
+-- 
+-- Next, pass the variant into this function:
+-- 
+-- ```ts
+-- const modVanilla = RegisterMod("My Mod", 1);
+-- const mod = upgradeMod(modVanilla);
+-- const fooEffectVariant = Isaac.GetEntityVariantByName("Foo Custom Door");
+-- initCustomDoor(mod, fooEffectVariant);
+-- ```
+-- 
+-- Also see the `spawnCustomDoor` function.
 function ____exports.initCustomDoor(self, mod, effectVariant)
     initializedEffectVariants:add(effectVariant)
     mod:AddCallback(ModCallback.POST_EFFECT_UPDATE, postEffectUpdaterCustomEntity, effectVariant)
@@ -169,6 +194,25 @@ function ____exports.initCustomDoor(self, mod, effectVariant)
         end
     )
 end
+--- Helper function to spawn a custom door. This is intended to be called from the `POST_NEW_ROOM`
+-- callback when the player enters a room that should have a custom door. (You could also call it
+-- from another callback if you want the door to appear e.g. after clearing all enemies.)
+-- 
+-- Like other entities, the door is not persistent, so you must spawn it every time when re-entering
+-- the room.
+-- 
+-- Handle when a player enters the door by hooking the custom `POST_CUSTOM_DOOR_ENTER` callback.
+-- 
+-- The custom door is an `EntityEffect`. You can manually open or close the door by modifying its
+-- state. (The values to use correspond to the `DoorState` enum.)
+-- 
+-- This function will throw a runtime error if:
+-- - the door slot already has a vanilla door
+-- - the door slot already has a custom door
+-- - the tile at the door slot does not have a wall
+-- 
+-- Before using this function, you must first initialize the effect/door variant with the
+-- `initCustomDoor` function.
 function ____exports.spawnCustomDoor(self, effectVariant, doorSlot)
     if not initializedEffectVariants:has(effectVariant) then
         error("In order to spawn custom doors, you must first initialize them with the \"initCustomDoor\" function at the beginning of your mod.")

package/callbacks/postDoorRender.lua

@@ -18,6 +18,8 @@ function postRender(self)
         postDoorRenderFire(nil, doors)
     end
 end
+---
+-- @internal
 function ____exports.postDoorRenderInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end

package/callbacks/postDoorUpdate.lua

@@ -18,6 +18,8 @@ function postUpdate(self)
         postDoorUpdateFire(nil, doors)
     end
 end
+---
+-- @internal
 function ____exports.postDoorUpdateInit(self, mod)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
 end

package/callbacks/postEffectInitLate.lua

@@ -24,6 +24,8 @@ function postEffectUpdate(self, effect)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postEffectInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postEffectInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_EFFECT_UPDATE, postEffectUpdate)

package/callbacks/postEffectStateChanged.lua

@@ -30,6 +30,8 @@ v = {run = {effectStateMap = __TS__New(
     DefaultMap,
     function(____, state) return state end
 )}}
+---
+-- @internal
 function ____exports.postEffectStateChangedCallbackInit(self, mod)
     saveDataManager(nil, "postEffectStateChanged", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_EFFECT_UPDATE, postEffectUpdate)

package/callbacks/postEsauJr.lua

@@ -59,6 +59,8 @@ function useItemEsauJr(self, _collectibleType, _rng, player, _useFlags, _activeS
     v.run.usedEsauJrControllerIndex = player.ControllerIndex
 end
 v = {run = {usedEsauJrFrame = nil, usedEsauJrControllerIndex = nil, usedEsauJrAtLeastOnce = false}}
+---
+-- @internal
 function ____exports.postEsauJrCallbacksInit(self, mod)
     saveDataManager(nil, "postEsauJr", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)

package/callbacks/postFamiliarInitLate.lua

@@ -24,6 +24,8 @@ function postFamiliarUpdate(self, familiar)
     end
 end
 v = {run = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postFamiliarInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postFamiliarInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_FAMILIAR_UPDATE, postFamiliarUpdate)

package/callbacks/postFamiliarStateChanged.lua

@@ -30,6 +30,8 @@ v = {run = {familiarStateMap = __TS__New(
     DefaultMap,
     function(____, state) return state end
 )}}
+---
+-- @internal
 function ____exports.postFamiliarStateChangedCallbackInit(self, mod)
     saveDataManager(nil, "postFamiliarStateChanged", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_FAMILIAR_UPDATE, postFamiliarUpdate)

package/callbacks/postFlip.lua

@@ -54,6 +54,8 @@ function getNewLazarus(self, oldLazarus)
     )
 end
 v = {run = {usedFlipAtLeastOnce = false}}
+---
+-- @internal
 function ____exports.postFlipCallbacksInit(self, mod)
     saveDataManager(nil, "postFlip", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_USE_ITEM, useItemFlip, CollectibleType.FLIP)

package/callbacks/postGreedModeWave.lua

@@ -25,6 +25,8 @@ function postUpdate(self)
     end
 end
 v = {run = {currentGreedWave = 0}}
+---
+-- @internal
 function ____exports.postGreedModeWaveCallbackInit(self, mod)
     saveDataManager(nil, "postModeGreedWave", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)

package/callbacks/postGridEntity.lua

@@ -97,6 +97,8 @@ function postNewRoom(self)
     end
 end
 v = {room = {initializedGridEntities = __TS__New(Map)}}
+---
+-- @internal
 function ____exports.postGridEntityCallbacksInit(self, mod)
     saveDataManager(nil, "postGridEntity", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)

package/callbacks/postGridEntityCollision.lua

@@ -58,6 +58,8 @@ v = {room = {collidingEntitiesMap = __TS__New(
     DefaultMap,
     function() return __TS__New(Set) end
 )}}
+---
+-- @internal
 function ____exports.postGridEntityCollisionInit(self, mod)
     saveDataManager(nil, "postGridEntityCollision", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)

package/callbacks/postGridEntityRender.lua

@@ -18,6 +18,8 @@ function postRender(self)
         postGridEntityRenderFire(nil, gridEntity)
     end
 end
+---
+-- @internal
 function ____exports.postGridEntityRenderInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end

package/callbacks/postHolyMantleRemoved.lua

@@ -32,6 +32,8 @@ function postPEffectUpdateReordered(self, player)
     end
 end
 v = {run = {playersHolyMantleMap = __TS__New(DefaultMap, 0)}}
+---
+-- @internal
 function ____exports.postHolyMantleRemovedCallbackInit(self, mod)
     saveDataManager(nil, "postHolyMantleRemoved", v, hasSubscriptions)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)

package/callbacks/postKnifeInitLate.lua

@@ -24,6 +24,8 @@ function postKnifeUpdate(self, knife)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postKnifeInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postKnifeInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_KNIFE_UPDATE, postKnifeUpdate)

package/callbacks/postLaserInitLate.lua

@@ -24,6 +24,8 @@ function postLaserUpdate(self, laser)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postLaserInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postLaserInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_LASER_UPDATE, postLaserUpdate)

package/callbacks/postNPCInitLate.lua

@@ -24,6 +24,8 @@ function postNPCUpdate(self, npc)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postNPCInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postNPCInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_NPC_UPDATE, postNPCUpdate)

package/callbacks/postNPCStateChanged.lua

@@ -30,6 +30,8 @@ v = {run = {npcStateMap = __TS__New(
     DefaultMap,
     function(____, state) return state end
 )}}
+---
+-- @internal
 function ____exports.postNPCStateChangedCallbackInit(self, mod)
     saveDataManager(nil, "postNPCStateChanged", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_NPC_UPDATE, postNPCUpdate)

package/callbacks/postNewRoomEarly.lua

@@ -58,6 +58,8 @@ function checkRoomChanged(self)
 end
 currentRoomTopLeftWallPtrHash = nil
 currentRoomTopLeftWallPtrHash2 = nil
+---
+-- @internal
 function ____exports.postNewRoomEarlyCallbackInit(self, mod)
     mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
     mod:AddCallback(ModCallback.PRE_ENTITY_SPAWN, preEntitySpawn)

package/callbacks/postPickupCollect.lua

@@ -32,6 +32,8 @@ function postPickupRender(self, pickup)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postPickupCollectCallbackInit(self, mod)
     saveDataManager(nil, "postPickupCollect", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_PICKUP_RENDER, postPickupRender)

package/callbacks/postPickupInitLate.lua

@@ -24,6 +24,8 @@ function postPickupUpdate(self, pickup)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postPickupInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postPickupInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_PICKUP_UPDATE, postPickupUpdate)

package/callbacks/postPickupStateChanged.lua

@@ -30,6 +30,8 @@ v = {run = {pickupStateMap = __TS__New(
     DefaultMap,
     function(____, state) return state end
 )}}
+---
+-- @internal
 function ____exports.postPickupStateChangedCallbackInit(self, mod)
     saveDataManager(nil, "postPickupStateChanged", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_PICKUP_UPDATE, postPickupUpdate)

package/callbacks/postPitRender.lua

@@ -18,6 +18,8 @@ function postRender(self)
         postPitRenderFire(nil, pit)
     end
 end
+---
+-- @internal
 function ____exports.postPitRenderInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end

package/callbacks/postPitUpdate.lua

@@ -18,6 +18,8 @@ function postUpdate(self)
         postPitUpdateFire(nil, pit)
     end
 end
+---
+-- @internal
 function ____exports.postPitUpdateInit(self, mod)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
 end

package/callbacks/postPlayerChangeHealth.lua

@@ -43,6 +43,8 @@ v = {run = {playersHealthMap = __TS__New(
     DefaultMap,
     function() return __TS__New(Map) end
 )}}
+---
+-- @internal
 function ____exports.postPlayerChangeHealthCallbackInit(self, mod)
     saveDataManager(nil, "postPlayerChangeHealth", v, hasSubscriptions)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)

package/callbacks/postPlayerChangeType.lua

@@ -32,6 +32,8 @@ v = {run = {playersCharacterMap = __TS__New(
     DefaultMap,
     function(____, character) return character end
 )}}
+---
+-- @internal
 function ____exports.postPlayerChangeTypeCallbackInit(self, mod)
     saveDataManager(nil, "postPlayerChangeType", v, hasSubscriptions)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)

package/callbacks/postPlayerFatalDamage.lua

@@ -64,6 +64,8 @@ function entityTakeDmgPlayer(self, tookDamage, damageAmount, damageFlags, damage
     return nil
 end
 v = {run = {playersLastDamageGameFrame = __TS__New(Map)}}
+---
+-- @internal
 function ____exports.postPlayerFatalDamageCallbackInit(self, mod)
     saveDataManager(nil, "postPlayerFatalDamage", v)
     mod:AddCallback(ModCallback.ENTITY_TAKE_DMG, entityTakeDmgPlayer, EntityType.PLAYER)

package/callbacks/postPlayerInitLate.lua

@@ -26,6 +26,8 @@ function postPlayerUpdate(self, player)
     end
 end
 v = {run = {playersFiredSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postPlayerInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postPlayerInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_PLAYER_UPDATE, postPlayerUpdate)

package/callbacks/postPlayerReordered.lua

@@ -101,6 +101,8 @@ v = {run = {
     postPlayerUpdateQueue = {},
     postPlayerRenderQueue = {}
 }}
+---
+-- @internal
 function ____exports.postPlayerReorderedCallbacksInit(self, mod)
     saveDataManager(nil, "postPlayerReordered", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_PEFFECT_UPDATE, postPEffectUpdate)

package/callbacks/postPoopRender.lua

@@ -18,6 +18,8 @@ function postRender(self)
         postPoopRenderFire(nil, poop)
     end
 end
+---
+-- @internal
 function ____exports.postPoopRenderInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end

package/callbacks/postPoopUpdate.lua

@@ -18,6 +18,8 @@ function postUpdate(self)
         postPoopUpdateFire(nil, poop)
     end
 end
+---
+-- @internal
 function ____exports.postPoopUpdateInit(self, mod)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
 end

package/callbacks/postPressurePlateRender.lua

@@ -18,6 +18,8 @@ function postRender(self)
         postPressurePlateRenderFire(nil, pressurePlate)
     end
 end
+---
+-- @internal
 function ____exports.postPressurePlateRenderInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end

package/callbacks/postPressurePlateUpdate.lua

@@ -18,6 +18,8 @@ function postUpdate(self)
         postPressurePlateUpdateFire(nil, pressurePlate)
     end
 end
+---
+-- @internal
 function ____exports.postPressurePlateUpdateInit(self, mod)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
 end

package/callbacks/postProjectileInitLate.lua

@@ -24,6 +24,8 @@ function postProjectileUpdate(self, projectile)
     end
 end
 v = {room = {firedSet = __TS__New(Set)}}
+---
+-- @internal
 function ____exports.postProjectileInitLateCallbackInit(self, mod)
     saveDataManager(nil, "postProjectileInitLate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_PROJECTILE_UPDATE, postProjectileUpdate)

package/callbacks/postPurchase.lua

@@ -42,6 +42,8 @@ function playerPickedUpNewItem(self, player)
     end
 end
 v = {room = {playersHoldingItemOnLastFrameMap = __TS__New(DefaultMap, false)}}
+---
+-- @internal
 function ____exports.postPurchaseCallbackInit(self, mod)
     saveDataManager(nil, "postPurchase", v, hasSubscriptions)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)

package/callbacks/postRockRender.lua

@@ -18,6 +18,8 @@ function postRender(self)
         postRockRenderFire(nil, rock)
     end
 end
+---
+-- @internal
 function ____exports.postRockRenderInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end

package/callbacks/postRockUpdate.lua

@@ -18,6 +18,8 @@ function postUpdate(self)
         postRockUpdateFire(nil, rock)
     end
 end
+---
+-- @internal
 function ____exports.postRockUpdateInit(self, mod)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
 end

package/callbacks/postRoomClearChanged.lua

@@ -32,6 +32,8 @@ function postNewRoom(self)
     v.room.cleared = roomClear
 end
 v = {room = {cleared = false}}
+---
+-- @internal
 function ____exports.postRoomClearChangedCallbackInit(self, mod)
     saveDataManager(nil, "postRoomClearChanged", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)

package/callbacks/postSacrifice.lua

@@ -35,6 +35,8 @@ function entityTakeDmgPlayer(self, tookDamage, _damageAmount, damageFlags, _dama
     end
 end
 v = {level = {numSacrifices = 0}}
+---
+-- @internal
 function ____exports.postSacrificeCallbackInit(self, mod)
     saveDataManager(nil, "postSacrifice", v, hasSubscriptions)
     mod:AddCallback(ModCallback.ENTITY_TAKE_DMG, entityTakeDmgPlayer, EntityType.PLAYER)

package/callbacks/postSlotDestroyed.d.ts

@@ -0,0 +1 @@
+export {};

package/callbacks/postSlotDestroyed.lua

@@ -0,0 +1,66 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local Map = ____lualib.Map
+local ____exports = {}
+local hasSubscriptions, postEntityRemove, postSlotAnimationChanged, BROKEN_ANIMATIONS, PRIZE_GAME_FRAME_DELAY_UNTIL_REMOVAL, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+local ____postSlotDestroyed = require("callbacks.subscriptions.postSlotDestroyed")
+local postSlotDestroyedFire = ____postSlotDestroyed.postSlotDestroyedFire
+local postSlotDestroyedHasSubscriptions = ____postSlotDestroyed.postSlotDestroyedHasSubscriptions
+function hasSubscriptions(self)
+    return postSlotDestroyedHasSubscriptions(nil)
+end
+function postEntityRemove(self, entity)
+    local slot = entity
+    local ptrHash = GetPtrHash(slot)
+    local gameFrameCount = game:GetFrameCount()
+    local prizeFrame = v.room.slotPrizeAnimationGameFrame:get(ptrHash)
+    if prizeFrame == nil then
+        return
+    end
+    if prizeFrame + PRIZE_GAME_FRAME_DELAY_UNTIL_REMOVAL == gameFrameCount then
+        postSlotDestroyedFire(nil, slot)
+    end
+end
+function postSlotAnimationChanged(self, slot)
+    local ptrHash = GetPtrHash(slot)
+    local gameFrameCount = game:GetFrameCount()
+    local alreadyBroken = v.room.brokenSlots:has(ptrHash)
+    if alreadyBroken then
+        return
+    end
+    local sprite = slot:GetSprite()
+    local animation = sprite:GetAnimation()
+    if BROKEN_ANIMATIONS:has(animation) then
+        v.room.brokenSlots:add(ptrHash)
+        postSlotDestroyedFire(nil, slot)
+    end
+    if animation == "Prize" then
+        v.room.slotPrizeAnimationGameFrame:set(ptrHash, gameFrameCount)
+    else
+        v.room.slotPrizeAnimationGameFrame:delete(ptrHash)
+    end
+end
+BROKEN_ANIMATIONS = __TS__New(Set, {"Broken", "Death"})
+PRIZE_GAME_FRAME_DELAY_UNTIL_REMOVAL = 3
+v = {room = {
+    brokenSlots = __TS__New(Set),
+    slotPrizeAnimationGameFrame = __TS__New(Map)
+}}
+---
+-- @internal
+function ____exports.postSlotDestroyedCallbacksInit(self, mod)
+    saveDataManager(nil, "postSlotDestroyed", v, hasSubscriptions)
+    mod:AddCallback(ModCallback.POST_ENTITY_REMOVE, postEntityRemove, EntityType.SLOT)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED, postSlotAnimationChanged)
+end
+return ____exports