isaacscript-common 13.3.4 → 14.1.0

package/dist/src/functions/charge.lua

@@ -27,13 +27,16 @@ local getRoomShapeCharges = ____roomShape.getRoomShapeCharges
 -- - AAA Battery
 -- 
 -- @param player The player to grant the charges to.
--- @param activeSlot The slot to grant the charges to.
+-- @param activeSlot Optional. The slot to grant the charges to. Default is `ActiveSlot.PRIMARY`.
 -- @param numCharges Optional. The amount of charges to grant. Default is 1.
 -- @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
 -- @returns The amount of charges that were actually granted. For example, if the active item was
 -- only one away from a full charge, but the `numCharges` provided to this function was 2,
 -- then this function would return 1.
 function ____exports.addCharge(self, player, activeSlot, numCharges, playSoundEffect)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
     if numCharges == nil then
         numCharges = 1
     end
@@ -66,12 +69,16 @@ end
 -- - Not charging active items with `chargetype="special"`
 -- 
 -- @param player The player to grant the charges to.
--- @param activeSlot The active item slot to grant the charges to.
+-- @param activeSlot Optional. The active item slot to grant the charges to. Default is
+-- `ActiveSlot.PRIMARY`.
 -- @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
 -- room for the purposes of calculating how much charge to grant. Default
 -- is true.
 -- @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
 function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, bigRoomDoubleCharge, playSoundEffect)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
     if bigRoomDoubleCharge == nil then
         bigRoomDoubleCharge = true
     end
@@ -115,7 +122,13 @@ end
 -- This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this
 -- function will return 10 (because there are 4 charges remaining on the base charge and 6 charges
 -- remaining on The Battery charge).
+-- 
+-- @param player The player to get the charges from.
+-- @param activeSlot Optional. The slot to get the charges from. Default is `ActiveSlot.PRIMARY`.
 function ____exports.getChargesAwayFromMax(self, player, activeSlot)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
     local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
     local activeItem = player:GetActiveItem(activeSlot)
     local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
@@ -126,12 +139,27 @@ end
 --- Helper function to get the combined normal charge and the battery charge for the player's active
 -- item. This is useful because you have to add these two values together when setting the active
 -- charge.
+-- 
+-- @param player The player to get the charges from.
+-- @param activeSlot Optional. The slot to get the charges from. Default is `ActiveSlot.PRIMARY`.
 function ____exports.getTotalCharge(self, player, activeSlot)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
     local activeCharge = player:GetActiveCharge(activeSlot)
     local batteryCharge = player:GetBatteryCharge(activeSlot)
     return activeCharge + batteryCharge
 end
+--- Helper function to play the appropriate sound effect for a player after getting one or more
+-- charges on their active item. (There is a different sound depending on whether the item is fully
+-- charged or not.)
+-- 
+-- @param player The player to play the sound effect for.
+-- @param activeSlot Optional. The slot that was just charged. Default is `ActiveSlot.PRIMARY`.
 function ____exports.playChargeSoundEffect(self, player, activeSlot)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
     for ____, soundEffect in ipairs({SoundEffect.BATTERY_CHARGE, SoundEffect.BEEP}) do
         sfxManager:Stop(soundEffect)
     end
@@ -199,7 +227,15 @@ function ____exports.addRoomClearCharges(self, bigRoomDoubleCharge)
         ____exports.addRoomClearCharge(nil, player, bigRoomDoubleCharge)
     end
 end
+--- Helper function to check if a player's active item is "double charged", meaning that it has both
+-- a full normal charge and a full charge from The Battery.
+-- 
+-- @param player The player to check.
+-- @param activeSlot Optional. The slot to check. Default is `ActiveSlot.PRIMARY`.
 function ____exports.isActiveSlotDoubleCharged(self, player, activeSlot)
+    if activeSlot == nil then
+        activeSlot = ActiveSlot.PRIMARY
+    end
     local collectibleType = player:GetActiveItem(activeSlot)
     local batteryCharge = player:GetBatteryCharge(activeSlot)
     local maxCharges = getCollectibleMaxCharges(nil, collectibleType)

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

