isaacscript-common 3.0.0 → 3.2.0

package/functions/entitySpecific.d.ts

@@ -138,18 +138,18 @@ export declare function npcFireProjectiles(npc: EntityNPC, position: Vector, vel
  * @param bombVariant Optional. If specified, will only remove bombs that match this variant.
  * @param subType Optional. If specified, will only remove bombs that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of bombs.
- * @returns True if one or more bombs were removed, false otherwise.
+ * @returns An array of the bombs that were removed.
  */
-export declare function removeAllBombs(bombVariant?: BombVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllBombs(bombVariant?: BombVariant, subType?: int, cap?: int): EntityBomb[];
 /**
  * Helper function to remove all of the effects in the room.
  *
  * @param effectVariant Optional. If specified, will only remove effects that match this variant.
  * @param subType Optional. If specified, will only remove effects that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of effects.
- * @returns True if one or more effects were removed, false otherwise.
+ * @returns An array of the effects that were removed.
  */
-export declare function removeAllEffects(effectVariant?: EffectVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllEffects(effectVariant?: EffectVariant, subType?: int, cap?: int): EntityEffect[];
 /**
  * Helper function to remove all of the familiars in the room.
  *
@@ -157,43 +157,43 @@ export declare function removeAllEffects(effectVariant?: EffectVariant, subType?
  *                        variant.
  * @param subType Optional. If specified, will only remove familiars that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of familiars.
- * @returns True if one or more familiars were removed, false otherwise.
+ * @returns An array of the familiars that were removed.
  */
-export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant, subType?: int, cap?: int): EntityFamiliar[];
 /**
  * Helper function to remove all of the `EntityType.KNIFE` in the room.
  *
  * @param knifeVariant Optional. If specified, will only remove knives that match this variant.
  * @param subType Optional. If specified, will only remove knives that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of knives.
- * @returns True if one or more knives were removed, false otherwise.
+ * @returns An array of the knives that were removed.
  */
-export declare function removeAllKnives(knifeVariant?: KnifeVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllKnives(knifeVariant?: KnifeVariant, subType?: int, cap?: int): EntityKnife[];
 /**
  * Helper function to remove all of the `EntityType.LASER` in the room.
  *
  * @param laserVariant Optional. If specified, will only remove lasers that match this variant.
  * @param subType Optional. If specified, will only remove lasers that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of lasers.
- * @returns True if one or more lasers were removed, false otherwise.
+ * @returns An array of the lasers that were removed.
  */
-export declare function removeAllLasers(laserVariant?: LaserVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllLasers(laserVariant?: LaserVariant, subType?: int, cap?: int): EntityLaser[];
 /**
  * Helper function to remove all NPCs in the room.
  *
  * @param cap Optional. If specified, will only remove the given amount of NPCs.
- * @returns True if one or more NPCs were removed, false otherwise.
+ * @returns An array of the NPCs that were removed.
  */
-export declare function removeAllNPCs(cap?: int): boolean;
+export declare function removeAllNPCs(cap?: int): EntityNPC[];
 /**
  * Helper function to remove all of the pickups in the room.
  *
  * @param pickupVariant Optional. If specified, will only remove pickups that match this variant.
  * @param subType Optional. If specified, will only remove pickups that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of pickups.
- * @returns True if one or more pickups were removed, false otherwise.
+ * @returns An array of the pickups that were removed.
  */
-export declare function removeAllPickups(pickupVariant?: PickupVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllPickups(pickupVariant?: PickupVariant, subType?: int, cap?: int): EntityPickup[];
 /**
  * Helper function to remove all of the `EntityType.PROJECTILE` in the room.
  *
@@ -201,27 +201,27 @@ export declare function removeAllPickups(pickupVariant?: PickupVariant, subType?
  *                          variant.
  * @param subType Optional. If specified, will only remove projectiles that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of projectiles.
- * @returns True if one or more projectiles were removed, false otherwise.
+ * @returns An array of the projectiles that were removed.
  */
-export declare function removeAllProjectiles(projectileVariant?: ProjectileVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllProjectiles(projectileVariant?: ProjectileVariant, subType?: int, cap?: int): EntityProjectile[];
 /**
  * Helper function to remove all of the `EntityType.SLOT` in the room.
  *
  * @param slotVariant Optional. If specified, will only remove slots that match this variant.
  * @param subType Optional. If specified, will only remove slots that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of slots.
- * @returns True if one or more slots were removed, false otherwise.
+ * @returns An array of the slots that were removed.
  */
-export declare function removeAllSlots(slotVariant?: SlotVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllSlots(slotVariant?: SlotVariant, subType?: int, cap?: int): Entity[];
 /**
  * Helper function to remove all of the `EntityType.TEAR` in the room.
  *
  * @param tearVariant Optional. If specified, will only remove tears that match this variant.
  * @param subType Optional. If specified, will only remove tears that match this sub-type.
  * @param cap Optional. If specified, will only remove the given amount of tears.
- * @returns True if one or more tears were removed, false otherwise.
+ * @returns An array of the tears that were removed.
  */
-export declare function removeAllTears(tearVariant?: TearVariant, subType?: int, cap?: int): boolean;
+export declare function removeAllTears(tearVariant?: TearVariant, subType?: int, cap?: int): EntityTear[];
 /** Helper function to spawn a `EntityType.BOMB` (4). */
 export declare function spawnBomb(bombVariant: BombVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
 /** Helper function to spawn a `EntityType.BOMB` (4) with a specific seed. */

package/functions/entitySpecific.lua

@@ -288,7 +288,7 @@ end
 -- @param bombVariant Optional. If specified, will only remove bombs that match this variant.
 -- @param subType Optional. If specified, will only remove bombs that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of bombs.
--- @returns True if one or more bombs were removed, false otherwise.
+-- @returns An array of the bombs that were removed.
 function ____exports.removeAllBombs(self, bombVariant, subType, cap)
     local bombs = ____exports.getBombs(nil, bombVariant, subType)
     return removeEntities(nil, bombs, cap)
@@ -298,7 +298,7 @@ end
 -- @param effectVariant Optional. If specified, will only remove effects that match this variant.
 -- @param subType Optional. If specified, will only remove effects that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of effects.
--- @returns True if one or more effects were removed, false otherwise.
+-- @returns An array of the effects that were removed.
 function ____exports.removeAllEffects(self, effectVariant, subType, cap)
     local effects = ____exports.getEffects(nil, effectVariant, subType)
     return removeEntities(nil, effects, cap)
@@ -309,7 +309,7 @@ end
 -- variant.
 -- @param subType Optional. If specified, will only remove familiars that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of familiars.
--- @returns True if one or more familiars were removed, false otherwise.
+-- @returns An array of the familiars that were removed.
 function ____exports.removeAllFamiliars(self, familiarVariant, subType, cap)
     local familiars = ____exports.getFamiliars(nil, familiarVariant, subType)
     return removeEntities(nil, familiars, cap)
@@ -319,7 +319,7 @@ end
 -- @param knifeVariant Optional. If specified, will only remove knives that match this variant.
 -- @param subType Optional. If specified, will only remove knives that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of knives.
--- @returns True if one or more knives were removed, false otherwise.
+-- @returns An array of the knives that were removed.
 function ____exports.removeAllKnives(self, knifeVariant, subType, cap)
     local knives = ____exports.getKnives(nil, knifeVariant, subType)
     return removeEntities(nil, knives, cap)
@@ -329,7 +329,7 @@ end
 -- @param laserVariant Optional. If specified, will only remove lasers that match this variant.
 -- @param subType Optional. If specified, will only remove lasers that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of lasers.
--- @returns True if one or more lasers were removed, false otherwise.
+-- @returns An array of the lasers that were removed.
 function ____exports.removeAllLasers(self, laserVariant, subType, cap)
     local lasers = ____exports.getLasers(nil, laserVariant, subType)
     return removeEntities(nil, lasers, cap)
@@ -337,7 +337,7 @@ end
 --- Helper function to remove all NPCs in the room.
 -- 
 -- @param cap Optional. If specified, will only remove the given amount of NPCs.
--- @returns True if one or more NPCs were removed, false otherwise.
+-- @returns An array of the NPCs that were removed.
 function ____exports.removeAllNPCs(self, cap)
     local npcs = ____exports.getNPCs(nil)
     return removeEntities(nil, npcs, cap)
@@ -347,7 +347,7 @@ end
 -- @param pickupVariant Optional. If specified, will only remove pickups that match this variant.
 -- @param subType Optional. If specified, will only remove pickups that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of pickups.
--- @returns True if one or more pickups were removed, false otherwise.
+-- @returns An array of the pickups that were removed.
 function ____exports.removeAllPickups(self, pickupVariant, subType, cap)
     local pickups = ____exports.getPickups(nil, pickupVariant, subType)
     return removeEntities(nil, pickups, cap)
@@ -358,7 +358,7 @@ end
 -- variant.
 -- @param subType Optional. If specified, will only remove projectiles that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of projectiles.
--- @returns True if one or more projectiles were removed, false otherwise.
+-- @returns An array of the projectiles that were removed.
 function ____exports.removeAllProjectiles(self, projectileVariant, subType, cap)
     local projectiles = ____exports.getProjectiles(nil, projectileVariant, subType)
     return removeEntities(nil, projectiles, cap)
@@ -368,7 +368,7 @@ end
 -- @param slotVariant Optional. If specified, will only remove slots that match this variant.
 -- @param subType Optional. If specified, will only remove slots that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of slots.
--- @returns True if one or more slots were removed, false otherwise.
+-- @returns An array of the slots that were removed.
 function ____exports.removeAllSlots(self, slotVariant, subType, cap)
     local slots = ____exports.getSlots(nil, slotVariant, subType)
     return removeEntities(nil, slots, cap)
@@ -378,7 +378,7 @@ end
 -- @param tearVariant Optional. If specified, will only remove tears that match this variant.
 -- @param subType Optional. If specified, will only remove tears that match this sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of tears.
--- @returns True if one or more tears were removed, false otherwise.
+-- @returns An array of the tears that were removed.
 function ____exports.removeAllTears(self, tearVariant, subType, cap)
     local tears = ____exports.getTears(nil, tearVariant, subType)
     return removeEntities(nil, tears, cap)

package/functions/enums.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
  * when you iterate over them, you will get both the names of the enums and the values of the enums,

package/functions/globals.lua

@@ -4,7 +4,6 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local ____exports = {}
-local twoDimensionalSort
 local ____debug = require("functions.debug")
 local isLuaDebugEnabled = ____debug.isLuaDebugEnabled
 local ____log = require("functions.log")
@@ -12,15 +11,8 @@ local log = ____log.log
 local ____set = require("functions.set")
 local addSetsToSet = ____set.addSetsToSet
 local copySet = ____set.copySet
-function twoDimensionalSort(self, a, b)
-    if a[1] == nil or b[1] == nil then
-        error("Failed to two-dimensional sort since the first element of the array was undefined.")
-    end
-    if a[1] == b[1] then
-        return 0
-    end
-    return a[1] < b[1] and -1 or 1
-end
+local ____utils = require("functions.utils")
+local twoDimensionalSort = ____utils.twoDimensionalSort
 local DEFAULT_GLOBALS = __TS__New(Set, {
     "ActionTriggers",
     "ActiveSlot",

package/functions/gridEntitySpecific.d.ts

@@ -1,4 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /** Helper function to get all of the `GridEntityPit` in the room. */
 export declare function getPits(): GridEntityPit[];
 /** Helper function to get all of the `GridEntityPoop` in the room. */

package/functions/isaacAPIClass.d.ts

@@ -1,14 +1,14 @@
 import { IsaacAPIClass } from "../types/private/IsaacAPIClass";
 /**
- * Helper function to get the type of a class from the Isaac API. This is contained within the
- * "__type" metatable key. In this context, the type of the class is equivalent to the name.
+ * Helper function to get the name of a class from the Isaac API. This is contained within the
+ * "__type" metatable key.
  *
- * For example, a `Vector` class is has a type of "Vector".
+ * For example, a `Vector` class is has a name of "Vector".
  *
  * Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
  * not exist.
  */
-export declare function getIsaacAPIClassType(object: unknown): string | undefined;
+export declare function getIsaacAPIClassName(object: unknown): string | undefined;
 /**
  * Helper function to check if something is an instantiated class from the Isaac API. (All classes
  * from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type" equal to the

package/functions/isaacAPIClass.lua

@@ -1,14 +1,14 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
---- Helper function to get the type of a class from the Isaac API. This is contained within the
--- "__type" metatable key. In this context, the type of the class is equivalent to the name.
+--- Helper function to get the name of a class from the Isaac API. This is contained within the
+-- "__type" metatable key.
 -- 
--- For example, a `Vector` class is has a type of "Vector".
+-- For example, a `Vector` class is has a name of "Vector".
 -- 
 -- Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
 -- not exist.
-function ____exports.getIsaacAPIClassType(self, object)
+function ____exports.getIsaacAPIClassName(self, object)
     local objectType = type(object)
     if objectType ~= "userdata" then
         return nil
@@ -27,11 +27,11 @@ end
 -- from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type" equal to the
 -- name of the class.)
 function ____exports.isIsaacAPIClass(self, object)
-    local isaacAPIClassType = ____exports.getIsaacAPIClassType(nil, object)
+    local isaacAPIClassType = ____exports.getIsaacAPIClassName(nil, object)
     return isaacAPIClassType ~= nil
 end
 function ____exports.isIsaacAPIClassOfType(self, object, classType)
-    local isaacAPIClassType = ____exports.getIsaacAPIClassType(nil, object)
+    local isaacAPIClassType = ____exports.getIsaacAPIClassName(nil, object)
     return isaacAPIClassType == classType or isaacAPIClassType == "const " .. classType
 end
 --- Helper function to check if an instantiated Isaac API class is equal to another one of the same

package/functions/jsonRoom.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { JSONRoom } from "../interfaces/JSONRoom";
 export declare function getJSONRoomOfVariant(jsonRooms: JSONRoom[], variant: int): JSONRoom | undefined;
 export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[], subType: int): JSONRoom[];

package/functions/log.lua

@@ -35,7 +35,7 @@ local hasFlag = ____flag.hasFlag
 local ____gridEntity = require("functions.gridEntity")
 local getGridEntities = ____gridEntity.getGridEntities
 local ____isaacAPIClass = require("functions.isaacAPIClass")
-local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
+local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____player = require("functions.player")
 local getEffectsList = ____player.getEffectsList
 local getPlayerName = ____player.getPlayerName
@@ -474,7 +474,7 @@ function ____exports.logTable(____table, parentTables)
         end
         numKeys = numKeys + 1
     end
-    ____exports.log("The size of the table was: " .. tostring(numKeys))
+    ____exports.log((indentation .. "The size of the table was: ") .. tostring(numKeys))
 end
 --- Helper function for printing out every tear flag that is turned on. Useful when debugging.
 function ____exports.logTearFlags(flags)
@@ -497,7 +497,7 @@ function ____exports.logUserdata(userdata)
         ____exports.log("Userdata: [no metatable]")
         return
     end
-    local classType = getIsaacAPIClassType(nil, userdata)
+    local classType = getIsaacAPIClassName(nil, userdata)
     if classType == nil then
         ____exports.log("Userdata: [no class type]")
     else

package/functions/pickups.d.ts

@@ -33,7 +33,7 @@ export declare function isRedHeart(pickup: EntityPickup): boolean;
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns True if one or more cards were removed, false otherwise.
  */
-export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?: int): boolean;
+export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?: int): EntityPickupBattery[];
 /**
  * Helper function to remove all of the cards in the room.
  *
@@ -41,7 +41,7 @@ export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns True if one or more cards were removed, false otherwise.
  */
-export declare function removeAllCards(card?: Card, cap?: int): boolean;
+export declare function removeAllCards(card?: Card, cap?: int): EntityPickupCard[];
 /**
  * Helper function to remove all of the coins in the room.
  *
@@ -49,7 +49,7 @@ export declare function removeAllCards(card?: Card, cap?: int): boolean;
  * @param cap Optional. If specified, will only remove the given amount of coins.
  * @returns True if one or more coins were removed, false otherwise.
  */
-export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): boolean;
+export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): EntityPickupCoin[];
 /**
  * Helper function to remove all of the collectibles in the room.
  *
@@ -58,7 +58,7 @@ export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): bo
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns True if one or more collectibles were removed, false otherwise.
  */
-export declare function removeAllCollectibles(collectibleType?: CollectibleType, cap?: int): boolean;
+export declare function removeAllCollectibles(collectibleType?: CollectibleType, cap?: int): EntityPickupCollectible[];
 /**
  * Helper function to remove all of the hearts in the room.
  *
@@ -66,7 +66,7 @@ export declare function removeAllCollectibles(collectibleType?: CollectibleType,
  * @param cap Optional. If specified, will only remove the given amount of hearts.
  * @returns True if one or more hearts were removed, false otherwise.
  */
-export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int): boolean;
+export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int): EntityPickupHeart[];
 /**
  * Helper function to remove all of the keys in the room.
  *
@@ -74,7 +74,7 @@ export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int):
  * @param cap Optional. If specified, will only remove the given amount of keys.
  * @returns True if one or more keys were removed, false otherwise.
  */
-export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): boolean;
+export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): EntityPickupKey[];
 /**
  * Helper function to remove all of the pills in the room.
  *
@@ -82,7 +82,7 @@ export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): boole
  * @param cap Optional. If specified, will only remove the given amount of pills.
  * @returns True if one or more pills were removed, false otherwise.
  */
-export declare function removeAllPills(pillColor?: PillColor, cap?: int): boolean;
+export declare function removeAllPills(pillColor?: PillColor, cap?: int): EntityPickupPill[];
 /**
  * Helper function to remove all of the sacks (i.e. grab bags) in the room.
  *
@@ -90,7 +90,7 @@ export declare function removeAllPills(pillColor?: PillColor, cap?: int): boolea
  * @param cap Optional. If specified, will only remove the given amount of trinkets.
  * @returns True if one or more trinkets were removed, false otherwise.
  */
-export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): boolean;
+export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): EntityPickupSack[];
 /**
  * Helper function to remove all of the trinkets in the room.
  *
@@ -99,7 +99,7 @@ export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): bo
  * @param cap Optional. If specified, will only remove the given amount of trinkets.
  * @returns True if one or more trinkets were removed, false otherwise.
  */
