isaacscript-common 69.4.0 → 70.0.0

package/dist/index.rollup.d.ts

@@ -17680,7 +17680,7 @@ export declare function spawnFamiliarWithSeed(familiarVariant: FamiliarVariant,
 export declare function spawnGiantPoop(topLeftGridIndex: int): boolean;
 
 /**
- * Helper function to spawn a grid entity.
+ * Helper function to spawn a grid entity with a specific type.
  *
  * This function assumes you want to give the grid entity a variant of 0. If you want to specify a
  * variant, use the `spawnGridEntityWithVariant` helper function instead.
@@ -17689,8 +17689,17 @@ export declare function spawnGiantPoop(topLeftGridIndex: int): boolean;
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify either the grid index or the position
+ *
+ * @param gridEntityType The `GridEntityType` to use.
+ * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+ *                            entity at. If a position is specified, the closest grid index will be
+ *                            used.
+ * @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+ *                                 tile, if it exists. Defaults to true. If false, this function
+ *                                 will do nothing, since spawning a grid entity on top of another
+ *                                 grid entity will not replace it.
  */
-export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndexOrPosition: int | Vector, removeExistingGridEntity?: boolean): GridEntity | undefined;
 
 /**
  * Helper function to spawn a grid entity with a specific variant.
@@ -17699,8 +17708,18 @@ export declare function spawnGridEntity(gridEntityType: GridEntityType, gridInde
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify the grid index or the position
- */
-export declare function spawnGridEntityWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+ *
+ * @param gridEntityType The `GridEntityType` to use.
+ * @param variant The variant to use.
+ * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+ *                            entity at. If a position is specified, the closest grid index will be
+ *                            used.
+ * @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+ *                                 tile, if it exists. Defaults to true. If false, this function
+ *                                 will do nothing, since spawning a grid entity on top of another
+ *                                 grid entity will not replace it.
+ */
+export declare function spawnGridEntityWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector, removeExistingGridEntity?: boolean): GridEntity | undefined;
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10). */
 export declare function spawnHeart(heartSubType: HeartSubType, positionOrGridIndex: Vector | int, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupHeart;

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 69.4.0
+isaacscript-common 70.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -10787,8 +10787,8 @@ ____exports.SoundEffect.TEAR_IMPACTS = 150
 ____exports.SoundEffect[____exports.SoundEffect.TEAR_IMPACTS] = "TEAR_IMPACTS"
 ____exports.SoundEffect.TEARS_FIRE = 153
 ____exports.SoundEffect[____exports.SoundEffect.TEARS_FIRE] = "TEARS_FIRE"
-____exports.SoundEffect.UNLOCK = 156
-____exports.SoundEffect[____exports.SoundEffect.UNLOCK] = "UNLOCK"
+____exports.SoundEffect.UNLOCK_DOOR = 156
+____exports.SoundEffect[____exports.SoundEffect.UNLOCK_DOOR] = "UNLOCK_DOOR"
 ____exports.SoundEffect.VAMP_GULP = 157
 ____exports.SoundEffect[____exports.SoundEffect.VAMP_GULP] = "VAMP_GULP"
 ____exports.SoundEffect.WHEEZY_COUGH = 158
@@ -10821,8 +10821,8 @@ ____exports.SoundEffect.LIGHT_BOLT_CHARGE = 173
 ____exports.SoundEffect[____exports.SoundEffect.LIGHT_BOLT_CHARGE] = "LIGHT_BOLT_CHARGE"
 ____exports.SoundEffect.BLOOD_BANK_TOUCHED = 174
 ____exports.SoundEffect[____exports.SoundEffect.BLOOD_BANK_TOUCHED] = "BLOOD_BANK_TOUCHED"
-____exports.SoundEffect.BLOOD_BANK_SPAWN = 175
-____exports.SoundEffect[____exports.SoundEffect.BLOOD_BANK_SPAWN] = "BLOOD_BANK_SPAWN"
+____exports.SoundEffect.PINKING_SHEARS = 175
+____exports.SoundEffect[____exports.SoundEffect.PINKING_SHEARS] = "PINKING_SHEARS"
 ____exports.SoundEffect.BLOOD_SHOOT = 178
 ____exports.SoundEffect[____exports.SoundEffect.BLOOD_SHOOT] = "BLOOD_SHOOT"
 ____exports.SoundEffect.BOIL_HATCH = 181
@@ -11035,8 +11035,8 @@ ____exports.SoundEffect.BERKANO = 331
 ____exports.SoundEffect[____exports.SoundEffect.BERKANO] = "BERKANO"
 ____exports.SoundEffect.BOMBS_ARE_KEY = 332
 ____exports.SoundEffect[____exports.SoundEffect.BOMBS_ARE_KEY] = "BOMBS_ARE_KEY"
-____exports.SoundEffect.CARD_VS_HUMAN = 333
-____exports.SoundEffect[____exports.SoundEffect.CARD_VS_HUMAN] = "CARD_VS_HUMAN"
+____exports.SoundEffect.CARD_AGAINST_HUMANITY = 333
+____exports.SoundEffect[____exports.SoundEffect.CARD_AGAINST_HUMANITY] = "CARD_AGAINST_HUMANITY"
 ____exports.SoundEffect.CHAOS_CARD = 334
 ____exports.SoundEffect[____exports.SoundEffect.CHAOS_CARD] = "CHAOS_CARD"
 ____exports.SoundEffect.CREDIT_CARD = 335
@@ -11127,8 +11127,8 @@ ____exports.SoundEffect.HERMIT = 377
 ____exports.SoundEffect[____exports.SoundEffect.HERMIT] = "HERMIT"
 ____exports.SoundEffect.HIEROPHANT = 378
 ____exports.SoundEffect[____exports.SoundEffect.HIEROPHANT] = "HIEROPHANT"
-____exports.SoundEffect.HIGHT_PRIESTESS = 379
-____exports.SoundEffect[____exports.SoundEffect.HIGHT_PRIESTESS] = "HIGHT_PRIESTESS"
+____exports.SoundEffect.HIGH_PRIESTESS = 379
+____exports.SoundEffect[____exports.SoundEffect.HIGH_PRIESTESS] = "HIGH_PRIESTESS"
 ____exports.SoundEffect.LOVERS = 380
 ____exports.SoundEffect[____exports.SoundEffect.LOVERS] = "LOVERS"
 ____exports.SoundEffect.MAGICIAN = 381
@@ -11143,14 +11143,14 @@ ____exports.SoundEffect.TOWER = 385
 ____exports.SoundEffect[____exports.SoundEffect.TOWER] = "TOWER"
 ____exports.SoundEffect.WORLD = 386
 ____exports.SoundEffect[____exports.SoundEffect.WORLD] = "WORLD"
-____exports.SoundEffect.TWO_CLUBS = 387
-____exports.SoundEffect[____exports.SoundEffect.TWO_CLUBS] = "TWO_CLUBS"
-____exports.SoundEffect.TWO_DIAMONDS = 388
-____exports.SoundEffect[____exports.SoundEffect.TWO_DIAMONDS] = "TWO_DIAMONDS"
-____exports.SoundEffect.TWO_HEARTS = 389
-____exports.SoundEffect[____exports.SoundEffect.TWO_HEARTS] = "TWO_HEARTS"
-____exports.SoundEffect.TWO_SPADES = 390
-____exports.SoundEffect[____exports.SoundEffect.TWO_SPADES] = "TWO_SPADES"
+____exports.SoundEffect.TWO_OF_CLUBS = 387
+____exports.SoundEffect[____exports.SoundEffect.TWO_OF_CLUBS] = "TWO_OF_CLUBS"
+____exports.SoundEffect.TWO_OF_DIAMONDS = 388
+____exports.SoundEffect[____exports.SoundEffect.TWO_OF_DIAMONDS] = "TWO_OF_DIAMONDS"
+____exports.SoundEffect.TWO_OF_HEARTS = 389
+____exports.SoundEffect[____exports.SoundEffect.TWO_OF_HEARTS] = "TWO_OF_HEARTS"
+____exports.SoundEffect.TWO_OF_SPADES = 390
+____exports.SoundEffect[____exports.SoundEffect.TWO_OF_SPADES] = "TWO_OF_SPADES"
 ____exports.SoundEffect.WHEEL_OF_FORTUNE = 391
 ____exports.SoundEffect[____exports.SoundEffect.WHEEL_OF_FORTUNE] = "WHEEL_OF_FORTUNE"
 ____exports.SoundEffect.RAGMAN_1 = 392
@@ -11173,12 +11173,12 @@ ____exports.SoundEffect.DICE_SHARD = 400
 ____exports.SoundEffect[____exports.SoundEffect.DICE_SHARD] = "DICE_SHARD"
 ____exports.SoundEffect.EMERGENCY = 401
 ____exports.SoundEffect[____exports.SoundEffect.EMERGENCY] = "EMERGENCY"
-____exports.SoundEffect.INFESTED_EXCL = 402
-____exports.SoundEffect[____exports.SoundEffect.INFESTED_EXCL] = "INFESTED_EXCL"
-____exports.SoundEffect.INFESTED_QUEST = 403
-____exports.SoundEffect[____exports.SoundEffect.INFESTED_QUEST] = "INFESTED_QUEST"
-____exports.SoundEffect.JAIL_CARD = 404
-____exports.SoundEffect[____exports.SoundEffect.JAIL_CARD] = "JAIL_CARD"
+____exports.SoundEffect.INFESTED_EXCLAMATION = 402
+____exports.SoundEffect[____exports.SoundEffect.INFESTED_EXCLAMATION] = "INFESTED_EXCLAMATION"
+____exports.SoundEffect.INFESTED_QUESTION = 403
+____exports.SoundEffect[____exports.SoundEffect.INFESTED_QUESTION] = "INFESTED_QUESTION"
+____exports.SoundEffect.GET_OUT_OF_JAIL_CARD = 404
+____exports.SoundEffect[____exports.SoundEffect.GET_OUT_OF_JAIL_CARD] = "GET_OUT_OF_JAIL_CARD"
 ____exports.SoundEffect.LARGER = 405
 ____exports.SoundEffect[____exports.SoundEffect.LARGER] = "LARGER"
 ____exports.SoundEffect.PERCS = 406
@@ -11193,8 +11193,8 @@ ____exports.SoundEffect.RETRO = 410
 ____exports.SoundEffect[____exports.SoundEffect.RETRO] = "RETRO"
 ____exports.SoundEffect.SMALL = 411
 ____exports.SoundEffect[____exports.SoundEffect.SMALL] = "SMALL"
-____exports.SoundEffect.QQQ = 412
-____exports.SoundEffect[____exports.SoundEffect.QQQ] = "QQQ"
+____exports.SoundEffect.QUESTION_MARKS = 412
+____exports.SoundEffect[____exports.SoundEffect.QUESTION_MARKS] = "QUESTION_MARKS"
 ____exports.SoundEffect.DANGLE_WHISTLE = 413
 ____exports.SoundEffect[____exports.SoundEffect.DANGLE_WHISTLE] = "DANGLE_WHISTLE"
 ____exports.SoundEffect.LITTLE_HORN_COUGH = 414
@@ -11253,8 +11253,8 @@ ____exports.SoundEffect.ULTRA_GREED_SPINNING = 440
 ____exports.SoundEffect[____exports.SoundEffect.ULTRA_GREED_SPINNING] = "ULTRA_GREED_SPINNING"
 ____exports.SoundEffect.DOG_BARK = 441
 ____exports.SoundEffect[____exports.SoundEffect.DOG_BARK] = "DOG_BARK"
-____exports.SoundEffect.DOG_HOWELL = 442
-____exports.SoundEffect[____exports.SoundEffect.DOG_HOWELL] = "DOG_HOWELL"
+____exports.SoundEffect.DOG_HOWL = 442
+____exports.SoundEffect[____exports.SoundEffect.DOG_HOWL] = "DOG_HOWL"
 ____exports.SoundEffect.X_LAX = 443
 ____exports.SoundEffect[____exports.SoundEffect.X_LAX] = "X_LAX"
 ____exports.SoundEffect.WRONG = 444
@@ -11263,14 +11263,14 @@ ____exports.SoundEffect.VURP = 445
 ____exports.SoundEffect[____exports.SoundEffect.VURP] = "VURP"
 ____exports.SoundEffect.SUNSHINE = 446
 ____exports.SoundEffect[____exports.SoundEffect.SUNSHINE] = "SUNSHINE"
-____exports.SoundEffect.SPADES = 447
-____exports.SoundEffect[____exports.SoundEffect.SPADES] = "SPADES"
+____exports.SoundEffect.ACE_OF_SPADES = 447
+____exports.SoundEffect[____exports.SoundEffect.ACE_OF_SPADES] = "ACE_OF_SPADES"
 ____exports.SoundEffect.HORF = 448
 ____exports.SoundEffect[____exports.SoundEffect.HORF] = "HORF"
 ____exports.SoundEffect.HOLY_CARD = 449
 ____exports.SoundEffect[____exports.SoundEffect.HOLY_CARD] = "HOLY_CARD"
-____exports.SoundEffect.HEARTS = 450
-____exports.SoundEffect[____exports.SoundEffect.HEARTS] = "HEARTS"
+____exports.SoundEffect.ACE_OF_HEARTS = 450
+____exports.SoundEffect[____exports.SoundEffect.ACE_OF_HEARTS] = "ACE_OF_HEARTS"
 ____exports.SoundEffect.GULP = 451
 ____exports.SoundEffect[____exports.SoundEffect.GULP] = "GULP"
 ____exports.SoundEffect.FRIENDS = 452
@@ -11279,10 +11279,10 @@ ____exports.SoundEffect.EXCITED = 453
 ____exports.SoundEffect[____exports.SoundEffect.EXCITED] = "EXCITED"
 ____exports.SoundEffect.DROWSY = 454
 ____exports.SoundEffect[____exports.SoundEffect.DROWSY] = "DROWSY"
-____exports.SoundEffect.DIAMONDS = 455
-____exports.SoundEffect[____exports.SoundEffect.DIAMONDS] = "DIAMONDS"
-____exports.SoundEffect.CLUBS = 456
-____exports.SoundEffect[____exports.SoundEffect.CLUBS] = "CLUBS"
+____exports.SoundEffect.ACE_OF_DIAMONDS = 455
+____exports.SoundEffect[____exports.SoundEffect.ACE_OF_DIAMONDS] = "ACE_OF_DIAMONDS"
+____exports.SoundEffect.ACE_OF_CLUBS = 456
+____exports.SoundEffect[____exports.SoundEffect.ACE_OF_CLUBS] = "ACE_OF_CLUBS"
 ____exports.SoundEffect.BLACK_RUNE = 457
 ____exports.SoundEffect[____exports.SoundEffect.BLACK_RUNE] = "BLACK_RUNE"
 ____exports.SoundEffect.PING_PONG = 458
@@ -28973,7 +28973,10 @@ function ____exports.removeGridEntity(self, gridEntityOrGridIndex, updateRoom)
         removeEntities(nil, effectsOnTile)
     end
 end
-function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndexOrPosition)
+function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndexOrPosition, removeExistingGridEntity)
+    if removeExistingGridEntity == nil then
+        removeExistingGridEntity = true
+    end
     local room = game:GetRoom()
     local ____isVector_result_3
     if isVector(nil, gridIndexOrPosition) then
