isaacscript-common 3.3.0 → 3.4.0

package/enums/ModCallbackCustom.lua

@@ -94,68 +94,72 @@ ____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 = 43
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_CHANGE_TYPE] = "POST_PLAYER_CHANGE_TYPE"
-____exports.ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE = 44
+____exports.ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED = 44
+____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED] = "POST_PLAYER_COLLECTIBLE_ADDED"
+____exports.ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED = 45
+____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED] = "POST_PLAYER_COLLECTIBLE_REMOVED"
+____exports.ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE = 46
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE] = "POST_PLAYER_FATAL_DAMAGE"
-____exports.ModCallbackCustom.POST_PLAYER_INIT_LATE = 45
+____exports.ModCallbackCustom.POST_PLAYER_INIT_LATE = 47
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_INIT_LATE] = "POST_PLAYER_INIT_LATE"
-____exports.ModCallbackCustom.POST_PLAYER_INIT_REORDERED = 46
+____exports.ModCallbackCustom.POST_PLAYER_INIT_REORDERED = 48
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_INIT_REORDERED] = "POST_PLAYER_INIT_REORDERED"
-____exports.ModCallbackCustom.POST_PLAYER_RENDER_REORDERED = 47
+____exports.ModCallbackCustom.POST_PLAYER_RENDER_REORDERED = 49
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_RENDER_REORDERED] = "POST_PLAYER_RENDER_REORDERED"
-____exports.ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED = 48
+____exports.ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED = 50
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED] = "POST_PLAYER_UPDATE_REORDERED"
-____exports.ModCallbackCustom.POST_POOP_RENDER = 49
+____exports.ModCallbackCustom.POST_POOP_RENDER = 51
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_POOP_RENDER] = "POST_POOP_RENDER"
-____exports.ModCallbackCustom.POST_POOP_UPDATE = 50
+____exports.ModCallbackCustom.POST_POOP_UPDATE = 52
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_POOP_UPDATE] = "POST_POOP_UPDATE"
-____exports.ModCallbackCustom.POST_PRESSURE_PLATE_RENDER = 51
+____exports.ModCallbackCustom.POST_PRESSURE_PLATE_RENDER = 53
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PRESSURE_PLATE_RENDER] = "POST_PRESSURE_PLATE_RENDER"
-____exports.ModCallbackCustom.POST_PRESSURE_PLATE_UPDATE = 52
+____exports.ModCallbackCustom.POST_PRESSURE_PLATE_UPDATE = 54
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PRESSURE_PLATE_UPDATE] = "POST_PRESSURE_PLATE_UPDATE"
-____exports.ModCallbackCustom.POST_PROJECTILE_INIT_LATE = 53
+____exports.ModCallbackCustom.POST_PROJECTILE_INIT_LATE = 55
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PROJECTILE_INIT_LATE] = "POST_PROJECTILE_INIT_LATE"
-____exports.ModCallbackCustom.POST_PURCHASE = 54
+____exports.ModCallbackCustom.POST_PURCHASE = 56
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_PURCHASE] = "POST_PURCHASE"
-____exports.ModCallbackCustom.POST_ROCK_RENDER = 55
+____exports.ModCallbackCustom.POST_ROCK_RENDER = 57
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_ROCK_RENDER] = "POST_ROCK_RENDER"
-____exports.ModCallbackCustom.POST_ROCK_UPDATE = 56
+____exports.ModCallbackCustom.POST_ROCK_UPDATE = 58
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_ROCK_UPDATE] = "POST_ROCK_UPDATE"
-____exports.ModCallbackCustom.POST_ROOM_CLEAR_CHANGED = 57
+____exports.ModCallbackCustom.POST_ROOM_CLEAR_CHANGED = 59
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_ROOM_CLEAR_CHANGED] = "POST_ROOM_CLEAR_CHANGED"
-____exports.ModCallbackCustom.POST_SACRIFICE = 58
+____exports.ModCallbackCustom.POST_SACRIFICE = 60
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SACRIFICE] = "POST_SACRIFICE"
-____exports.ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED = 59
+____exports.ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED = 61
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_ANIMATION_CHANGED] = "POST_SLOT_ANIMATION_CHANGED"
-____exports.ModCallbackCustom.POST_SLOT_DESTROYED = 60
+____exports.ModCallbackCustom.POST_SLOT_DESTROYED = 62
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_DESTROYED] = "POST_SLOT_DESTROYED"
-____exports.ModCallbackCustom.POST_SLOT_INIT = 61
+____exports.ModCallbackCustom.POST_SLOT_INIT = 63
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_INIT] = "POST_SLOT_INIT"
-____exports.ModCallbackCustom.POST_SLOT_RENDER = 62
+____exports.ModCallbackCustom.POST_SLOT_RENDER = 64
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_RENDER] = "POST_SLOT_RENDER"
-____exports.ModCallbackCustom.POST_SLOT_UPDATE = 63
+____exports.ModCallbackCustom.POST_SLOT_UPDATE = 65
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SLOT_UPDATE] = "POST_SLOT_UPDATE"
-____exports.ModCallbackCustom.POST_SPIKES_RENDER = 64
+____exports.ModCallbackCustom.POST_SPIKES_RENDER = 66
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SPIKES_RENDER] = "POST_SPIKES_RENDER"
-____exports.ModCallbackCustom.POST_SPIKES_UPDATE = 65
+____exports.ModCallbackCustom.POST_SPIKES_UPDATE = 67
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_SPIKES_UPDATE] = "POST_SPIKES_UPDATE"
-____exports.ModCallbackCustom.POST_TEAR_INIT_LATE = 66
+____exports.ModCallbackCustom.POST_TEAR_INIT_LATE = 68
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TEAR_INIT_LATE] = "POST_TEAR_INIT_LATE"
-____exports.ModCallbackCustom.POST_TEAR_INIT_VERY_LATE = 67
+____exports.ModCallbackCustom.POST_TEAR_INIT_VERY_LATE = 69
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TEAR_INIT_VERY_LATE] = "POST_TEAR_INIT_VERY_LATE"
-____exports.ModCallbackCustom.POST_TNT_RENDER = 68
+____exports.ModCallbackCustom.POST_TNT_RENDER = 70
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TNT_RENDER] = "POST_TNT_RENDER"
-____exports.ModCallbackCustom.POST_TNT_UPDATE = 69
+____exports.ModCallbackCustom.POST_TNT_UPDATE = 71
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TNT_UPDATE] = "POST_TNT_UPDATE"
-____exports.ModCallbackCustom.POST_TRANSFORMATION = 70
+____exports.ModCallbackCustom.POST_TRANSFORMATION = 72
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TRANSFORMATION] = "POST_TRANSFORMATION"
-____exports.ModCallbackCustom.POST_TRINKET_BREAK = 71
+____exports.ModCallbackCustom.POST_TRINKET_BREAK = 73
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.POST_TRINKET_BREAK] = "POST_TRINKET_BREAK"
-____exports.ModCallbackCustom.PRE_BERSERK_DEATH = 72
+____exports.ModCallbackCustom.PRE_BERSERK_DEATH = 74
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_BERSERK_DEATH] = "PRE_BERSERK_DEATH"
-____exports.ModCallbackCustom.PRE_CUSTOM_REVIVE = 73
+____exports.ModCallbackCustom.PRE_CUSTOM_REVIVE = 75
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_CUSTOM_REVIVE] = "PRE_CUSTOM_REVIVE"
-____exports.ModCallbackCustom.PRE_ITEM_PICKUP = 74
+____exports.ModCallbackCustom.PRE_ITEM_PICKUP = 76
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_ITEM_PICKUP] = "PRE_ITEM_PICKUP"
-____exports.ModCallbackCustom.PRE_NEW_LEVEL = 75
+____exports.ModCallbackCustom.PRE_NEW_LEVEL = 77
 ____exports.ModCallbackCustom[____exports.ModCallbackCustom.PRE_NEW_LEVEL] = "PRE_NEW_LEVEL"
 return ____exports