-export declare function removeAllTrinkets(trinketType?: TrinketType, cap?: int): boolean;
+export declare function removeAllTrinkets(trinketType?: TrinketType, cap?: int): EntityPickupTrinket[];
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
  */

package/functions/player.d.ts

@@ -100,6 +100,8 @@ export declare function getPlayerCollectibleCount(player: EntityPlayer, ...colle
  * the player has.
  */
 export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
+/** Helper function to get the player from a tear, laser, bomb, etc. */
+export declare function getPlayerFromTear(entity: Entity): EntityPlayer | undefined;
 /**
  * Returns the number of red hearts that the player has, excluding any rotten hearts. For example,
  * if the player has one full black heart, one full soul heart, and one half black heart, this
@@ -207,6 +209,11 @@ export declare function isBethany(player: EntityPlayer): boolean;
  * for. Returns true if the player is any of the supplied characters.
  */
 export declare function isCharacter(player: EntityPlayer, ...characters: PlayerType[]): boolean;
+/**
+ * Helper function to see if a damage source is from a player. Use this instead of comparing to the
+ * entity directly because it takes familiars into account.
+ */
+export declare function isDamageFromPlayer(damageSource: Entity): boolean;
 /**
  * Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
  * you want to know if the starting stats were randomized, for example.

package/functions/player.lua

@@ -15,6 +15,7 @@ local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
 local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
 local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local FamiliarVariant = ____isaac_2Dtypescript_2Ddefinitions.FamiliarVariant
 local NullItemID = ____isaac_2Dtypescript_2Ddefinitions.NullItemID
 local PlayerForm = ____isaac_2Dtypescript_2Ddefinitions.PlayerForm
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
@@ -377,6 +378,30 @@ function ____exports.getPlayerCollectibleMap(self, player)
     end
     return collectibleMap
 end
+--- Helper function to get the player from a tear, laser, bomb, etc.
+function ____exports.getPlayerFromTear(self, entity)
+    if entity.Parent ~= nil then
+        local player = entity.Parent:ToPlayer()
+        if player ~= nil then
+            return player
+        end
+        local familiar = entity.Parent:ToFamiliar()
+        if familiar ~= nil and familiar.Variant == FamiliarVariant.INCUBUS then
+            return familiar.Player
+        end
+    end
+    if entity.SpawnerEntity ~= nil then
+        local player = entity.SpawnerEntity:ToPlayer()
+        if player ~= nil then
+            return player
+        end
+        local familiar = entity.SpawnerEntity:ToFamiliar()
+        if familiar ~= nil and familiar.Variant == FamiliarVariant.INCUBUS then
+            return familiar.Player
+        end
+    end
+    return nil
+end
 --- Returns the number of red hearts that the player has, excluding any rotten hearts. For example,
 -- if the player has one full black heart, one full soul heart, and one half black heart, this
 -- function returns 3.
@@ -567,6 +592,16 @@ function ____exports.isBethany(self, player)
     local character = player:GetPlayerType()
     return character == PlayerType.BETHANY or character == PlayerType.BETHANY_B
 end
+--- Helper function to see if a damage source is from a player. Use this instead of comparing to the
+-- entity directly because it takes familiars into account.
+function ____exports.isDamageFromPlayer(self, damageSource)
+    local player = damageSource:ToPlayer()
+    if player ~= nil then
+        return true
+    end
+    local indirectPlayer = ____exports.getPlayerFromTear(nil, damageSource)
+    return indirectPlayer ~= nil
+end
 --- Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
 -- you want to know if the starting stats were randomized, for example.
 function ____exports.isEden(self, player)
@@ -684,9 +719,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch113 = activeSlot
-        local ____cond113 = ____switch113 == ActiveSlot.PRIMARY
-        if ____cond113 then
+        local ____switch122 = activeSlot
+        local ____cond122 = ____switch122 == ActiveSlot.PRIMARY
+        if ____cond122 then
             do
                 if primaryCollectibleType ~= CollectibleType.NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -695,8 +730,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond113 = ____cond113 or ____switch113 == ActiveSlot.SECONDARY
-        if ____cond113 then
+        ____cond122 = ____cond122 or ____switch122 == ActiveSlot.SECONDARY
+        if ____cond122 then
             do
                 if primaryCollectibleType ~= CollectibleType.NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -711,16 +746,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond113 = ____cond113 or ____switch113 == ActiveSlot.POCKET
-        if ____cond113 then
+        ____cond122 = ____cond122 or ____switch122 == ActiveSlot.POCKET
+        if ____cond122 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond113 = ____cond113 or ____switch113 == ActiveSlot.POCKET_SINGLE_USE
-        if ____cond113 then
+        ____cond122 = ____cond122 or ____switch122 == ActiveSlot.POCKET_SINGLE_USE
+        if ____cond122 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/functions/playerHealth.d.ts

@@ -1,4 +1,5 @@
 /// <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;
@@ -11,6 +12,8 @@ export declare function addPlayerHealthType(player: EntityPlayer, healthType: He
  */
 export declare function getPlayerHealth(player: EntityPlayer): PlayerHealth;
 export declare function getPlayerHealthType(player: EntityPlayer, healthType: HealthType): int;
+export declare function playerConvertBlackHeartsToSoulHearts(player: EntityPlayer): void;
+export declare function playerConvertSoulHeartsToBlackHearts(player: EntityPlayer): void;
 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