isaacscript-common 17.2.1 → 17.3.0

package/src/functions/entitiesSpecific.ts

@@ -546,7 +546,7 @@ export function removeAllTears(
 export function spawnBomb(
   bombVariant: BombVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -555,7 +555,7 @@ export function spawnBomb(
     EntityType.BOMB,
     bombVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -573,7 +573,7 @@ export function spawnBomb(
 export function spawnBombWithSeed(
   bombVariant: BombVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -581,7 +581,7 @@ export function spawnBombWithSeed(
   return spawnBomb(
     bombVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -592,7 +592,7 @@ export function spawnBombWithSeed(
 export function spawnEffect(
   effectVariant: EffectVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -601,7 +601,7 @@ export function spawnEffect(
     EntityType.EFFECT,
     effectVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -619,7 +619,7 @@ export function spawnEffect(
 export function spawnEffectWithSeed(
   effectVariant: EffectVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -627,7 +627,7 @@ export function spawnEffectWithSeed(
   return spawnEffect(
     effectVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -643,7 +643,7 @@ export function spawnEffectWithSeed(
 export function spawnFamiliar(
   familiarVariant: FamiliarVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -652,7 +652,7 @@ export function spawnFamiliar(
     EntityType.FAMILIAR,
     familiarVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -670,7 +670,7 @@ export function spawnFamiliar(
 export function spawnFamiliarWithSeed(
   familiarVariant: FamiliarVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -678,7 +678,7 @@ export function spawnFamiliarWithSeed(
   return spawnFamiliar(
     familiarVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -689,7 +689,7 @@ export function spawnFamiliarWithSeed(
 export function spawnKnife(
   knifeVariant: KnifeVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -698,7 +698,7 @@ export function spawnKnife(
     EntityType.KNIFE,
     knifeVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -716,7 +716,7 @@ export function spawnKnife(
 export function spawnKnifeWithSeed(
   knifeVariant: KnifeVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -724,7 +724,7 @@ export function spawnKnifeWithSeed(
   return spawnKnife(
     knifeVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -735,7 +735,7 @@ export function spawnKnifeWithSeed(
 export function spawnLaser(
   laserVariant: LaserVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -744,7 +744,7 @@ export function spawnLaser(
     EntityType.LASER,
     laserVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -762,7 +762,7 @@ export function spawnLaser(
 export function spawnLaserWithSeed(
   laserVariant: LaserVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -770,7 +770,7 @@ export function spawnLaserWithSeed(
   return spawnLaser(
     laserVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -787,7 +787,7 @@ export function spawnNPC(
   entityType: EntityType,
   variant: int,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -796,7 +796,7 @@ export function spawnNPC(
     entityType,
     variant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -820,7 +820,7 @@ export function spawnNPCWithSeed(
   entityType: EntityType,
   variant: int,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -829,7 +829,7 @@ export function spawnNPCWithSeed(
     entityType,
     variant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -840,7 +840,7 @@ export function spawnNPCWithSeed(
 export function spawnPickup(
   pickupVariant: PickupVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -849,7 +849,7 @@ export function spawnPickup(
     EntityType.PICKUP,
     pickupVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -867,7 +867,7 @@ export function spawnPickup(
 export function spawnPickupWithSeed(
   pickupVariant: PickupVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -875,7 +875,7 @@ export function spawnPickupWithSeed(
   return spawnPickup(
     pickupVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -886,7 +886,7 @@ export function spawnPickupWithSeed(
 export function spawnProjectile(
   projectileVariant: ProjectileVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -895,7 +895,7 @@ export function spawnProjectile(
     EntityType.PROJECTILE,
     projectileVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -913,7 +913,7 @@ export function spawnProjectile(
 export function spawnProjectileWithSeed(
   projectileVariant: ProjectileVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -921,7 +921,7 @@ export function spawnProjectileWithSeed(
   return spawnProjectile(
     projectileVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -932,7 +932,7 @@ export function spawnProjectileWithSeed(
 export function spawnSlot(
   slotVariant: SlotVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -941,7 +941,7 @@ export function spawnSlot(
     EntityType.SLOT,
     slotVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -952,7 +952,7 @@ export function spawnSlot(
 export function spawnSlotWithSeed(
   slotVariant: SlotVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -960,7 +960,7 @@ export function spawnSlotWithSeed(
   return spawnSlot(
     slotVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -971,7 +971,7 @@ export function spawnSlotWithSeed(
 export function spawnTear(
   tearVariant: TearVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -980,7 +980,7 @@ export function spawnTear(
     EntityType.TEAR,
     tearVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -998,7 +998,7 @@ export function spawnTear(
 export function spawnTearWithSeed(
   tearVariant: TearVariant,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -1006,7 +1006,7 @@ export function spawnTearWithSeed(
   return spawnTear(
     tearVariant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,

package/src/functions/pickupsSpecific.ts

@@ -330,7 +330,7 @@ export function removeAllTrinkets(
  */
 export function spawnBattery(
   batterySubType: BatterySubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -338,7 +338,7 @@ export function spawnBattery(
   return spawnPickup(
     PickupVariant.LIL_BATTERY,
     batterySubType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -351,18 +351,24 @@ export function spawnBattery(
  */
 export function spawnBatteryWithSeed(
   batterySubType: BatterySubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupBattery {
-  return spawnBattery(batterySubType, position, velocity, spawner, seedOrRNG);
+  return spawnBattery(
+    batterySubType,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.BOMB` (40). */
 export function spawnBombPickup(
   bombSubType: BombSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -370,7 +376,7 @@ export function spawnBombPickup(
   return spawnPickup(
     PickupVariant.BOMB,
     bombSubType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -383,12 +389,18 @@ export function spawnBombPickup(
  */
 export function spawnBombPickupWithSeed(
   bombSubType: BombSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupBomb {
-  return spawnBombPickup(bombSubType, position, velocity, spawner, seedOrRNG);
+  return spawnBombPickup(
+    bombSubType,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }
 
 /**
@@ -396,7 +408,7 @@ export function spawnBombPickupWithSeed(
  */
 export function spawnCard(
   cardType: CardType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -404,7 +416,7 @@ export function spawnCard(
   return spawnPickup(
     PickupVariant.TAROT_CARD,
     cardType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -417,18 +429,18 @@ export function spawnCard(
  */
 export function spawnCardWithSeed(
   cardType: CardType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupCard {
-  return spawnCard(cardType, position, velocity, spawner, seedOrRNG);
+  return spawnCard(cardType, positionOrGridIndex, velocity, spawner, seedOrRNG);
 }
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */
 export function spawnCoin(
   coinSubType: CoinSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -436,7 +448,7 @@ export function spawnCoin(
   return spawnPickup(
     PickupVariant.COIN,
     coinSubType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -449,18 +461,24 @@ export function spawnCoin(
  */
 export function spawnCoinWithSeed(
   coinSubType: CoinSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupCoin {
-  return spawnCoin(coinSubType, position, velocity, spawner, seedOrRNG);
+  return spawnCoin(
+    coinSubType,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10). */
 export function spawnHeart(
   heartSubType: HeartSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -468,7 +486,7 @@ export function spawnHeart(
   return spawnPickup(
     PickupVariant.HEART,
     heartSubType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -477,18 +495,24 @@ export function spawnHeart(
 
 export function spawnHeartWithSeed(
   heartSubType: HeartSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupHeart {
-  return spawnHeart(heartSubType, position, velocity, spawner, seedOrRNG);
+  return spawnHeart(
+    heartSubType,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30). */
 export function spawnKey(
   keySubType: KeySubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -496,7 +520,7 @@ export function spawnKey(
   return spawnPickup(
     PickupVariant.KEY,
     keySubType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -509,18 +533,24 @@ export function spawnKey(
  */
 export function spawnKeyWithSeed(
   keySubType: KeySubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupKey {
-  return spawnKey(keySubType, position, velocity, spawner, seedOrRNG);
+  return spawnKey(
+    keySubType,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70). */
 export function spawnPill(
   pillColor: PillColor,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -528,7 +558,7 @@ export function spawnPill(
   return spawnPickup(
     PickupVariant.PILL,
     pillColor,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -541,18 +571,24 @@ export function spawnPill(
  */
 export function spawnPillWithSeed(
   pillColor: PillColor,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupPill {
-  return spawnPill(pillColor, position, velocity, spawner, seedOrRNG);
+  return spawnPill(
+    pillColor,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69). */
 export function spawnSack(
   sackSubType: SackSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -560,7 +596,7 @@ export function spawnSack(
   return spawnPickup(
     PickupVariant.SACK,
     sackSubType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -573,12 +609,18 @@ export function spawnSack(
  */
 export function spawnSackWithSeed(
   sackSubType: SackSubType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupSack {
-  return spawnSack(sackSubType, position, velocity, spawner, seedOrRNG);
+  return spawnSack(
+    sackSubType,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }
 
 /**
@@ -586,7 +628,7 @@ export function spawnSackWithSeed(
  */
 export function spawnTrinket(
   trinketType: TrinketType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -594,7 +636,7 @@ export function spawnTrinket(
   return spawnPickup(
     PickupVariant.TRINKET,
     trinketType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -607,10 +649,16 @@ export function spawnTrinket(
  */
 export function spawnTrinketWithSeed(
   trinketType: TrinketType,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupTrinket {
-  return spawnTrinket(trinketType, position, velocity, spawner, seedOrRNG);
+  return spawnTrinket(
+    trinketType,
+    positionOrGridIndex,
+    velocity,
+    spawner,
+    seedOrRNG,
+  );
 }