isaacscript-common 2.3.0 → 2.3.1

package/functions/math.d.ts

@@ -0,0 +1,50 @@
+import { Direction } from "isaac-typescript-definitions";
+/**
+ * Helper function to normalize an integer.
+ *
+ * - If `x` is less than `min`, then it will be clamped to `min`.
+ * - If `x` is greater than `max`, then it will be clamped to `max`.
+ */
+export declare function clamp(x: int, min: int, max: int): int;
+export declare function getAngleDifference(angle1: float, angle2: float): float;
+/**
+ * Helper function to get an array of equidistant points on the circumference around a circle.
+ * Useful for equally distributing things in a circle pattern.
+ *
+ * @param centerPos A position that represents the center of the center to get the points from.
+ * @param radius The radius of the circle.
+ * @param numPoints The number of points on the circumference of the circle to get.
+ * @param xMultiplier An optional multiplier to get the points around an oval. Default is 1.
+ * @param yMultiplier An optional multiplier to get the points around an oval. Default is 1.
+ * @param initialDirection By default, the first point on the circle will be on the top center, but
+ *                         this can be optionally changed by specifying this argument.
+ */
+export declare function getCircleDiscretizedPoints(centerPos: Vector, radius: float, numPoints: int, xMultiplier?: number, yMultiplier?: number, initialDirection?: Direction): Vector[];
+/**
+ * Helper function to check if a given position is within a given rectangle.
+ *
+ * This is an inclusive check, meaning that it will return true if the position is on the border of
+ * the rectangle.
+ */
+export declare function inRectangle(position: Vector, topLeft: Vector, bottomRight: Vector): boolean;
+/**
+ * From: https://www.geeksforgeeks.org/check-if-any-point-overlaps-the-given-circle-and-rectangle/
+ */
+export declare function isCircleIntersectingRectangle(circleCenter: Vector, circleRadius: float, rectangleTopLeft: Vector, rectangleBottomRight: Vector): boolean;
+export declare function isEven(num: int): boolean;
+export declare function isOdd(num: int): boolean;
+export declare function lerp(a: number, b: number, pos: float): number;
+export declare function lerpAngleDegrees(aStart: number, aEnd: number, percent: float): number;
+/**
+ * If rounding fails, this function returns 0.
+ * From: http://lua-users.org/wiki/SimpleRound
+ *
+ * @param num The number to round.
+ * @param numDecimalPlaces Default is 0.
+ */
+export declare function round(num: float, numDecimalPlaces?: number): float;
+/**
+ * @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0.
+ */
+export declare function sign(n: number): int;
+export declare function tanh(x: number): number;

package/functions/math.lua

