isaacscript-common 1.2.237 → 1.2.240

package/dist/functions/entitySpecific.d.ts

@@ -198,34 +198,38 @@ export declare function removeAllSlots(variant?: SlotVariant | int, subType?: in
  */
 export declare function removeAllTears(variant?: TearVariant | int, subType?: int, cap?: int): boolean;
 /** Helper function to spawn a `EntityType.ENTITY_BOMB` (4). */
-export declare function spawnBomb(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
+export declare function spawnBomb(variant: BombVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
 /** Helper function to spawn a `EntityType.ENTITY_BOMB` (4) with a specific seed. */
-export declare function spawnBombWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
+export declare function spawnBombWithSeed(variant: BombVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
 /** Helper function to spawn a `EntityType.ENTITY_EFFECT` (1000). */
-export declare function spawnEffect(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityEffect;
+export declare function spawnEffect(variant: EffectVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityEffect;
 /** Helper function to spawn a `EntityType.ENTITY_EFFECT` (1000) with a specific seed. */
-export declare function spawnEffectWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
+export declare function spawnEffectWithSeed(variant: EffectVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
 /** Helper function to spawn a `EntityType.ENTITY_FAMILIAR` (3). */
-export declare function spawnFamiliar(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityFamiliar;
+export declare function spawnFamiliar(variant: FamiliarVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityFamiliar;
 /** Helper function to spawn a `EntityType.ENTITY_FAMILIAR` (3) with a specific seed. */
-export declare function spawnFamiliarWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
+export declare function spawnFamiliarWithSeed(variant: FamiliarVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
 /** Helper function to spawn a `EntityType.ENTITY_KNIFE` (8). */
-export declare function spawnKnife(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityKnife;
+export declare function spawnKnife(variant: KnifeVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityKnife;
 /** Helper function to spawn a `EntityType.ENTITY_KNIFE` (8) with a specific seed. */
-export declare function spawnKnifeWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
+export declare function spawnKnifeWithSeed(variant: KnifeVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
 /** Helper function to spawn a `EntityType.ENTITY_LASER` (7). */
-export declare function spawnLaser(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
+export declare function spawnLaser(variant: LaserVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
 /** Helper function to spawn a `EntityType.ENTITY_LASER` (7) with a specific seed. */
-export declare function spawnLaserWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
+export declare function spawnLaserWithSeed(variant: LaserVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
 /** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5). */
-export declare function spawnPickup(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnPickup(variant: PickupVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with a specific seed. */
-export declare function spawnPickupWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnPickupWithSeed(variant: PickupVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.ENTITY_PROJECTILE` (9). */
-export declare function spawnProjectile(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityProjectile;
+export declare function spawnProjectile(variant: ProjectileVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityProjectile;
 /** Helper function to spawn a `EntityType.ENTITY_PROJECTILE` (9) with a specific seed. */
-export declare function spawnProjectileWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
+export declare function spawnProjectileWithSeed(variant: ProjectileVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
+/** Helper function to spawn a `EntityType.ENTITY_SLOT` (6). */
+export declare function spawnSlot(variant: SlotVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): Entity;
+/** Helper function to spawn a `EntityType.ENTITY_SLOT` (6) with a specific seed. */
+export declare function spawnSlotWithSeed(variant: int | SlotVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): Entity;
 /** Helper function to spawn a `EntityType.ENTITY_TEAR` (2). */
 export declare function spawnTear(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityTear;
 /** Helper function to spawn a `EntityType.EntityType` (2) with a specific seed. */
-export declare function spawnTearWithSeed(variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;
+export declare function spawnTearWithSeed(variant: TearVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;

package/dist/functions/entitySpecific.lua

@@ -514,6 +514,44 @@ function ____exports.spawnProjectileWithSeed(self, variant, subType, position, s
         seed
     )
 end
+function ____exports.spawnSlot(self, variant, 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 spawn(
+        nil,
+        EntityType.ENTITY_SLOT,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnSlotWithSeed(self, variant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnSlot(
+        nil,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
 function ____exports.spawnTear(self, variant, subType, position, velocity, spawner, seed)
     if velocity == nil then
         velocity = VectorZero

package/dist/functions/pickups.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/** Helper function to get all of the battery entities in the room. */
+export declare function getBatteries(matchingSubType?: number): EntityPickup[];
 /** 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. */
@@ -13,10 +15,20 @@ export declare function getKeys(matchingSubType?: number): EntityPickup[];
 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 sack (i.e. grab bag) entities in the room. */
+export declare function getSacks(matchingSubType?: number): 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 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 | int, cap?: int): boolean;
 /**
  * Helper function to remove all of the cards in the room.
  *
@@ -66,6 +78,14 @@ export declare function removeAllKeys(keySubType?: KeySubType | int, cap?: int):
  * @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 | int, cap?: int): boolean;
 /**
  * Helper function to remove all of the trinkets in the room.
  *
@@ -75,39 +95,51 @@ export declare function removeAllPills(pillColor?: PillColor, cap?: int): boolea
  * @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_LIL_BATTERY` (90).
+ */
+export declare function spawnBattery(subType: BatterySubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnBatteryWithSeed(subType: BatterySubType | 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_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;
+export declare function spawnCard(subType: Card | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnCardWithSeed(subType: Card | 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;
+export declare function spawnCoin(subType: CoinSubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnCoinWithSeed(subType: CoinSubType | 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;
+export declare function spawnHeart(subType: HeartSubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnHeartWithSeed(subType: HeartSubType | 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;
+export declare function spawnKey(subType: KeySubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnKeyWithSeed(subType: KeySubType | 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;
+export declare function spawnPill(subType: PillColor | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnPillWithSeed(subType: PillColor | 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_GRAB_BAG` (69).
+ */
+export declare function spawnSack(subType: SackSubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnSackWithSeed(subType: SackSubType | 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 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;
+export declare function spawnTrinket(subType: TrinketType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnTrinketWithSeed(subType: TrinketType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;

package/dist/functions/pickups.lua

@@ -11,6 +11,12 @@ local ____entitySpecific = require("functions.entitySpecific")
 local getPickups = ____entitySpecific.getPickups
 local removeAllPickups = ____entitySpecific.removeAllPickups
 local spawnPickup = ____entitySpecific.spawnPickup
+function ____exports.getBatteries(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, 90, matchingSubType)
+end
 function ____exports.getCards(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
@@ -54,6 +60,12 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
+function ____exports.getSacks(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, 69, matchingSubType)
+end
 function ____exports.getTrinkets(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
@@ -66,6 +78,9 @@ end
 function ____exports.isRedHeart(self, pickup)
     return pickup.Variant == 10 and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
 end
+function ____exports.removeAllBatteries(self, batterySubType, cap)
+    return removeAllPickups(nil, 90, batterySubType, cap)
+end
 function ____exports.removeAllCards(self, card, cap)
     return removeAllPickups(nil, 300, card, cap)
 end
@@ -84,9 +99,48 @@ end
 function ____exports.removeAllPills(self, pillColor, cap)
     return removeAllPickups(nil, 70, pillColor, cap)
 end
+function ____exports.removeAllSacks(self, sackSubType, cap)
+    return removeAllPickups(nil, 350, sackSubType, cap)
+end
 function ____exports.removeAllTrinkets(self, trinketType, cap)
     return removeAllPickups(nil, 350, trinketType, cap)
 end
+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,
+        90,
+        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
 function ____exports.spawnCard(self, subType, position, velocity, spawner, seed)
     if velocity == nil then
         velocity = VectorZero
@@ -267,6 +321,42 @@ function ____exports.spawnPillWithSeed(self, subType, position, seed, velocity,
         seed
     )
 end
+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,
+        69,
+        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
 function ____exports.spawnTrinket(self, subType, position, velocity, spawner, seed)
     if velocity == nil then
         velocity = VectorZero

package/package.json

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