isaacscript-common 73.1.0 → 74.0.0

package/dist/functions/pills.lua

@@ -0,0 +1,166 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArraySlice = ____lualib.__TS__ArraySlice
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PillColor = ____isaac_2Dtypescript_2Ddefinitions.PillColor
+local ____cachedEnumValues = require("arrays.cachedEnumValues")
+local PILL_COLOR_VALUES = ____cachedEnumValues.PILL_COLOR_VALUES
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local itemConfig = ____cachedClasses.itemConfig
+local ____constantsFirstLast = require("core.constantsFirstLast")
+local FIRST_HORSE_PILL_COLOR = ____constantsFirstLast.FIRST_HORSE_PILL_COLOR
+local FIRST_PILL_COLOR = ____constantsFirstLast.FIRST_PILL_COLOR
+local LAST_HORSE_PILL_COLOR = ____constantsFirstLast.LAST_HORSE_PILL_COLOR
+local LAST_NORMAL_PILL_COLOR = ____constantsFirstLast.LAST_NORMAL_PILL_COLOR
+local LAST_VANILLA_PILL_EFFECT = ____constantsFirstLast.LAST_VANILLA_PILL_EFFECT
+local ____PHDPillConversionsMap = require("maps.PHDPillConversionsMap")
+local PHD_PILL_CONVERSIONS_MAP = ____PHDPillConversionsMap.PHD_PILL_CONVERSIONS_MAP
+local ____falsePHDPillConversionsMap = require("maps.falsePHDPillConversionsMap")
+local FALSE_PHD_PILL_CONVERSIONS_MAP = ____falsePHDPillConversionsMap.FALSE_PHD_PILL_CONVERSIONS_MAP
+local ____pillEffectClasses = require("objects.pillEffectClasses")
+local DEFAULT_PILL_EFFECT_CLASS = ____pillEffectClasses.DEFAULT_PILL_EFFECT_CLASS
+local PILL_EFFECT_CLASSES = ____pillEffectClasses.PILL_EFFECT_CLASSES
+local ____pillEffectNames = require("objects.pillEffectNames")
+local DEFAULT_PILL_EFFECT_NAME = ____pillEffectNames.DEFAULT_PILL_EFFECT_NAME
+local PILL_EFFECT_NAMES = ____pillEffectNames.PILL_EFFECT_NAMES
+local ____pillEffectTypeToPillEffects = require("objects.pillEffectTypeToPillEffects")
+local PILL_EFFECT_TYPE_TO_PILL_EFFECTS = ____pillEffectTypeToPillEffects.PILL_EFFECT_TYPE_TO_PILL_EFFECTS
+local ____pillEffectTypes = require("objects.pillEffectTypes")
+local DEFAULT_PILL_EFFECT_TYPE = ____pillEffectTypes.DEFAULT_PILL_EFFECT_TYPE
+local PILL_EFFECT_TYPES = ____pillEffectTypes.PILL_EFFECT_TYPES
+local ____types = require("functions.types")
+local asNumber = ____types.asNumber
+local asPillColor = ____types.asPillColor
+local ____utils = require("functions.utils")
+local iRange = ____utils.iRange
+function ____exports.isVanillaPillEffect(self, pillEffect)
+    return pillEffect <= LAST_VANILLA_PILL_EFFECT
+end
+--- Add this to a `PillColor` to get the corresponding giant pill color.
+-- 
+-- Corresponds to the vanilla `PillColor.GIANT_FLAG` value.
+-- 
+-- 1 << 11
+local HORSE_PILL_ADJUSTMENT = 2048
+--- Helper function to get an array with every non-null pill color. This includes all gold colors and
+-- all horse colors.
+function ____exports.getAllPillColors(self)
+    return __TS__ArraySlice(PILL_COLOR_VALUES, 1)
+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_MAP:get(pillEffect)
+    return convertedPillEffect or pillEffect
+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
+-- corresponds to the horse pill color for blue/blue.
+function ____exports.getHorsePillColor(self, pillColor)
+    return asNumber(nil, pillColor) + HORSE_PILL_ADJUSTMENT
+end
+--- Helper function to get an array with every non-gold horse pill color.
+function ____exports.getHorsePillColors(self)
+    return iRange(nil, FIRST_HORSE_PILL_COLOR, LAST_HORSE_PILL_COLOR)
+end
+--- Helper function to get the corresponding normal pill color from a horse pill color.
+-- 
+-- For example, passing 2049 would result in `PillColor.BLUE_BLUE`.
+-- 
+-- If called with a non-horse pill color, this function will return back the same color.
+function ____exports.getNormalPillColorFromHorse(self, pillColor)
+    local normalPillColor = asPillColor(
+        nil,
+        asNumber(nil, pillColor) - HORSE_PILL_ADJUSTMENT
+    )
+    return normalPillColor > PillColor.NULL and normalPillColor or pillColor
+end
+--- Helper function to get an array with every non-gold and non-horse pill color.
+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_MAP:get(pillEffect)
+    return convertedPillEffect or pillEffect
+end
+--- Helper function to get the corresponding pill color from an effect by repeatedly using the
+-- `ItemPool.GetPillEffect` method.
+-- 
+-- Note that this will return the corresponding effect even if the passed pill color is not yet
+-- identified by the player.
+-- 
+-- Returns `PillColor.NULL` if there is the corresponding pill color cannot be found.
+-- 
+-- This function is especially useful in the `POST_USE_PILL` callback, since at that point, the used
+-- pill is already consumed, and the callback only passes the effect. In this specific circumstance,
+-- consider using the `POST_USE_PILL_FILTER` callback instead of the `POST_USE_PILL` callback, since
+-- it correctly passes the color and handles the case of horse pills.
+function ____exports.getPillColorFromEffect(self, pillEffect)
+    local itemPool = game:GetItemPool()
+    local normalPillColors = ____exports.getNormalPillColors(nil)
+    for ____, normalPillColor in ipairs(normalPillColors) do
+        local normalPillEffect = itemPool:GetPillEffect(normalPillColor)
+        if normalPillEffect == pillEffect then
+            return normalPillColor
+        end
+    end
+    return PillColor.NULL
+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 the pill effect is positive, negative,
+-- or neutral.
+-- 
+-- Due to limitations in the API, this function will not work properly for modded pill effects, and
+-- will always return `DEFAULT_PILL_EFFECT_CLASS` in those cases.
+function ____exports.getPillEffectClass(self, pillEffect)
+    local pillEffectClass = PILL_EFFECT_CLASSES[pillEffect]
+    return pillEffectClass or DEFAULT_PILL_EFFECT_CLASS
+end
+--- Helper function to get a pill effect name from a `PillEffect`. Returns "Unknown" if the provided
+-- pill effect is not valid.
+-- 
+-- This function works for both vanilla and modded pill effects.
+-- 
+-- For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
+function ____exports.getPillEffectName(self, pillEffect)
+    local pillEffectName = PILL_EFFECT_NAMES[pillEffect]
+    if pillEffectName ~= nil then
+        return pillEffectName
+    end
+    local itemConfigPillEffect = itemConfig:GetPillEffect(pillEffect)
+    if itemConfigPillEffect ~= nil then
+        return itemConfigPillEffect.Name
+    end
+    return DEFAULT_PILL_EFFECT_NAME
+end
+--- Helper function to get a pill effect type from a `PillEffect` enum value. In this context, the
+-- type is equal to positive, negative, or neutral. This is derived from the suffix of the "class"
+-- tag in the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the
+-- "power" of the pill.
+-- 
+-- Due to limitations in the API, this function will not work properly for modded pill effects, and
+-- will always return `DEFAULT_PILL_EFFECT_TYPE` in those cases.
+function ____exports.getPillEffectType(self, pillEffect)
+    local pillEffectType = PILL_EFFECT_TYPES[pillEffect]
+    return pillEffectType or DEFAULT_PILL_EFFECT_TYPE
+end
+function ____exports.getVanillaPillEffectsOfType(self, pillEffectType)
+    return PILL_EFFECT_TYPE_TO_PILL_EFFECTS[pillEffectType]
+end
+--- Helper function to see if the given pill color is either a gold pill or a horse gold pill.
+function ____exports.isGoldPill(self, pillColor)
+    return pillColor == PillColor.GOLD or pillColor == PillColor.HORSE_GOLD
+end
+--- Helper function to see if the given pill color is a horse pill.
+function ____exports.isHorsePill(self, pillColor)
+    return asNumber(nil, pillColor) > HORSE_PILL_ADJUSTMENT
+end
+function ____exports.isModdedPillEffect(self, pillEffect)
+    return not ____exports.isVanillaPillEffect(nil, pillEffect)
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"playerCenter.d.ts","sourceRoot":"","sources":["../../src/functions/playerCenter.ts"],"names":[],"mappings":";AAUA;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,KAAU,GAAG,IAAI,CAmC5D"}

