isaacscript-common 73.1.0 → 74.0.0

package/dist/functions/players.lua

@@ -0,0 +1,472 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayAt = ____lualib.__TS__ArrayAt
+local __TS__ArrayFind = ____lualib.__TS__ArrayFind
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local ControllerIndex = ____isaac_2Dtypescript_2Ddefinitions.ControllerIndex
+local NullItemID = ____isaac_2Dtypescript_2Ddefinitions.NullItemID
+local PlayerForm = ____isaac_2Dtypescript_2Ddefinitions.PlayerForm
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local TearFlag = ____isaac_2Dtypescript_2Ddefinitions.TearFlag
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local ____ReadonlySet = require("types.ReadonlySet")
+local ReadonlySet = ____ReadonlySet.ReadonlySet
+local ____characters = require("functions.characters")
+local getCharacterName = ____characters.getCharacterName
+local isVanillaCharacter = ____characters.isVanillaCharacter
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____playerIndex = require("functions.playerIndex")
+local getAllPlayers = ____playerIndex.getAllPlayers
+local getPlayerIndexVanilla = ____playerIndex.getPlayerIndexVanilla
+local getPlayers = ____playerIndex.getPlayers
+local ____types = require("functions.types")
+local isNumber = ____types.isNumber
+local ____utils = require("functions.utils")
+local assertDefined = ____utils.assertDefined
+local ____repeat = ____utils["repeat"]
+--- Helper function to get an array containing the characters of all of the current players.
+function ____exports.getCharacters(self)
+    local players = getPlayers(nil)
+    return __TS__ArrayMap(
+        players,
+        function(____, player) return player:GetPlayerType() end
+    )
+end
+function ____exports.isModdedPlayer(self, player)
+    return not ____exports.isVanillaPlayer(nil, player)
+end
+function ____exports.isVanillaPlayer(self, player)
+    local character = player:GetPlayerType()
+    return isVanillaCharacter(nil, character)
+end
+--- Helper function to check to see if any player has a temporary collectible effect.
+function ____exports.anyPlayerHasCollectibleEffect(self, collectibleType)
+    local players = getAllPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player)
+            local effects = player:GetEffects()
+            return effects:HasCollectibleEffect(collectibleType)
+        end
+    )
+end
+--- Helper function to check to see if any player has a temporary null effect.
+function ____exports.anyPlayerHasNullEffect(self, nullItemID)
+    local players = getAllPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player)
+            local effects = player:GetEffects()
+            return effects:HasNullEffect(nullItemID)
+        end
+    )
+end
+--- Helper function to check to see if any player has a temporary trinket effect.
+function ____exports.anyPlayerHasTrinketEffect(self, trinketType)
+    local players = getAllPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player)
+            local effects = player:GetEffects()
+            return effects:HasTrinketEffect(trinketType)
+        end
+    )
+end
+--- Helper function to check to see if any player is holding up an item (from e.g. an active item
+-- activation, a poop from IBS, etc.).
+function ____exports.anyPlayerHoldingItem(self)
+    local players = getAllPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player) return player:IsHoldingItem() end
+    )
+end
+--- Helper function to determine if the given character is present.
+-- 
+-- This function is variadic, meaning that you can supply as many characters as you want to check
+-- for. Returns true if any of the characters supplied are present.
+function ____exports.anyPlayerIs(self, ...)
+    local matchingCharacters = {...}
+    local matchingCharacterSet = __TS__New(ReadonlySet, matchingCharacters)
+    local characters = ____exports.getCharacters(nil)
+    return __TS__ArraySome(
+        characters,
+        function(____, character) return matchingCharacterSet:has(character) end
+    )
+end
+--- Helper function to determine if a player will destroy a rock/pot/skull if they walk over it.
+-- 
+-- The following situations allow for this to be true:
+-- - the player has Leo (collectible 302)
+-- - the player has Thunder Thighs (collectible 314)
+-- - the player is under the effects of Mega Mush (collectible 625)
+-- - the player has Stompy (transformation 13)
+function ____exports.canPlayerCrushRocks(self, player)
+    local effects = player:GetEffects()
+    return player:HasCollectible(CollectibleType.LEO) or player:HasCollectible(CollectibleType.THUNDER_THIGHS) or effects:HasCollectibleEffect(CollectibleType.MEGA_MUSH) or player:HasPlayerForm(PlayerForm.STOMPY)
+end
+--- Helper function to remove a collectible or trinket that is currently queued to go into a player's
+-- inventory (i.e. the item is being held over their head).
+-- 
+-- If the player does not have an item currently queued, then this function will be a no-op.
+-- 
+-- Returns whether an item was actually dequeued.
+function ____exports.dequeueItem(self, player)
+    if player.QueuedItem.Item == nil then
+        return false
+    end
+    local queue = player.QueuedItem
+    queue.Item = nil
+    player.QueuedItem = queue
+    return true
+end
+--- Helper function to get how long Azazel's Brimstone laser should be. You can pass either an
+-- `EntityPlayer` object or a tear height stat.
+-- 
+-- The formula for calculating it is: 32 - 2.5 * tearHeight
+function ____exports.getAzazelBrimstoneDistance(self, playerOrTearHeight)
+    local tearHeight = isNumber(nil, playerOrTearHeight) and playerOrTearHeight or playerOrTearHeight.TearHeight
+    return 32 - 2.5 * tearHeight
+end
+--- Helper function to get the closest player to a certain position. Note that this will never
+-- include players with a non-undefined parent, since they are not real players (e.g. the Strawman
+-- Keeper).
+function ____exports.getClosestPlayer(self, position)
+    local closestPlayer
+    local closestDistance = math.huge
+    for ____, player in ipairs(getPlayers(nil)) do
+        local distance = position:Distance(player.Position)
+        if distance < closestDistance then
+            closestPlayer = player
+            closestDistance = distance
+        end
+    end
+    assertDefined(nil, closestPlayer, "Failed to find the closest player.")
+    return closestPlayer
+end
+--- Helper function to get an array of temporary effects for a player. This is helpful so that you
+-- don't have to manually create an array from an `EffectsList` object.
+function ____exports.getEffectsList(self, player)
+    local effects = player:GetEffects()
+    local effectsList = effects:GetEffectsList()
+    local effectArray = {}
+    do
+        local i = 0
+        while i < effectsList.Size do
+            local effect = effectsList:Get(i)
+            if effect ~= nil then
+                effectArray[#effectArray + 1] = effect
+            end
+            i = i + 1
+        end
+    end
+    return effectArray
+end
+--- Helper function to return the player with the highest ID, according to the `Isaac.GetPlayer`
+-- method.
+function ____exports.getFinalPlayer(self)
+    local players = getPlayers(nil)
+    local lastPlayer = __TS__ArrayAt(players, -1)
+    assertDefined(nil, lastPlayer, "Failed to get the final player since there were 0 players.")
+    return lastPlayer
+end
+--- Helper function to get the first player with the lowest frame count. Useful to find a freshly
+-- spawned player after using items like Esau Jr. Don't use this function if two or more players
+-- will be spawned on the same frame.
+function ____exports.getNewestPlayer(self)
+    local newestPlayer
+    local lowestFrame = math.huge
+    for ____, player in ipairs(getPlayers(nil)) do
+        if player.FrameCount < lowestFrame then
+            newestPlayer = player
+            lowestFrame = player.FrameCount
+        end
+    end
+    assertDefined(nil, newestPlayer, "Failed to find the newest player.")
+    return newestPlayer
+end
+--- Iterates over all players and checks if any are close enough to the specified position.
+-- 
+-- @returns The first player found when iterating upwards from index 0.
+function ____exports.getPlayerCloserThan(self, position, distance)
+    local players = getPlayers(nil)
+    return __TS__ArrayFind(
+        players,
+        function(____, player) return player.Position:Distance(position) <= distance end
+    )
+end
+--- Helper function to get the player from a tear, laser, bomb, etc. Returns undefined if the entity
+-- does not correspond to any particular player.
+-- 
+-- This function works by looking at the `Parent` and the `SpawnerEntity` fields (in that order). As
+-- a last resort, it will attempt to use the `Entity.ToPlayer` method on the entity itself.
+function ____exports.getPlayerFromEntity(self, entity)
+    if entity.Parent ~= nil then
+        local player = entity.Parent:ToPlayer()
+        if player ~= nil then
+            return player
+        end
+        local familiar = entity.Parent:ToFamiliar()
+        if familiar ~= nil then
+            return familiar.Player
+        end
+    end
+    if entity.SpawnerEntity ~= nil then
+        local player = entity.SpawnerEntity:ToPlayer()
+        if player ~= nil then
+            return player
+        end
+        local familiar = entity.SpawnerEntity:ToFamiliar()
+        if familiar ~= nil then
+            return familiar.Player
+        end
+    end
+    return entity:ToPlayer()
+end
+--- Helper function to get an `EntityPlayer` object from an `EntityPtr`. Returns undefined if the
+-- entity has gone out of scope or if the associated entity is not a player.
+function ____exports.getPlayerFromPtr(self, entityPtr)
+    local entity = entityPtr.Ref
+    if entity == nil then
+        return nil
+    end
+    return entity:ToPlayer()
+end
+--- Helper function to get the proper name of the player. Use this instead of the
+-- `EntityPlayer.GetName` method because it accounts for Blue Baby, Lazarus II, and Tainted
+-- characters.
+function ____exports.getPlayerName(self, player)
+    local character = player:GetPlayerType()
+    return ____exports.isModdedPlayer(nil, player) and player:GetName() or getCharacterName(nil, character)
+end
+--- Returns the combined value of all of the player's red hearts, soul/black hearts, and bone hearts,
+-- minus the value of the player's rotten hearts.
+-- 
+-- This is equivalent to the number of hits that the player can currently take, but does not take
+-- into account double damage from champion enemies and/or being on later floors. (For example, on
+-- Womb 1, players who have 1 soul heart remaining would die in 1 hit to anything, even though this
+-- function would report that they have 2 hits remaining.)
+function ____exports.getPlayerNumHitsRemaining(self, player)
+    local hearts = player:GetHearts()
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    local eternalHearts = player:GetEternalHearts()
+    local rottenHearts = player:GetRottenHearts()
+    return hearts + soulHearts + boneHearts + eternalHearts - rottenHearts
+end
+--- Helper function to get all of the players that are a certain character.
+-- 
+-- This function is variadic, meaning that you can supply as many characters as you want to check
+-- for. Returns true if any of the characters supplied are present.
+function ____exports.getPlayersOfType(self, ...)
+    local characters = {...}
+    local charactersSet = __TS__New(ReadonlySet, characters)
+    local players = getPlayers(nil)
+    return __TS__ArrayFilter(
+        players,
+        function(____, player)
+            local character = player:GetPlayerType()
+            return charactersSet:has(character)
+        end
+    )
+end
+--- Helper function to get all of the players that are using keyboard (i.e.
+-- `ControllerIndex.KEYBOARD`). This function returns an array of players because it is possible
+-- that there is more than one player with the same controller index (e.g. Jacob & Esau).
+-- 
+-- Note that this function includes players with a non-undefined parent like e.g. the Strawman
+-- Keeper.
+function ____exports.getPlayersOnKeyboard(self)
+    local players = getAllPlayers(nil)
+    return __TS__ArrayFilter(
+        players,
+        function(____, player) return player.ControllerIndex == ControllerIndex.KEYBOARD end
+    )
+end
+--- Helper function to get all of the players that match the provided controller index. This function
+-- returns an array of players because it is possible that there is more than one player with the
+-- same controller index (e.g. Jacob & Esau).
+-- 
+-- Note that this function includes players with a non-undefined parent like e.g. the Strawman
+-- Keeper.
+function ____exports.getPlayersWithControllerIndex(self, controllerIndex)
+    local players = getAllPlayers(nil)
+    return __TS__ArrayFilter(
+        players,
+        function(____, player) return player.ControllerIndex == controllerIndex end
+    )
+end
+--- Helper function to check to see if a player has one or more transformations.
+-- 
+-- This function is variadic, meaning that you can supply as many transformations as you want to
+-- check for. Returns true if the player has any of the supplied transformations.
+function ____exports.hasForm(self, player, ...)
+    local playerForms = {...}
+    return __TS__ArraySome(
+        playerForms,
+        function(____, playerForm) return player:HasPlayerForm(playerForm) end
+    )
+end
+--- Helper function to check if a player has homing tears.
+-- 
+-- Under the hood, this checks the `EntityPlayer.TearFlags` variable for `TearFlag.HOMING` (1 << 2).
+function ____exports.hasHoming(self, player)
+    return hasFlag(nil, player.TearFlags, TearFlag.HOMING)
+end
+--- After touching a white fire, a player will turn into The Lost until they clear a room.
+function ____exports.hasLostCurse(self, player)
+    local effects = player:GetEffects()
+    return effects:HasNullEffect(NullItemID.LOST_CURSE)
+end
+--- Helper function to check if a player has piercing tears.
+-- 
+-- Under the hood, this checks the `EntityPlayer.TearFlags` variable for `TearFlag.PIERCING` (1 <<
+-- 1).
+function ____exports.hasPiercing(self, player)
+    return hasFlag(nil, player.TearFlags, TearFlag.PIERCING)
+end
+--- Helper function to check if a player has spectral tears.
+-- 
+-- Under the hood, this checks the `EntityPlayer.TearFlags` variable for `TearFlag.SPECTRAL` (1 <<
+-- 0).
+function ____exports.hasSpectral(self, player)
+    return hasFlag(nil, player.TearFlags, TearFlag.SPECTRAL)
+end
+--- Helper function for detecting when a player is Bethany or Tainted Bethany. This is useful if you
+-- need to adjust UI elements to account for Bethany's soul charges or Tainted Bethany's blood
+-- charges.
+function ____exports.isBethany(self, player)
+    local character = player:GetPlayerType()
+    return character == PlayerType.BETHANY or character == PlayerType.BETHANY_B
+end
+--- Helper function to check if a player is a specific character (i.e. `PlayerType`).
+-- 
+-- This function is variadic, meaning that you can supply as many characters as you want to check
+-- for. Returns true if the player is any of the supplied characters.
+function ____exports.isCharacter(self, player, ...)
+    local characters = {...}
+    local characterSet = __TS__New(ReadonlySet, characters)
+    local character = player:GetPlayerType()
+    return characterSet:has(character)
+end
+--- Helper function to see if a damage source is from a player. Use this instead of comparing to the
+-- entity directly because it takes familiars into account.
+function ____exports.isDamageFromPlayer(self, damageSource)
+    local player = damageSource:ToPlayer()
+    if player ~= nil then
+        return true
+    end
+    local indirectPlayer = ____exports.getPlayerFromEntity(nil, damageSource)
+    return indirectPlayer ~= nil
+end
+--- Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
+-- you want to know if the starting stats were randomized, for example.
+function ____exports.isEden(self, player)
+    local character = player:GetPlayerType()
+    return character == PlayerType.EDEN or character == PlayerType.EDEN_B
+end
+local function isTaintedModded(self, player)
+    local character = player:GetPlayerType()
+    local name = player:GetName()
+    local taintedCharacter = Isaac.GetPlayerTypeByName(name, true)
+    return character == taintedCharacter
+end
+function ____exports.isFirstPlayer(self, player)
+    return getPlayerIndexVanilla(nil, player) == 0
+end
+--- Helper function for detecting when a player is Jacob or Esau. This will only match the
+-- non-tainted versions of these characters.
+function ____exports.isJacobOrEsau(self, player)
+    local character = player:GetPlayerType()
+    return character == PlayerType.JACOB or character == PlayerType.ESAU
+end
+--- Helper function for detecting when a player is Keeper or Tainted Keeper. Useful for situations
+-- where you want to know if the health is coin hearts, for example.
+function ____exports.isKeeper(self, player)
+    local character = player:GetPlayerType()
+    return character == PlayerType.KEEPER or character == PlayerType.KEEPER_B
+end
+--- Helper function for detecting when a player is The Lost or Tainted Lost.
+function ____exports.isLost(self, player)
+    local character = player:GetPlayerType()
+    return character == PlayerType.LOST or character == PlayerType.LOST_B
+end
+--- Helper function for determining if a player is able to turn their head by pressing the shooting
+-- buttons.
+-- 
+-- Under the hood, this function uses the `EntityPlayer.IsExtraAnimationFinished` method.
+function ____exports.isPlayerAbleToAim(self, player)
+    return player:IsExtraAnimationFinished()
+end
+--- Helper function for detecting if a player is one of the Tainted characters.
+function ____exports.isTainted(self, player)
+    local character = player:GetPlayerType()
+    local ____isVanillaPlayer_result_0
+    if ____exports.isVanillaPlayer(nil, player) then
+        ____isVanillaPlayer_result_0 = character >= PlayerType.ISAAC_B
+    else
+        ____isVanillaPlayer_result_0 = isTaintedModded(nil, player)
+    end
+    return ____isVanillaPlayer_result_0
+end
+--- Helper function for detecting when a player is Tainted Lazarus or Dead Tainted Lazarus.
+function ____exports.isTaintedLazarus(self, player)
+    local character = player:GetPlayerType()
+    return character == PlayerType.LAZARUS_B or character == PlayerType.LAZARUS_2_B
+end
+--- Helper function to remove the Dead Eye multiplier from a player.
+-- 
+-- Note that each time the `EntityPlayer.ClearDeadEyeCharge` method is called, it only has a chance
+-- of working, so this function calls it 100 times to be safe.
+function ____exports.removeDeadEyeMultiplier(self, player)
+    ____repeat(
+        nil,
+        100,
+        function()
+            player:ClearDeadEyeCharge()
+        end
+    )
+end
+--- Helper function to blindfold the player by using a hack with the challenge variable.
+-- 
+-- Note that if the player dies and respawns (from e.g. Dead Cat), the blindfold will have to be
+-- reapplied.
+-- 
+-- Under the hood, this function sets the challenge to one with a blindfold, changes the player to
+-- the same character that they currently are, and then changes the challenge back. This method was
+-- discovered by im_tem.
+-- 
+-- @param player The player to apply or remove the blindfold state from.
+-- @param enabled Whether to apply or remove the blindfold.
+-- @param modifyCostume Optional. Whether to add or remove the blindfold costume. Default is true.
+function ____exports.setBlindfold(self, player, enabled, modifyCostume)
+    if modifyCostume == nil then
+        modifyCostume = true
+    end
+    local character = player:GetPlayerType()
+    local challenge = Isaac.GetChallenge()
+    if enabled then
+        game.Challenge = Challenge.SOLAR_SYSTEM
+        player:ChangePlayerType(character)
+        game.Challenge = challenge
+        if not modifyCostume then
+            player:TryRemoveNullCostume(NullItemID.BLINDFOLD)
+        end
+    else
+        game.Challenge = Challenge.NULL
+        player:ChangePlayerType(character)
+        game.Challenge = challenge
+        if modifyCostume then
+            player:TryRemoveNullCostume(NullItemID.BLINDFOLD)
+        end
+    end
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"pocketItems.d.ts","sourceRoot":"","sources":["../../src/functions/pocketItems.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAUnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAIjF;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,YAAY,GACnB,cAAc,GAAG,SAAS,CAS5B;AAED,6FAA6F;AAC7F,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,GACnB,qBAAqB,GAAG,SAAS,CAKnC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,GACnB,qBAAqB,GAAG,SAAS,CAOnC;AAED,6FAA6F;AAC7F,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,GACnB,qBAAqB,GAAG,SAAS,CAKnC;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,qBAAqB,EAAE,CA8D5E;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CASnE;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAQzE;AAED,oFAAoF;AACpF,wBAAgB,iBAAiB,CAC/B,YAAY,EAAE,qBAAqB,EAAE,EACrC,YAAY,EAAE,qBAAqB,EAAE,GACpC,OAAO,CAqBT"}

package/dist/functions/pocketItems.lua

@@ -0,0 +1,143 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFind = ____lualib.__TS__ArrayFind
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
+local CardType = ____isaac_2Dtypescript_2Ddefinitions.CardType
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PillColor = ____isaac_2Dtypescript_2Ddefinitions.PillColor
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____cachedEnumValues = require("arrays.cachedEnumValues")
+local POCKET_ITEM_SLOT_VALUES = ____cachedEnumValues.POCKET_ITEM_SLOT_VALUES
+local ____PocketItemType = require("enums.PocketItemType")
+local PocketItemType = ____PocketItemType.PocketItemType
+local ____players = require("functions.players")
+local isCharacter = ____players.isCharacter
+local ____types = require("functions.types")
+local asNumber = ____types.asNumber
+--- Use this helper function as a workaround for the `EntityPlayer.GetPocketItem` method not working
+-- correctly.
+-- 
+-- Note that due to API limitations, there is no way to determine the location of a Dice Bag trinket
+-- dice. Furthermore, when the player has a Dice Bag trinket dice and a pocket active at the same
+-- time, there is no way to determine the location of the pocket active item. If this function
+-- cannot determine the identity of a particular slot, it will mark the type of the slot as
+-- `PocketItemType.UNDETERMINABLE`.
+function ____exports.getPocketItems(self, player)
+    local pocketItem = player:GetActiveItem(ActiveSlot.POCKET)
+    local hasPocketItem = pocketItem ~= CollectibleType.NULL
+    local pocketItem2 = player:GetActiveItem(ActiveSlot.POCKET_SINGLE_USE)
+    local hasPocketItem2 = pocketItem2 ~= CollectibleType.NULL
+    local maxPocketItems = player:GetMaxPocketItems()
+    local pocketItems = {}
+    local pocketItemIdentified = false
+    local pocketItem2Identified = false
+    for ____, slot in ipairs(POCKET_ITEM_SLOT_VALUES) do
+        local cardType = player:GetCard(slot)
+        local pillColor = player:GetPill(slot)
+        if cardType ~= CardType.NULL then
+            pocketItems[#pocketItems + 1] = {slot = slot, type = PocketItemType.CARD, subType = cardType}
+        elseif pillColor ~= PillColor.NULL then
+            pocketItems[#pocketItems + 1] = {slot = slot, type = PocketItemType.PILL, subType = pillColor}
+        elseif hasPocketItem and not hasPocketItem2 and not pocketItemIdentified then
+            pocketItemIdentified = true
+            pocketItems[#pocketItems + 1] = {slot = slot, type = PocketItemType.ACTIVE_ITEM, subType = pocketItem}
+        elseif not hasPocketItem and hasPocketItem2 and not pocketItem2Identified then
+            pocketItem2Identified = true
+            pocketItems[#pocketItems + 1] = {slot = slot, type = PocketItemType.DICE_BAG_DICE, subType = pocketItem2}
+        elseif hasPocketItem and hasPocketItem2 then
+            pocketItems[#pocketItems + 1] = {slot = slot, type = PocketItemType.UNDETERMINABLE, subType = 0}
+        else
+            pocketItems[#pocketItems + 1] = {slot = slot, type = PocketItemType.EMPTY, subType = 0}
+        end
+        if asNumber(nil, slot) + 1 == maxPocketItems then
+            break
+        end
+    end
+    return pocketItems
+end
+--- Helper function to get the `PocketItemSlot` that the player's pocket active collectible item is
+-- in, if any. Returns undefined if the player does not have a pocket active item.
+function ____exports.getActivePocketItemSlot(self, player)
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    for ____, pocketItem in ipairs(pocketItems) do
+        if pocketItem.type == PocketItemType.ACTIVE_ITEM then
+            return pocketItem.slot
+        end
+    end
+    return nil
+end
+--- Helper item to get the first card that a player is holding in their pocket item slots.
+function ____exports.getFirstCard(self, player)
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    return __TS__ArrayFind(
+        pocketItems,
+        function(____, pocketItem) return pocketItem.type == PocketItemType.CARD end
+    )
+end
+--- Helper item to get the first card or pill that a player is holding in their pocket item slots.
+function ____exports.getFirstCardOrPill(self, player)
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    return __TS__ArrayFind(
+        pocketItems,
+        function(____, pocketItem) return pocketItem.type == PocketItemType.CARD or pocketItem.type == PocketItemType.PILL end
+    )
+end
+--- Helper item to get the first pill that a player is holding in their pocket item slots.
+function ____exports.getFirstPill(self, player)
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    return __TS__ArrayFind(
+        pocketItems,
+        function(____, pocketItem) return pocketItem.type == PocketItemType.PILL end
+    )
+end
+--- Returns whether the player can hold an additional pocket item, beyond what they are currently
+-- carrying. This takes into account items that modify the max number of pocket items, like Starter
+-- Deck.
+-- 
+-- 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.hasOpenPocketItemSlot(self, player)
+    if isCharacter(nil, player, PlayerType.SOUL_B) then
+        return false
+    end
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    return __TS__ArraySome(
+        pocketItems,
+        function(____, pocketItem) return pocketItem.type == PocketItemType.EMPTY end
+    )
+end
+--- Helper function to determine whether the player's "active" pocket item slot is set to their
+-- pocket active item.
+function ____exports.isFirstSlotPocketActiveItem(self, player)
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    local firstPocketItem = pocketItems[1]
+    if firstPocketItem == nil then
+        return false
+    end
+    return firstPocketItem.type == PocketItemType.ACTIVE_ITEM
+end
+--- Helper function to see if two sets of pocket item descriptions are identical.
+function ____exports.pocketItemsEquals(self, pocketItems1, pocketItems2)
+    if #pocketItems1 ~= #pocketItems2 then
+        return false
+    end
+    do
+        local i = 0
+        while i < #pocketItems1 do
+            local pocketItem1 = pocketItems1[i + 1]
+            local pocketItem2 = pocketItems2[i + 1]
+            local keys = __TS__ObjectKeys(pocketItem1)
+            for ____, key in ipairs(keys) do
+                if pocketItem1[key] ~= pocketItem2[key] then
+                    return false
+                end
+            end
+            i = i + 1
+        end
+    end
+    return true
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"positionVelocity.d.ts","sourceRoot":"","sources":["../../src/functions/positionVelocity.ts"],"names":[],"mappings":";;;;AAaA,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAAE,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,GACZ,OAAO,CAIT;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,KAAK,GACd,OAAO,CAKT;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,gBAAgB,EAAE,MAAM,EACxB,mBAAmB,UAAQ,EAC3B,eAAe,CAAC,EAAE,KAAK,GACtB,QAAQ,CAAC,MAAM,CAAC,CA4ClB;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAY5E;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAY7E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EACrC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,IAAI,CAYN;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EACtC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,IAAI,CAYN"}