isaacscript-common 2.3.0 → 3.0.0

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;

package/functions/pickups.lua

@@ -0,0 +1,474 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____coinSubTypeToValue = require("objects.coinSubTypeToValue")
+local COIN_SUBTYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUBTYPE_TO_VALUE
+local DEFAULT_COIN_VALUE = ____coinSubTypeToValue.DEFAULT_COIN_VALUE
+local ____chestPickupVariantsSet = require("sets.chestPickupVariantsSet")
+local CHEST_PICKUP_VARIANTS = ____chestPickupVariantsSet.CHEST_PICKUP_VARIANTS
+local ____redHeartSubTypesSet = require("sets.redHeartSubTypesSet")
+local RED_HEART_SUB_TYPES_SET = ____redHeartSubTypesSet.RED_HEART_SUB_TYPES_SET
+local ____entitySpecific = require("functions.entitySpecific")
+local getPickups = ____entitySpecific.getPickups
+local removeAllPickups = ____entitySpecific.removeAllPickups
+local spawnPickup = ____entitySpecific.spawnPickup
+local ____pickupVariants = require("functions.pickupVariants")
+local isHeart = ____pickupVariants.isHeart
+--- Helper function to get all of the battery entities in the room.
+function ____exports.getBatteries(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.LIL_BATTERY, matchingSubType)
+end
+--- Helper function to get all of the card entities in the room.
+function ____exports.getCards(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.TAROT_CARD, matchingSubType)
+end
+--- Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
+-- sub-types.
+function ____exports.getCoinValue(self, coinSubType)
+    local value = COIN_SUBTYPE_TO_VALUE[coinSubType]
+    return value == nil and DEFAULT_COIN_VALUE or value
+end
+--- Helper function to get all of the coin pickup entities in the room.
+function ____exports.getCoins(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.COIN, matchingSubType)
+end
+--- Helper function to get all of the collectible entities in the room.
+function ____exports.getCollectibles(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.COLLECTIBLE, matchingSubType)
+end
+--- Helper function to get all of the heart pickup entities in the room.
+function ____exports.getHearts(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.HEART, matchingSubType)
+end
+--- Helper function to get all of the key pickup entities in the room.
+function ____exports.getKeys(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.KEY, matchingSubType)
+end
+--- Helper function to get all of the pill entities in the room.
+function ____exports.getPills(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.PILL, matchingSubType)
+end
+--- Helper function to get all of the red heart pickup entities in the room.
+function ____exports.getRedHearts(self)
+    local hearts = ____exports.getHearts(nil)
+    return __TS__ArrayFilter(
+        hearts,
+        function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
+    )
+end
+--- Helper function to get all of the sack (i.e. grab bag) entities in the room.
+function ____exports.getSacks(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.SACK, matchingSubType)
+end
+--- Helper function to get all of the trinket entities in the room.
+function ____exports.getTrinkets(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.TRINKET, matchingSubType)
+end
+function ____exports.isChest(self, pickup)
+    return CHEST_PICKUP_VARIANTS:has(pickup.Variant)
+end
+function ____exports.isRedHeart(self, pickup)
+    return isHeart(nil, pickup) and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
+end
+--- 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.
+function ____exports.removeAllBatteries(self, batterySubType, cap)
+    return removeAllPickups(nil, PickupVariant.LIL_BATTERY, batterySubType, cap)
+end
+--- 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.
+function ____exports.removeAllCards(self, card, cap)
+    return removeAllPickups(nil, PickupVariant.TAROT_CARD, card, cap)
+end
+--- 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.
+function ____exports.removeAllCoins(self, coinSubType, cap)
+    return removeAllPickups(nil, PickupVariant.COIN, coinSubType, cap)
+end
+--- 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.
+function ____exports.removeAllCollectibles(self, collectibleType, cap)
+    return removeAllPickups(nil, PickupVariant.COLLECTIBLE, collectibleType, cap)
+end
+--- 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.
+function ____exports.removeAllHearts(self, heartSubType, cap)
+    return removeAllPickups(nil, PickupVariant.HEART, heartSubType, cap)
+end
+--- 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.
+function ____exports.removeAllKeys(self, keySubType, cap)
+    return removeAllPickups(nil, PickupVariant.KEY, keySubType, cap)
+end
+--- 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.
+function ____exports.removeAllPills(self, pillColor, cap)
+    return removeAllPickups(nil, PickupVariant.PILL, pillColor, cap)
+end
+--- 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.
+function ____exports.removeAllSacks(self, sackSubType, cap)
+    return removeAllPickups(nil, PickupVariant.TRINKET, sackSubType, cap)
+end
+--- 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.
+function ____exports.removeAllTrinkets(self, trinketType, cap)
+    return removeAllPickups(nil, PickupVariant.TRINKET, trinketType, cap)
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
+function ____exports.spawnBattery(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.LIL_BATTERY,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnBatteryWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnBattery(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
+function ____exports.spawnCard(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.TAROT_CARD,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnCardWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnCard(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20).
+function ____exports.spawnCoin(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.COIN,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnCoinWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnCoin(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10).
+function ____exports.spawnHeart(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.HEART,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnHeartWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnHeart(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30).
+function ____exports.spawnKey(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.KEY,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnKeyWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnKey(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70).
+function ____exports.spawnPill(self, pillColor, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.PILL,
+        pillColor,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnPillWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnPill(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69).
+function ____exports.spawnSack(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.SACK,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnSackWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnSack(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
+function ____exports.spawnTrinket(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.TRINKET,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnTrinketWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnTrinket(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+return ____exports

package/functions/pills.d.ts

@@ -0,0 +1,69 @@
+import { ItemConfigPillEffectClass, ItemConfigPillEffectType, PillColor, PillEffect } from "isaac-typescript-definitions";
+/**
+ * Helper function to get an array with every non-null pill color. This includes all gold colors and
+ * all horse colors.
+ */
+export declare function getAllPillColors(): PillColor[];
+/**
+ * Helper function to get an array with every valid pill effect. This includes modded pill effects.
+ */
+export declare function getAllPillEffects(): PillEffect[];
+/**
+ * Helper function to get the corresponding horse pill color from a normal pill color.
+ *
+ * For example, passing `PillColor.BLUE_BLUE` would result in 2049, which is the value that
+ * corresponds to the horse pill color for blue/blue.
+ */
+export declare function getHorsePillColor(pillColor: PillColor): PillColor;
+/** Helper function to get an array with every non-gold horse pill color. */
+export declare function getHorsePillColors(): PillColor[];
+/**
+ * Helper function to get an array with every modded pill effect.
+ *
+ * Returns an empty array if there are no modded pill effects.
+ */
+export declare function getModdedPillEffects(): PillEffect[];
+/**
+ * Helper function to get the corresponding normal pill color from a horse pill color.
+ *
+ * For example, passing 2049 would result in `PillColor.BLUE_BLUE`.
+ *
+ * If called with a non-horse pill color, this function will return back the same color.
+ */
+export declare function getNormalPillColorFromHorse(pillColor: PillColor): PillColor;
+/** Helper function to get an array with every non-gold and non-horse pill color. */
+export declare function getNormalPillColors(): PillColor[];
+/**
+ * Helper function to get a pill effect class from a PillEffect enum value. In this context, the
+ * class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
+ * `getPillEffectType` helper function to determine whether or not the pill effect is positive,
+ * negative, or neutral.
+ *
+ * Due to limitations in the API, this function will not work properly for modded pill effects, and
+ * will always return `DEFAULT_PILL_EFFECT_CLASS` in those cases.
+ */
+export declare function getPillEffectClass(pillEffect: PillEffect): ItemConfigPillEffectClass;
+/**
+ * Helper function to get a pill effect name from a PillEffect enum value.
+ *
+ * For example:
+ *
+ * ```ts
+ * const pillEffect = PillEffect.BAD_GAS;
+ * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"
+ * ```
+ */
+export declare function getPillEffectName(pillEffect: PillEffect): string;
+/**
+ * Helper function to get a pill effect type from a PillEffect enum value. In this context, the type
+ * is equal to positive, negative, or neutral. This is derived from the suffix of the the "class"
+ * tag in the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the
+ * "power" of the pill.
+ *
+ * Due to limitations in the API, this function will not work properly for modded pill effects, and
+ * will always return `DEFAULT_PILL_EFFECT_TYPE` in those cases.
+ */
+export declare function getPillEffectType(pillEffect: PillEffect): ItemConfigPillEffectType;
+/** Helper function to get an array with every vanilla pill effect. */
+export declare function getVanillaPillEffects(): PillEffect[];
+export declare function isHorsePill(pillColor: PillColor): boolean;