package/dist/functions/playerCenter.lua

@@ -0,0 +1,68 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayEntries = ____lualib.__TS__ArrayEntries
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local movePlayerAndTheirFamiliars
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("core.constants")
+local NEW_FLOOR_STARTING_POSITION_GREED_MODE = ____constants.NEW_FLOOR_STARTING_POSITION_GREED_MODE
+local NEW_FLOOR_STARTING_POSITION_NORMAL_MODE = ____constants.NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
+local ____familiars = require("functions.familiars")
+local getPlayerFamiliars = ____familiars.getPlayerFamiliars
+local ____math = require("functions.math")
+local getCircleDiscretizedPoints = ____math.getCircleDiscretizedPoints
+local ____playerIndex = require("functions.playerIndex")
+local getAllPlayers = ____playerIndex.getAllPlayers
+function movePlayerAndTheirFamiliars(self, player, position)
+    player.Position = position
+    local familiars = getPlayerFamiliars(nil, player)
+    for ____, familiar in ipairs(familiars) do
+        familiar.Position = position
+    end
+end
+--- Helper function to move all of the players to where they would normally go when arriving at a new
+-- floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
+-- door.)
+-- 
+-- If there is more than one player, they will be distributed around the center in a circle.
+-- 
+-- This function emulates what happens in the vanilla game when you travel to a new floor.
+-- 
+-- @param radius Optional. The radius of the circle. Default is 10.
+function ____exports.movePlayersToCenter(self, radius)
+    if radius == nil then
+        radius = 10
+    end
+    local isGreedMode = game:IsGreedMode()
+    local startingPosition = isGreedMode and NEW_FLOOR_STARTING_POSITION_GREED_MODE or NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
+    local players = getAllPlayers(nil)
+    local firstPlayer = players[1]
+    if firstPlayer == nil then
+        return
+    end
+    if #players == 1 then
+        movePlayerAndTheirFamiliars(nil, firstPlayer, startingPosition)
+        return
+    end
+    local circlePoints = getCircleDiscretizedPoints(
+        nil,
+        startingPosition,
+        radius,
+        #players,
+        1,
+        1,
+        Direction.LEFT
+    )
+    for ____, ____value in __TS__Iterator(__TS__ArrayEntries(players)) do
+        local i = ____value[1]
+        local player = ____value[2]
+        local circlePosition = circlePoints[i + 1]
+        if circlePosition ~= nil then
+            player.Position = circlePosition
+        end
+    end
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"playerCollectibles.d.ts","sourceRoot":"","sources":["../../src/functions/playerCollectibles.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,eAAe,EAEhB,MAAM,8BAA8B,CAAC;AAStC;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAIN;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,EAChC,eAAe,CAAC,EAAE,OAAO,GACxB,OAAO,CAMT;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,UAAU,EAAE,CAKd;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,GAAG,CAQL;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,YAAY,EAAE,CAQhB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,eAAe,GAC/B,GAAG,CAQL;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,OAAO,CAIT;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,EAChC,GAAG,WAAW,EAAE,UAAU,EAAE,GAC3B,OAAO,CAOT;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAiBnE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,OAAO,CAGT;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAa/D;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAIN;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAC7C,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAQN;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,EAChC,UAAU,aAAqB,EAC/B,MAAM,CAAC,EAAE,GAAG,EACZ,WAAW,UAAQ,GAClB,IAAI,CA6DN;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAEN"}