@@ -0,0 +1,92 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local ____direction = require("functions.direction")
+local directionToVector = ____direction.directionToVector
+function ____exports.clamp(self, x, min, max)
+    return math.max(
+        min,
+        math.min(x, max)
+    )
+end
+function ____exports.getAngleDifference(self, angle1, angle2)
+    local subtractedAngle = angle1 - angle2
+    return (subtractedAngle + 180) % 360 - 180
+end
+function ____exports.getCircleDiscretizedPoints(self, centerPos, radius, numPoints, xMultiplier, yMultiplier, initialDirection)
+    if xMultiplier == nil then
+        xMultiplier = 1
+    end
+    if yMultiplier == nil then
+        yMultiplier = 1
+    end
+    if initialDirection == nil then
+        initialDirection = Direction.UP
+    end
+    local vector = directionToVector(nil, initialDirection)
+    local initialPosition = vector * radius
+    local positions = {}
+    do
+        local i = 0
+        while i < numPoints do
+            local rotatedPosition = initialPosition:Rotated(i * 360 / numPoints)
+            rotatedPosition.X = rotatedPosition.X * xMultiplier
+            rotatedPosition.Y = rotatedPosition.Y * yMultiplier
+            local positionFromCenter = centerPos + rotatedPosition
+            positions[#positions + 1] = positionFromCenter
+            i = i + 1
+        end
+    end
+    return positions
+end
+function ____exports.inRectangle(self, position, topLeft, bottomRight)
+    return position.X >= topLeft.X and position.X <= bottomRight.X and position.Y >= topLeft.Y and position.Y <= bottomRight.Y
+end
+function ____exports.isCircleIntersectingRectangle(self, circleCenter, circleRadius, rectangleTopLeft, rectangleBottomRight)
+    local nearestX = math.max(
+        rectangleTopLeft.X,
+        math.min(circleCenter.X, rectangleBottomRight.X)
+    )
+    local nearestY = math.max(
+        rectangleTopLeft.Y,
+        math.min(circleCenter.Y, rectangleBottomRight.Y)
+    )
+    local nearestPointToCircleOnRectangle = Vector(nearestX, nearestY)
+    local distanceToCenterOfCircle = nearestPointToCircleOnRectangle:Distance(circleCenter)
+    return distanceToCenterOfCircle <= circleRadius
+end
+function ____exports.isEven(self, num)
+    return num & 1 == 0
+end
+function ____exports.isOdd(self, num)
+    return num & 1 == 1
+end
+function ____exports.lerp(self, a, b, pos)
+    return a + (b - a) * pos
+end
+function ____exports.lerpAngleDegrees(self, aStart, aEnd, percent)
+    return aStart + ____exports.getAngleDifference(nil, aStart, aEnd) * percent
+end
+function ____exports.round(self, num, numDecimalPlaces)
+    if numDecimalPlaces == nil then
+        numDecimalPlaces = 0
+    end
+    local roundedNum = tonumber(string.format(
+        ("%." .. tostring(numDecimalPlaces)) .. "f",
+        num
+    ))
+    return roundedNum == nil and 0 or roundedNum
+end
+function ____exports.sign(self, n)
+    if n > 0 then
+        return 1
+    end
+    if n < 0 then
+        return -1
+    end
+    return 0
+end
+function ____exports.tanh(self, x)
+    return (math.exp(x) - math.exp(-x)) / (math.exp(x) + math.exp(-x))
+end
+return ____exports

package/functions/mergeTests.d.ts

@@ -0,0 +1 @@
+export declare function mergeTests(): void;

package/functions/mergeTests.lua

@@ -0,0 +1,182 @@
+local ____exports = {}
+local oldTableHasUpdatedValue, newTableHasSameValue, oldTableHasUpdatedValueFromNull, oldTableHasSerializedIsaacAPIClass, oldTableHasFilledInterface, oldTableHasVector, oldTableHasVectorSerialized, oldTableHasRNG, oldTableHasRNGSerialized
+local ____SerializationType = require("enums.SerializationType")
+local SerializationType = ____SerializationType.SerializationType
+local ____merge = require("features.saveDataManager.merge")
+local merge = ____merge.merge
+local ____deepCopy = require("functions.deepCopy")
+local deepCopy = ____deepCopy.deepCopy
+local ____log = require("functions.log")
+local log = ____log.log
+local ____rng = require("functions.rng")
+local isRNG = ____rng.isRNG
+local newRNG = ____rng.newRNG
+local ____serialization = require("functions.serialization")
+local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
+local ____vector = require("functions.vector")
+local copyVector = ____vector.copyVector
+local isVector = ____vector.isVector
+function oldTableHasUpdatedValue(self)
+    local key = "foo"
+    local oldValue = "bar"
+    local newValue = "baz"
+    local oldTable = {foo = oldValue}
+    local newTable = {foo = newValue}
+    merge(nil, oldTable, newTable, "oldTableHasUpdatedValue")
+    local oldTableValue = oldTable[key]
+    if oldTableValue ~= newValue then
+        error("The old table does not have a value of: " .. newValue)
+    end
+end
+function newTableHasSameValue(self)
+    local key = "foo"
+    local oldValue = "bar"
+    local newValue = "baz"
+    local oldTable = {foo = oldValue}
+    local newTable = {foo = newValue}
+    merge(nil, oldTable, newTable, "newTableHasSameValue")
+    local newTableValue = newTable[key]
+    if newTableValue ~= newValue then
+        error("The new table does not have a value of: " .. newValue)
+    end
+end
+function oldTableHasUpdatedValueFromNull(self)
+    local key = "foo"
+    local newValue = "baz"
+    local oldTable = {foo = nil}
+    local newTable = {foo = newValue}
+    merge(nil, oldTable, newTable, "oldTableHasUpdatedValueFromNull")
+    local oldTableValue = oldTable[key]
+    if oldTableValue ~= newValue then
+        error("The old table does not have a value of: " .. newValue)
+    end
+end
+function oldTableHasSerializedIsaacAPIClass(self)
+    local x = 50
+    local y = 60
+    local vector = Vector(x, y)
+    local vectorSerialized = copyVector(nil, vector, SerializationType.SERIALIZE)
+    if not isSerializedIsaacAPIClass(nil, vectorSerialized) then
+        error("The \"isSerializedIsaacAPIClass\" function says that a serialized vector is not serialized.")
+    end
+end
+function oldTableHasFilledInterface(self)
+    local key = "foo"
+    local newValue = "baz"
+    local oldTable = {foo = nil}
+    local foo = {bar = newValue}
+    local newTable = {foo = foo}
+    merge(nil, oldTable, newTable, "oldTableHasFilledInterface")
+    local oldTableValue = oldTable[key]
+    if oldTableValue == nil then
+        error(("The old table's key of \"" .. key) .. "\" was not filled.")
+    end
+    if oldTableValue.bar ~= newValue then
+        error("The old table's key of \"bar\" was not filled.")
+    end
+end
+function oldTableHasVector(self)
+    log("Starting test: oldTableHasVector")
+    local key = "foo"
+    local x = 50
+    local y = 60
+    local newValue = Vector(x, y)
+    local oldTable = {foo = nil}
+    local foo = {bar = newValue}
+    local newTable = {foo = foo}
+    merge(nil, oldTable, newTable, "oldTableHasVector")
+    local oldTableValue = oldTable[key]
+    if oldTableValue == nil then
+        error(("The old table's key of \"" .. key) .. "\" was not filled.")
+    end
+    if oldTableValue.bar.X ~= x then
+        error("The old table's value for \"x\" does not match: " .. tostring(x))
+    end
+    if oldTableValue.bar.Y ~= y then
+        error("The old table's value for \"y\" does not match: " .. tostring(y))
+    end
+    if not isVector(nil, oldTableValue.bar) then
+        error("The old table's value is not a Vector object.")
+    end
+end
+function oldTableHasVectorSerialized(self)
+    log("Starting test: oldTableHasVectorSerialized")
+    local key = "foo"
+    local x = 50
+    local y = 60
+    local newValue = Vector(x, y)
+    local oldTable = {foo = nil}
+    local foo = {bar = newValue}
+    local newTable = {foo = foo}
+    local newTableSerialized = deepCopy(nil, newTable, SerializationType.SERIALIZE)
+    merge(nil, oldTable, newTableSerialized, "oldTableHasVectorSerialized")
+    local oldTableValue = oldTable[key]
+    if oldTableValue == nil then
+        error(("The old table's key of \"" .. key) .. "\" was not filled.")
+    end
+    if oldTableValue.bar.X ~= x then
+        error("The old table's value for \"x\" does not match: " .. tostring(x))
+    end
+    if oldTableValue.bar.Y ~= y then
+        error("The old table's value for \"y\" does not match: " .. tostring(y))
+    end
+    if not isVector(nil, oldTableValue.bar) then
+        error("The old table's value is not a Vector object (during the serialized test).")
+    end
+end
+function oldTableHasRNG(self)
+    log("Starting test: oldTableHasRNG")
+    local key = "foo"
+    local seed = 50
+    local newValue = newRNG(nil, seed)
+    local oldTable = {foo = nil}
+    local foo = {bar = newValue}
+    local newTable = {foo = foo}
+    merge(nil, oldTable, newTable, "oldTableHasRNG")
+    local oldTableValue = oldTable[key]
+    if oldTableValue == nil then
+        error(("The old table's key of \"" .. key) .. "\" was not filled.")
+    end
+    if not isRNG(nil, oldTableValue.bar) then
+        error("The old table's value is not an RNG object.")
+    end
+    local newSeed = oldTableValue.bar:GetSeed()
+    if newSeed ~= seed then
+        error("The old table's seed not match: " .. tostring(seed))
+    end
+end
+function oldTableHasRNGSerialized(self)
+    log("Starting test: oldTableHasRNGSerialized")
+    local key = "foo"
+    local seed = 50
+    local newValue = newRNG(nil, seed)
+    local oldTable = {foo = nil}
+    local foo = {bar = newValue}
+    local newTable = {foo = foo}
+    local newTableSerialized = deepCopy(nil, newTable, SerializationType.SERIALIZE)
+    merge(nil, oldTable, newTableSerialized, "oldTableHasRNGSerialized")
+    local oldTableValue = oldTable[key]
+    if oldTableValue == nil then
+        error(("The old table's key of \"" .. key) .. "\" was not filled.")
+    end
+    if not isRNG(nil, oldTableValue.bar) then
+        error("The old table's value is not an RNG object (during the serialized test).")
+    end
+    local newSeed = oldTableValue.bar:GetSeed()
+    if newSeed ~= seed then
+        error("The old table's seed not match: " .. tostring(seed))
+    end
+end
+function ____exports.mergeTests(self)
+    oldTableHasUpdatedValue(nil)
+    newTableHasSameValue(nil)
+    oldTableHasUpdatedValueFromNull(nil)
+    oldTableHasSerializedIsaacAPIClass(nil)
+    oldTableHasFilledInterface(nil)
+    oldTableHasVector(nil)
+    oldTableHasVectorSerialized(nil)
+    oldTableHasRNG(nil)
+    oldTableHasRNGSerialized(nil)
+    log("All merge tests passed!")
+end
+return ____exports

package/functions/npc.d.ts

@@ -0,0 +1,40 @@
+import { EntityType, ProjectilesMode } from "isaac-typescript-definitions";
+/**
+ * Helper function to make an NPC fire a projectile. Returns the fired projectile. Use this function
+ * instead of the `EntityNPC.FireProjectiles` method, since that returns void.
+ *
+ * @param npc The NPC to fire the projectile from.
+ * @param position The staring position of the projectile.
+ * @param velocity The starting velocity of the projectile.
+ * @param projectilesMode The mode of the projectile. Optional. Default is
+ *                        `ProjectilesMode.ONE_PROJECTILE`.
+ * @param projectileParams The parameters of the projectile. Optional. Default is
+ *                         `ProjectileParams()`.
+ * @returns The fired projectile.
+ */
+export declare function fireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode?: ProjectilesMode, projectileParams?: ProjectileParams): EntityProjectile[];
+/**
+ * Helper function to get all of the non-dead NPCs in the room.
+ *
+ * This function will not include NPCs on an internal blacklist, such as Death's scythes or Big Horn
+ * holes.
+ */
+export declare function getAliveNPCs(matchingEntityType?: EntityType, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
+/**
+ * Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should
+ * not actually keep the doors closed (like Death's scythes).
+ */
+export declare function isAliveExceptionNPC(npc: EntityNPC): boolean;
+/**
+ * Helper function to detect the custom death state of an Eggy. Eggies are never actually marked
+ * dead by the game. Instead, when Eggies take fatal damage, they go into NpcState.STATE_SUICIDE and
+ * spawn 14 Swarm Spiders while their StateFrame ticks upwards.
+ */
+export declare function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean;
+/**
+ * Helper function to detect the custom death state of a Rag Man Ragling. When Rag Man Raglings die,
+ * they turn into a patch on the ground and can be revived by Rag Man at a later time. This causes
+ * them to show up as an "alive" enemy, so they should usually be filtered out of lists of alive
+ * enemies.
+ */
+export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;

package/functions/npc.lua

@@ -0,0 +1,104 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local NON_ALIVE_NPCS_TYPE_VARIANT, NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BegottenVariant = ____isaac_2Dtypescript_2Ddefinitions.BegottenVariant
+local BigHornVariant = ____isaac_2Dtypescript_2Ddefinitions.BigHornVariant
+local ChargerSubType = ____isaac_2Dtypescript_2Ddefinitions.ChargerSubType
+local ChargerVariant = ____isaac_2Dtypescript_2Ddefinitions.ChargerVariant
+local DarkEsauVariant = ____isaac_2Dtypescript_2Ddefinitions.DarkEsauVariant
+local DeathVariant = ____isaac_2Dtypescript_2Ddefinitions.DeathVariant
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local MamaGurdyVariant = ____isaac_2Dtypescript_2Ddefinitions.MamaGurdyVariant
+local MotherSubType = ____isaac_2Dtypescript_2Ddefinitions.MotherSubType
+local MotherVariant = ____isaac_2Dtypescript_2Ddefinitions.MotherVariant
+local NpcState = ____isaac_2Dtypescript_2Ddefinitions.NpcState
+local PeepVariant = ____isaac_2Dtypescript_2Ddefinitions.PeepVariant
+local ProjectilesMode = ____isaac_2Dtypescript_2Ddefinitions.ProjectilesMode
+local RaglingVariant = ____isaac_2Dtypescript_2Ddefinitions.RaglingVariant
+local VisVariant = ____isaac_2Dtypescript_2Ddefinitions.VisVariant
+local ____constants = require("constants")
+local EGGY_STATE_FRAME_OF_FINAL_SPIDER = ____constants.EGGY_STATE_FRAME_OF_FINAL_SPIDER
+local ____entity = require("functions.entity")
+local getFilteredNewEntities = ____entity.getFilteredNewEntities
+local ____entitySpecific = require("functions.entitySpecific")
+local getNPCs = ____entitySpecific.getNPCs
+local getProjectiles = ____entitySpecific.getProjectiles
+function ____exports.isAliveExceptionNPC(self, npc)
+    local entityTypeVariant = (tostring(npc.Type) .. ".") .. tostring(npc.Variant)
+    if NON_ALIVE_NPCS_TYPE_VARIANT:has(entityTypeVariant) then
+        return true
+    end
+    local entityTypeVariantSubType = (((tostring(npc.Type) .. ".") .. tostring(npc.Variant)) .. ".") .. tostring(npc.SubType)
+    if NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE:has(entityTypeVariantSubType) then
+        return true
+    end
+    if ____exports.isRaglingDeathPatch(nil, npc) then
+        return true
+    end
+    if ____exports.isDyingEggyWithNoSpidersLeft(nil, npc) then
+        return true
+    end
+    return false
+end
+function ____exports.isDyingEggyWithNoSpidersLeft(self, npc)
+    return npc.State == NpcState.SUICIDE and npc.StateFrame >= EGGY_STATE_FRAME_OF_FINAL_SPIDER
+end
+function ____exports.isRaglingDeathPatch(self, npc)
+    return npc.Type == EntityType.RAGLING and npc.Variant == RaglingVariant.RAG_MANS_RAGLING and npc.State == NpcState.SPECIAL
+end
+NON_ALIVE_NPCS_TYPE_VARIANT = __TS__New(
+    Set,
+    {
+        (tostring(EntityType.VIS) .. ".") .. tostring(VisVariant.CHUBBER_PROJECTILE),
+        (tostring(EntityType.DEATH) .. ".") .. tostring(DeathVariant.DEATH_SCYTHE),
+        (tostring(EntityType.PEEP) .. ".") .. tostring(PeepVariant.PEEP_EYE),
+        (tostring(EntityType.PEEP) .. ".") .. tostring(PeepVariant.BLOAT_EYE),
+        (tostring(EntityType.BEGOTTEN) .. ".") .. tostring(BegottenVariant.BEGOTTEN_CHAIN),
+        (tostring(EntityType.MAMA_GURDY) .. ".") .. tostring(MamaGurdyVariant.LEFT_HAND),
+        (tostring(EntityType.MAMA_GURDY) .. ".") .. tostring(MamaGurdyVariant.RIGHT_HAND),
+        (tostring(EntityType.BIG_HORN) .. ".") .. tostring(BigHornVariant.SMALL_HOLE),
+        (tostring(EntityType.BIG_HORN) .. ".") .. tostring(BigHornVariant.BIG_HOLE),
+        (tostring(EntityType.DARK_ESAU) .. ".") .. tostring(DarkEsauVariant.DARK_ESAU),
+        (tostring(EntityType.DARK_ESAU) .. ".") .. tostring(DarkEsauVariant.PIT)
+    }
+)
+NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE = __TS__New(
+    Set,
+    {
+        (((tostring(EntityType.CHARGER) .. ".") .. tostring(ChargerVariant.CHARGER)) .. ".") .. tostring(ChargerSubType.MY_SHADOW),
+        (((tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_1)) .. ".") .. tostring(MotherSubType.PHASE_2)
+    }
+)
+function ____exports.fireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
+    if projectilesMode == nil then
+        projectilesMode = ProjectilesMode.ONE_PROJECTILE
+    end
+    if projectileParams == nil then
+        projectileParams = ProjectileParams()
+    end
+    local oldProjectiles = getProjectiles(nil, projectileParams.Variant)
+    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
+    local newProjectiles = getProjectiles(nil, projectileParams.Variant)
+    return getFilteredNewEntities(nil, oldProjectiles, newProjectiles)
+end
+function ____exports.getAliveNPCs(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
+    end
+    local npcs = getNPCs(
+        nil,
+        matchingEntityType,
+        matchingVariant,
+        matchingSubType,
+        ignoreFriendly
+    )
+    return __TS__ArrayFilter(
+        npcs,
+        function(____, npc) return not npc:IsDead() and not ____exports.isAliveExceptionNPC(nil, npc) end
+    )
+end
+return ____exports

package/functions/pickupVariants.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="isaac-typescript-definitions" />
+/** For PickupVariant.HEART (10) */
+export declare function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart;
+/** For PickupVariant.COIN (20) */
+export declare function isCoin(pickup: EntityPickup): pickup is EntityPickupCoin;
+/** For PickupVariant.KEY (30) */
+export declare function isKey(pickup: EntityPickup): pickup is EntityPickupKey;
+/** For PickupVariant.BOMB (40) */
+export declare function isBomb(pickup: EntityPickup): pickup is EntityPickupBomb;
+/** For PickupVariant.POOP (42) */
+export declare function isPoop(pickup: EntityPickup): pickup is EntityPickupPoop;
+/** For PickupVariant.POOP (42) */
+export declare function isSack(pickup: EntityPickup): pickup is EntityPickupSack;
+/** For PickupVariant.PILL (70) */
+export declare function isPill(pickup: EntityPickup): pickup is EntityPickupPill;
+/** For PickupVariant.LIL_BATTERY (90) */
+export declare function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery;
+/** For PickupVariant.COLLECTIBLE (100) */
+export declare function isCollectible(pickup: EntityPickup): pickup is EntityPickupCollectible;
+/** For PickupVariant.TAROT_CARD (300) */
+export declare function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard;
+/** For PickupVariant.TRINKET (350) */
+export declare function isTrinket(pickup: EntityPickup): pickup is EntityPickupTrinket;

package/functions/pickupVariants.lua

@@ -0,0 +1,37 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+function ____exports.isHeart(self, pickup)
+    return pickup.Variant == PickupVariant.HEART
+end
+function ____exports.isCoin(self, pickup)
+    return pickup.Variant == PickupVariant.COIN
+end
+function ____exports.isKey(self, pickup)
+    return pickup.Variant == PickupVariant.KEY
+end
+function ____exports.isBomb(self, pickup)
+    return pickup.Variant == PickupVariant.BOMB
+end
+function ____exports.isPoop(self, pickup)
+    return pickup.Variant == PickupVariant.POOP
+end
+function ____exports.isSack(self, pickup)
+    return pickup.Variant == PickupVariant.SACK
+end
+function ____exports.isPill(self, pickup)
+    return pickup.Variant == PickupVariant.PILL
+end
+function ____exports.isBattery(self, pickup)
+    return pickup.Variant == PickupVariant.LIL_BATTERY
+end
+function ____exports.isCollectible(self, pickup)
+    return pickup.Variant == PickupVariant.COLLECTIBLE
+end
+function ____exports.isCardPickup(self, pickup)
+    return pickup.Variant == PickupVariant.TAROT_CARD
+end
+function ____exports.isTrinket(self, pickup)
+    return pickup.Variant == PickupVariant.TRINKET
+end
+return ____exports

package/functions/pickups.d.ts

@@ -0,0 +1,132 @@
+import { BatterySubType, Card, CoinSubType, CollectibleType, HeartSubType, KeySubType, PillColor, SackSubType, TrinketType } from "isaac-typescript-definitions";
+/** Helper function to get all of the battery entities in the room. */
+export declare function getBatteries(matchingSubType?: number): EntityPickupBattery[];
+/** Helper function to get all of the card entities in the room. */
+export declare function getCards(matchingSubType?: number): EntityPickupCard[];
+/**
+ * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
+ * sub-types.
+ */
+export declare function getCoinValue(coinSubType: CoinSubType): int;
+/** Helper function to get all of the coin pickup entities in the room. */
+export declare function getCoins(matchingSubType?: number): EntityPickupCoin[];
+/** Helper function to get all of the collectible entities in the room. */
+export declare function getCollectibles(matchingSubType?: number): EntityPickupCollectible[];
+/** Helper function to get all of the heart pickup entities in the room. */
+export declare function getHearts(matchingSubType?: number): EntityPickupHeart[];
+/** Helper function to get all of the key pickup entities in the room. */
+export declare function getKeys(matchingSubType?: number): EntityPickupKey[];
+/** Helper function to get all of the pill entities in the room. */
+export declare function getPills(matchingSubType?: number): EntityPickupPill[];
+/** Helper function to get all of the red heart pickup entities in the room. */
+export declare function getRedHearts(): EntityPickupHeart[];
+/** Helper function to get all of the sack (i.e. grab bag) entities in the room. */
+export declare function getSacks(matchingSubType?: number): EntityPickupSack[];
+/** Helper function to get all of the trinket entities in the room. */
+export declare function getTrinkets(matchingSubType?: number): EntityPickupTrinket[];
+export declare function isChest(pickup: EntityPickup): boolean;
+export declare function isRedHeart(pickup: EntityPickup): boolean;
+/**
+ * Helper function to remove all of the batteries in the room.
+ *
+ * @param batterySubType Optional. If specified, will only remove cards that match this sub-type.
+ * @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;
+/**
+ * Helper function to remove all of the cards in the room.
+ *
+ * @param card Optional. If specified, will only remove cards that match this sub-type.
+ * @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;
+/**
+ * Helper function to remove all of the coins in the room.
+ *
+ * @param coinSubType Optional. If specified, will only remove coins that match this sub-type.
+ * @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;
+/**
+ * Helper function to remove all of the collectibles in the room.
+ *
+ * @param collectibleType Optional. If specified, will only remove collectibles that match this
+ *                        collectible type.
+ * @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;
+/**
+ * Helper function to remove all of the hearts in the room.
+ *
+ * @param heartSubType Optional. If specified, will only remove hearts that match this sub-type.
+ * @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;
+/**
+ * Helper function to remove all of the keys in the room.
+ *
+ * @param keySubType Optional. If specified, will only remove keys that match this sub-type.
+ * @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;
+/**
+ * Helper function to remove all of the pills in the room.
+ *
+ * @param pillColor Optional. If specified, will only remove pills that match this color.
+ * @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;
+/**
+ * Helper function to remove all of the sacks (i.e. grab bags) in the room.
+ *
+ * @param sackSubType Optional. If specified, will only remove sacks that match this sub-type.
+ * @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;
+/**
+ * Helper function to remove all of the trinkets in the room.
+ *
+ * @param trinketType Optional. If specified, will only remove trinkets that match this trinket
+ *                    type.
+ * @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;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
+ */
+export declare function spawnBattery(subType: BatterySubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupBattery;
+export declare function spawnBatteryWithSeed(subType: BatterySubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupBattery;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
+ */
+export declare function spawnCard(subType: Card, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupCard;
+export declare function spawnCardWithSeed(subType: Card, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupCard;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */
+export declare function spawnCoin(subType: CoinSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupCoin;
+export declare function spawnCoinWithSeed(subType: CoinSubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupCoin;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10). */
+export declare function spawnHeart(subType: HeartSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupHeart;
+export declare function spawnHeartWithSeed(subType: HeartSubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupHeart;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30). */
+export declare function spawnKey(subType: KeySubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupKey;
+export declare function spawnKeyWithSeed(subType: KeySubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupKey;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70). */
+export declare function spawnPill(pillColor: PillColor, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupPill;
+export declare function spawnPillWithSeed(subType: PillColor, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupPill;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69). */
+export declare function spawnSack(subType: SackSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupSack;
+export declare function spawnSackWithSeed(subType: SackSubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupSack;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
+ */
+export declare function spawnTrinket(subType: TrinketType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickupTrinket;
+export declare function spawnTrinketWithSeed(subType: TrinketType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupTrinket;