isaacscript-common 17.2.0 → 17.3.0

package/dist/src/functions/pickupsSpecific.lua

@@ -209,7 +209,7 @@ 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, batterySubType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnBattery(self, batterySubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -223,7 +223,7 @@ function ____exports.spawnBattery(self, batterySubType, position, velocity, spaw
         nil,
         PickupVariant.LIL_BATTERY,
         batterySubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -231,7 +231,7 @@ function ____exports.spawnBattery(self, batterySubType, position, velocity, spaw
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90)
 -- and a specific seed.
-function ____exports.spawnBatteryWithSeed(self, batterySubType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnBatteryWithSeed(self, batterySubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -241,14 +241,14 @@ function ____exports.spawnBatteryWithSeed(self, batterySubType, position, seedOr
     return ____exports.spawnBattery(
         nil,
         batterySubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.BOMB` (40).
-function ____exports.spawnBombPickup(self, bombSubType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnBombPickup(self, bombSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -262,7 +262,7 @@ function ____exports.spawnBombPickup(self, bombSubType, position, velocity, spaw
         nil,
         PickupVariant.BOMB,
         bombSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -270,7 +270,7 @@ function ____exports.spawnBombPickup(self, bombSubType, position, velocity, spaw
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.BOMB` (40) and a
 -- specific seed.
-function ____exports.spawnBombPickupWithSeed(self, bombSubType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnBombPickupWithSeed(self, bombSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -280,14 +280,14 @@ function ____exports.spawnBombPickupWithSeed(self, bombSubType, position, seedOr
     return ____exports.spawnBombPickup(
         nil,
         bombSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
-function ____exports.spawnCard(self, cardType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnCard(self, cardType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -301,7 +301,7 @@ function ____exports.spawnCard(self, cardType, position, velocity, spawner, seed
         nil,
         PickupVariant.TAROT_CARD,
         cardType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -309,7 +309,7 @@ function ____exports.spawnCard(self, cardType, position, velocity, spawner, seed
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300)
 -- and a specific seed.
-function ____exports.spawnCardWithSeed(self, cardType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnCardWithSeed(self, cardType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -319,14 +319,14 @@ function ____exports.spawnCardWithSeed(self, cardType, position, seedOrRNG, velo
     return ____exports.spawnCard(
         nil,
         cardType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20).
-function ____exports.spawnCoin(self, coinSubType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnCoin(self, coinSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -340,7 +340,7 @@ function ____exports.spawnCoin(self, coinSubType, position, velocity, spawner, s
         nil,
         PickupVariant.COIN,
         coinSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -348,7 +348,7 @@ function ____exports.spawnCoin(self, coinSubType, position, velocity, spawner, s
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20) and a
 -- specific seed.
-function ____exports.spawnCoinWithSeed(self, coinSubType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnCoinWithSeed(self, coinSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -358,14 +358,14 @@ function ____exports.spawnCoinWithSeed(self, coinSubType, position, seedOrRNG, v
     return ____exports.spawnCoin(
         nil,
         coinSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10).
-function ____exports.spawnHeart(self, heartSubType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnHeart(self, heartSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -379,13 +379,13 @@ function ____exports.spawnHeart(self, heartSubType, position, velocity, spawner,
         nil,
         PickupVariant.HEART,
         heartSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
-function ____exports.spawnHeartWithSeed(self, heartSubType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnHeartWithSeed(self, heartSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -395,14 +395,14 @@ function ____exports.spawnHeartWithSeed(self, heartSubType, position, seedOrRNG,
     return ____exports.spawnHeart(
         nil,
         heartSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30).
-function ____exports.spawnKey(self, keySubType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnKey(self, keySubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -416,7 +416,7 @@ function ____exports.spawnKey(self, keySubType, position, velocity, spawner, see
         nil,
         PickupVariant.KEY,
         keySubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -424,7 +424,7 @@ function ____exports.spawnKey(self, keySubType, position, velocity, spawner, see
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30) and a
 -- specific seed.
-function ____exports.spawnKeyWithSeed(self, keySubType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnKeyWithSeed(self, keySubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -434,14 +434,14 @@ function ____exports.spawnKeyWithSeed(self, keySubType, position, seedOrRNG, vel
     return ____exports.spawnKey(
         nil,
         keySubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70).
-function ____exports.spawnPill(self, pillColor, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnPill(self, pillColor, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -455,7 +455,7 @@ function ____exports.spawnPill(self, pillColor, position, velocity, spawner, see
         nil,
         PickupVariant.PILL,
         pillColor,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -463,7 +463,7 @@ function ____exports.spawnPill(self, pillColor, position, velocity, spawner, see
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70) and a
 -- specific seed.
-function ____exports.spawnPillWithSeed(self, pillColor, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnPillWithSeed(self, pillColor, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -473,14 +473,14 @@ function ____exports.spawnPillWithSeed(self, pillColor, position, seedOrRNG, vel
     return ____exports.spawnPill(
         nil,
         pillColor,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69).
-function ____exports.spawnSack(self, sackSubType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnSack(self, sackSubType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -494,7 +494,7 @@ function ____exports.spawnSack(self, sackSubType, position, velocity, spawner, s
         nil,
         PickupVariant.SACK,
         sackSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -502,7 +502,7 @@ function ____exports.spawnSack(self, sackSubType, position, velocity, spawner, s
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69) and a
 -- specific seed.
-function ____exports.spawnSackWithSeed(self, sackSubType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnSackWithSeed(self, sackSubType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -512,14 +512,14 @@ function ____exports.spawnSackWithSeed(self, sackSubType, position, seedOrRNG, v
     return ____exports.spawnSack(
         nil,
         sackSubType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
     )
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
-function ____exports.spawnTrinket(self, trinketType, position, velocity, spawner, seedOrRNG)
+function ____exports.spawnTrinket(self, trinketType, positionOrGridIndex, velocity, spawner, seedOrRNG)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -533,7 +533,7 @@ function ____exports.spawnTrinket(self, trinketType, position, velocity, spawner
         nil,
         PickupVariant.TRINKET,
         trinketType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG
@@ -541,7 +541,7 @@ function ____exports.spawnTrinket(self, trinketType, position, velocity, spawner
 end
 --- Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350) and
 -- a specific seed.
-function ____exports.spawnTrinketWithSeed(self, trinketType, position, seedOrRNG, velocity, spawner)
+function ____exports.spawnTrinketWithSeed(self, trinketType, positionOrGridIndex, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
     end
@@ -551,7 +551,7 @@ function ____exports.spawnTrinketWithSeed(self, trinketType, position, seedOrRNG
     return ____exports.spawnTrinket(
         nil,
         trinketType,
-        position,
+        positionOrGridIndex,
         velocity,
         spawner,
         seedOrRNG

package/dist/src/functions/spawnCollectible.d.ts

@@ -10,7 +10,7 @@ import { CollectibleType } from "isaac-typescript-definitions";
  * (which is provided by `ISCFeature.SPAWN_COLLECTIBLE`).
  *
  * @param collectibleType The collectible type to spawn.
- * @param position The position to spawn the collectible at.
+ * @param positionOrGridIndex The position or grid index to spawn the collectible at.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param options Optional. Set to true to make the collectible a "There's Options" style
@@ -19,7 +19,7 @@ import { CollectibleType } from "isaac-typescript-definitions";
  *                      Tainted Keeper. Default is false.
  * @param spawner Optional.
  */
-export declare function spawnCollectibleUnsafe(collectibleType: CollectibleType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
+export declare function spawnCollectibleUnsafe(collectibleType: CollectibleType, positionOrGridIndex: Vector | int, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
 /**
  * Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
  * with `CollectibleType.NULL` will result in spawning a collectible with a random type from the
@@ -28,9 +28,9 @@ export declare function spawnCollectibleUnsafe(collectibleType: CollectibleType,
  * Instead, this function arbitrarily spawns a collectible with `CollectibleType.SAD_ONION`, and
  * then converts it to an empty pedestal afterward.
  *
- * @param position The position to spawn the empty collectible at.
+ * @param positionOrGridIndex The position or grid index to spawn the empty collectible at.
  * @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
-export declare function spawnEmptyCollectible(position: Vector, seedOrRNG?: Seed | RNG): EntityPickup;
+export declare function spawnEmptyCollectible(positionOrGridIndex: Vector | int, seedOrRNG?: Seed | RNG): EntityPickup;
 //# sourceMappingURL=spawnCollectible.d.ts.map

package/dist/src/functions/spawnCollectible.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"spawnCollectible.d.ts","sourceRoot":"","sources":["../../../src/functions/spawnCollectible.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAQtC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,EACf,aAAa,UAAQ,EACrB,OAAO,CAAC,EAAE,MAAM,GACf,uBAAuB,CAiCzB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,YAAY,CAWd"}
+{"version":3,"file":"spawnCollectible.d.ts","sourceRoot":"","sources":["../../../src/functions/spawnCollectible.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAQtC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,EAChC,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,EACf,aAAa,UAAQ,EACrB,OAAO,CAAC,EAAE,MAAM,GACf,uBAAuB,CAiCzB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CACnC,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,YAAY,CAWd"}

package/dist/src/functions/spawnCollectible.lua

@@ -26,7 +26,7 @@ local isRNG = ____rng.isRNG
 -- (which is provided by `ISCFeature.SPAWN_COLLECTIBLE`).
 -- 
 -- @param collectibleType The collectible type to spawn.
--- @param position The position to spawn the collectible at.
+-- @param positionOrGridIndex The position or grid index to spawn the collectible at.
 -- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
 -- `RNG.Next` method will be called. Default is `getRandomSeed()`.
 -- @param options Optional. Set to true to make the collectible a "There's Options" style
@@ -34,7 +34,7 @@ local isRNG = ____rng.isRNG
 -- @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
 -- Tainted Keeper. Default is false.
 -- @param spawner Optional.
-function ____exports.spawnCollectibleUnsafe(self, collectibleType, position, seedOrRNG, options, forceFreeItem, spawner)
+function ____exports.spawnCollectibleUnsafe(self, collectibleType, positionOrGridIndex, seedOrRNG, options, forceFreeItem, spawner)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
@@ -49,7 +49,7 @@ function ____exports.spawnCollectibleUnsafe(self, collectibleType, position, see
         nil,
         PickupVariant.COLLECTIBLE,
         collectibleType,
-        position,
+        positionOrGridIndex,
         seed,
         VectorZero,
         spawner
@@ -70,17 +70,17 @@ end
 -- Instead, this function arbitrarily spawns a collectible with `CollectibleType.SAD_ONION`, and
 -- then converts it to an empty pedestal afterward.
 -- 
--- @param position The position to spawn the empty collectible at.
+-- @param positionOrGridIndex The position or grid index to spawn the empty collectible at.
 -- @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
 -- `RNG.Next` method will be called. Default is `getRandomSeed()`.
-function ____exports.spawnEmptyCollectible(self, position, seedOrRNG)
+function ____exports.spawnEmptyCollectible(self, positionOrGridIndex, seedOrRNG)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
     local collectible = ____exports.spawnCollectibleUnsafe(
         nil,
         CollectibleType.SAD_ONION,
-        position,
+        positionOrGridIndex,
         seedOrRNG,
         false,
         true

package/dist/src/functions/stage.d.ts

@@ -22,8 +22,11 @@ export declare function getEffectiveStage(): int;
  * which will not display correctly on some fonts.
  *
  * Note that this returns "Blue Womb" instead of "???" for stage 9.
+ *
+ * @param stage Optional. If not specified, the current stage will be used.
+ * @param stageType Optional. If not specified, the current stage type will be used.
  */
-export declare function getEnglishLevelName(stage: LevelStage, stageType: StageType): string;
+export declare function getEnglishLevelName(stage?: LevelStage, stageType?: StageType): string;
 /**
  * Helper function to get the corresponding "goto" console command that would correspond to the
  * provided room type and room variant.

package/dist/src/functions/stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAQtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,CASvC;AAGD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,MAAM,CAGR;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,MAAM,CAG3E;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAQtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,CASvC;AAGD;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,MAAM,CAG3E;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}

package/dist/src/functions/stage.lua

@@ -83,7 +83,17 @@ end
 -- which will not display correctly on some fonts.
 -- 
 -- Note that this returns "Blue Womb" instead of "???" for stage 9.
+-- 
+-- @param stage Optional. If not specified, the current stage will be used.
+-- @param stageType Optional. If not specified, the current stage type will be used.
 function ____exports.getEnglishLevelName(self, stage, stageType)
+    local level = game:GetLevel()
+    if stage == nil then
+        stage = level:GetStage()
+    end
+    if stageType == nil then
+        stageType = level:GetStageType()
+    end
     local stageNames = ENGLISH_LEVEL_NAMES[stage]
     return stageNames[stageType]
 end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "17.2.0",
+  "version": "17.3.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/classes/features/other/CustomHotkeys.ts

@@ -67,6 +67,8 @@ export class CustomHotkeys extends Feature {
    * This can be used to easily set up custom hotkeys to facilitate custom game features or to
    * assist in debugging.
    *
+   * Inputs are checked for in the `POST_RENDER` callback.
+   *
    * This is different from the `setHotkey` function in that the keyboard activation key is not
    * hardcoded and is instead the return value of a provided function. This is useful for situations
    * where the key can change (like if end-users can specify a custom hotkey using Mod Config Menu).
@@ -97,6 +99,8 @@ export class CustomHotkeys extends Feature {
    * This can be used to easily set up custom hotkeys to facilitate custom game features or to
    * assist in debugging.
    *
+   * Inputs are checked for in the `POST_RENDER` callback.
+   *
    * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_HOTKEYS`.
    *
    * @param keyboard The key that you want to trigger the hotkey.

package/src/classes/features/other/SpawnCollectible.ts

@@ -34,7 +34,7 @@ export class SpawnCollectible extends Feature {
    * In order to use this function, you must upgrade your mod with `ISCFeature.SPAWN_COLLECTIBLE`.
    *
    * @param collectibleType The collectible type to spawn.
-   * @param position The position to spawn the collectible at.
+   * @param positionOrGridIndex The position or grid index to spawn the collectible at.
    * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
    *                  the `RNG.Next` method will be called. Default is `getRandomSeed()`.
    * @param options Optional. Set to true to make the collectible a "There's Options" style
@@ -46,7 +46,7 @@ export class SpawnCollectible extends Feature {
   @Exported
   public spawnCollectible(
     collectibleType: CollectibleType,
-    position: Vector,
+    positionOrGridIndex: Vector | int,
     seedOrRNG: Seed | RNG = getRandomSeed(),
     options = false,
     forceFreeItem = false,
@@ -54,7 +54,7 @@ export class SpawnCollectible extends Feature {
   ): EntityPickupCollectible {
     const collectible = spawnCollectibleUnsafe(
       collectibleType,
-      position,
+      positionOrGridIndex,
       seedOrRNG,
       options,
       forceFreeItem,
@@ -81,7 +81,7 @@ export class SpawnCollectible extends Feature {
    * In order to use this function, you must upgrade your mod with `ISCFeature.SPAWN_COLLECTIBLE`.
    *
    * @param itemPoolType The item pool to draw the collectible type from.
-   * @param position The position to spawn the collectible at.
+   * @param positionOrGridIndex The position or grid index to spawn the collectible at.
    * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
    *                  the `RNG.Next` method will be called. Default is `getRandomSeed()`.
    * @param options Optional. Set to true to make the collectible a "There's Options" style
@@ -93,7 +93,7 @@ export class SpawnCollectible extends Feature {
   @Exported
   public spawnCollectibleFromPool(
     itemPoolType: ItemPoolType,
-    position: Vector,
+    positionOrGridIndex: Vector | int,
     seedOrRNG: Seed | RNG = getRandomSeed(),
     options = false,
     forceFreeItem = false,
@@ -104,7 +104,7 @@ export class SpawnCollectible extends Feature {
 
     return this.spawnCollectible(
       collectibleType,
-      position,
+      positionOrGridIndex,
       seedOrRNG,
       options,
       forceFreeItem,

package/src/classes/features/other/SpawnRockAltRewards.ts

@@ -31,7 +31,7 @@ import { getRandom } from "../../../functions/random";
 import { getRandomSeed, isRNG, newRNG } from "../../../functions/rng";
 import { spawnCollectibleUnsafe } from "../../../functions/spawnCollectible";
 import { repeat } from "../../../functions/utils";
-import { getRandomVector } from "../../../functions/vector";
+import { getRandomVector, isVector } from "../../../functions/vector";
 import { Feature } from "../../private/Feature";
 import { ItemPoolDetection } from "./ItemPoolDetection";
 
@@ -92,7 +92,7 @@ export class SpawnRockAltRewards extends Feature {
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
    *
-   * @param position The place to spawn the reward.
+   * @param positionOrGridIndex The position or grid index to spawn the reward.
    * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a
    *                    chance at spawning coins and spiders.
    * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
@@ -102,10 +102,14 @@ export class SpawnRockAltRewards extends Feature {
    */
   @Exported
   public spawnRockAltReward(
-    position: Vector,
+    positionOrGridIndex: Vector | int,
     rockAltType: RockAltType,
     seedOrRNG: Seed | RNG = getRandomSeed(),
   ): boolean {
+    const room = game.GetRoom();
+    const position = isVector(positionOrGridIndex)
+      ? positionOrGridIndex
+      : room.GetGridPosition(positionOrGridIndex);
     const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
     switch (rockAltType) {

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,