package/dist/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("arrays.cachedEnumValues")
+local ACTIVE_SLOT_VALUES = ____cachedEnumValues.ACTIVE_SLOT_VALUES
+local ____cachedClasses = require("core.cachedClasses")
+local game = ____cachedClasses.game
+local itemConfig = ____cachedClasses.itemConfig
+local ____ReadonlySet = require("types.ReadonlySet")
+local ReadonlySet = ____ReadonlySet.ReadonlySet
+local ____array = require("functions.array")
+local sumArray = ____array.sumArray
+local ____collectibles = require("functions.collectibles")
+local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
+local ____playerIndex = require("functions.playerIndex")
+local getAllPlayers = ____playerIndex.getAllPlayers
+local getPlayers = ____playerIndex.getPlayers
+local ____players = require("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/functions/playerDataStructures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playerDataStructures.d.ts","sourceRoot":"","sources":["../../src/functions/playerDataStructures.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,IAAI,SAAS,OAAO,EAAE,EAC3D,GAAG,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,IAAI,CAAC,EACrC,MAAM,EAAE,YAAY,EACpB,GAAG,SAAS,EAAE,IAAI,GACjB,CAAC,CAGH;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,EACxB,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,CAAC,GACP,IAAI,CAEN;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,EAC9B,MAAM,EAAE,YAAY,GACnB,OAAO,CAGT;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,EACxB,MAAM,EAAE,YAAY,GACnB,CAAC,GAAG,SAAS,CAGf;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,EACxB,MAAM,EAAE,YAAY,GACnB,OAAO,CAGT;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,EACxB,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,CAAC,GACP,IAAI,CAGN;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC,EACrB,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,WAAW,CAAC,CAGlB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC,EACrB,MAAM,EAAE,YAAY,GACnB,OAAO,CAGT;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC,EACrB,MAAM,EAAE,YAAY,GACnB,OAAO,CAGT"}

package/dist/functions/playerDataStructures.lua

@@ -0,0 +1,111 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local Set = ____lualib.Set
+local ____exports = {}
+local ____playerIndex = require("functions.playerIndex")
+local getPlayerIndex = ____playerIndex.getPlayerIndex
+--- Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
+-- `Map.set` method if you have a map of this type.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const v = {
+--   run: {
+--     playersSpeedBoost: new Map<PlayerIndex, int>(),
+--   },
+-- };
+-- 
+-- function incrementSpeedBoost(player: EntityPlayer) {
+--   const oldSpeedBoost = mapGetPlayer(v.run.playersSpeedBoost, player);
+--   const newSpeedBoost = oldSpeedBoost + 0.1;
+--   mapSetPlayer(v.run.playersSpeedBoost, player);
+-- }
+-- ```
+function ____exports.mapSetPlayer(self, map, player, value)
+    local playerIndex = getPlayerIndex(nil, player)
+    map:set(playerIndex, value)
+end
+--- Helper function to make using default maps with an index of `PlayerIndex` easier. Use this
+-- instead of the `DefaultMap.getAndSetDefault` method if you have a default map of this type.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const v = {
+--   run: {
+--     playersSpeedBoost: new DefaultMap<PlayerIndex, int>(0),
+--   },
+-- };
+-- 
+-- function evaluateCacheSpeed(player: EntityPlayer) {
+--   player.MoveSpeed = defaultMapGetPlayer(v.run.playersSpeedBoost, player);
+-- }
+-- ```
+-- 
+-- @allowEmptyVariadic
+function ____exports.defaultMapGetPlayer(self, map, player, ...)
+    local playerIndex = getPlayerIndex(nil, player)
+    return map:getAndSetDefault(playerIndex, ...)
+end
+--- Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
+-- `Map.set` method if you have a map of this type.
+-- 
+-- Since `Map` and `DefaultMap` set values in the same way, this function is simply an alias for the
+-- `mapSetPlayer` helper function.
+function ____exports.defaultMapSetPlayer(self, map, player, value)
+    ____exports.mapSetPlayer(nil, map, player, value)
+end
+--- Helper function to make using maps with an type of `PlayerIndex` easier. Use this instead of the
+-- `Map.delete` method if you have a set of this type.
+function ____exports.mapDeletePlayer(self, map, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return map:delete(playerIndex)
+end
+--- Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
+-- `Map.get` method if you have a map of this type.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const v = {
+--   run: {
+--     playersSpeedBoost: new Map<PlayerIndex, int>(),
+--   },
+-- };
+-- 
+-- function incrementSpeedBoost(player: EntityPlayer) {
+--   const oldSpeedBoost = mapGetPlayer(v.run.playersSpeedBoost, player);
+--   const newSpeedBoost = oldSpeedBoost + 0.1;
+--   mapSetPlayer(v.run.playersSpeedBoost, player);
+-- }
+-- ```
+function ____exports.mapGetPlayer(self, map, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return map:get(playerIndex)
+end
+--- Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
+-- `Map.has` method if you have a map of this type.
+function ____exports.mapHasPlayer(self, map, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return map:has(playerIndex)
+end
+--- Helper function to make using sets with an type of `PlayerIndex` easier. Use this instead of the
+-- `Set.add` method if you have a set of this type.
+function ____exports.setAddPlayer(self, set, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return set:add(playerIndex)
+end
+--- Helper function to make using sets with an type of `PlayerIndex` easier. Use this instead of the
+-- `Set.delete` method if you have a set of this type.
+function ____exports.setDeletePlayer(self, set, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return set:delete(playerIndex)
+end
+--- Helper function to make using sets with an type of `PlayerIndex` easier. Use this instead of the
+-- `Set.has` method if you have a set of this type.
+function ____exports.setHasPlayer(self, set, player)
+    local playerIndex = getPlayerIndex(nil, player)
+    return set:has(playerIndex)
+end
+return ____exports

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

@@ -0,0 +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;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"}