isaacscript-common 17.2.1 → 17.4.0

package/src/functions/bosses.ts

@@ -157,7 +157,7 @@ export function spawnBoss(
   entityType: EntityType,
   variant: int,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -168,7 +168,7 @@ export function spawnBoss(
     entityType,
     variant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seed,
@@ -182,7 +182,15 @@ export function spawnBoss(
     );
     const remainingSegmentsToSpawn = numBossSegments - 1;
     repeat(remainingSegmentsToSpawn, () => {
-      spawnNPC(entityType, variant, subType, position, velocity, spawner, seed);
+      spawnNPC(
+        entityType,
+        variant,
+        subType,
+        positionOrGridIndex,
+        velocity,
+        spawner,
+        seed,
+      );
     });
   }
 
@@ -231,7 +239,7 @@ export function spawnBossWithSeed(
   entityType: EntityType,
   variant: int,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -242,7 +250,7 @@ export function spawnBossWithSeed(
     entityType,
     variant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seed,

package/src/functions/entities.ts

@@ -488,7 +488,7 @@ export function setEntityRandomColor(entity: Entity): void {
  * @param entityType The `EntityType` of the entity to spawn.
  * @param variant The variant of the entity to spawn.
  * @param subType The sub-type of the entity to spawn.
- * @param position The position of the entity to spawn.
+ * @param positionOrGridIndex The position or grid index of the entity to spawn.
  * @param velocity Optional. The velocity of the entity to spawn. Default is `VectorZero`.
  * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
  * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
@@ -499,13 +499,15 @@ export function spawn(
   entityType: EntityType,
   variant: int,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
 ): Entity {
+  const room = game.GetRoom();
+
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (position === undefined) {
+  if (positionOrGridIndex === undefined) {
     const entityID = getEntityIDFromConstituents(entityType, variant, subType);
     error(
       `Failed to spawn entity ${entityID} since an undefined position was passed to the "spawn" function.`,
@@ -520,6 +522,10 @@ export function spawn(
     );
   }
 
+  const position = isVector(positionOrGridIndex)
+    ? positionOrGridIndex
+    : room.GetGridPosition(positionOrGridIndex);
+
   if (seedOrRNG === undefined) {
     return Isaac.Spawn(
       entityType,
@@ -547,7 +553,7 @@ export function spawn(
  * Helper function to spawn the entity corresponding to an `EntityID`.
  *
  * @param entityID The `EntityID` of the entity to spawn.
- * @param position The position of the entity to spawn.
+ * @param positionOrGridIndex The position or grid index of the entity to spawn.
  * @param velocity Optional. The velocity of the entity to spawn. Default is `VectorZero`.
  * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
  * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
@@ -556,7 +562,7 @@ export function spawn(
  */
 export function spawnEntityID(
   entityID: EntityID,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
   seedOrRNG: Seed | RNG | undefined = undefined,
@@ -566,7 +572,7 @@ export function spawnEntityID(
     entityType,
     variant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,
@@ -581,7 +587,7 @@ export function spawnWithSeed(
   entityType: EntityType,
   variant: int,
   subType: int,
-  position: Vector,
+  positionOrGridIndex: Vector | int,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -590,7 +596,7 @@ export function spawnWithSeed(
     entityType,
     variant,
     subType,
-    position,
+    positionOrGridIndex,
     velocity,
     spawner,
     seedOrRNG,

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,