isaacscript-common 6.14.0 → 6.15.0

package/dist/functions/saveFile.lua

@@ -1,108 +1,22 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
-local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
-local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____collectibleSet = require("functions.collectibleSet")
-local getCollectibleSet = ____collectibleSet.getCollectibleSet
-local ____playerDataStructures = require("functions.playerDataStructures")
-local mapGetPlayer = ____playerDataStructures.mapGetPlayer
-local mapSetPlayer = ____playerDataStructures.mapSetPlayer
-local ____playerIndex = require("functions.playerIndex")
-local getPlayers = ____playerIndex.getPlayers
 local ____players = require("functions.players")
 local anyPlayerHasCollectible = ____players.anyPlayerHasCollectible
-local getPlayersOfType = ____players.getPlayersOfType
-local ____utils = require("functions.utils")
-local ____repeat = ____utils["repeat"]
-local COLLECTIBLES_THAT_AFFECT_ITEM_POOLS = {CollectibleType.CHAOS, CollectibleType.SACRED_ORB, CollectibleType.TMTRAINER}
-local TRINKETS_THAT_AFFECT_ITEM_POOLS = {TrinketType.NO}
---- Helper function to see if the given collectible is unlocked on the player's save file. This
+--- Helper function to see if the given collectible is unlocked on the current save file. This
 -- requires providing the corresponding item pool that the collectible is located in.
 -- 
--- - If any player currently has the item, then it is assumed to be unlocked. (This is because Eden
---   may have randomly started with the provided collectible, and it will be subsequently removed
---   from all pools.)
+-- - If any player currently has the collectible, then it is assumed to be unlocked. (This is
+--   because in almost all cases, when a collectible is added to a player's inventory, it is
+--   subsequently removed from all pools.)
 -- - If the collectible is located in more than one item pool, then any item pool can be provided.
 -- - If the collectible is not located in any item pools, then this function will always return
 --   false.
--- - If any player is Tainted Lost, they will be temporarily changed to Isaac and then temporarily
---   changed back (because Tainted Lost is not able to retrieve some collectibles from item pools).
-function ____exports.isCollectibleUnlocked(self, collectibleTypeToCheckFor, itemPoolToCheckFor)
-    if anyPlayerHasCollectible(nil, collectibleTypeToCheckFor) then
+-- - If the collectible is non-offensive, any Tainted Losts will be temporarily changed to Isaac and
+--   then changed back. (This is because Tainted Lost is not able to retrieve non-offensive
+--   collectibles from item pools).
+function ____exports.isCollectibleUnlocked(self, collectibleType, itemPoolType)
+    if anyPlayerHasCollectible(nil, collectibleType) then
         return true
     end