@@ -4,11 +4,17 @@ import { ChargeBarSprites } from "../interfaces/ChargeBarSprites";
 /**
  * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
  * helper function.
+ *
+ * Note that this is for the vertical charge bar that represents the number of charges that an
+ * active item has, not the circular charge bar that shows e.g. the charge rate of Brimstone.
  */
 export declare function newChargeBarSprites(maxCharges: int): ChargeBarSprites;
 /**
  * Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
  * function to initialize the sprites, and then call this function on every render frame.
+ *
+ * Note that this is for the vertical charge bar that represents the number of charges that an
+ * active item has, not the circular charge bar that shows e.g. the charge rate of Brimstone.
  */
 export declare function renderChargeBar(sprites: ChargeBarSprites, position: Vector, normalCharges: int, batteryCharges: int): void;
 //# sourceMappingURL=chargeBar.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"chargeBar.d.ts","sourceRoot":"","sources":["../../../src/functions/chargeBar.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAIlE;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,GAAG,GAAG,gBAAgB,CAwBrE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,GAAG,EAClB,cAAc,EAAE,GAAG,GAClB,IAAI,CAgBN"}
+{"version":3,"file":"chargeBar.d.ts","sourceRoot":"","sources":["../../../src/functions/chargeBar.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAIlE;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,GAAG,GAAG,gBAAgB,CAwBrE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,GAAG,EAClB,cAAc,EAAE,GAAG,GAClB,IAAI,CAgBN"}

package/dist/src/functions/chargeBar.lua

@@ -8,6 +8,9 @@ end
 local CHARGE_BAR_ANM2 = "gfx/ui/ui_chargebar.anm2"
 --- Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
 -- helper function.
+-- 
+-- Note that this is for the vertical charge bar that represents the number of charges that an
+-- active item has, not the circular charge bar that shows e.g. the charge rate of Brimstone.
 function ____exports.newChargeBarSprites(self, maxCharges)
     local back = Sprite()
     back:Load(CHARGE_BAR_ANM2, true)
@@ -34,6 +37,9 @@ function ____exports.newChargeBarSprites(self, maxCharges)
 end
 --- Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
 -- function to initialize the sprites, and then call this function on every render frame.
+-- 
+-- Note that this is for the vertical charge bar that represents the number of charges that an
+-- active item has, not the circular charge bar that shows e.g. the charge rate of Brimstone.
 function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
     sprites.back:Render(position)
     local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)

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

@@ -0,0 +1,19 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { ModFeature } from "../classes/ModFeature";
+import { ModUpgraded } from "../classes/ModUpgraded";
+import { ModCallbackCustom2 } from "../enums/ModCallbackCustom2";
+import { AddCallbackParametersCustom2 } from "../interfaces/private/AddCallbackParametersCustom2";
+import { AllButFirst } from "../types/AllButFirst";
+/**
+ * A decorator function that signifies that the decorated class method should be automatically
+ * registered with `Mod.AddCallback`.
+ */
+export declare function Callback<T extends ModCallback>(modCallback: T, ...optionalArgs: AllButFirst<AddCallbackParameters[T]>): <Class extends ModFeature, Fn extends AddCallbackParameters[T][0]>(target: Class, propertyKey: string, _descriptor: TypedPropertyDescriptor<Fn>) => void;
+/**
+ * A decorator function that signifies that the decorated class method should be automatically
+ * registered with `ModUpgraded.AddCallbackCustom`.
+ */
+export declare function CallbackCustom<T extends ModCallbackCustom2>(modCallbackCustom: T, ...optionalArgs: AllButFirst<AddCallbackParametersCustom2[T]>): <Class extends {
+    mod: ModUpgraded;
+}>(target: Class, propertyKey: string) => void;
+//# sourceMappingURL=decorators.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../src/functions/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,4BAA4B,EAAE,MAAM,oDAAoD,CAAC;AAClG,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,WAAW,EAC5C,WAAW,EAAE,CAAC,EACd,GAAG,YAAY,EAAE,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,kGAIvC,MAAM,+CAElB,IAAI,CAMR;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,kBAAkB,EACzD,iBAAiB,EAAE,CAAC,EACpB,GAAG,YAAY,EAAE,WAAW,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;SAEhC,WAAW;+BAEzB,MAAM,KAClB,IAAI,CAMR"}

package/dist/src/functions/decorators.lua