package/features/playerInventory.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSlot, CollectibleType } from "isaac-typescript-definitions";
+import { CollectibleType } from "isaac-typescript-definitions";
 /**
  * Helper function to get all of the collectibles that the player has gotten so far on this run, in
  * order.
@@ -12,12 +12,3 @@ import { ActiveSlot, CollectibleType } from "isaac-typescript-definitions";
  * order of the lowest `CollectibleType` to the highest.
  */
 export declare function getPlayerInventory(player: EntityPlayer, includeActiveCollectibles?: boolean): CollectibleType[];
-/**
- * Helper function to add a collectible to a player. Use this instead of the
- * `EntityPlayer.AddCollectible` method if you want the collectible that is added to be
- * automatically tracked by the player inventory tracker feature.
- *
- * You only need to use this function if you are using the inventory feature from the standard
- * library.
- */
-export declare function addCollectible(player: EntityPlayer, collectibleType: CollectibleType, charge?: int, firstTimePickingUp?: boolean, activeSlot?: ActiveSlot, varData?: int): void;

package/features/playerInventory.lua

@@ -1,10 +1,9 @@
 local ____lualib = require("lualib_bundle")
 local __TS__New = ____lualib.__TS__New
-local Set = ____lualib.Set
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
-local newPlayerInventory, useItemD4, postGameStarted, postItemPickup, addCollectibleToInventory, v
+local newPlayerInventory, resetInventory, useItemD4, postGameStarted, postCollectibleAdded, postCollectibleRemoved, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
@@ -21,13 +20,14 @@ local ____collectibles = require("functions.collectibles")
 local isActiveCollectible = ____collectibles.isActiveCollectible
 local ____collectibleSet = require("functions.collectibleSet")
 local getCollectibleSet = ____collectibleSet.getCollectibleSet
+local ____playerDataStructures = require("functions.playerDataStructures")
+local defaultMapGetPlayer = ____playerDataStructures.defaultMapGetPlayer
+local mapSetPlayer = ____playerDataStructures.mapSetPlayer
 local ____playerIndex = require("functions.playerIndex")
 local getAllPlayers = ____playerIndex.getAllPlayers
 local getPlayerIndex = ____playerIndex.getPlayerIndex
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
-local ____PickingUpItem = require("types.PickingUpItem")
-local pickingUpItemIsCollectible = ____PickingUpItem.pickingUpItemIsCollectible
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 function newPlayerInventory(self, player)
@@ -45,62 +45,42 @@ function newPlayerInventory(self, player)
     end
     return inventory
 end
-function useItemD4(self, _collectibleType, _rng, player)
-    local playerIndex = getPlayerIndex(nil, player)
+function resetInventory(self, player)
     local inventory = newPlayerInventory(nil, player)
-    v.run.playersInventory:set(playerIndex, inventory)
+    mapSetPlayer(nil, v.run.playersInventory, player, inventory)
+end
+function useItemD4(self, _collectibleType, _rng, player)
+    resetInventory(nil, player)
 end
 function postGameStarted(self)
     for ____, player in ipairs(getAllPlayers(nil)) do
         local playerIndex = getPlayerIndex(nil, player)
         if not v.run.playersInventory:has(playerIndex) then
-            local inventory = newPlayerInventory(nil, player)
-            v.run.playersInventory:set(playerIndex, inventory)
+            resetInventory(nil, player)
         end
     end
 end
-function postItemPickup(self, player, pickingUpItem)
-    if not pickingUpItemIsCollectible(nil, pickingUpItem) then
-        return
-    end
-    addCollectibleToInventory(nil, player, pickingUpItem.subType)
-end
-function addCollectibleToInventory(self, player, collectibleType)
-    local playerIndex = getPlayerIndex(nil, player)
-    local inventory = v.run.playersInventory:getAndSetDefault(playerIndex, player)
+function postCollectibleAdded(self, player, collectibleType)
+    local inventory = defaultMapGetPlayer(nil, v.run.playersInventory, player, player)
     inventory[#inventory + 1] = collectibleType
-    if not isActiveCollectible(nil, collectibleType) then
-        return
-    end
-    local activeCollectibleTypes = v.run.playersActiveCollectibleTypes:getAndSetDefault(playerIndex)
-    activeCollectibleTypes[#activeCollectibleTypes + 1] = collectibleType
-    local droppedActiveCollectibleTypes = __TS__ArrayFilter(
-        activeCollectibleTypes,
-        function(____, activeCollectibleType) return not player:HasCollectible(activeCollectibleType) end
-    )
-    for ____, activeCollectibleType in ipairs(droppedActiveCollectibleTypes) do
-        arrayRemoveInPlace(nil, inventory, activeCollectibleType)
-        arrayRemoveInPlace(nil, activeCollectibleTypes, activeCollectibleType)
-    end
+end
+function postCollectibleRemoved(self, player, collectibleType)
+    local inventory = defaultMapGetPlayer(nil, v.run.playersInventory, player, player)
+    arrayRemoveInPlace(nil, inventory, collectibleType)
 end
 local FEATURE_NAME = "player inventory tracker"
-v = {run = {
-    playersInventory = __TS__New(
-        DefaultMap,
-        function(____, player) return newPlayerInventory(nil, player) end
-    ),
-    playersActiveCollectibleTypes = __TS__New(
-        DefaultMap,
-        function() return {} end
-    )
-}}
+v = {run = {playersInventory = __TS__New(
+    DefaultMap,
+    function(____, player) return newPlayerInventory(nil, player) end
+)}}
 ---
 -- @internal
 function ____exports.playerInventoryInit(self, mod)
     saveDataManager(nil, "playerInventory", v)
     mod:AddCallback(ModCallback.POST_USE_ITEM, useItemD4, CollectibleType.D4)
     mod:AddCallback(ModCallback.POST_GAME_STARTED, postGameStarted)
-    mod:AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED, postCollectibleAdded)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED, postCollectibleRemoved)
 end
 --- Helper function to get all of the collectibles that the player has gotten so far on this run, in
 -- order.