-    local taintedLosts = getPlayersOfType(nil, PlayerType.THE_LOST_B)
-    for ____, player in ipairs(taintedLosts) do
-        player:ChangePlayerType(PlayerType.ISAAC)
-    end
-    local removedItemsMap = __TS__New(Map)
-    local removedTrinketsMap = __TS__New(Map)
-    for ____, player in ipairs(getPlayers(nil)) do
-        local removedItems = {}
-        for ____, itemToRemove in ipairs(COLLECTIBLES_THAT_AFFECT_ITEM_POOLS) do
-            if player:HasCollectible(itemToRemove) then
-                local numCollectibles = player:GetCollectibleNum(itemToRemove)
-                ____repeat(
-                    nil,
-                    numCollectibles,
-                    function()
-                        player:RemoveCollectible(itemToRemove)
-                        removedItems[#removedItems + 1] = itemToRemove
-                    end
-                )
-            end
-        end
-        mapSetPlayer(nil, removedItemsMap, player, removedItems)
-        local removedTrinkets = {}
-        for ____, trinketToRemove in ipairs(TRINKETS_THAT_AFFECT_ITEM_POOLS) do
-            if player:HasTrinket(trinketToRemove) then
-                local numTrinkets = player:GetTrinketMultiplier(trinketToRemove)
-                ____repeat(
-                    nil,
-                    numTrinkets,
-                    function()
-                        player:TryRemoveTrinket(trinketToRemove)
-                        removedTrinkets[#removedTrinkets + 1] = trinketToRemove
-                    end
-                )
-            end
-        end
-        mapSetPlayer(nil, removedTrinketsMap, player, removedTrinkets)
-    end
-    local itemPool = game:GetItemPool()
-    local collectibleSet = getCollectibleSet(nil)
-    for ____, collectibleType in __TS__Iterator(collectibleSet:values()) do
-        if collectibleType ~= collectibleTypeToCheckFor then
-            itemPool:AddRoomBlacklist(collectibleType)
-        end
-    end
-    local retrievedCollectibleType = itemPool:GetCollectible(itemPoolToCheckFor, false, 1)
-    local collectibleUnlocked = retrievedCollectibleType == collectibleTypeToCheckFor
-    itemPool:ResetRoomBlacklist()
-    for ____, player in ipairs(getPlayers(nil)) do
-        local removedItems = mapGetPlayer(nil, removedItemsMap, player)
-        if removedItems ~= nil then
-            for ____, collectibleType in ipairs(removedItems) do
-                player:AddCollectible(collectibleType, 0, false)
-            end
-        end
-        local removedTrinkets = mapGetPlayer(nil, removedTrinketsMap, player)
-        if removedTrinkets ~= nil then
-            for ____, trinketType in ipairs(removedTrinkets) do
-                player:AddTrinket(trinketType, false)
-            end
-        end
-    end
-    for ____, player in ipairs(taintedLosts) do
-        player:ChangePlayerType(PlayerType.THE_LOST_B)
-    end
-    return collectibleUnlocked
+    return ____exports.isCollectibleUnlocked(nil, collectibleType, itemPoolType)
 end
 return ____exports

package/dist/functions/trinketGive.d.ts

@@ -17,6 +17,19 @@ export declare function giveTrinketsBack(player: EntityPlayer, trinketSituation:
  *                    avoid calling this function multiple times. Default is 1.
  */
 export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketType, numTrinkets?: number): void;
+/**
+ * Helper function to smelt two or more different trinkets. If you want to smelt one trinket (or
+ * multiple copies of one trinket), then use the `smeltTrinket` helper function instead.
+ *
+ * This function is variadic, meaning that you can pass as many trinket types as you want to smelt.
+ *
+ * Before smelting, this function will automatically remove the trinkets that the player is holding,
+ * if any, and then give them back after the new trinket is smelted.
+ *
+ * @param player The player to smelt the trinkets to.
+ * @param trinketTypes The trinket types to smelt.
+ */
+export declare function smeltTrinkets(player: EntityPlayer, ...trinketTypes: TrinketType[]): void;
 /**
  * Helper function to temporarily remove a specific kind of trinket from the player. Use this in
  * combination with the `giveTrinketsBack` function to take away and give back a trinket on the same

package/dist/functions/trinketGive.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trinketGive.d.ts","sourceRoot":"","sources":["../../src/functions/trinketGive.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAKlE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,YAAY,EACpB,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,GAC7C,IAAI,CA+BN;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,EACxB,WAAW,SAAI,GACd,IAAI,CASN;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,gBAAgB,GAAG,SAAS,CAkC9B;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,GACnB,gBAAgB,GAAG,SAAS,CAsB9B"}
+{"version":3,"file":"trinketGive.d.ts","sourceRoot":"","sources":["../../src/functions/trinketGive.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAKlE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,YAAY,EACpB,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,GAC7C,IAAI,CA+BN;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,EACxB,WAAW,SAAI,GACd,IAAI,CASN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,YAAY,EACpB,GAAG,YAAY,EAAE,WAAW,EAAE,GAC7B,IAAI,CAIN;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,gBAAgB,GAAG,SAAS,CAkC9B;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,GACnB,gBAAgB,GAAG,SAAS,CAsB9B"}

package/dist/functions/trinketGive.lua

@@ -81,6 +81,22 @@ function ____exports.smeltTrinket(self, player, trinketType, numTrinkets)
     )
     ____exports.giveTrinketsBack(nil, player, trinketSituation)
 end
+--- Helper function to smelt two or more different trinkets. If you want to smelt one trinket (or
+-- multiple copies of one trinket), then use the `smeltTrinket` helper function instead.
+-- 
+-- This function is variadic, meaning that you can pass as many trinket types as you want to smelt.
+-- 
+-- Before smelting, this function will automatically remove the trinkets that the player is holding,
+-- if any, and then give them back after the new trinket is smelted.
+-- 
+-- @param player The player to smelt the trinkets to.
+-- @param trinketTypes The trinket types to smelt.
+function ____exports.smeltTrinkets(self, player, ...)
+    local trinketTypes = {...}
+    for ____, trinketType in ipairs(trinketTypes) do
+        ____exports.smeltTrinket(nil, player, trinketType)
+    end
+end
 --- Helper function to temporarily remove a specific kind of trinket from the player. Use this in
 -- combination with the `giveTrinketsBack` function to take away and give back a trinket on the same
 -- frame. This function correctly handles multiple trinket slots and ensures that all copies of the

package/dist/index.d.ts

@@ -74,6 +74,7 @@ export * from "./functions/gridEntities";
 export * from "./functions/gridEntitiesSpecific";
 export * from "./functions/input";
 export * from "./functions/isaacAPIClass";
+export * from "./functions/itemPool";
 export * from "./functions/jsonHelpers";
 export * from "./functions/jsonRoom";
 export * from "./functions/kColor";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,OAAO,EACL,cAAc,EACd,eAAe,GAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,0BAA0B,GAC3B,MAAM,gCAAgC,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EACL,gBAAgB,EAChB,qBAAqB,IAAI,eAAe,GACzC,MAAM,6BAA6B,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAClC,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,+BAA+B,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,2BAA2B,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,OAAO,EACL,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,OAAO,EACL,cAAc,EACd,eAAe,GAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,0BAA0B,GAC3B,MAAM,gCAAgC,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EACL,gBAAgB,EAChB,qBAAqB,IAAI,eAAe,GACzC,MAAM,6BAA6B,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAClC,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,+BAA+B,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,2BAA2B,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,OAAO,EACL,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC"}

package/dist/index.lua

@@ -590,6 +590,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.itemPool")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.jsonHelpers")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.14.0",
+  "version": "6.15.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/collectibles.ts

@@ -323,6 +323,10 @@ export function getCollectibleName(collectibleType: CollectibleType): string {
   return DEFAULT_COLLECTIBLE_NAME;
 }
 
+/**
+ * Helper function to get the "pedestal type" of a collectible. For example, it might be sitting on
+ * top of a broken Blood Donation Machine, or it might be sitting on top of an opened Spiked Chest.
+ */
 export function getCollectiblePedestalType(
   collectible: EntityPickup,
 ): CollectiblePedestalType {
@@ -338,8 +342,8 @@ export function getCollectiblePedestalType(
 }
 
 /**
- * Helper function to get the path to a collectible's quality. Returns 0 if the provided collectible
- * type was not valid.
+ * Helper function to get a collectible's quality. For example, Mom's Knife has a quality of 4.
+ * Returns 0 if the provided collectible type was not valid.
  */
 export function getCollectibleQuality(collectibleType: CollectibleType): int {
   const itemConfigItem = itemConfig.GetCollectible(collectibleType);

package/src/functions/itemPool.ts

@@ -0,0 +1,153 @@
+import {
+  CollectibleType,
+  ItemConfigTag,
+  ItemPoolType,
+  PlayerType,
+  TrinketType,
+} from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { PlayerIndex } from "../types/PlayerIndex";
+import { getCollectibleSet } from "./collectibleSet";
+import { collectibleHasTag } from "./collectibleTag";
+import { mapGetPlayer, mapSetPlayer } from "./playerDataStructures";
+import { getPlayers } from "./playerIndex";
+import { getPlayersOfType } from "./players";
+import { repeat } from "./utils";
+
+const COLLECTIBLES_THAT_AFFECT_ITEM_POOLS: readonly CollectibleType[] = [
+  CollectibleType.CHAOS, // 402
+  CollectibleType.SACRED_ORB, // 691
+  CollectibleType.TMTRAINER, // 721
+];
+
+const TRINKETS_THAT_AFFECT_ITEM_POOLS: readonly TrinketType[] = [
+  TrinketType.NO,
+];
+
+/**
+ * Helper function to see if the given collectible is still present in the given item pool.
+ *
+ * If the collectible is non-offensive, any Tainted Losts will be temporarily changed to Isaac and
+ * then changed back. (This is because Tainted Lost is not able to retrieve non-offensive
+ * collectibles from item pools).
+ */
+export function isCollectibleInItemPool(
+  collectibleType: CollectibleType,
+  itemPoolType: ItemPoolType,
+): boolean {
+  // On Tainted Lost, it is impossible to retrieve non-offensive collectibles from pools, so we
+  // temporarily change the character to Isaac.
+  const taintedLosts = getPlayersOfType(PlayerType.THE_LOST_B);
+  const isOffensive = collectibleHasTag(
+    collectibleType,
+    ItemConfigTag.OFFENSIVE,
+  );
+  let changedPlayerTypes = false;
+  if (!isOffensive) {
+    changedPlayerTypes = true;
+    for (const player of taintedLosts) {
+      player.ChangePlayerType(PlayerType.ISAAC);
+    }
+  }
+
+  const [removedItemsMap, removedTrinketsMap] =
+    removeItemsAndTrinketsThatAffectItemPools();
+
+  // Blacklist every collectible in the game except for the provided collectible.
+  const itemPool = game.GetItemPool();
+  const collectibleSet = getCollectibleSet();
+  for (const collectibleTypeInSet of collectibleSet.values()) {
+    if (collectibleTypeInSet !== collectibleType) {
+      itemPool.AddRoomBlacklist(collectibleTypeInSet);
+    }
+  }
+
+  // Get a collectible from the pool and see if it is the intended collectible. (We can use any
+  // arbitrary value as the seed since it should not influence the result.)
+  const retrievedCollectibleType = itemPool.GetCollectible(
+    itemPoolType,
+    false,
+    1 as Seed,
+  );
+
+  const collectibleUnlocked = retrievedCollectibleType === collectibleType;
+
+  // Reset the blacklist
+  itemPool.ResetRoomBlacklist();
+
+  restoreItemsAndTrinketsThatAffectItemPools(
+    removedItemsMap,
+    removedTrinketsMap,
+  );
+
+  // Change any players back to Tainted Lost, if necessary.
+  if (changedPlayerTypes) {
+    for (const player of taintedLosts) {
+      player.ChangePlayerType(PlayerType.THE_LOST_B);
+    }
+  }
+
+  return collectibleUnlocked;
+}
+
+/**
+ * Before checking the item pools, remove any collectibles or trinkets that would affect the
+ * retrieved collectible types.
+ */
+function removeItemsAndTrinketsThatAffectItemPools(): [
+  removedItemsMap: Map<PlayerIndex, CollectibleType[]>,
+  removedTrinketsMap: Map<PlayerIndex, TrinketType[]>,
+] {
+  const removedItemsMap = new Map<PlayerIndex, CollectibleType[]>();
+  const removedTrinketsMap = new Map<PlayerIndex, TrinketType[]>();
+  for (const player of getPlayers()) {
+    const removedItems: CollectibleType[] = [];
+    for (const itemToRemove of COLLECTIBLES_THAT_AFFECT_ITEM_POOLS) {
+      if (player.HasCollectible(itemToRemove)) {
+        const numCollectibles = player.GetCollectibleNum(itemToRemove);
+        repeat(numCollectibles, () => {
+          player.RemoveCollectible(itemToRemove);
+          removedItems.push(itemToRemove);
+        });
+      }
+    }
+
+    mapSetPlayer(removedItemsMap, player, removedItems);
+
+    const removedTrinkets: TrinketType[] = [];
+    for (const trinketToRemove of TRINKETS_THAT_AFFECT_ITEM_POOLS) {
+      if (player.HasTrinket(trinketToRemove)) {
+        const numTrinkets = player.GetTrinketMultiplier(trinketToRemove);
+        repeat(numTrinkets, () => {
+          player.TryRemoveTrinket(trinketToRemove);
+          removedTrinkets.push(trinketToRemove);
+        });
+      }
+    }
+
+    mapSetPlayer(removedTrinketsMap, player, removedTrinkets);
+  }
+
+  return [removedItemsMap, removedTrinketsMap];
+}
+
+function restoreItemsAndTrinketsThatAffectItemPools(
+  removedItemsMap: Map<PlayerIndex, CollectibleType[]>,
+  removedTrinketsMap: Map<PlayerIndex, TrinketType[]>,
+) {
+  for (const player of getPlayers()) {
+    const removedItems = mapGetPlayer(removedItemsMap, player);
+    if (removedItems !== undefined) {
+      for (const collectibleType of removedItems) {
+        player.AddCollectible(collectibleType, 0, false); // Prevent Chaos from spawning pickups
+      }
+    }
+
+    const removedTrinkets = mapGetPlayer(removedTrinketsMap, player);
+    if (removedTrinkets !== undefined) {
+      for (const trinketType of removedTrinkets) {
+        player.AddTrinket(trinketType, false);
+      }
+    }
+  }
+}