@@ -28983,7 +28986,11 @@ function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, g
     end
     local existingGridEntity = ____isVector_result_3
     if existingGridEntity ~= nil then
-        ____exports.removeGridEntity(nil, existingGridEntity, true)
+        if removeExistingGridEntity then
+            ____exports.removeGridEntity(nil, existingGridEntity, true)
+        else
+            return
+        end
     end
     local position = isVector(nil, gridIndexOrPosition) and gridIndexOrPosition or room:GetGridPosition(gridIndexOrPosition)
     local gridEntity = Isaac.GridSpawn(gridEntityType, variant, position)
@@ -29332,8 +29339,17 @@ function ____exports.spawnGiantPoop(self, topLeftGridIndex)
     local bottomRight = ____exports.spawnGridEntityWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIANT_BOTTOM_RIGHT, bottomRightGridIndex)
     return topLeft ~= nil and topLeft:GetType() == GridEntityType.POOP and topLeft:GetVariant() == PoopGridEntityVariant.GIANT_TOP_LEFT and topRight ~= nil and topRight:GetType() == GridEntityType.POOP and topRight:GetVariant() == PoopGridEntityVariant.GIANT_TOP_RIGHT and bottomLeft ~= nil and bottomLeft:GetType() == GridEntityType.POOP and bottomLeft:GetVariant() == PoopGridEntityVariant.GIANT_BOTTOM_LEFT and bottomRight ~= nil and bottomRight:GetType() == GridEntityType.POOP and bottomRight:GetVariant() == PoopGridEntityVariant.GIANT_BOTTOM_RIGHT
 end