@@ -117,8 +97,7 @@ function ____exports.getPlayerInventory(self, player, includeActiveCollectibles)
         includeActiveCollectibles = true
     end
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
-    local playerIndex = getPlayerIndex(nil, player)
-    local inventory = v.run.playersInventory:getAndSetDefault(playerIndex, player)
+    local inventory = defaultMapGetPlayer(nil, v.run.playersInventory, player, player)
     local copiedInventory = copyArray(nil, inventory)
     if includeActiveCollectibles then
         return copiedInventory
@@ -128,20 +107,4 @@ function ____exports.getPlayerInventory(self, player, includeActiveCollectibles)
         function(____, collectibleType) return not isActiveCollectible(nil, collectibleType) end
     )
 end
---- Helper function to add a collectible to a player. Use this instead of the
--- `EntityPlayer.AddCollectible` method if you want the collectible that is added to be
--- automatically tracked by the player inventory tracker feature.
--- 
--- You only need to use this function if you are using the inventory feature from the standard
--- library.
-function ____exports.addCollectible(self, player, collectibleType, charge, firstTimePickingUp, activeSlot, varData)
-    player:AddCollectible(
-        collectibleType,
-        charge,
-        firstTimePickingUp,
-        activeSlot,
-        varData
-    )
-    addCollectibleToInventory(nil, player, collectibleType)
-end
 return ____exports

package/functions/array.d.ts