@@ -0,0 +1,32 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Spread = ____lualib.__TS__Spread
+local ____exports = {}
+--- A decorator function that signifies that the decorated class method should be automatically
+-- registered with `Mod.AddCallback`.
+function ____exports.Callback(self, modCallback, ...)
+    local optionalArgs = {...}
+    return function(____, target, propertyKey, _descriptor)
+        local methodName = propertyKey
+        local method = target[methodName]
+        target.mod:AddCallback(
+            modCallback,
+            method,
+            __TS__Spread(optionalArgs)
+        )
+    end
+end
+--- A decorator function that signifies that the decorated class method should be automatically
+-- registered with `ModUpgraded.AddCallbackCustom`.
+function ____exports.CallbackCustom(self, modCallbackCustom, ...)
+    local optionalArgs = {...}
+    return function(____, target, propertyKey)
+        local methodName = propertyKey
+        local method = target[methodName]
+        target.mod:AddCallbackCustom2(
+            modCallbackCustom,
+            method,
+            __TS__Spread(optionalArgs)
+        )
+    end
+end
+return ____exports

package/dist/src/functions/flying.lua

@@ -16,11 +16,11 @@ local copySet = ____set.copySet
 local deleteSetsFromSet = ____set.deleteSetsFromSet
 local FLYING_CHARACTERS = __TS__New(Set, {
     PlayerType.AZAZEL,
-    PlayerType.THE_LOST,
-    PlayerType.THE_SOUL,
-    PlayerType.THE_LOST_B,
+    PlayerType.LOST,
+    PlayerType.SOUL,
+    PlayerType.LOST_B,
     PlayerType.JACOB_2_B,
-    PlayerType.THE_SOUL_B
+    PlayerType.SOUL_B
 })
 local FLYING_TRINKETS = __TS__New(Set, {TrinketType.BAT_WING, TrinketType.AZAZELS_STUMP})
 local FLYING_NULL_ITEMS = {NullItemID.REVERSE_SUN, NullItemID.SPIRIT_SHACKLES_SOUL, NullItemID.LOST_CURSE}

package/dist/src/functions/gridEntities.lua