-function ____exports.spawnGridEntity(self, gridEntityType, gridIndexOrPosition)
-    return ____exports.spawnGridEntityWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
+function ____exports.spawnGridEntity(self, gridEntityType, gridIndexOrPosition, removeExistingGridEntity)
+    if removeExistingGridEntity == nil then
+        removeExistingGridEntity = true
+    end
+    return ____exports.spawnGridEntityWithVariant(
+        nil,
+        gridEntityType,
+        0,
+        gridIndexOrPosition,
+        removeExistingGridEntity
+    )
 end
 function ____exports.spawnVoidPortal(self, gridIndex)
     local voidPortal = ____exports.spawnGridEntityWithVariant(nil, GridEntityType.TRAPDOOR, TrapdoorVariant.VOID_PORTAL, gridIndex)

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

@@ -281,7 +281,7 @@ export declare function setGridEntityType(gridEntity: GridEntity, gridEntityType
  */
 export declare function spawnGiantPoop(topLeftGridIndex: int): boolean;
 /**
- * Helper function to spawn a grid entity.
+ * Helper function to spawn a grid entity with a specific type.
  *
  * This function assumes you want to give the grid entity a variant of 0. If you want to specify a
  * variant, use the `spawnGridEntityWithVariant` helper function instead.
@@ -290,8 +290,17 @@ export declare function spawnGiantPoop(topLeftGridIndex: int): boolean;
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify either the grid index or the position
+ *
+ * @param gridEntityType The `GridEntityType` to use.
+ * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+ *                            entity at. If a position is specified, the closest grid index will be
+ *                            used.
+ * @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+ *                                 tile, if it exists. Defaults to true. If false, this function
+ *                                 will do nothing, since spawning a grid entity on top of another
+ *                                 grid entity will not replace it.
  */
-export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndexOrPosition: int | Vector, removeExistingGridEntity?: boolean): GridEntity | undefined;
 /**
  * Helper function to spawn a grid entity with a specific variant.
  *
@@ -299,8 +308,18 @@ export declare function spawnGridEntity(gridEntityType: GridEntityType, gridInde
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify the grid index or the position
+ *
+ * @param gridEntityType The `GridEntityType` to use.
+ * @param variant The variant to use.
+ * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+ *                            entity at. If a position is specified, the closest grid index will be
+ *                            used.
+ * @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+ *                                 tile, if it exists. Defaults to true. If false, this function
+ *                                 will do nothing, since spawning a grid entity on top of another
+ *                                 grid entity will not replace it.
  */