@@ -16,7 +16,7 @@ export declare function arrayEquals<T>(array1: T[] | readonly T[], array2: T[] |
 export declare function arrayRemove<T>(originalArray: T[] | readonly T[], ...elementsToRemove: T[]): T[];
 /**
  * Removes the specified element(s) from the array. If the specified element(s) are not found in the
- * array, this function will do nothing. Returns whether or not one or more elements were removed.
+ * array, this function will do nothing. Returns true if one or more elements were removed.
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
@@ -31,8 +31,8 @@ export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: T
 export declare function arrayRemoveIndex<T>(originalArray: T[] | readonly T[], ...indexesToRemove: int[]): T[];
 /**
  * Removes the elements at the specified indexes from the array. If the specified indexes are not
- * found in the array, this function will do nothing. Returns whether or not one or more elements
- * were removed.
+ * found in the array, this function will do nothing. Returns true if one or more elements were
+ * removed.
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */

package/functions/array.lua

@@ -87,7 +87,7 @@ function ____exports.arrayRemove(self, originalArray, ...)
     return array
 end
 --- Removes the specified element(s) from the array. If the specified element(s) are not found in the
--- array, this function will do nothing. Returns whether or not one or more elements were removed.
+-- array, this function will do nothing. Returns true if one or more elements were removed.
 -- 
 -- This function is variadic, meaning that you can specify N arguments to remove N elements.
 function ____exports.arrayRemoveInPlace(self, array, ...)
@@ -122,8 +122,8 @@ function ____exports.arrayRemoveIndex(self, originalArray, ...)
     return array
 end
 --- Removes the elements at the specified indexes from the array. If the specified indexes are not
--- found in the array, this function will do nothing. Returns whether or not one or more elements
--- were removed.
+-- found in the array, this function will do nothing. Returns true if one or more elements were
+-- removed.
 -- 
 -- This function is variadic, meaning that you can specify N arguments to remove N elements.
 function ____exports.arrayRemoveIndexInPlace(self, array, ...)

package/functions/collectibleSet.d.ts

@@ -2,8 +2,8 @@ import { CollectibleType } from "isaac-typescript-definitions";
 /**
  * Returns a set containing every valid collectible type in the game, including modded collectibles.
  */
-export declare function getCollectibleSet(): Set<CollectibleType>;
+export declare function getCollectibleSet(): ReadonlySet<CollectibleType>;
 /** Returns a set containing every modded collectible type in the game. */
-export declare function getModdedCollectibleSet(): Set<CollectibleType>;
+export declare function getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
 /** Returns a set containing every valid vanilla collectible type in the game. */
-export declare function getVanillaCollectibleSet(): Set<CollectibleType>;
+export declare function getVanillaCollectibleSet(): ReadonlySet<CollectibleType>;

package/functions/collectibleSet.lua

@@ -8,8 +8,6 @@ local ____constantsFirstLast = require("constantsFirstLast")
 local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
 local ____collectibles = require("functions.collectibles")
 local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
-local ____set = require("functions.set")
-local copySet = ____set.copySet
 local ALL_COLLECTIBLES_SET = __TS__New(Set)
 local VANILLA_COLLECTIBLES_SET = __TS__New(Set)
 local MODDED_COLLECTIBLES_SET = __TS__New(Set)
@@ -35,20 +33,20 @@ function ____exports.getCollectibleSet(self)
     if ALL_COLLECTIBLES_SET.size == 0 then
         initCollectibleSets(nil)
     end
-    return copySet(nil, ALL_COLLECTIBLES_SET)
+    return ALL_COLLECTIBLES_SET
 end
 --- Returns a set containing every modded collectible type in the game.
 function ____exports.getModdedCollectibleSet(self)
     if ALL_COLLECTIBLES_SET.size == 0 then
         initCollectibleSets(nil)
     end
-    return copySet(nil, MODDED_COLLECTIBLES_SET)
+    return MODDED_COLLECTIBLES_SET
 end
 --- Returns a set containing every valid vanilla collectible type in the game.
 function ____exports.getVanillaCollectibleSet(self)
     if ALL_COLLECTIBLES_SET.size == 0 then
         initCollectibleSets(nil)
     end
-    return copySet(nil, VANILLA_COLLECTIBLES_SET)
+    return VANILLA_COLLECTIBLES_SET
 end
 return ____exports

package/functions/pills.d.ts

@@ -8,6 +8,11 @@ export declare function getAllPillColors(): PillColor[];
  * Helper function to get an array with every valid pill effect. This includes modded pill effects.
  */
 export declare function getAllPillEffects(): PillEffect[];
+/**
+ * Helper function to get the associated pill effect after False PHD is acquired. If a pill effect
+ * is not altered by False PHD, then the same pill effect will be returned.
+ */
+export declare function getFalsePHDPillEffect(pillEffect: PillEffect): PillEffect;
 /**
  * Helper function to get the corresponding horse pill color from a normal pill color.
  *
@@ -33,6 +38,11 @@ export declare function getModdedPillEffects(): PillEffect[];
 export declare function getNormalPillColorFromHorse(pillColor: PillColor): PillColor;
 /** Helper function to get an array with every non-gold and non-horse pill color. */
 export declare function getNormalPillColors(): PillColor[];
+/**
+ * Helper function to get the associated pill effect after PHD is acquired. If a pill effect is not
+ * altered by PHD, then the same pill effect will be returned.
+ */
+export declare function getPHDPillEffect(pillEffect: PillEffect): PillEffect;
 /**
  * Helper function to get a pill effect class from a PillEffect enum value. In this context, the
  * class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the

package/functions/pills.lua

@@ -14,6 +14,10 @@ local LAST_HORSE_PILL_COLOR = ____constantsFirstLast.LAST_HORSE_PILL_COLOR
 local LAST_NORMAL_PILL_COLOR = ____constantsFirstLast.LAST_NORMAL_PILL_COLOR
 local LAST_PILL_EFFECT = ____constantsFirstLast.LAST_PILL_EFFECT
 local LAST_VANILLA_PILL_EFFECT = ____constantsFirstLast.LAST_VANILLA_PILL_EFFECT
+local ____falsePHDPillConversions = require("maps.falsePHDPillConversions")
+local FALSE_PHD_PILL_CONVERSIONS = ____falsePHDPillConversions.FALSE_PHD_PILL_CONVERSIONS
+local ____PHDPillConversions = require("maps.PHDPillConversions")
+local PHD_PILL_CONVERSIONS = ____PHDPillConversions.PHD_PILL_CONVERSIONS
 local ____pillEffectClasses = require("objects.pillEffectClasses")
 local DEFAULT_PILL_EFFECT_CLASS = ____pillEffectClasses.DEFAULT_PILL_EFFECT_CLASS
 local PILL_EFFECT_CLASSES = ____pillEffectClasses.PILL_EFFECT_CLASSES
@@ -44,6 +48,12 @@ end
 function ____exports.getAllPillEffects(self)
     return irange(nil, FIRST_PILL_EFFECT, LAST_PILL_EFFECT)
 end
+--- Helper function to get the associated pill effect after False PHD is acquired. If a pill effect
+-- is not altered by False PHD, then the same pill effect will be returned.
+function ____exports.getFalsePHDPillEffect(self, pillEffect)
+    local convertedPillEffect = FALSE_PHD_PILL_CONVERSIONS:get(pillEffect)
+    return convertedPillEffect == nil and pillEffect or convertedPillEffect
+end
 --- Helper function to get the corresponding horse pill color from a normal pill color.
 -- 
 -- For example, passing `PillColor.BLUE_BLUE` would result in 2049, which is the value that
@@ -77,6 +87,12 @@ end
 function ____exports.getNormalPillColors(self)
     return irange(nil, FIRST_PILL_COLOR, LAST_NORMAL_PILL_COLOR)
 end
+--- Helper function to get the associated pill effect after PHD is acquired. If a pill effect is not
+-- altered by PHD, then the same pill effect will be returned.
+function ____exports.getPHDPillEffect(self, pillEffect)
+    local convertedPillEffect = PHD_PILL_CONVERSIONS:get(pillEffect)
+    return convertedPillEffect == nil and pillEffect or convertedPillEffect
+end
 --- Helper function to get a pill effect class from a PillEffect enum value. In this context, the
 -- class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
 -- `getPillEffectType` helper function to determine whether or not the pill effect is positive,

package/functions/roomData.d.ts

@@ -1,9 +1,4 @@
 import { DoorSlot, RoomShape, RoomType, StageID } from "isaac-typescript-definitions";
-/**
- * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
- * `RoomDescriptor` object that you are retrieving.
- */
-export declare function getCurrentRoomDescriptorReadOnly(): ReadonlyRoomDescriptor;
 /**
  * Helper function to get the set of allowed door slots for the room at the supplied grid index.
  * This corresponds to the doors that are enabled in the STB/XML file for the room.
@@ -21,6 +16,11 @@ export declare function getRoomData(roomGridIndex?: int): RoomConfig | undefined
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
+/**
+ * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
+ * `RoomDescriptor` object that you are retrieving.
+ */
+export declare function getRoomDescriptorReadOnly(): ReadonlyRoomDescriptor;
 /**
  * Helper function to get the grid index of the current room.
  *

package/functions/roomData.lua

@@ -12,12 +12,6 @@ local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
---- Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
--- `RoomDescriptor` object that you are retrieving.
-function ____exports.getCurrentRoomDescriptorReadOnly(self)
-    local level = game:GetLevel()
-    return level:GetCurrentRoomDesc()
-end
 --- Helper function to get the room data for the provided room.
 -- 
 -- @param roomGridIndex Optional. Default is the current room index.
@@ -35,6 +29,12 @@ function ____exports.getRoomDescriptor(self, roomGridIndex)
     end
     return level:GetRoomByIdx(roomGridIndex)
 end
+--- Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
+-- `RoomDescriptor` object that you are retrieving.
+function ____exports.getRoomDescriptorReadOnly(self)
+    local level = game:GetLevel()
+    return level:GetCurrentRoomDesc()
+end
 --- Helper function to get the grid index of the current room.
 -- 
 -- - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
@@ -55,7 +55,7 @@ function ____exports.getRoomGridIndex(self)
     if currentRoomIndex < 0 then
         return currentRoomIndex
     end
-    local roomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
+    local roomDescriptor = ____exports.getRoomDescriptorReadOnly(nil)
     return roomDescriptor.SafeGridIndex
 end
 --- Helper function to get the set of allowed door slots for the room at the supplied grid index.

package/functions/rooms.d.ts

@@ -13,11 +13,8 @@ export declare function getAllRoomGridIndexes(): int[];
 /**
  * Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,
  * but it can change if e.g. the player is in the mirror world of Downpour/Dross.
- *
- * Note that this function correctly handles detecting the Death Certificate dimension, which is
- * tricky to properly detect.
  */
-export declare function getCurrentDimension(): Dimension;
+export declare function getDimension(): Dimension;
 /**
  * Helper function to get the number of rooms that are currently on the floor layout. This does not
  * include off-grid rooms, like the Devil Room.

package/functions/rooms.lua

@@ -51,10 +51,10 @@ local getEntityVelocities = ____positionVelocity.getEntityVelocities
 local setEntityPositions = ____positionVelocity.setEntityPositions
 local setEntityVelocities = ____positionVelocity.setEntityVelocities
 local ____roomData = require("functions.roomData")
-local getCurrentRoomDescriptorReadOnly = ____roomData.getCurrentRoomDescriptorReadOnly
 local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
 local getRoomData = ____roomData.getRoomData
 local getRoomDescriptor = ____roomData.getRoomDescriptor
+local getRoomDescriptorReadOnly = ____roomData.getRoomDescriptorReadOnly
 local getRoomGridIndex = ____roomData.getRoomGridIndex
 local getRoomName = ____roomData.getRoomName
 local getRoomShape = ____roomData.getRoomShape
@@ -103,13 +103,6 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
     end
     return {__TS__Spread(roomsMap:values())}
 end
---- We cannot use the standard code in the `inDimension` function for this purpose since it is bugged
--- with the Death Certificate area.
-function ____exports.inDeathCertificateArea(self)
-    local roomStageID = getRoomStageID(nil)
-    local roomSubType = getRoomSubType(nil)
-    return roomStageID == StageID.HOME and (roomSubType == HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE or roomSubType == HomeRoomSubType.DEATH_CERTIFICATE_ITEMS)
-end
 --- Helper function to check if a room exists at the given room grid index.
 function ____exports.roomExists(self, roomGridIndex)
     local roomData = getRoomData(nil, roomGridIndex)
@@ -140,25 +133,19 @@ function ____exports.getAllRoomGridIndexes(self)
 end
 --- Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,
 -- but it can change if e.g. the player is in the mirror world of Downpour/Dross.
--- 
--- Note that this function correctly handles detecting the Death Certificate dimension, which is
--- tricky to properly detect.
-function ____exports.getCurrentDimension(self)
+function ____exports.getDimension(self)
     local level = game:GetLevel()
-    if ____exports.inDeathCertificateArea(nil) then
-        return Dimension.DEATH_CERTIFICATE
-    end
-    local startingRoomGridIndex = level:GetStartingRoomIndex()
-    local startingRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, Dimension.CURRENT)
-    local startingRoomHash = GetPtrHash(startingRoomDescription)
+    local roomGridIndex = getRoomGridIndex(nil)
+    local roomDescription = level:GetRoomByIdx(roomGridIndex, Dimension.CURRENT)
+    local currentRoomHash = GetPtrHash(roomDescription)
     for ____, dimension in ipairs(____exports.getAllDimensions(nil)) do
-        local dimensionRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, dimension)
+        local dimensionRoomDescription = level:GetRoomByIdx(roomGridIndex, dimension)
         local dimensionRoomHash = GetPtrHash(dimensionRoomDescription)
-        if dimensionRoomHash == startingRoomHash then
+        if dimensionRoomHash == currentRoomHash then
             return dimension
         end
     end
-    return error("Failed to get the current dimension using the starting room index of: " .. tostring(startingRoomGridIndex))
+    return error("Failed to get the current dimension.")
 end
 --- Helper function to get the number of rooms that are currently on the floor layout. This does not
 -- include off-grid rooms, like the Devil Room.
@@ -277,15 +264,22 @@ function ____exports.inCrawlspace(self)
     local roomSubType = getRoomSubType(nil)
     return roomType == RoomType.DUNGEON and roomSubType == DungeonSubType.NORMAL
 end
+--- We cannot use the standard code in the `inDimension` function for this purpose since it is bugged
+-- with the Death Certificate area.
+function ____exports.inDeathCertificateArea(self)
+    local roomStageID = getRoomStageID(nil)
+    local roomSubType = getRoomSubType(nil)
+    return roomStageID == StageID.HOME and (roomSubType == HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE or roomSubType == HomeRoomSubType.DEATH_CERTIFICATE_ITEMS)
+end
 --- Helper function to detect if the current room is a Treasure Room created when entering with a
 -- Devil's Crown trinket. Under the hood, this checks for the `RoomDescriptorFlag.DEVIL_TREASURE`
 -- flag.
 function ____exports.inDevilsCrownTreasureRoom(self)
-    local roomDescriptor = getCurrentRoomDescriptorReadOnly(nil)
+    local roomDescriptor = getRoomDescriptorReadOnly(nil)
     return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE)
 end
 function ____exports.inDimension(self, dimension)
-    return dimension == ____exports.getCurrentDimension(nil)
+    return dimension == ____exports.getDimension(nil)
 end
 function ____exports.inDoubleTrouble(self)
     local room = game:GetRoom()
@@ -438,12 +432,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue68
+                goto __continue67
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue68::
+        ::__continue67::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/functions/saveFile.lua

@@ -1,7 +1,6 @@
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
-local Set = ____lualib.Set
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")

package/index.d.ts

@@ -21,7 +21,7 @@ export { disableFastReset, enableFastReset } from "./features/fastReset";
 export { forgottenSwitch } from "./features/forgottenSwitch";
 export { getCollectibleItemPoolType } from "./features/getCollectibleItemPoolType";
 export { removePersistentEntity, spawnPersistentEntity, } from "./features/persistentEntities";
-export { addCollectible, getPlayerInventory } from "./features/playerInventory";
+export { getPlayerInventory } from "./features/playerInventory";
 export * from "./features/ponyDetection";
 export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
 export { runInNGameFrames, runInNRenderFrames, runNextGameFrame, runNextRenderFrame, } from "./features/runInNFrames";

package/index.lua

@@ -176,9 +176,7 @@ do
 end
 do
     local ____playerInventory = require("features.playerInventory")
-    local addCollectible = ____playerInventory.addCollectible
     local getPlayerInventory = ____playerInventory.getPlayerInventory
-    ____exports.addCollectible = addCollectible
     ____exports.getPlayerInventory = getPlayerInventory
 end
 do

package/initCustomCallbacks.lua

@@ -65,6 +65,8 @@ local ____postPlayerChangeHealth = require("callbacks.postPlayerChangeHealth")
 local postPlayerChangeHealthCallbackInit = ____postPlayerChangeHealth.postPlayerChangeHealthCallbackInit
 local ____postPlayerChangeType = require("callbacks.postPlayerChangeType")
 local postPlayerChangeTypeCallbackInit = ____postPlayerChangeType.postPlayerChangeTypeCallbackInit
+local ____postPlayerCollectible = require("callbacks.postPlayerCollectible")
+local postPlayerCollectibleCallbackInit = ____postPlayerCollectible.postPlayerCollectibleCallbackInit
 local ____postPlayerFatalDamage = require("callbacks.postPlayerFatalDamage")
 local postPlayerFatalDamageCallbackInit = ____postPlayerFatalDamage.postPlayerFatalDamageCallbackInit
 local ____postPlayerInitLate = require("callbacks.postPlayerInitLate")
@@ -153,6 +155,7 @@ function ____exports.initCustomCallbacks(self, mod)
     postPitUpdateInit(nil, mod)
     postPlayerChangeHealthCallbackInit(nil, mod)
     postPlayerChangeTypeCallbackInit(nil, mod)
+    postPlayerCollectibleCallbackInit(nil, mod)
     postPlayerFatalDamageCallbackInit(nil, mod)
     postPlayerInitLateCallbackInit(nil, mod)
     postPlayerReorderedCallbacksInit(nil, mod)