isaacscript-common 6.6.1-dev.1 → 6.6.1-dev.5

package/dist/functions/playerCenter.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+export declare function movePlayersToCenter(): void;
+//# sourceMappingURL=playerCenter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playerCenter.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/playerCenter.ts"],"names":[],"mappings":"AAYA;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAqC1C"}

package/dist/functions/playerCenter.lua

@@ -0,0 +1,64 @@
+local ____exports = {}
+local movePlayerAndTheirFamiliars
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("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 getPlayers = ____playerIndex.getPlayers
+function movePlayerAndTheirFamiliars(self, player, position)
+    player.Position = position
+    local familiars = getPlayerFamiliars(nil, player)
+    for ____, familiar in ipairs(familiars) do
+        familiar.Position = position
+    end
+end
+local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
+--- 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.
+function ____exports.movePlayersToCenter(self)
+    local isGreedMode = game:IsGreedMode()
+    local startingPosition = isGreedMode and NEW_FLOOR_STARTING_POSITION_GREED_MODE or NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
+    local players = getPlayers(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,
+        CIRCLE_RADIUS_BETWEEN_PLAYERS,
+        #players,
+        1,
+        1,
+        Direction.LEFT
+    )
+    do
+        local i = 0
+        while i < #players do
+            local player = players[i + 1]
+            local circlePosition = circlePoints[i + 1]
+            if player ~= nil and circlePosition ~= nil then
+                player.Position = circlePosition
+            end
+            i = i + 1
+        end
+    end
+end
+return ____exports

package/dist/functions/playerDataStructures.d.ts

@@ -0,0 +1,93 @@
+/// <reference types="isaac-typescript-definitions" />
+import { DefaultMap } from "../classes/DefaultMap";
+import { PlayerIndex } from "../types/PlayerIndex";
+/**
+ * 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);
+ * }
+ * ```
+ */
+export declare function defaultMapGetPlayer<V, A extends unknown[]>(map: DefaultMap<PlayerIndex, V, A>, player: EntityPlayer, ...extraArgs: A): V;
+/**
+ * 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.
+ */
+export declare function defaultMapSetPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer, value: V): void;
+/**
+ * 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);
+ * }
+ * ```
+ */
+export declare function mapGetPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer): V | undefined;
+/**
+ * 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.
+ */
+export declare function mapHasPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer): boolean;
+/**
+ * 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);
+ * }
+ * ```
+ */
+export declare function mapSetPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer, value: V): void;
+/**
+ * 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.
+ */
+export declare function setAddPlayer(set: Set<PlayerIndex>, player: EntityPlayer): Set<PlayerIndex>;
+/**
+ * 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.
+ */
+export declare function setDeletePlayer(set: Set<PlayerIndex>, player: EntityPlayer): boolean;
+/**
+ * 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.
+ */
+export declare function setHasPlayer(set: Set<PlayerIndex>, player: EntityPlayer): boolean;
+//# sourceMappingURL=playerDataStructures.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playerDataStructures.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/playerDataStructures.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGnD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EACxD,GAAG,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC,EAClC,MAAM,EAAE,YAAY,EACpB,GAAG,SAAS,EAAE,CAAC,GACd,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;;;;;;;;;;;;;;;;;;;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,103 @@
+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);
+-- }
+-- ```
+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 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

@@ -0,0 +1,35 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+import { HealthType } from "../enums/HealthType";
+import { PlayerHealth } from "../interfaces/PlayerHealth";
+export declare function addPlayerHealthType(player: EntityPlayer, healthType: HealthType, numHearts: int): void;
+/**
+ * Helper function to get an object representing the player's health. You can use this in
+ * combination with the `setPlayerHealth` function to restore the player's health back to a certain
+ * configuration at a later time.
+ *
+ * This is based on the `REVEL.StoreHealth` function in the Revelations mod.
+ */
+export declare function getPlayerHealth(player: EntityPlayer): PlayerHealth;
+export declare function getPlayerHealthType(player: EntityPlayer, healthType: HealthType): int;
+/** Returns a `PlayerHealth` object with all 0s. */
+export declare function newPlayerHealth(): PlayerHealth;
+export declare function playerConvertBlackHeartsToSoulHearts(player: EntityPlayer): void;
+export declare function playerConvertSoulHeartsToBlackHearts(player: EntityPlayer): void;
+/**
+ * Helper function to see if the player is out of health.
+ *
+ * Specifically, this function will return false if the player has 0 red hearts, 0 soul/black
+ * hearts, and 0 bone hearts.
+ */
+export declare function playerHasHealthLeft(player: EntityPlayer): boolean;
+export declare function removeAllPlayerHealth(player: EntityPlayer): void;
+/**
+ * Helper function to set a player's health to a specific state. You can use this in combination
+ * with the `getPlayerHealth` function to restore the player's health back to a certain
+ * configuration at a later time.
+ *
+ * Based on the `REVEL.LoadHealth` function in the Revelations mod.
+ */
+export declare function setPlayerHealth(player: EntityPlayer, playerHealth: PlayerHealth): void;
+//# sourceMappingURL=playerHealth.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playerHealth.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/playerHealth.ts"],"names":[],"mappings":";;AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAW1D,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,GAAG,GACb,IAAI,CA+CN;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,mDAAmD;AACnD,wBAAgB,eAAe,IAAI,YAAY,CAc9C;AAED,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,YAAY,GACnB,IAAI,CAQN;AAED,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,CA4FN"}

package/dist/functions/playerHealth.lua

@@ -0,0 +1,353 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local HeartSubType = ____isaac_2Dtypescript_2Ddefinitions.HeartSubType
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____constants = require("constants")
+local MAX_PLAYER_HEART_CONTAINERS = ____constants.MAX_PLAYER_HEART_CONTAINERS
+local ____HealthType = require("enums.HealthType")
+local HealthType = ____HealthType.HealthType
+local ____charge = require("functions.charge")
+local getTotalCharge = ____charge.getTotalCharge
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____player = require("functions.player")
+local getPlayerBlackHearts = ____player.getPlayerBlackHearts
+local getPlayerHearts = ____player.getPlayerHearts
+local getPlayerSoulHearts = ____player.getPlayerSoulHearts
+local isCharacter = ____player.isCharacter
+local setActiveItem = ____player.setActiveItem
+function ____exports.removeAllPlayerHealth(self, player)
+    local goldenHearts = player:GetGoldenHearts()
+    local eternalHearts = player:GetEternalHearts()
+    local boneHearts = player:GetBoneHearts()
+    local brokenHearts = player:GetBrokenHearts()
+    player:AddGoldenHearts(goldenHearts * -1)
+    player:AddEternalHearts(eternalHearts * -1)
+    player:AddBoneHearts(boneHearts * -1)
+    player:AddBrokenHearts(brokenHearts * -1)
+    player:AddMaxHearts(MAX_PLAYER_HEART_CONTAINERS * -2, true)
+    player:AddSoulHearts(MAX_PLAYER_HEART_CONTAINERS * -2)
+    if isCharacter(nil, player, PlayerType.THE_SOUL) then
+        local forgotten = player:GetSubPlayer()
+        if forgotten ~= nil then
+            local forgottenBoneHearts = forgotten:GetBoneHearts()
+            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
+        end
+    end
+end
+--- Helper function to set a player's health to a specific state. You can use this in combination
+-- with the `getPlayerHealth` function to restore the player's health back to a certain
+-- configuration at a later time.
+-- 
+-- Based on the `REVEL.LoadHealth` function in the Revelations mod.
+function ____exports.setPlayerHealth(self, player, playerHealth)
+    local character = player:GetPlayerType()
+    local subPlayer = player:GetSubPlayer()
+    ____exports.removeAllPlayerHealth(nil, player)
+    local alabasterBoxes = {}
+    if player:HasCollectible(CollectibleType.ALABASTER_BOX) then
+        for ____, activeSlot in ipairs(getEnumValues(nil, ActiveSlot)) do
+            local activeItem = player:GetActiveItem()
+            if activeItem == CollectibleType.ALABASTER_BOX then
+                local totalCharge = getTotalCharge(nil, player, activeSlot)
+                setActiveItem(nil, player, CollectibleType.NULL, activeSlot)
+                alabasterBoxes[#alabasterBoxes + 1] = {activeSlot, totalCharge}
+            end
+        end
+    end
+    if character == PlayerType.THE_SOUL and subPlayer ~= nil then
+        subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
+    else
+        player:AddMaxHearts(playerHealth.maxHearts, false)
+    end
+    player:AddEternalHearts(playerHealth.eternalHearts)
+    local soulHeartsRemaining = playerHealth.soulHearts
+    __TS__ArrayForEach(
+        playerHealth.soulHeartTypes,
+        function(____, heartType, i)
+            local isHalf = playerHealth.soulHearts + playerHealth.boneHearts * 2 < (i + 1) * 2
+            local addAmount = 2
+            if isHalf or heartType == HeartSubType.BONE or soulHeartsRemaining < 2 then
+                addAmount = 1
+            end
+            if heartType == HeartSubType.SOUL then
+                player:AddSoulHearts(addAmount)
+                soulHeartsRemaining = soulHeartsRemaining - addAmount
+            elseif heartType == HeartSubType.BLACK then
+                player:AddBlackHearts(addAmount)
+                soulHeartsRemaining = soulHeartsRemaining - addAmount
+            elseif heartType == HeartSubType.BONE then
+                player:AddBoneHearts(addAmount)
+            end
+        end
+    )
+    player:AddRottenHearts(playerHealth.rottenHearts)
+    if character == PlayerType.MAGDALENE_B then
+        local effectiveHearts = playerHealth.hearts / 2
+        player:AddHearts(effectiveHearts)
+    else
+        player:AddHearts(playerHealth.hearts)
+    end
+    player:AddGoldenHearts(playerHealth.goldenHearts)
+    player:AddBrokenHearts(playerHealth.brokenHearts)
+    if character == PlayerType.BETHANY then
+        player:SetSoulCharge(playerHealth.soulCharges)
+    elseif character == PlayerType.BETHANY_B then
+        player:SetBloodCharge(playerHealth.bloodCharges)
+    end
+    for ____, ____value in ipairs(alabasterBoxes) do
+        local activeSlot = ____value[1]
+        local totalCharge = ____value[2]
+        setActiveItem(
+            nil,
+            player,
+            CollectibleType.ALABASTER_BOX,
+            activeSlot,
+            totalCharge
+        )
+    end
+end
+function ____exports.addPlayerHealthType(self, player, healthType, numHearts)
+    repeat
+        local ____switch3 = healthType
+        local ____cond3 = ____switch3 == HealthType.RED
+        if ____cond3 then
+            do
+                player:AddHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.SOUL
+        if ____cond3 then
+            do
+                player:AddSoulHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.ETERNAL
+        if ____cond3 then
+            do
+                player:AddEternalHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.BLACK
+        if ____cond3 then
+            do
+                player:AddBlackHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.GOLDEN
+        if ____cond3 then
+            do
+                player:AddGoldenHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.BONE
+        if ____cond3 then
+            do
+                player:AddBoneHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.ROTTEN
+        if ____cond3 then
+            do
+                player:AddRottenHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.BROKEN
+        if ____cond3 then
+            do
+                player:AddBrokenHearts(numHearts)
+                break
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == HealthType.MAX_HEARTS
+        if ____cond3 then
+            do
+                player:AddMaxHearts(numHearts, false)
+                break
+            end
+        end
+    until true
+end
+--- Helper function to get an object representing the player's health. You can use this in
+-- combination with the `setPlayerHealth` function to restore the player's health back to a certain
+-- configuration at a later time.
+-- 
+-- This is based on the `REVEL.StoreHealth` function in the Revelations mod.
+function ____exports.getPlayerHealth(self, player)
+    local character = player:GetPlayerType()
+    local soulHeartTypes = {}
+    local maxHearts = player:GetMaxHearts()
+    local hearts = getPlayerHearts(nil, player)
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    local goldenHearts = player:GetGoldenHearts()
+    local eternalHearts = player:GetEternalHearts()
+    local rottenHearts = player:GetRottenHearts()
+    local brokenHearts = player:GetBrokenHearts()
+    local subPlayer = player:GetSubPlayer()
+    local soulCharges = player:GetEffectiveSoulCharge()
+    local bloodCharges = player:GetEffectiveBloodCharge()
+    if character == PlayerType.THE_FORGOTTEN and subPlayer ~= nil then
+        maxHearts = boneHearts * 2
+        boneHearts = 0
+        soulHearts = subPlayer:GetSoulHearts()
+    elseif character == PlayerType.THE_SOUL and subPlayer ~= nil then
+        maxHearts = subPlayer:GetBoneHearts() * 2
+        hearts = subPlayer:GetHearts()
+    end
+    local extraHearts = math.ceil(soulHearts / 2) + boneHearts
+    local currentSoulHeart = 0
+    do
+        local i = 0
+        while i < extraHearts do
+            local isBoneHeart = player:IsBoneHeart(i)
+            if character == PlayerType.THE_FORGOTTEN and subPlayer ~= nil then
+                isBoneHeart = subPlayer:IsBoneHeart(i)
+            end
+            if isBoneHeart then
+                soulHeartTypes[#soulHeartTypes + 1] = HeartSubType.BONE
+            else
+                local isBlackHeart = player:IsBlackHeart(currentSoulHeart + 1)
+                if character == PlayerType.THE_FORGOTTEN and subPlayer ~= nil then
+                    isBlackHeart = subPlayer:IsBlackHeart(currentSoulHeart + 1)
+                end
+                if isBlackHeart then
+                    soulHeartTypes[#soulHeartTypes + 1] = HeartSubType.BLACK
+                else
+                    soulHeartTypes[#soulHeartTypes + 1] = HeartSubType.SOUL
+                end
+                currentSoulHeart = currentSoulHeart + 2
+            end
+            i = i + 1
+        end
+    end
+    return {
+        maxHearts = maxHearts,
+        hearts = hearts,
+        eternalHearts = eternalHearts,
+        soulHearts = soulHearts,
+        boneHearts = boneHearts,
+        goldenHearts = goldenHearts,
+        rottenHearts = rottenHearts,
+        brokenHearts = brokenHearts,
+        soulCharges = soulCharges,
+        bloodCharges = bloodCharges,
+        soulHeartTypes = soulHeartTypes
+    }
+end
+function ____exports.getPlayerHealthType(self, player, healthType)
+    repeat
+        local ____switch24 = healthType
+        local ____cond24 = ____switch24 == HealthType.RED
+        if ____cond24 then
+            do
+                return getPlayerHearts(nil, player)
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.SOUL
+        if ____cond24 then
+            do
+                return getPlayerSoulHearts(nil, player)
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.ETERNAL
+        if ____cond24 then
+            do
+                return player:GetEternalHearts()
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.BLACK
+        if ____cond24 then
+            do
+                return getPlayerBlackHearts(nil, player)
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.GOLDEN
+        if ____cond24 then
+            do
+                return player:GetGoldenHearts()
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.BONE
+        if ____cond24 then
+            do
+                return player:GetBoneHearts()
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.ROTTEN
+        if ____cond24 then
+            do
+                return player:GetRottenHearts()
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.BROKEN
+        if ____cond24 then
+            do
+                return player:GetBrokenHearts()
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == HealthType.MAX_HEARTS
+        if ____cond24 then
+            do
+                return player:GetMaxHearts()
+            end
+        end
+    until true
+end
+--- Returns a `PlayerHealth` object with all 0s.
+function ____exports.newPlayerHealth(self)
+    return {
+        maxHearts = 0,
+        hearts = 0,
+        eternalHearts = 0,
+        soulHearts = 0,
+        boneHearts = 0,
+        goldenHearts = 0,
+        rottenHearts = 0,
+        brokenHearts = 0,
+        soulCharges = 0,
+        bloodCharges = 0,
+        soulHeartTypes = {}
+    }
+end
+function ____exports.playerConvertBlackHeartsToSoulHearts(self, player)
+    local playerHealth = ____exports.getPlayerHealth(nil, player)
+    ____exports.removeAllPlayerHealth(nil, player)
+    playerHealth.soulHeartTypes = __TS__ArrayMap(
+        playerHealth.soulHeartTypes,
+        function(____, soulHeartType) return soulHeartType == HeartSubType.BLACK and HeartSubType.SOUL or soulHeartType end
+    )
+    ____exports.setPlayerHealth(nil, player, playerHealth)
+end
+function ____exports.playerConvertSoulHeartsToBlackHearts(self, player)
+    local playerHealth = ____exports.getPlayerHealth(nil, player)
+    ____exports.removeAllPlayerHealth(nil, player)
+    playerHealth.soulHeartTypes = __TS__ArrayMap(
+        playerHealth.soulHeartTypes,
+        function(____, soulHeartType) return soulHeartType == HeartSubType.SOUL and HeartSubType.BLACK or soulHeartType end
+    )
+    ____exports.setPlayerHealth(nil, player, playerHealth)
+end
+--- Helper function to see if the player is out of health.
+-- 
+-- Specifically, this function will return false if the player has 0 red hearts, 0 soul/black
+-- hearts, and 0 bone hearts.
+function ____exports.playerHasHealthLeft(self, player)
+    local hearts = player:GetHearts()
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    return hearts > 0 or soulHearts > 0 or boneHearts > 0
+end
+return ____exports