@@ -169,11 +169,11 @@ function ____exports.convertXMLGridEntityType(self, gridEntityXMLType, gridEntit
         error("Failed to find an entry in the grid entity map for XML entity type: " .. tostring(gridEntityXMLType))
     end
     local gridEntityType = gridEntityArray[1]
-    local gridEntityVariant = gridEntityArray[2]
+    local variant = gridEntityArray[2]
     if gridEntityType == GridEntityType.SPIKES_ON_OFF or gridEntityType == GridEntityType.PRESSURE_PLATE or gridEntityType == GridEntityType.TELEPORTER then
-        gridEntityVariant = gridEntityXMLVariant
+        variant = gridEntityXMLVariant
     end
-    return {gridEntityType, gridEntityVariant}
+    return {gridEntityType, variant}
 end
 --- Gets the entities that have a hitbox that overlaps with any part of the square that the grid
 -- entity is on.
@@ -322,8 +322,8 @@ end
 -- the actual collision for the entity is removed.
 function ____exports.isGridEntityBreakableByExplosion(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
-    local gridEntityVariant = gridEntity:GetVariant()
-    local gridEntityTypeVariant = (tostring(gridEntityType) .. ".") .. tostring(gridEntityVariant)
+    local variant = gridEntity:GetVariant()
+    local gridEntityTypeVariant = (tostring(gridEntityType) .. ".") .. tostring(variant)
     return BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS:has(gridEntityType) or BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS:has(gridEntityTypeVariant)
 end
 --- Helper function to detect whether a given Void Portal is one that randomly spawns after a boss is

package/dist/src/functions/gridEntitiesSpecific.lua

@@ -132,8 +132,8 @@ function ____exports.getPits(self, pitVariant)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         local pit = gridEntity:ToPit()
         if pit ~= nil then
-            local gridEntityVariant = pit:GetVariant()
-            if asNumber(nil, pitVariant) == -1 or pitVariant == gridEntityVariant then
+            local thisPitVariant = pit:GetVariant()
+            if asNumber(nil, pitVariant) == -1 or pitVariant == thisPitVariant then
                 pits[#pits + 1] = pit
             end
         end
@@ -152,8 +152,8 @@ function ____exports.getPoops(self, poopVariant)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         local poop = gridEntity:ToPoop()
         if poop ~= nil then
-            local gridEntityVariant = poop:GetVariant()
-            if asNumber(nil, poopVariant) == -1 or poopVariant == gridEntityVariant then
+            local thisPoopVariant = poop:GetVariant()
+            if asNumber(nil, poopVariant) == -1 or poopVariant == thisPoopVariant then
                 poops[#poops + 1] = poop
             end
         end
@@ -172,8 +172,8 @@ function ____exports.getPressurePlates(self, pressurePlateVariant)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         local pressurePlate = gridEntity:ToPressurePlate()
         if pressurePlate ~= nil then
-            local gridEntityVariant = pressurePlate:GetVariant()
-            if asNumber(nil, pressurePlateVariant) == -1 or pressurePlateVariant == gridEntityVariant then
+            local thisPressurePlateVariant = pressurePlate:GetVariant()
+            if asNumber(nil, pressurePlateVariant) == -1 or pressurePlateVariant == thisPressurePlateVariant then
                 pressurePlates[#pressurePlates + 1] = pressurePlate
             end
         end
@@ -194,8 +194,8 @@ function ____exports.getRocks(self, variant)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         local rock = gridEntity:ToRock()
         if rock ~= nil then
-            local gridEntityVariant = rock:GetVariant()
-            if variant == -1 or variant == gridEntityVariant then
+            local thisVariant = rock:GetVariant()
+            if variant == -1 or variant == thisVariant then
                 rocks[#rocks + 1] = rock
             end
         end
@@ -211,8 +211,8 @@ function ____exports.getSpikes(self, variant)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         local spike = gridEntity:ToSpikes()
         if spike ~= nil then
-            local gridEntityVariant = spike:GetVariant()
-            if variant == -1 or variant == gridEntityVariant then
+            local thisVariant = spike:GetVariant()
+            if variant == -1 or variant == thisVariant then
                 spikes[#spikes + 1] = spike
             end
         end
@@ -228,8 +228,8 @@ function ____exports.getTNT(self, variant)
     for ____, gridEntity in ipairs(getGridEntities(nil)) do
         local tnt = gridEntity:ToTNT()
         if tnt ~= nil then
-            local gridEntityVariant = tnt:GetVariant()
-            if variant == -1 or variant == gridEntityVariant then
+            local thisVariant = tnt:GetVariant()
+            if variant == -1 or variant == thisVariant then
                 tntArray[#tntArray + 1] = tnt
             end
         end

package/dist/src/functions/itemPool.lua

@@ -36,7 +36,7 @@ function ____exports.isCollectibleInItemPool(self, collectibleType, itemPoolType
     if collectibleType == COLLECTIBLE_TYPE_THAT_IS_NOT_IN_ANY_POOLS then
         return false
     end
-    local taintedLosts = getPlayersOfType(nil, PlayerType.THE_LOST_B)
+    local taintedLosts = getPlayersOfType(nil, PlayerType.LOST_B)
     local isOffensive = collectibleHasTag(nil, collectibleType, ItemConfigTag.OFFENSIVE)
     local changedPlayerTypes = false
     if not isOffensive then
@@ -60,7 +60,7 @@ function ____exports.isCollectibleInItemPool(self, collectibleType, itemPoolType
     restoreItemsAndTrinketsThatAffectItemPools(nil, removedItemsMap, removedTrinketsMap)
     if changedPlayerTypes then
         for ____, player in ipairs(taintedLosts) do
-            player:ChangePlayerType(PlayerType.THE_LOST_B)
+            player:ChangePlayerType(PlayerType.LOST_B)
         end
     end
     return collectibleUnlocked

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

@@ -3,6 +3,8 @@ import { DisplayFlag } from "isaac-typescript-definitions";
  * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
  * or not it is visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param roomGridIndex Set to undefined to use the current room index.
  * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
  * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
@@ -34,6 +36,8 @@ export declare function getRoomDisplayFlags(roomGridIndex?: int): BitFlags<Displ
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
  * the changes will be immediately visible.
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
  */
 export declare function setDisplayFlags(displayFlagsMap: Map<int, BitFlags<DisplayFlag>>): void;

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

@@ -1 +1 @@
-{"version":3,"file":"minimap.d.ts","sourceRoot":"","sources":["../../../src/functions/minimap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,8BAA8B,CAAC;AAM5E;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,WAAW,EAAE,WAAW,EACxB,gBAAgB,UAAO,GACtB,IAAI,CAwBN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAS7C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAYtE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,GAClB,QAAQ,CAAC,WAAW,CAAC,CAGvB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAiBN;AAED,gDAAgD;AAChD,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAEN;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,EACnC,gBAAgB,UAAO,GACtB,IAAI,CAkBN;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,gBAAgB,UAAO,GACtB,IAAI,CAEN"}
+{"version":3,"file":"minimap.d.ts","sourceRoot":"","sources":["../../../src/functions/minimap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,8BAA8B,CAAC;AAM5E;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,WAAW,EAAE,WAAW,EACxB,gBAAgB,UAAO,GACtB,IAAI,CAwBN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAS7C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAYtE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,GAClB,QAAQ,CAAC,WAAW,CAAC,CAGvB;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAiBN;AAED,gDAAgD;AAChD,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAEN;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,EACnC,gBAAgB,UAAO,GACtB,IAAI,CAkBN;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,gBAAgB,UAAO,GACtB,IAAI,CAEN"}

package/dist/src/functions/minimap.lua

@@ -46,6 +46,8 @@ end
 --- Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
 -- or not it is visible and so on).
 -- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
+-- 
 -- @param roomGridIndex Set to undefined to use the current room index.
 -- @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
 -- @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
@@ -105,6 +107,8 @@ end
 -- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
 -- the changes will be immediately visible.
 -- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
+-- 
 -- @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
 function ____exports.setDisplayFlags(self, displayFlagsMap)
     local level = game:GetLevel()

package/dist/src/functions/playerHealth.lua

@@ -91,7 +91,7 @@ function ____exports.removeAllPlayerHealth(self, player)
     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
+    if isCharacter(nil, player, PlayerType.SOUL) then
         local forgotten = player:GetSubPlayer()
         if forgotten ~= nil then
             local forgottenBoneHearts = forgotten:GetBoneHearts()
@@ -119,7 +119,7 @@ function ____exports.setPlayerHealth(self, player, playerHealth)
             end
         end
     end
-    if character == PlayerType.THE_SOUL and subPlayer ~= nil then
+    if character == PlayerType.SOUL and subPlayer ~= nil then
         subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
     else
         player:AddMaxHearts(playerHealth.maxHearts, false)
@@ -345,11 +345,11 @@ function ____exports.getPlayerHealth(self, player)
     local subPlayer = player:GetSubPlayer()
     local soulCharges = player:GetEffectiveSoulCharge()
     local bloodCharges = player:GetEffectiveBloodCharge()
-    if character == PlayerType.THE_FORGOTTEN and subPlayer ~= nil then
+    if character == PlayerType.FORGOTTEN and subPlayer ~= nil then
         maxHearts = boneHearts * 2
         boneHearts = 0
         soulHearts = subPlayer:GetSoulHearts()
-    elseif character == PlayerType.THE_SOUL and subPlayer ~= nil then
+    elseif character == PlayerType.SOUL and subPlayer ~= nil then
         maxHearts = subPlayer:GetBoneHearts() * 2
         hearts = subPlayer:GetHearts()
     end
@@ -360,14 +360,14 @@ function ____exports.getPlayerHealth(self, player)
         local i = 0
         while i < extraHearts do
             local isBoneHeart = player:IsBoneHeart(i)
-            if character == PlayerType.THE_FORGOTTEN and subPlayer ~= nil then
+            if character == PlayerType.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
+                if character == PlayerType.FORGOTTEN and subPlayer ~= nil then
                     isBlackHeart = subPlayer:IsBlackHeart(currentSoulHeart + 1)
                 end
                 if isBlackHeart then

package/dist/src/functions/playerIndex.lua

@@ -76,7 +76,7 @@ function ____exports.getPlayerIndex(self, player, differentiateForgottenAndSoul)
 end
 function getPlayerIndexCollectibleType(self, player, differentiateForgottenAndSoul)
     local character = player:GetPlayerType()
-    if character == PlayerType.THE_SOUL then
+    if character == PlayerType.SOUL then
         return differentiateForgottenAndSoul and CollectibleType.INNER_EYE or DEFAULT_COLLECTIBLE_TYPE
     end
     return DEFAULT_COLLECTIBLE_TYPE
@@ -131,7 +131,7 @@ function ____exports.isChildPlayer(self, player)
     return player.Parent ~= nil
 end
 DEFAULT_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION
-EXCLUDED_CHARACTERS = __TS__New(Set, {PlayerType.ESAU, PlayerType.THE_SOUL_B})
+EXCLUDED_CHARACTERS = __TS__New(Set, {PlayerType.ESAU, PlayerType.SOUL_B})
 --- Helper function to get all of the other players in the room besides the one provided. (This
 -- includes "child" players.)
 function ____exports.getOtherPlayers(self, player)

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

@@ -81,6 +81,11 @@ export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<Colle
  * a last resort, it will attempt to use the `Entity.ToPlayer` method on the entity itself.
  */
 export declare function getPlayerFromEntity(entity: Entity): EntityPlayer | undefined;
+/**
+ * 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.
+ */
+export declare function getPlayerFromPtr(entityPtr: EntityPtr): EntityPlayer | undefined;
 /**
  * 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
@@ -153,7 +158,13 @@ export declare function hasLostCurse(player: EntityPlayer): boolean;
  * items. (Only Tainted Forgotten can pick up items.)
  */
 export declare function hasOpenActiveItemSlot(player: EntityPlayer): boolean;
-export declare function isActiveSlotEmpty(player: EntityPlayer, activeSlot: ActiveSlot): boolean;
+/**
+ * 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`.
+ */
+export declare function isActiveSlotEmpty(player: EntityPlayer, activeSlot?: ActiveSlot): boolean;
 /**
  * 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
@@ -250,12 +261,12 @@ export declare function removeTrinketCostume(player: EntityPlayer, trinketType:
  *
  * @param player The player to give the item to.
  * @param collectibleType The collectible type of the item to give.
- * @param activeSlot The slot to set.
+ * @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 or not to remove the item from pools. Default is false.
  */
-export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot: ActiveSlot, charge?: int, keepInPools?: boolean): void;
+export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot?: ActiveSlot, charge?: int, keepInPools?: boolean): void;
 /**
  * Helper function to blindfold the player by using a hack with the challenge variable.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"players.d.ts","sourceRoot":"","sources":["../../../src/functions/players.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,eAAe,EACf,eAAe,EAGf,UAAU,EAEV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAetC,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,kBAAkB,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CASjE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,UAAU,GAAG,SAAS,CAMxB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,kBAAkB,EAAE,YAAY,GAAG,KAAK,GACvC,KAAK,CAMP;AAED,+FAA+F;AAC/F,wBAAgB,aAAa,IAAI,UAAU,EAAE,CAG5C;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,CAiB/D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,EAAE,CAatE;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,YAAY,CAS7C;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAe9C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,KAAK,GACd,YAAY,GAAG,SAAS,CAK1B;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,GAAG,CASL;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAc3B;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CA0B5E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAO1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAQnE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,CAO5E;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,IAAI,YAAY,EAAE,CAKrD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,YAAY,EAAE,CAOhB;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,eAAe,GAC/B,YAAY,EAAE,CAGhB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,YAAY,EAAE,WAAW,EAAE,GAC7B,YAAY,EAAE,CAKhB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,eAAe,GAC/B,GAAG,CASL;AAED,6FAA6F;AAC7F,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG1D;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAiBnE;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,YAAY,EACpB,GAAG,UAAU,EAAE,UAAU,EAAE,GAC1B,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAQhE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIpD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE3D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAI3D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAItD;AAED,+EAA+E;AAC/E,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMpD;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE5D;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMvD;AAaD,8FAA8F;AAC9F,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAM9D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAIN;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAa/D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAalE;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,EAChC,UAAU,EAAE,UAAU,EACtB,MAAM,CAAC,EAAE,GAAG,EACZ,WAAW,UAAQ,GAClB,IAAI,CA6DN;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,EAChB,aAAa,UAAO,GACnB,IAAI,CAsBN;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAEN"}
+{"version":3,"file":"players.d.ts","sourceRoot":"","sources":["../../../src/functions/players.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,eAAe,EACf,eAAe,EAGf,UAAU,EAEV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAetC,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,kBAAkB,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CASjE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,UAAU,GAAG,SAAS,CAMxB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,kBAAkB,EAAE,YAAY,GAAG,KAAK,GACvC,KAAK,CAMP;AAED,+FAA+F;AAC/F,wBAAgB,aAAa,IAAI,UAAU,EAAE,CAG5C;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,CAiB/D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,EAAE,CAatE;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,YAAY,CAS7C;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAe9C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,KAAK,GACd,YAAY,GAAG,SAAS,CAK1B;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,GAAG,CASL;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAc3B;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CA0B5E;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,SAAS,GACnB,YAAY,GAAG,SAAS,CAO1B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAO1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAQnE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,CAO5E;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,IAAI,YAAY,EAAE,CAKrD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,YAAY,EAAE,CAOhB;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,eAAe,GAC/B,YAAY,EAAE,CAGhB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,YAAY,EAAE,WAAW,EAAE,GAC7B,YAAY,EAAE,CAKhB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,eAAe,GAC/B,GAAG,CASL;AAED,6FAA6F;AAC7F,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG1D;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;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,YAAY,EACpB,GAAG,UAAU,EAAE,UAAU,EAAE,GAC1B,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAQhE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIpD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE3D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAI3D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAItD;AAED,+EAA+E;AAC/E,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIpD;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE5D;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMvD;AAaD,8FAA8F;AAC9F,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAM9D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAIN;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAa/D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAalE;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;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;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,EAChB,aAAa,UAAO,GACnB,IAAI,CAsBN;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAEN"}

package/dist/src/functions/players.lua

@@ -272,6 +272,15 @@ function ____exports.getPlayerFromEntity(self, entity)
     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.
@@ -389,7 +398,7 @@ end
 -- 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 ____exports.isCharacter(nil, player, PlayerType.THE_SOUL_B) then
+    if ____exports.isCharacter(nil, player, PlayerType.SOUL_B) then
         return false
     end
     local activeItemPrimary = player:GetActiveItem(ActiveSlot.PRIMARY)
@@ -400,7 +409,14 @@ function ____exports.hasOpenActiveItemSlot(self, player)
     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
@@ -445,7 +461,7 @@ 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.THE_LOST or character == PlayerType.THE_LOST_B
+    return character == PlayerType.LOST or character == PlayerType.LOST_B
 end
 --- Helper function for detecting if a player is one of the Tainted characters.
 function ____exports.isTainted(self, player)
@@ -491,7 +507,7 @@ function ____exports.removeAllActiveItems(self, player)
         do
             local collectibleType = player:GetActiveItem(activeSlot)
             if collectibleType == CollectibleType.NULL then
-                goto __continue90
+                goto __continue92
             end
             local hasCollectible
             repeat
@@ -501,7 +517,7 @@ function ____exports.removeAllActiveItems(self, player)
                 end
             until not hasCollectible
         end
-        ::__continue90::
+        ::__continue92::
     end
 end
 --- Helper function to remove all of the held trinkets from a player.
@@ -513,7 +529,7 @@ function ____exports.removeAllPlayerTrinkets(self, player)
         do
             local trinketType = player:GetTrinket(trinketSlot)
             if trinketType == TrinketType.NULL then
-                goto __continue95
+                goto __continue97
             end
             local hasTrinket
             repeat
@@ -523,7 +539,7 @@ function ____exports.removeAllPlayerTrinkets(self, player)
                 end
             until not hasTrinket
         end
-        ::__continue95::
+        ::__continue97::
     end
 end
 --- Helper function to remove a collectible costume from a player. Use this helper function to avoid
@@ -567,11 +583,14 @@ end
 -- 
 -- @param player The player to give the item to.
 -- @param collectibleType The collectible type of the item to give.
--- @param activeSlot The slot to set.
+-- @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 or not 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
@@ -586,9 +605,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch108 = activeSlot
-        local ____cond108 = ____switch108 == ActiveSlot.PRIMARY
-        if ____cond108 then
+        local ____switch110 = activeSlot
+        local ____cond110 = ____switch110 == ActiveSlot.PRIMARY
+        if ____cond110 then
             do
                 if primaryCollectibleType ~= CollectibleType.NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -597,8 +616,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond108 = ____cond108 or ____switch108 == ActiveSlot.SECONDARY
-        if ____cond108 then
+        ____cond110 = ____cond110 or ____switch110 == ActiveSlot.SECONDARY
+        if ____cond110 then
             do
                 if primaryCollectibleType ~= CollectibleType.NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -613,16 +632,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond108 = ____cond108 or ____switch108 == ActiveSlot.POCKET
-        if ____cond108 then
+        ____cond110 = ____cond110 or ____switch110 == ActiveSlot.POCKET
+        if ____cond110 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond108 = ____cond108 or ____switch108 == ActiveSlot.POCKET_SINGLE_USE
-        if ____cond108 then
+        ____cond110 = ____cond110 or ____switch110 == ActiveSlot.POCKET_SINGLE_USE
+        if ____cond110 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break