isaacscript-common 44.0.0 → 45.0.0

package/dist/src/functions/playerCollectibles.lua

@@ -0,0 +1,308 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____cachedEnumValues = require("src.arrays.cachedEnumValues")
+local ACTIVE_SLOT_VALUES = ____cachedEnumValues.ACTIVE_SLOT_VALUES
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local itemConfig = ____cachedClasses.itemConfig
+local ____ReadonlySet = require("src.types.ReadonlySet")
+local ReadonlySet = ____ReadonlySet.ReadonlySet
+local ____array = require("src.functions.array")
+local sumArray = ____array.sumArray
+local ____collectibles = require("src.functions.collectibles")
+local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
+local ____playerIndex = require("src.functions.playerIndex")
+local getAllPlayers = ____playerIndex.getAllPlayers
+local getPlayers = ____playerIndex.getPlayers
+local ____players = require("src.functions.players")
+local isCharacter = ____players.isCharacter
+--- Helper function to add one or more collectibles to a player.
+-- 
+-- This function is variadic, meaning that you can supply as many collectible types as you want to
+-- add.
+function ____exports.addCollectible(self, player, ...)
+    local collectibleTypes = {...}
+    for ____, collectibleType in ipairs(collectibleTypes) do
+        player:AddCollectible(collectibleType)
+    end
+end
+function ____exports.addCollectibleCostume(self, player, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return
+    end
+    player:AddCostume(itemConfigItem, false)
+end
+--- Helper function to check to see if any player has a particular collectible.
+-- 
+-- @param collectibleType The collectible type to check for.
+-- @param ignoreModifiers If set to true, only counts collectibles the player actually owns and
+-- ignores effects granted by items like Zodiac, 3 Dollar Bill and Lemegeton.
+-- Default is false.
+function ____exports.anyPlayerHasCollectible(self, collectibleType, ignoreModifiers)
+    local players = getAllPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player) return player:HasCollectible(collectibleType, ignoreModifiers) end
+    )
+end
+--- Helper function to find the active slots that the player has the corresponding collectible type
+-- in. Returns an empty array if the player does not have the collectible in any active slot.
+function ____exports.getActiveItemSlots(self, player, collectibleType)
+    return __TS__ArrayFilter(
+        ACTIVE_SLOT_VALUES,
+        function(____, activeSlot)
+            local activeItem = player:GetActiveItem(activeSlot)
+            return activeItem == collectibleType
+        end
+    )
+end
+--- Helper function to return the total amount of collectibles that a player has that match the
+-- collectible type(s) provided.
+-- 
+-- This function is variadic, meaning that you can specify N collectible types.
+-- 
+-- Note that this will filter out non-real collectibles like Lilith's Incubus.
+function ____exports.getPlayerCollectibleCount(self, player, ...)
+    local collectibleTypes = {...}
+    local numCollectibles = 0
+    for ____, collectibleType in ipairs(collectibleTypes) do
+        numCollectibles = numCollectibles + player:GetCollectibleNum(collectibleType, true)
+    end
+    return numCollectibles
+end
+--- Helper function to get only the players that have a certain collectible.
+-- 
+-- This function is variadic, meaning that you can supply as many collectible types as you want to
+-- check for. It only returns the players that have all of the collectibles.
+function ____exports.getPlayersWithCollectible(self, ...)
+    local collectibleTypes = {...}
+    local players = getPlayers(nil)
+    return __TS__ArrayFilter(
+        players,
+        function(____, player) return __TS__ArrayEvery(
+            collectibleTypes,
+            function(____, collectibleType) return player:HasCollectible(collectibleType) end
+        ) end
+    )
+end
+--- Returns the total number of collectibles amongst all players. For example, if player 1 has 1 Sad
+-- Onion and player 2 has 2 Sad Onions, then this function would return 3.
+-- 
+-- Note that this will filter out non-real collectibles like Lilith's Incubus.
+function ____exports.getTotalPlayerCollectibles(self, collectibleType)
+    local players = getPlayers(nil)
+    local numCollectiblesArray = __TS__ArrayMap(
+        players,
+        function(____, player) return player:GetCollectibleNum(collectibleType, true) end
+    )
+    return sumArray(nil, numCollectiblesArray)
+end
+--- Helper function to check to see if a player has one or more collectibles.
+-- 
+-- This function is variadic, meaning that you can supply as many collectible types as you want to
+-- check for. Returns true if the player has any of the supplied collectible types.
+-- 
+-- This function always passes `false` to the `ignoreModifiers` argument.
+function ____exports.hasCollectible(self, player, ...)
+    local collectibleTypes = {...}
+    return __TS__ArraySome(
+        collectibleTypes,
+        function(____, collectibleType) return player:HasCollectible(collectibleType) end
+    )
+end
+--- Helper function to check to see if a player has a specific collectible in one or more active
+-- slots.
+-- 
+-- This function is variadic, meaning that you can specify as many active slots as you want to check
+-- for. This function will return true if the collectible type is located in any of the active slots
+-- provided.
+function ____exports.hasCollectibleInActiveSlot(self, player, collectibleType, ...)
+    local activeSlots = {...}
+    local matchingActiveSlotsSet = __TS__New(ReadonlySet, activeSlots)
+    local activeItemSlots = ____exports.getActiveItemSlots(nil, player, collectibleType)
+    return __TS__ArraySome(
+        activeItemSlots,
+        function(____, activeSlot) return matchingActiveSlotsSet:has(activeSlot) end
+    )
+end
+--- Returns whether the player can hold an additional active item, beyond what they are currently
+-- carrying. This takes the Schoolbag into account.
+-- 
+-- If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+-- items. (Only Tainted Forgotten can pick up items.)
+function ____exports.hasOpenActiveItemSlot(self, player)
+    if isCharacter(nil, player, PlayerType.SOUL_B) then
+        return false
+    end
+    local activeItemPrimary = player:GetActiveItem(ActiveSlot.PRIMARY)
+    local activeItemSecondary = player:GetActiveItem(ActiveSlot.SECONDARY)
+    local hasSchoolbag = player:HasCollectible(CollectibleType.SCHOOLBAG)
+    if hasSchoolbag then
+        return activeItemPrimary == CollectibleType.NULL or activeItemSecondary == CollectibleType.NULL
+    end
+    return activeItemPrimary == CollectibleType.NULL
+end
+--- Helper function to check if the active slot of a particular player is empty.
+-- 
+-- @param player The player to check.
+-- @param activeSlot Optional. The active slot to check. Default is `ActiveSlot.PRIMARY`.
+function ____exports.isActiveSlotEmpty(self, player, activeSlot)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
+    local activeCollectibleType = player:GetActiveItem(activeSlot)
+    return activeCollectibleType == CollectibleType.NULL
+end
+--- Helper function to remove all of the active items from a player. This includes the Schoolbag item
+-- and any pocket actives.
+function ____exports.removeAllActiveItems(self, player)
+    for ____, activeSlot in ipairs(ACTIVE_SLOT_VALUES) do
+        do
+            local collectibleType = player:GetActiveItem(activeSlot)
+            if collectibleType == CollectibleType.NULL then
+                goto __continue28
+            end
+            local stillHasCollectible
+            repeat
+                do
+                    player:RemoveCollectible(collectibleType)
+                    stillHasCollectible = player:HasCollectible(collectibleType)
+                end
+            until not stillHasCollectible
+        end
+        ::__continue28::
+    end
+end
+--- Helper function to remove one or more collectibles to a player.
+-- 
+-- This function is variadic, meaning that you can supply as many collectible types as you want to
+-- remove.
+function ____exports.removeCollectible(self, player, ...)
+    local collectibleTypes = {...}
+    for ____, collectibleType in ipairs(collectibleTypes) do
+        player:RemoveCollectible(collectibleType)
+    end
+end
+--- Helper function to remove a collectible costume from a player. Use this helper function to avoid
+-- having to request the collectible from the item config.
+function ____exports.removeCollectibleCostume(self, player, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return
+    end
+    player:RemoveCostume(itemConfigItem)
+end
+--- Helper function to remove one or more collectibles from all players. If any player has more than
+-- one copy of the item, then all copies of it will be removed.
+-- 
+-- This function is variadic, meaning that you can specify as many collectibles as you want to
+-- remove.
+function ____exports.removeCollectibleFromAllPlayers(self, ...)
+    local collectibleTypes = {...}
+    for ____, player in ipairs(getAllPlayers(nil)) do
+        for ____, collectibleType in ipairs(collectibleTypes) do
+            while player:HasCollectible(collectibleType, true) do
+                player:RemoveCollectible(collectibleType)
+            end
+        end
+    end
+end
+--- Helper function to set an active collectible to a particular slot. This has different behavior
+-- than calling the `player.AddCollectible` method with the `activeSlot` argument, because this
+-- function will not shift existing items into the Schoolbag and it handles
+-- `ActiveSlot.SLOT_POCKET2`.
+-- 
+-- Note that if an item is set to `ActiveSlot.SLOT_POCKET2`, it will disappear after being used and
+-- will be automatically removed upon entering a new room.
+-- 
+-- @param player The player to give the item to.
+-- @param collectibleType The collectible type of the item to give.
+-- @param activeSlot Optional. The slot to set. Default is `ActiveSlot.PRIMARY`.
+-- @param charge Optional. The argument of charges to set. If not specified, the item will be set
+-- with maximum charges.
+-- @param keepInPools Optional. Whether to remove the item from pools. Default is false.
+function ____exports.setActiveItem(self, player, collectibleType, activeSlot, charge, keepInPools)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
+    if keepInPools == nil then
+        keepInPools = false
+    end
+    local itemPool = game:GetItemPool()
+    local primaryCollectibleType = player:GetActiveItem(ActiveSlot.PRIMARY)
+    local primaryCharge = player:GetActiveCharge(ActiveSlot.PRIMARY)
+    local secondaryCollectibleType = player:GetActiveItem(ActiveSlot.SECONDARY)
+    if charge == nil then
+        charge = getCollectibleMaxCharges(nil, collectibleType)
+    end
+    if not keepInPools then
+        itemPool:RemoveCollectible(collectibleType)
+    end
+    repeat
+        local ____switch46 = activeSlot
+        local ____cond46 = ____switch46 == ActiveSlot.PRIMARY
+        if ____cond46 then
+            do
+                if primaryCollectibleType ~= CollectibleType.NULL then
+                    player:RemoveCollectible(primaryCollectibleType)
+                end
+                player:AddCollectible(collectibleType, charge, false)
+                break
+            end
+        end
+        ____cond46 = ____cond46 or ____switch46 == ActiveSlot.SECONDARY
+        if ____cond46 then
+            do
+                if primaryCollectibleType ~= CollectibleType.NULL then
+                    player:RemoveCollectible(primaryCollectibleType)
+                end
+                if secondaryCollectibleType ~= CollectibleType.NULL then
+                    player:RemoveCollectible(secondaryCollectibleType)
+                end
+                player:AddCollectible(secondaryCollectibleType, charge, false)
+                if primaryCollectibleType ~= CollectibleType.NULL then
+                    player:AddCollectible(primaryCollectibleType, primaryCharge, false)
+                end
+                break
+            end
+        end
+        ____cond46 = ____cond46 or ____switch46 == ActiveSlot.POCKET
+        if ____cond46 then
+            do
+                player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
+                player:SetActiveCharge(charge, activeSlot)
+                break
+            end
+        end
+        ____cond46 = ____cond46 or ____switch46 == ActiveSlot.POCKET_SINGLE_USE
+        if ____cond46 then
+            do
+                player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
+                break
+            end
+        end
+    until true
+end
+--- Helper function to use an active item without showing an animation, keeping the item, or adding
+-- any costumes.
+function ____exports.useActiveItemTemp(self, player, collectibleType)
+    player:UseActiveItem(
+        collectibleType,
+        false,
+        false,
+        true,
+        false,
+        -1
+    )
+end
+return ____exports

package/dist/src/functions/playerHealth.d.ts

@@ -59,7 +59,7 @@ export declare function getPlayerBlackHearts(player: EntityPlayer): int;
  *
  * This is based on the `REVEL.StoreHealth` function in the Revelations mod.
  */
-export declare function getPlayerHealth(player: EntityPlayer): PlayerHealth;
+export declare function getPlayerHealth(player: EntityPlayer): Readonly<PlayerHealth>;
 export declare function getPlayerHealthType(player: EntityPlayer, healthType: HealthType): int;
 /**
  * Returns the number of red hearts that the player has, excluding any rotten hearts. For example,

package/dist/src/functions/playerHealth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playerHealth.d.ts","sourceRoot":"","sources":["../../../src/functions/playerHealth.ts"],"names":[],"mappings":";;AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAiB,MAAM,4BAA4B,CAAC;AAY9E,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,GAAG,GACb,IAAI,CA+CN;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMlE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAK1E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAKzE;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAYtE;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAK9D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CA2ElE;AAED,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAmDL;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAKzD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,UAAU,CAoDnE;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAqCrE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAK7D;AAED;;;;;;;;;GASG;AACH,wBAAgB,wCAAwC,CACtD,MAAM,EAAE,YAAY,GACnB,GAAG,CAML;AAED,sDAAsD;AACtD,wBAAgB,eAAe,IAAI,YAAY,CAc9C;AAED;;;GAGG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,YAAY,GACnB,IAAI,CAQN;AAED;;;GAGG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,YAAY,GACnB,IAAI,CAQN;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMjE;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAwBhE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,YAAY,EACpB,YAAY,EAAE,YAAY,GACzB,IAAI,CAyHN;AAED;;;;;;;;;GASG;AACH,wBAAgB,sDAAsD,CACpE,MAAM,EAAE,YAAY,EACpB,YAAY,EAAE,KAAK,GAClB,OAAO,CAyBT"}
+{"version":3,"file":"playerHealth.d.ts","sourceRoot":"","sources":["../../../src/functions/playerHealth.ts"],"names":[],"mappings":";;AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAiB,MAAM,4BAA4B,CAAC;AAQ9E,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,GAAG,GACb,IAAI,CA+CN;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMlE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAK1E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAKzE;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAYtE;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAK9D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC,CA2E5E;AAED,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAmDL;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAKzD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,UAAU,CAoDnE;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAqCrE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAK7D;AAED;;;;;;;;;GASG;AACH,wBAAgB,wCAAwC,CACtD,MAAM,EAAE,YAAY,GACnB,GAAG,CAML;AAED,sDAAsD;AACtD,wBAAgB,eAAe,IAAI,YAAY,CAc9C;AAED;;;GAGG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,YAAY,GACnB,IAAI,CAcN;AAED;;;GAGG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,YAAY,GACnB,IAAI,CAcN;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMjE;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAwBhE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,YAAY,EACpB,YAAY,EAAE,YAAY,GACzB,IAAI,CAyHN;AAED;;;;;;;;;GASG;AACH,wBAAgB,sDAAsD,CACpE,MAAM,EAAE,YAAY,EACpB,YAAY,EAAE,KAAK,GAClB,OAAO,CAyBT"}

package/dist/src/functions/playerHealth.lua

@@ -1,5 +1,6 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ObjectAssign = ____lualib.__TS__ObjectAssign
 local __TS__ArrayEntries = ____lualib.__TS__ArrayEntries
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
@@ -20,11 +21,12 @@ local ____characters = require("src.functions.characters")
 local getCharacterMaxHeartContainers = ____characters.getCharacterMaxHeartContainers
 local ____charge = require("src.functions.charge")
 local getTotalCharge = ____charge.getTotalCharge
+local ____playerCollectibles = require("src.functions.playerCollectibles")
+local getActiveItemSlots = ____playerCollectibles.getActiveItemSlots
+local setActiveItem = ____playerCollectibles.setActiveItem
 local ____players = require("src.functions.players")
-local getActiveItemSlots = ____players.getActiveItemSlots
 local isCharacter = ____players.isCharacter
 local isKeeper = ____players.isKeeper
-local setActiveItem = ____players.setActiveItem
 local ____utils = require("src.functions.utils")
 local ____repeat = ____utils["repeat"]
 --- Returns the number of black hearts that the player has, excluding any soul hearts. For example,
@@ -525,22 +527,24 @@ end
 function ____exports.playerConvertBlackHeartsToSoulHearts(self, player)
     local playerHealth = ____exports.getPlayerHealth(nil, player)
     ____exports.removeAllPlayerHealth(nil, player)
-    playerHealth.soulHeartTypes = __TS__ArrayMap(
+    local newSoulHeartTypes = __TS__ArrayMap(
         playerHealth.soulHeartTypes,
         function(____, soulHeartType) return soulHeartType == HeartSubType.BLACK and HeartSubType.SOUL or soulHeartType end
     )
-    ____exports.setPlayerHealth(nil, player, playerHealth)
+    local playerHealthWithSoulHearts = __TS__ObjectAssign({}, playerHealth, {soulHeartTypes = newSoulHeartTypes})
+    ____exports.setPlayerHealth(nil, player, playerHealthWithSoulHearts)
 end
 --- Helper function to remove all of a player's soul hearts and add the corresponding amount of black
 -- hearts.
 function ____exports.playerConvertSoulHeartsToBlackHearts(self, player)
     local playerHealth = ____exports.getPlayerHealth(nil, player)
     ____exports.removeAllPlayerHealth(nil, player)
-    playerHealth.soulHeartTypes = __TS__ArrayMap(
+    local newSoulHeartTypes = __TS__ArrayMap(
         playerHealth.soulHeartTypes,
         function(____, soulHeartType) return soulHeartType == HeartSubType.SOUL and HeartSubType.BLACK or soulHeartType end
     )
-    ____exports.setPlayerHealth(nil, player, playerHealth)
+    local playerHealthWithBlackHearts = __TS__ObjectAssign({}, playerHealth, {soulHeartTypes = newSoulHeartTypes})
+    ____exports.setPlayerHealth(nil, player, playerHealthWithBlackHearts)
 end
 --- Helper function to see if the player is out of health.
 -- 

package/dist/src/functions/playerTrinkets.d.ts

@@ -0,0 +1,69 @@
+import { TrinketType } from "isaac-typescript-definitions";
+export declare function addTrinketCostume(player: EntityPlayer, trinketType: TrinketType): void;
+/**
+ * Helper function to check to see if any player has a particular trinket.
+ *
+ * @param trinketType The trinket type to check for.
+ * @param ignoreModifiers If set to true, only counts trinkets the player actually holds and ignores
+ *                        effects granted by other items. Default is false.
+ */
+export declare function anyPlayerHasTrinket(trinketType: TrinketType, ignoreModifiers?: boolean): boolean;
+/**
+ * Returns the slot number corresponding to where a trinket can be safely inserted.
+ *
+ * For example:
+ *
+ * ```ts
+ * const player = Isaac.GetPlayer();
+ * const trinketSlot = getOpenTrinketSlotNum(player);
+ * if (trinketSlot !== undefined) {
+ *   // They have one or more open trinket slots
+ *   player.AddTrinket(TrinketType.SWALLOWED_PENNY);
+ * }
+ * ```
+ */
+export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefined;
+/**
+ * Helper function to get all of the trinkets that the player is currently holding. This will not
+ * include any smelted trinkets.
+ */
+export declare function getPlayerTrinkets(player: EntityPlayer): TrinketType[];
+/**
+ * Helper function to get only the players that have a certain trinket.
+ *
+ * This function is variadic, meaning that you can supply as many trinket types as you want to check
+ * for. It only returns the players that have all of the trinkets.
+ */
+export declare function getPlayersWithTrinket(...trinketTypes: TrinketType[]): EntityPlayer[];
+/** Helper function to check to see if the player is holding one or more trinkets. */
+export declare function hasAnyTrinket(player: EntityPlayer): boolean;
+/**
+ * Returns whether the player can hold an additional trinket, beyond what they are currently
+ * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
+ *
+ * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+ * items. (Only Tainted Forgotten can pick up items.)
+ */
+export declare function hasOpenTrinketSlot(player: EntityPlayer): boolean;
+/**
+ * Helper function to check to see if a player has one or more trinkets.
+ *
+ * This function is variadic, meaning that you can supply as many trinket types as you want to check
+ * for. Returns true if the player has any of the supplied trinket types.
+ *
+ * This function always passes `false` to the `ignoreModifiers` argument.
+ */
+export declare function hasTrinket(player: EntityPlayer, ...trinketTypes: TrinketType[]): boolean;
+/**
+ * Helper function to remove all of the held trinkets from a player.
+ *
+ * This will not remove any smelted trinkets, unless the player happens to also be holding a trinket
+ * that they have smelted. (In that case, both the held and the smelted trinket will be removed.)
+ */
+export declare function removeAllPlayerTrinkets(player: EntityPlayer): void;
+/**
+ * Helper function to remove a trinket costume from a player. Use this helper function to avoid
+ * having to request the trinket from the item config.
+ */
+export declare function removeTrinketCostume(player: EntityPlayer, trinketType: TrinketType): void;
+//# sourceMappingURL=playerTrinkets.d.ts.map

package/dist/src/functions/playerTrinkets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playerTrinkets.d.ts","sourceRoot":"","sources":["../../../src/functions/playerTrinkets.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAMtC,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,WAAW,EACxB,eAAe,CAAC,EAAE,OAAO,GACxB,OAAO,CAMT;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,GAAG,SAAS,CAkBxE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW,EAAE,CAWrE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,YAAY,EAAE,WAAW,EAAE,GAC7B,YAAY,EAAE,CAMhB;AAED,qFAAqF;AACrF,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAO3D;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAOhE;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,YAAY,EACpB,GAAG,YAAY,EAAE,WAAW,EAAE,GAC7B,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAalE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON"}

package/dist/src/functions/playerTrinkets.lua

@@ -0,0 +1,160 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local TrinketSlot = ____isaac_2Dtypescript_2Ddefinitions.TrinketSlot
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedEnumValues = require("src.arrays.cachedEnumValues")
+local TRINKET_SLOT_VALUES = ____cachedEnumValues.TRINKET_SLOT_VALUES
+local ____cachedClasses = require("src.core.cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____playerIndex = require("src.functions.playerIndex")
+local getAllPlayers = ____playerIndex.getAllPlayers
+local getPlayers = ____playerIndex.getPlayers
+local ____players = require("src.functions.players")
+local isCharacter = ____players.isCharacter
+function ____exports.addTrinketCostume(self, player, trinketType)
+    local itemConfigTrinket = itemConfig:GetTrinket(trinketType)
+    if itemConfigTrinket == nil then
+        return
+    end
+    player:AddCostume(itemConfigTrinket, false)
+end
+--- Helper function to check to see if any player has a particular trinket.
+-- 
+-- @param trinketType The trinket type to check for.
+-- @param ignoreModifiers If set to true, only counts trinkets the player actually holds and ignores
+-- effects granted by other items. Default is false.
+function ____exports.anyPlayerHasTrinket(self, trinketType, ignoreModifiers)
+    local players = getAllPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player) return player:HasTrinket(trinketType, ignoreModifiers) end
+    )
+end
+--- Returns the slot number corresponding to where a trinket can be safely inserted.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const player = Isaac.GetPlayer();
+-- const trinketSlot = getOpenTrinketSlotNum(player);
+-- if (trinketSlot !== undefined) {
+--   // They have one or more open trinket slots
+--   player.AddTrinket(TrinketType.SWALLOWED_PENNY);
+-- }
+-- ```
+function ____exports.getOpenTrinketSlot(self, player)
+    local maxTrinkets = player:GetMaxTrinkets()
+    local trinketType1 = player:GetTrinket(TrinketSlot.SLOT_1)
+    local trinketType2 = player:GetTrinket(TrinketSlot.SLOT_2)
+    if maxTrinkets == 1 then
+        return trinketType1 == TrinketType.NULL and 0 or nil
+    end
+    if maxTrinkets == 2 then
+        if trinketType1 == TrinketType.NULL then
+            return 0
+        end
+        return trinketType2 == TrinketType.NULL and 1 or nil
+    end
+    error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
+end
+--- Helper function to get all of the trinkets that the player is currently holding. This will not
+-- include any smelted trinkets.
+function ____exports.getPlayerTrinkets(self, player)
+    local trinketTypes = {}
+    for ____, trinketSlot in ipairs(TRINKET_SLOT_VALUES) do
+        local trinketType = player:GetTrinket(trinketSlot)
+        if trinketType ~= TrinketType.NULL then
+            trinketTypes[#trinketTypes + 1] = trinketType
+        end
+    end
+    return trinketTypes
+end
+--- Helper function to get only the players that have a certain trinket.
+-- 
+-- This function is variadic, meaning that you can supply as many trinket types as you want to check
+-- for. It only returns the players that have all of the trinkets.
+function ____exports.getPlayersWithTrinket(self, ...)
+    local trinketTypes = {...}
+    local players = getPlayers(nil)
+    return __TS__ArrayFilter(
+        players,
+        function(____, player) return __TS__ArrayEvery(
+            trinketTypes,
+            function(____, trinketType) return player:HasTrinket(trinketType) end
+        ) end
+    )
+end
+--- Helper function to check to see if the player is holding one or more trinkets.
+function ____exports.hasAnyTrinket(self, player)
+    local playerTrinketTypes = __TS__ArrayMap(
+        TRINKET_SLOT_VALUES,
+        function(____, trinketSlot) return player:GetTrinket(trinketSlot) end
+    )
+    return __TS__ArraySome(
+        playerTrinketTypes,
+        function(____, trinketType) return trinketType ~= TrinketType.NULL end
+    )
+end
+--- Returns whether the player can hold an additional trinket, beyond what they are currently
+-- carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
+-- 
+-- If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+-- items. (Only Tainted Forgotten can pick up items.)
+function ____exports.hasOpenTrinketSlot(self, player)
+    if isCharacter(nil, player, PlayerType.SOUL_B) then
+        return false
+    end
+    local openTrinketSlot = ____exports.getOpenTrinketSlot(nil, player)
+    return openTrinketSlot ~= nil
+end
+--- Helper function to check to see if a player has one or more trinkets.
+-- 
+-- This function is variadic, meaning that you can supply as many trinket types as you want to check
+-- for. Returns true if the player has any of the supplied trinket types.
+-- 
+-- This function always passes `false` to the `ignoreModifiers` argument.
+function ____exports.hasTrinket(self, player, ...)
+    local trinketTypes = {...}
+    return __TS__ArraySome(
+        trinketTypes,
+        function(____, trinketType) return player:HasTrinket(trinketType) end
+    )
+end
+--- Helper function to remove all of the held trinkets from a player.
+-- 
+-- This will not remove any smelted trinkets, unless the player happens to also be holding a trinket
+-- that they have smelted. (In that case, both the held and the smelted trinket will be removed.)
+function ____exports.removeAllPlayerTrinkets(self, player)
+    for ____, trinketSlot in ipairs(TRINKET_SLOT_VALUES) do
+        do
+            local trinketType = player:GetTrinket(trinketSlot)
+            if trinketType == TrinketType.NULL then
+                goto __continue25
+            end
+            local alreadyHasTrinket
+            repeat
+                do
+                    player:TryRemoveTrinket(trinketType)
+                    alreadyHasTrinket = player:HasTrinket(trinketType)
+                end
+            until not alreadyHasTrinket
+        end
+        ::__continue25::
+    end
+end
+--- Helper function to remove a trinket costume from a player. Use this helper function to avoid
+-- having to request the trinket from the item config.
+function ____exports.removeTrinketCostume(self, player, trinketType)
+    local itemConfigTrinket = itemConfig:GetTrinket(trinketType)
+    if itemConfigTrinket == nil then
+        return
+    end
+    player:RemoveCostume(itemConfigTrinket)
+end
+return ____exports