isaacscript-common 1.2.236 → 1.2.237

package/dist/functions/pickups.d.ts

@@ -1,28 +1,113 @@
 /// <reference types="isaac-typescript-definitions" />
+/** Helper function to get all of the card entities in the room. */
+export declare function getCards(matchingSubType?: number): EntityPickup[];
+/** Helper function to get all of the coin pickup entities in the room. */
 export declare function getCoins(matchingSubType?: number): EntityPickup[];
+/** Helper function to get all of the collectible entities in the room. */
+export declare function getCollectibles(matchingSubType?: number): EntityPickup[];
+/** Helper function to get all of the heart pickup entities in the room. */
 export declare function getHearts(matchingSubType?: number): EntityPickup[];
+/** Helper function to get all of the key pickup entities in the room. */
 export declare function getKeys(matchingSubType?: number): EntityPickup[];
-/**
- * Helper function to get all of the pickups in the room.
- *
- * Example:
- * ```ts
- * // Make all of the pickups in the room invisible
- * for (const pickup of getPickups()) {
- *   pickup.Visible = false;
- * }
- * ```
- */
-export declare function getPickups(matchingVariant?: PickupVariant | int, matchingSubType?: number): EntityPickup[];
+/** Helper function to get all of the pill entities in the room. */
+export declare function getPills(matchingSubType?: number): EntityPickup[];
+/** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickup[];
+/** Helper function to get all of the trinket entities in the room. */
+export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 export declare function isChest(pickup: EntityPickup): boolean;
 export declare function isRedHeart(pickup: EntityPickup): boolean;
 /**
- * Helper function to remove all of the pickups in the room.
+ * 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 | int, 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 | int, 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 | int, 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 | int, 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 | int, 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 trinkets in the room.
  *
- * @param variant 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 was removed, false otherwise.
+ * @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 | int, cap?: int): boolean;
+/**
+ * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
+ * `PickupVariant.PICKUP_TAROTCARD` (300).
+ */
+export declare function spawnCard(subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnCardWithSeed(subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+/**
+ * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
+ * `PickupVariant.PICKUP_COIN` (20).
+ */
+export declare function spawnCoin(subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnCoinWithSeed(subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+/**
+ * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
+ * `PickupVariant.PICKUP_HEART` (10).
+ */
+export declare function spawnHeart(subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnHeartWithSeed(subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+/**
+ * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
+ * `PickupVariant.PICKUP_KEY` (30).
+ */
+export declare function spawnKey(subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnKeyWithSeed(subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+/**
+ * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
+ * `PickupVariant.PICKUP_PILL` (70).
+ */
+export declare function spawnPill(subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnPillWithSeed(subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+/**
+ * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
+ * `PickupVariant.PICKUP_TRINKET` (350).
  */
-export declare function removeAllPickups(variant?: PickupVariant | int, subType?: int, cap?: int): boolean;
+export declare function spawnTrinket(subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnTrinketWithSeed(subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;

package/dist/functions/pickups.lua

@@ -1,48 +1,51 @@
 local ____lualib = require("lualib_bundle")
-local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 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 ____entity = require("functions.entity")
-local getEntities = ____entity.getEntities
-local removeEntities = ____entity.removeEntities
-function ____exports.getPickups(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
+local ____entitySpecific = require("functions.entitySpecific")
+local getPickups = ____entitySpecific.getPickups
+local removeAllPickups = ____entitySpecific.removeAllPickups
+local spawnPickup = ____entitySpecific.spawnPickup
+function ____exports.getCards(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
     end
-    local entities = getEntities(nil, EntityType.ENTITY_PICKUP, matchingVariant, matchingSubType)
-    local pickups = {}
-    for ____, entity in ipairs(entities) do
-        local pickup = entity:ToPickup()
-        if pickup ~= nil then
-            __TS__ArrayPush(pickups, pickup)
-        end
-    end
-    return pickups
+    return getPickups(nil, 300, matchingSubType)
 end
 function ____exports.getCoins(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
     end
-    return ____exports.getPickups(nil, 20, matchingSubType)
+    return getPickups(nil, 20, matchingSubType)
+end
+function ____exports.getCollectibles(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, 100, matchingSubType)
 end
 function ____exports.getHearts(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
     end
-    return ____exports.getPickups(nil, 10, matchingSubType)
+    return getPickups(nil, 10, matchingSubType)
 end
 function ____exports.getKeys(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
     end
-    return ____exports.getPickups(nil, 30, matchingSubType)
+    return getPickups(nil, 30, matchingSubType)
+end
+function ____exports.getPills(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, 70, matchingSubType)
 end
 function ____exports.getRedHearts(self)
     local hearts = ____exports.getHearts(nil)
@@ -51,14 +54,253 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
+function ____exports.getTrinkets(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, 350, matchingSubType)
+end
 function ____exports.isChest(self, pickup)
     return CHEST_PICKUP_VARIANTS:has(pickup.Variant)
 end
 function ____exports.isRedHeart(self, pickup)
     return pickup.Variant == 10 and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
 end
-function ____exports.removeAllPickups(self, variant, subType, cap)
-    local pickups = ____exports.getPickups(nil, variant, subType)
-    return removeEntities(nil, pickups, cap)
+function ____exports.removeAllCards(self, card, cap)
+    return removeAllPickups(nil, 300, card, cap)
+end
+function ____exports.removeAllCoins(self, coinSubType, cap)
+    return removeAllPickups(nil, 20, coinSubType, cap)
+end
+function ____exports.removeAllCollectibles(self, collectibleType, cap)
+    return removeAllPickups(nil, 100, collectibleType, cap)
+end
+function ____exports.removeAllHearts(self, heartSubType, cap)
+    return removeAllPickups(nil, 10, heartSubType, cap)
+end
+function ____exports.removeAllKeys(self, keySubType, cap)
+    return removeAllPickups(nil, 30, keySubType, cap)
+end
+function ____exports.removeAllPills(self, pillColor, cap)
+    return removeAllPickups(nil, 70, pillColor, cap)
+end
+function ____exports.removeAllTrinkets(self, trinketType, cap)
+    return removeAllPickups(nil, 350, trinketType, cap)
+end
+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,
+        300,
+        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
+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,
+        20,
+        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
+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,
+        10,
+        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
+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,
+        30,
+        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
+function ____exports.spawnPill(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,
+        70,
+        subType,
+        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
+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,
+        350,
+        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/dist/functions/spawnCollectible.lua

@@ -1,9 +1,5 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____constants = require("constants")
-local VectorZero = ____constants.VectorZero
 local ____preventCollectibleRotate = require("features.preventCollectibleRotate")
 local preventCollectibleRotate = ____preventCollectibleRotate.preventCollectibleRotate
 local ____featuresInitialized = require("featuresInitialized")
@@ -11,6 +7,8 @@ local areFeaturesInitialized = ____featuresInitialized.areFeaturesInitialized
 local ____collectibles = require("functions.collectibles")
 local isQuestCollectible = ____collectibles.isQuestCollectible
 local setCollectibleEmpty = ____collectibles.setCollectibleEmpty
+local ____entitySpecific = require("functions.entitySpecific")
+local spawnPickupWithSeed = ____entitySpecific.spawnPickupWithSeed
 local ____player = require("functions.player")
 local anyPlayerIs = ____player.anyPlayerIs
 local ____rng = require("functions.rng")
@@ -27,18 +25,13 @@ function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG
         forceFreeItem = false
     end
     local seed = isRNG(nil, seedOrRNG) and seedOrRNG:Next() or seedOrRNG
-    local collectible = game:Spawn(
-        EntityType.ENTITY_PICKUP,
-        100,
-        position,
-        VectorZero,
+    local collectible = spawnPickupWithSeed(
         nil,
+        100,
         collectibleType,
+        position,
         seed
-    ):ToPickup()
-    if collectible == nil then
-        error("Failed to spawn a collectible.")
-    end
+    )
     if options then
         collectible.OptionsPickupIndex = 1
     end

package/dist/functions/trinkets.d.ts

@@ -34,8 +34,6 @@ export declare function getTrinketDescription(trinketType: TrinketType | int): s
  * ```
  */
 export declare function getTrinketName(trinketType: TrinketType | int): string;
-/** Helper function to get all of the trinket entities in the room. */
-export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 /**
  * Returns whether or not the player can hold an additional trinket, beyond what they are currently
  * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.

package/dist/functions/trinkets.lua

@@ -12,8 +12,6 @@ local DEFAULT_TRINKET_NAME = ____trinketNameMap.DEFAULT_TRINKET_NAME
 local TRINKET_NAME_MAP = ____trinketNameMap.TRINKET_NAME_MAP
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____pickups = require("functions.pickups")
-local getPickups = ____pickups.getPickups
 local ____player = require("functions.player")
 local isCharacter = ____player.isCharacter
 local useActiveItemTemp = ____player.useActiveItemTemp
@@ -65,12 +63,6 @@ function ____exports.getTrinketName(self, trinketType)
     end
     return DEFAULT_TRINKET_NAME
 end
-function ____exports.getTrinkets(self, matchingSubType)
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    return getPickups(nil, 350, matchingSubType)
-end
 function ____exports.hasOpenTrinketSlot(self, player)
     if isCharacter(nil, player, PlayerType.PLAYER_THESOUL_B) then
         return false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.236",
+  "version": "1.2.237",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",