isaacscript-common 2.3.2 → 3.1.1

package/enums/ModCallbackCustom.d.ts

@@ -2,7 +2,7 @@
  * - The Isaac API offers a lot of callbacks, but a lot of times there isn't one for the specific
  *   thing that you are looking to do. So, `isaacscript-common` adds a bunch of new callbacks that
  *   you can use.
- * - The extra callbacks are efficient such that no code is ran until they have one or more
+ * - The extra callbacks are efficient such that no code is executed until there is one or more
  *   subscriptions.
  * - You must upgrade your mod with the `upgradeMod` helper function before using a custom callback.
  */
@@ -143,7 +143,7 @@ export declare enum ModCallbackCustom {
      * only fire if the familiar variant matches the `FamiliarVariant` provided.
      *
      * ```ts
-     * function postTearInitLate(familiar: EntityFamiliar): void {}
+     * function postFamiliarInitLate(familiar: EntityFamiliar): void {}
      * ```
      */
     POST_FAMILIAR_INIT_LATE = 11,
@@ -490,6 +490,28 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_PICKUP_COLLECT = 36,
+    /**
+     * Fires from the `MC_POST_PICKUP_INIT` callback on the first time that a player has seen the
+     * respective pickup on the run.
+     *
+     * This callback is useful because pickups will despawn upon leaving the room and respawn upon
+     * re-entering the room.
+     *
+     * For most cases, this callback will simply fire when `MC_POST_PICKUP_INIT` fires and the player
+     * is not re-entering a previously visited room.
+     *
+     * The special case is when a player enters a post-Ascent Treasure Room or Boss Room. For these
+     * cases, the `InitSeed` of any pickups seen from previous floors is kept track of to prevent the
+     * callback from firing when re-entering the room.
+     *
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if the collectible type matches the `PickupVariant` provided.
+     *
+     * ```ts
+     * function postPickupInitFirst(pickup: EntityPickup): void {}
+     * ```
+     */
+    POST_PICKUP_INIT_FIRST = 37,
     /**
      * Fires on the first `MC_POST_PICKUP_UPDATE` frame for each pickup.
      *
@@ -503,7 +525,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 37,
+    POST_PICKUP_INIT_LATE = 38,
     /**
      * Fires from the `MC_POST_PICKUP_UPDATE` callback when a pickup's state has changed from what it
      * was on the previous frame.
@@ -519,9 +541,9 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 38,
-    POST_PIT_RENDER = 39,
-    POST_PIT_UPDATE = 40,
+    POST_PICKUP_STATE_CHANGED = 39,
+    POST_PIT_RENDER = 40,
+    POST_PIT_UPDATE = 41,
     /**
      * Fires from the `MC_POST_PEFFECT_UPDATE` callback when a player entity gains or loses any health
      * (i.e. hearts). For more information, see the `PlayerHealth` enum.
@@ -537,7 +559,7 @@ export declare enum ModCallbackCustom {
      * ) {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 41,
+    POST_PLAYER_CHANGE_HEALTH = 42,
     /**
      * Fires from the `MC_POST_PEFFECT_UPDATE` callback when a player entity changes its player type
      * (i.e. character). For example, it will fire after using Clicker, after dying with the Judas'
@@ -555,7 +577,7 @@ export declare enum ModCallbackCustom {
      * ) {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 42,
+    POST_PLAYER_CHANGE_TYPE = 43,
     /**
      * Fires from the `MC_ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
      * prevent the fatal damage.
@@ -572,7 +594,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerFatalDamage(player: EntityPlayer) {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 43,
+    POST_PLAYER_FATAL_DAMAGE = 44,
     /**
      * Fires on the first `MC_POST_PLAYER_UPDATE` frame for each player.
      *
@@ -586,7 +608,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 44,
+    POST_PLAYER_INIT_LATE = 45,
     /**
      * Similar to the vanilla callback of the same name, but fires after the `MC_POST_GAME_STARTED`
      * callback fires (if the player is spawning on the 0th game frame of the run).
@@ -607,8 +629,8 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_REORDERED = 45,
-    POST_PLAYER_RENDER_REORDERED = 46,
+    POST_PLAYER_INIT_REORDERED = 46,
+    POST_PLAYER_RENDER_REORDERED = 47,
     /**
      * Similar to the vanilla callback of the same name, but fires after the `MC_POST_GAME_STARTED`
      * callback fires (if the player is being updated on the 0th game frame of the run).
@@ -629,11 +651,11 @@ export declare enum ModCallbackCustom {
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 47,
-    POST_POOP_RENDER = 48,
-    POST_POOP_UPDATE = 49,
-    POST_PRESSURE_PLATE_RENDER = 50,
-    POST_PRESSURE_PLATE_UPDATE = 51,
+    POST_PLAYER_UPDATE_REORDERED = 48,
+    POST_POOP_RENDER = 49,
+    POST_POOP_UPDATE = 50,
+    POST_PRESSURE_PLATE_RENDER = 51,
+    POST_PRESSURE_PLATE_UPDATE = 52,
     /**
      * Fires on the first `MC_POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -647,7 +669,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 52,
+    POST_PROJECTILE_INIT_LATE = 53,
     /**
      * Fires from the `MC_POST_PEFFECT_UPDATE` callback when a player first picks up a new item. The
      * pickup returned in the callback is assumed to be the first pickup that no longer exists.
@@ -661,10 +683,10 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 53,
-    POST_ROCK_RENDER = 54,
-    POST_ROCK_UPDATE = 55,
-    POST_ROOM_CLEAR_CHANGED = 56,
+    POST_PURCHASE = 54,
+    POST_ROCK_RENDER = 55,
+    POST_ROCK_UPDATE = 56,
+    POST_ROOM_CLEAR_CHANGED = 57,
     /**
      * Fires from the `MC_ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a
      * Sacrifice Room.
@@ -673,7 +695,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 57,
+    POST_SACRIFICE = 58,
     /**
      * Fires from the `MC_POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -684,7 +706,7 @@ export declare enum ModCallbackCustom {
      * function postSlotAnimationChanged(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 58,
+    POST_SLOT_ANIMATION_CHANGED = 59,
     /**
      * Fires from the `MC_POST_RENDER` callback when a slot plays the animation that indicates that it
      * has broken.
@@ -696,7 +718,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 59,
+    POST_SLOT_DESTROYED = 60,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -712,7 +734,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 60,
+    POST_SLOT_INIT = 61,
     /**
      * Fires from the `MC_POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -723,7 +745,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 61,
+    POST_SLOT_RENDER = 62,
     /**
      * Fires from the `MC_POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -734,9 +756,9 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 62,
-    POST_SPIKES_RENDER = 63,
-    POST_SPIKES_UPDATE = 64,
+    POST_SLOT_UPDATE = 63,
+    POST_SPIKES_RENDER = 64,
+    POST_SPIKES_UPDATE = 65,
     /**
      * Fires on the first `MC_POST_TEAR_UPDATE` frame for each tear.
      *
@@ -750,7 +772,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 65,
+    POST_TEAR_INIT_LATE = 66,
     /**
      * Fires on the second `MC_POST_TEAR_UPDATE` frame for each tear (i.e. frame 1).
      *
@@ -763,9 +785,9 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 66,
-    POST_TNT_RENDER = 67,
-    POST_TNT_UPDATE = 68,
+    POST_TEAR_INIT_VERY_LATE = 67,
+    POST_TNT_RENDER = 68,
+    POST_TNT_UPDATE = 69,
     /**
      * Fires from the `MC_POST_PEFFECT_UPDATE` callback when a player gains or loses a new
      * transformation.
@@ -783,7 +805,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 69,
+    POST_TRANSFORMATION = 70,
     /**
      * Fires from `MC_ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -797,7 +819,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 70,
+    POST_TRINKET_BREAK = 71,
     /**
      * Fires from the `MC_POST_PEFFECT_UPDATE` callback on the frame before a Berserk! effect ends
      * when the player is predicted to die (e.g. they currently have no health left or they took
@@ -810,7 +832,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer) {}
      * ```
      */
-    PRE_BERSERK_DEATH = 71,
+    PRE_BERSERK_DEATH = 72,
     /**
      * Fires from the `MC_POST_PLAYER_FATAL_DAMAGE` callback when a player is about to die. If you
      * want to initiate a custom revival, return an integer that corresponds to the item or type of
@@ -823,7 +845,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer) {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 72,
+    PRE_CUSTOM_REVIVE = 73,
     /**
      * Fires from the `MC_POST_PEFFECT_UPDATE` callback when an item becomes queued (i.e. when the
      * player begins to hold the item above their head).
@@ -842,7 +864,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 73,
+    PRE_ITEM_PICKUP = 74,
     /**
      * Fires on the `MC_POST_RENDER` frame before the player is taken to a new floor. Only fires when
      * a player jumps into a trapdoor or enters a heaven door (beam of light). Does not fire on the
@@ -856,5 +878,5 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 74
+    PRE_NEW_LEVEL = 75
 }

package/enums/ModCallbackCustom.lua

@@ -1,4 +1,10 @@
 local ____exports = {}
+--- - The Isaac API offers a lot of callbacks, but a lot of times there isn't one for the specific
+--   thing that you are looking to do. So, `isaacscript-common` adds a bunch of new callbacks that
+--   you can use.
+-- - The extra callbacks are efficient such that no code is executed until there is one or more
+--   subscriptions.
+-- - You must upgrade your mod with the `upgradeMod` helper function before using a custom callback.
 ____exports.ModCallbackCustom = {}
 ____exports.ModCallbackCustom.POST_BOMB_INIT_LATE = 0
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_BOMB_INIT_LATE] = "POST_BOMB_INIT_LATE"
@@ -74,80 +80,82 @@ ____exports.ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED = 35
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED] = "POST_PEFFECT_UPDATE_REORDERED"
 ____exports.ModCallbackCustom.POST_PICKUP_COLLECT = 36
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PICKUP_COLLECT] = "POST_PICKUP_COLLECT"
-____exports.ModCallbackCustom.POST_PICKUP_INIT_LATE = 37
+____exports.ModCallbackCustom.POST_PICKUP_INIT_FIRST = 37
+____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PICKUP_INIT_FIRST] = "POST_PICKUP_INIT_FIRST"
+____exports.ModCallbackCustom.POST_PICKUP_INIT_LATE = 38
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PICKUP_INIT_LATE] = "POST_PICKUP_INIT_LATE"
-____exports.ModCallbackCustom.POST_PICKUP_STATE_CHANGED = 38
+____exports.ModCallbackCustom.POST_PICKUP_STATE_CHANGED = 39
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PICKUP_STATE_CHANGED] = "POST_PICKUP_STATE_CHANGED"
-____exports.ModCallbackCustom.POST_PIT_RENDER = 39
+____exports.ModCallbackCustom.POST_PIT_RENDER = 40
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PIT_RENDER] = "POST_PIT_RENDER"
-____exports.ModCallbackCustom.POST_PIT_UPDATE = 40
+____exports.ModCallbackCustom.POST_PIT_UPDATE = 41
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PIT_UPDATE] = "POST_PIT_UPDATE"
-____exports.ModCallbackCustom.POST_PLAYER_CHANGE_HEALTH = 41
+____exports.ModCallbackCustom.POST_PLAYER_CHANGE_HEALTH = 42
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_CHANGE_HEALTH] = "POST_PLAYER_CHANGE_HEALTH"
-____exports.ModCallbackCustom.POST_PLAYER_CHANGE_TYPE = 42
+____exports.ModCallbackCustom.POST_PLAYER_CHANGE_TYPE = 43
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_CHANGE_TYPE] = "POST_PLAYER_CHANGE_TYPE"
-____exports.ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE = 43
+____exports.ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE = 44
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE] = "POST_PLAYER_FATAL_DAMAGE"
-____exports.ModCallbackCustom.POST_PLAYER_INIT_LATE = 44
+____exports.ModCallbackCustom.POST_PLAYER_INIT_LATE = 45
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_INIT_LATE] = "POST_PLAYER_INIT_LATE"
-____exports.ModCallbackCustom.POST_PLAYER_INIT_REORDERED = 45
+____exports.ModCallbackCustom.POST_PLAYER_INIT_REORDERED = 46
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_INIT_REORDERED] = "POST_PLAYER_INIT_REORDERED"
-____exports.ModCallbackCustom.POST_PLAYER_RENDER_REORDERED = 46
+____exports.ModCallbackCustom.POST_PLAYER_RENDER_REORDERED = 47
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_RENDER_REORDERED] = "POST_PLAYER_RENDER_REORDERED"
-____exports.ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED = 47
+____exports.ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED = 48
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED] = "POST_PLAYER_UPDATE_REORDERED"
-____exports.ModCallbackCustom.POST_POOP_RENDER = 48
+____exports.ModCallbackCustom.POST_POOP_RENDER = 49
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_POOP_RENDER] = "POST_POOP_RENDER"
-____exports.ModCallbackCustom.POST_POOP_UPDATE = 49
+____exports.ModCallbackCustom.POST_POOP_UPDATE = 50
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_POOP_UPDATE] = "POST_POOP_UPDATE"
-____exports.ModCallbackCustom.POST_PRESSURE_PLATE_RENDER = 50
+____exports.ModCallbackCustom.POST_PRESSURE_PLATE_RENDER = 51
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PRESSURE_PLATE_RENDER] = "POST_PRESSURE_PLATE_RENDER"
-____exports.ModCallbackCustom.POST_PRESSURE_PLATE_UPDATE = 51
+____exports.ModCallbackCustom.POST_PRESSURE_PLATE_UPDATE = 52
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PRESSURE_PLATE_UPDATE] = "POST_PRESSURE_PLATE_UPDATE"
-____exports.ModCallbackCustom.POST_PROJECTILE_INIT_LATE = 52
+____exports.ModCallbackCustom.POST_PROJECTILE_INIT_LATE = 53
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PROJECTILE_INIT_LATE] = "POST_PROJECTILE_INIT_LATE"
-____exports.ModCallbackCustom.POST_PURCHASE = 53
+____exports.ModCallbackCustom.POST_PURCHASE = 54
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PURCHASE] = "POST_PURCHASE"
-____exports.ModCallbackCustom.POST_ROCK_RENDER = 54
+____exports.ModCallbackCustom.POST_ROCK_RENDER = 55
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_ROCK_RENDER] = "POST_ROCK_RENDER"
-____exports.ModCallbackCustom.POST_ROCK_UPDATE = 55
+____exports.ModCallbackCustom.POST_ROCK_UPDATE = 56
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_ROCK_UPDATE] = "POST_ROCK_UPDATE"
-____exports.ModCallbackCustom.POST_ROOM_CLEAR_CHANGED = 56
+____exports.ModCallbackCustom.POST_ROOM_CLEAR_CHANGED = 57
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_ROOM_CLEAR_CHANGED] = "POST_ROOM_CLEAR_CHANGED"
-____exports.ModCallbackCustom.POST_SACRIFICE = 57
+____exports.ModCallbackCustom.POST_SACRIFICE = 58
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SACRIFICE] = "POST_SACRIFICE"
-____exports.ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED = 58
+____exports.ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED = 59
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED] = "POST_SLOT_ANIMATION_CHANGED"
-____exports.ModCallbackCustom.POST_SLOT_DESTROYED = 59
+____exports.ModCallbackCustom.POST_SLOT_DESTROYED = 60
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_DESTROYED] = "POST_SLOT_DESTROYED"
-____exports.ModCallbackCustom.POST_SLOT_INIT = 60
+____exports.ModCallbackCustom.POST_SLOT_INIT = 61
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_INIT] = "POST_SLOT_INIT"
-____exports.ModCallbackCustom.POST_SLOT_RENDER = 61
+____exports.ModCallbackCustom.POST_SLOT_RENDER = 62
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_RENDER] = "POST_SLOT_RENDER"
-____exports.ModCallbackCustom.POST_SLOT_UPDATE = 62
+____exports.ModCallbackCustom.POST_SLOT_UPDATE = 63
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_UPDATE] = "POST_SLOT_UPDATE"
-____exports.ModCallbackCustom.POST_SPIKES_RENDER = 63
+____exports.ModCallbackCustom.POST_SPIKES_RENDER = 64
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SPIKES_RENDER] = "POST_SPIKES_RENDER"
-____exports.ModCallbackCustom.POST_SPIKES_UPDATE = 64
+____exports.ModCallbackCustom.POST_SPIKES_UPDATE = 65
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SPIKES_UPDATE] = "POST_SPIKES_UPDATE"
-____exports.ModCallbackCustom.POST_TEAR_INIT_LATE = 65
+____exports.ModCallbackCustom.POST_TEAR_INIT_LATE = 66
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TEAR_INIT_LATE] = "POST_TEAR_INIT_LATE"
-____exports.ModCallbackCustom.POST_TEAR_INIT_VERY_LATE = 66
+____exports.ModCallbackCustom.POST_TEAR_INIT_VERY_LATE = 67
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TEAR_INIT_VERY_LATE] = "POST_TEAR_INIT_VERY_LATE"
-____exports.ModCallbackCustom.POST_TNT_RENDER = 67
+____exports.ModCallbackCustom.POST_TNT_RENDER = 68
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TNT_RENDER] = "POST_TNT_RENDER"
-____exports.ModCallbackCustom.POST_TNT_UPDATE = 68
+____exports.ModCallbackCustom.POST_TNT_UPDATE = 69
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TNT_UPDATE] = "POST_TNT_UPDATE"
-____exports.ModCallbackCustom.POST_TRANSFORMATION = 69
+____exports.ModCallbackCustom.POST_TRANSFORMATION = 70
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TRANSFORMATION] = "POST_TRANSFORMATION"
-____exports.ModCallbackCustom.POST_TRINKET_BREAK = 70
+____exports.ModCallbackCustom.POST_TRINKET_BREAK = 71
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TRINKET_BREAK] = "POST_TRINKET_BREAK"
-____exports.ModCallbackCustom.PRE_BERSERK_DEATH = 71
+____exports.ModCallbackCustom.PRE_BERSERK_DEATH = 72
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_BERSERK_DEATH] = "PRE_BERSERK_DEATH"
-____exports.ModCallbackCustom.PRE_CUSTOM_REVIVE = 72
+____exports.ModCallbackCustom.PRE_CUSTOM_REVIVE = 73
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_CUSTOM_REVIVE] = "PRE_CUSTOM_REVIVE"
-____exports.ModCallbackCustom.PRE_ITEM_PICKUP = 73
+____exports.ModCallbackCustom.PRE_ITEM_PICKUP = 74
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_ITEM_PICKUP] = "PRE_ITEM_PICKUP"
-____exports.ModCallbackCustom.PRE_NEW_LEVEL = 74
+____exports.ModCallbackCustom.PRE_NEW_LEVEL = 75
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_NEW_LEVEL] = "PRE_NEW_LEVEL"
 return ____exports

package/enums/private/CopyableIsaacAPIClassType.lua

@@ -1,4 +1,5 @@
 local ____exports = {}
+--- This must match the enumeration in the JSDoc comments for `deepCopy` and `merge`.
 ____exports.CopyableIsaacAPIClassType = {}
 ____exports.CopyableIsaacAPIClassType.COLOR = "Color"
 ____exports.CopyableIsaacAPIClassType.K_COLOR = "KColor"

package/enums/private/SerializationBrand.lua

@@ -1,4 +1,9 @@
 local ____exports = {}
+--- During serialization, we write an arbitrary string key to the object with a value of an empty
+-- string. This is used during deserialization to instantiate the correct type of object.
+-- 
+-- Note that we do not bother branding TSTL classes because we have no way to invoke the proper
+-- constructor during deserialization.
 ____exports.SerializationBrand = {}
 ____exports.SerializationBrand.DEFAULT_MAP = "__TSTL_DEFAULT_MAP"
 ____exports.SerializationBrand.MAP = "__TSTL_MAP"

package/features/characterHealthConversion.lua

@@ -74,10 +74,16 @@ function prePickupCollisionHeart(self, pickup, collider)
 end
 local FEATURE_NAME = "character health manager"
 characterHealthReplacementMap = __TS__New(Map)
+---
+-- @internal
 function ____exports.characterHealthConversionInit(self, mod)
     mod:AddCallback(ModCallback.POST_PEFFECT_UPDATE, postPEffectUpdate)
     mod:AddCallback(ModCallback.PRE_PICKUP_COLLISION, prePickupCollisionHeart, PickupVariant.HEART)
 end
+--- Helper function to make a character that has the same health mechanic as Blue Baby (red heart
+-- containers --> soul hearts) or Dark Judas (red heart containers --> black hearts).
+-- 
+-- Call this function once at the beginning of your mod to declare the health conversion type.
 function ____exports.registerCharacterHealthConversion(self, playerType, conversionHeartSubType)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     characterHealthReplacementMap:set(playerType, conversionHeartSubType)

package/features/characterStats.lua

@@ -27,9 +27,26 @@ function evaluateCache(self, player, cacheFlag)
 end
 local FEATURE_NAME = "character stat manager"
 charactersStatMap = __TS__New(Map)
+---
+-- @internal
 function ____exports.characterStatsInit(self, mod)
     mod:AddCallback(ModCallback.EVALUATE_CACHE, evaluateCache)
 end
+--- Helper function to manage the stats for a vanilla or custom character. Call this function once at
+-- the beginning of your mod to declare the starting stats.
+-- 
+-- You must provide this function with a map of CacheFlag to the default stat amount. For example,
+-- the default amount of damage is 3.5. To make a custom character start with 4.5 damage:
+-- 
+-- ```ts
+-- const fooDefaultStats = new Map<CacheFlag, number>([
+--   [CacheFlag.DAMAGE, 4.5],
+-- ])
+-- registerCharacterStats(PlayerTypeCustom.FOO, fooDefaultStats);
+-- ```
+-- 
+-- Note that the format for the `CacheFlag.FIRE_DELAY` value should be in the tears stat format, not
+-- the `MaxFireDelay` format.
 function ____exports.registerCharacterStats(self, playerType, statMap)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     charactersStatMap:set(playerType, statMap)

package/features/debugDisplay/exports.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" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * After using the "playerDisplay" console command, text will be drawn on each player for debugging
  * purposes. Use this function to specify a callback function that will returns the string that