-export declare function spawnGridEntityWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+export declare function spawnGridEntityWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector, removeExistingGridEntity?: boolean): GridEntity | undefined;
 /**
  * Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
  * with the appropriate variant, as the game does not give it the correct sprite automatically.

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

@@ -1 +1 @@
-{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAIL,cAAc,EAIf,MAAM,8BAA8B,CAAC;AAYtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AA0C1D;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAenC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,cAAc,EAC9B,OAAO,SAAK,GACX,OAAO,CAiBT;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;;;;GASG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CAoBV;AAED,qFAAqF;AACrF,wBAAgB,+BAA+B,CAC7C,YAAY,EAAE,YAAY,GACzB,CAAC,cAAc,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,CAuBhD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD,uFAAuF;AACvF,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,GACb,UAAU,EAAE,CAyCd;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,mEAAmE;AACnE,wBAAgB,qBAAqB,CACnC,cAAc,EAAE,cAAc,GAC7B,MAAM,GAAG,SAAS,CAGpB;AAkID,2FAA2F;AAC3F,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAWA;AAED,qFAAqF;AACrF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,YAAY,CAIpE;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,YAAY,CAEd;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAGvC;AAkJD;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CAed;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,GAAG,GACb;IACD,OAAO,EAAE,GAAG;IACZ,GAAG,EAAE,GAAG;IACR,QAAQ,EAAE,GAAG;IACb,IAAI,EAAE,GAAG;IACT,KAAK,EAAE,GAAG;IACV,UAAU,EAAE,GAAG;IACf,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,GAAG;CACjB,CAgBA;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAO7C;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAEzE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAgBjE;AAED,4EAA4E;AAC5E,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAET;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAQpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,MAAM,EAAE,EAClB,UAAU,EAAE,UAAU,GACrB,IAAI,CAON;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,cAAc,GAC7B,IAAI,CAmBN;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAwD7D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}
+{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAIL,cAAc,EAIf,MAAM,8BAA8B,CAAC;AAYtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AA0C1D;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAenC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,cAAc,EAC9B,OAAO,SAAK,GACX,OAAO,CAiBT;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;;;;GASG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CAoBV;AAED,qFAAqF;AACrF,wBAAgB,+BAA+B,CAC7C,YAAY,EAAE,YAAY,GACzB,CAAC,cAAc,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,CAuBhD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD,uFAAuF;AACvF,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,GACb,UAAU,EAAE,CAyCd;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,mEAAmE;AACnE,wBAAgB,qBAAqB,CACnC,cAAc,EAAE,cAAc,GAC7B,MAAM,GAAG,SAAS,CAGpB;AAkID,2FAA2F;AAC3F,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAWA;AAED,qFAAqF;AACrF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,YAAY,CAIpE;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,YAAY,CAEd;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAGvC;AAkJD;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CAed;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,GAAG,GACb;IACD,OAAO,EAAE,GAAG;IACZ,GAAG,EAAE,GAAG;IACR,QAAQ,EAAE,GAAG;IACb,IAAI,EAAE,GAAG;IACT,KAAK,EAAE,GAAG;IACV,UAAU,EAAE,GAAG;IACf,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,GAAG;CACjB,CAgBA;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAO7C;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAEzE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAgBjE;AAED,4EAA4E;AAC5E,wBAAgB,uBAAuB,CACrC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAET;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAQpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,MAAM,EAAE,EAClB,UAAU,EAAE,UAAU,GACrB,IAAI,CAON;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,cAAc,GAC7B,IAAI,CAmBN;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAwD7D;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,wBAAwB,UAAO,GAC9B,UAAU,GAAG,SAAS,CAOxB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,wBAAwB,UAAO,GAC9B,UAAU,GAAG,SAAS,CAoCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}

package/dist/src/functions/gridEntities.lua

@@ -417,7 +417,20 @@ end
 -- - handles giving pits collision
 -- - removes existing grid entities on the same tile, if any
 -- - allows you to specify the grid index or the position
-function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndexOrPosition)
+-- 
+-- @param gridEntityType The `GridEntityType` to use.
+-- @param variant The variant to use.
+-- @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+-- entity at. If a position is specified, the closest grid index will be
+-- used.
+-- @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+-- tile, if it exists. Defaults to true. If false, this function
+-- will do nothing, since spawning a grid entity on top of another
+-- grid entity will not replace it.
+function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndexOrPosition, removeExistingGridEntity)
+    if removeExistingGridEntity == nil then
+        removeExistingGridEntity = true
+    end
     local room = game:GetRoom()
     local ____isVector_result_3
     if isVector(nil, gridIndexOrPosition) then
@@ -427,7 +440,11 @@ function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, g
     end
     local existingGridEntity = ____isVector_result_3
     if existingGridEntity ~= nil then
-        ____exports.removeGridEntity(nil, existingGridEntity, true)
+        if removeExistingGridEntity then
+            ____exports.removeGridEntity(nil, existingGridEntity, true)
+        else
+            return
+        end
     end
     local position = isVector(nil, gridIndexOrPosition) and gridIndexOrPosition or room:GetGridPosition(gridIndexOrPosition)
     local gridEntity = Isaac.GridSpawn(gridEntityType, variant, position)
@@ -932,7 +949,7 @@ function ____exports.spawnGiantPoop(self, topLeftGridIndex)
     local bottomRight = ____exports.spawnGridEntityWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIANT_BOTTOM_RIGHT, bottomRightGridIndex)
     return topLeft ~= nil and topLeft:GetType() == GridEntityType.POOP and topLeft:GetVariant() == PoopGridEntityVariant.GIANT_TOP_LEFT and topRight ~= nil and topRight:GetType() == GridEntityType.POOP and topRight:GetVariant() == PoopGridEntityVariant.GIANT_TOP_RIGHT and bottomLeft ~= nil and bottomLeft:GetType() == GridEntityType.POOP and bottomLeft:GetVariant() == PoopGridEntityVariant.GIANT_BOTTOM_LEFT and bottomRight ~= nil and bottomRight:GetType() == GridEntityType.POOP and bottomRight:GetVariant() == PoopGridEntityVariant.GIANT_BOTTOM_RIGHT
 end
---- Helper function to spawn a grid entity.
+--- Helper function to spawn a grid entity with a specific type.
 -- 
 -- This function assumes you want to give the grid entity a variant of 0. If you want to specify a
 -- variant, use the `spawnGridEntityWithVariant` helper function instead.
@@ -941,8 +958,26 @@ end
 -- - handles giving pits collision
 -- - removes existing grid entities on the same tile, if any
 -- - allows you to specify either the grid index or the position
-function ____exports.spawnGridEntity(self, gridEntityType, gridIndexOrPosition)
-    return ____exports.spawnGridEntityWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
+-- 
+-- @param gridEntityType The `GridEntityType` to use.
+-- @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+-- entity at. If a position is specified, the closest grid index will be
+-- used.
+-- @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+-- tile, if it exists. Defaults to true. If false, this function
+-- will do nothing, since spawning a grid entity on top of another
+-- grid entity will not replace it.
+function ____exports.spawnGridEntity(self, gridEntityType, gridIndexOrPosition, removeExistingGridEntity)
+    if removeExistingGridEntity == nil then
+        removeExistingGridEntity = true
+    end
+    return ____exports.spawnGridEntityWithVariant(
+        nil,
+        gridEntityType,
+        0,
+        gridIndexOrPosition,
+        removeExistingGridEntity
+    )
 end
 --- Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
 -- with the appropriate variant, as the game does not give it the correct sprite automatically.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "69.4.0",
+  "version": "70.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -25,6 +25,6 @@
   "main": "dist/src/index",
   "types": "dist/index.rollup.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^33.2.0"
+    "isaac-typescript-definitions": "^35.0.0"
   }
 }

package/src/classes/ModFeature.ts

@@ -215,7 +215,7 @@ function initDecoratedCallbacks(
       );
     }
 
-    // eslint-disable-next-line prefer-destructuring, @typescript-eslint/dot-notation
+    // eslint-disable-next-line @typescript-eslint/dot-notation, @typescript-eslint/prefer-destructuring
     const mod = modFeature["mod"];
 
     if (init) {

package/src/functions/gridEntities.ts

@@ -1151,7 +1151,7 @@ export function spawnGiantPoop(topLeftGridIndex: int): boolean {
 }
 
 /**
- * Helper function to spawn a grid entity.
+ * Helper function to spawn a grid entity with a specific type.
  *
  * This function assumes you want to give the grid entity a variant of 0. If you want to specify a
  * variant, use the `spawnGridEntityWithVariant` helper function instead.
@@ -1160,12 +1160,27 @@ export function spawnGiantPoop(topLeftGridIndex: int): boolean {
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify either the grid index or the position
+ *
+ * @param gridEntityType The `GridEntityType` to use.
+ * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+ *                            entity at. If a position is specified, the closest grid index will be
+ *                            used.
+ * @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+ *                                 tile, if it exists. Defaults to true. If false, this function
+ *                                 will do nothing, since spawning a grid entity on top of another
+ *                                 grid entity will not replace it.
  */
 export function spawnGridEntity(
   gridEntityType: GridEntityType,
   gridIndexOrPosition: int | Vector,
+  removeExistingGridEntity = true,
 ): GridEntity | undefined {
-  return spawnGridEntityWithVariant(gridEntityType, 0, gridIndexOrPosition);
+  return spawnGridEntityWithVariant(
+    gridEntityType,
+    0,
+    gridIndexOrPosition,
+    removeExistingGridEntity,
+  );
 }
 
 /**
@@ -1175,11 +1190,22 @@ export function spawnGridEntity(
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify the grid index or the position
+ *
+ * @param gridEntityType The `GridEntityType` to use.
+ * @param variant The variant to use.
+ * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
+ *                            entity at. If a position is specified, the closest grid index will be
+ *                            used.
+ * @param removeExistingGridEntity Optional. Whether to remove the existing grid entity on the same
+ *                                 tile, if it exists. Defaults to true. If false, this function
+ *                                 will do nothing, since spawning a grid entity on top of another
+ *                                 grid entity will not replace it.
  */
 export function spawnGridEntityWithVariant(
   gridEntityType: GridEntityType,
   variant: int,
   gridIndexOrPosition: int | Vector,
+  removeExistingGridEntity = true,
 ): GridEntity | undefined {
   const room = game.GetRoom();
 
@@ -1187,7 +1213,11 @@ export function spawnGridEntityWithVariant(
     ? room.GetGridEntityFromPos(gridIndexOrPosition)
     : room.GetGridEntity(gridIndexOrPosition);
   if (existingGridEntity !== undefined) {
-    removeGridEntity(existingGridEntity, true);
+    if (removeExistingGridEntity) {
+      removeGridEntity(existingGridEntity, true);
+    } else {
+      return;
+    }
   }
 
   const position = isVector(gridIndexOrPosition)