isaacscript-common 1.0.584 → 1.0.588

package/dist/functions/gridEntity.d.ts

@@ -93,6 +93,29 @@ export declare function removeGridEntity(gridEntity: GridEntity, updateRoom?: bo
  * For more information, see the documentation for the `clearSprite()` helper function.
  */
 export declare function setGridEntityInvisible(gridEntity: GridEntity): void;
+/**
+ * Helper function to spawn a giant poop. This is performed by spawning each of the four quadrant
+ * grid entities in the appropriate positions.
+ */
 export declare function spawnGiantPoop(topLeftGridIndex: int): void;
+/**
+ * Helper function to spawn a grid entity. This function assumes you want to give the grid entity a
+ * variant of 0. Use this instead of the `Isaac.GridSpawn()` method since it:
+ * - handles giving pits collision
+ * - removes existing grid entities on the same tile, if any
+ * - allows you to specify the grid index instead of the position
+ */
 export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndex: int): GridEntity;
+/**
+ * Helper function to spawn a grid entity with a specific variant. Use this instead of the
+ * `Isaac.GridSpawn()` method since it:
+ * - handles giving pits collision
+ * - removes existing grid entities on the same tile, if any
+ * - allows you to specify the grid index instead of the position
+ */
 export declare function spawnGridEntityWithVariant(gridEntityType: GridEntityType, variant: int, gridIndex: int): GridEntity;
+/**
+ * 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.
+ */
+export declare function spawnVoidPortal(gridIndex: int): void;

package/dist/functions/gridEntity.lua

@@ -32,6 +32,10 @@ end
 function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndex)
     local game = Game()
     local room = game:GetRoom()
+    local existingGridEntity = room:GetGridEntity(gridIndex)
+    if existingGridEntity ~= nil then
+        ____exports.removeGridEntity(nil, existingGridEntity)
+    end
     local position = room:GetGridPosition(gridIndex)
     local gridEntity = Isaac.GridSpawn(gridEntityType, variant, position, true)
     if gridEntityType == GridEntityType.GRID_PIT then
@@ -183,4 +187,10 @@ end
 function ____exports.spawnGridEntity(self, gridEntityType, gridIndex)
     return ____exports.spawnGridEntityWithVariant(nil, gridEntityType, 0, gridIndex)
 end
+function ____exports.spawnVoidPortal(self, gridIndex)
+    local voidPortal = ____exports.spawnGridEntityWithVariant(nil, GridEntityType.GRID_TRAPDOOR, 1, gridIndex)
+    voidPortal.VarData = 1
+    local sprite = voidPortal:GetSprite()
+    sprite:Load("gfx/grid/voidtrapdoor.anm2", true)
+end
 return ____exports

package/dist/functions/position.d.ts

@@ -5,5 +5,9 @@
  * with heaven doors and partially overlap with players, if the thing being spawned is bigger than a
  * tile (like a Blood Donation Machine). Use this function instead if you want to account for those
  * specific situations.
+ *
+ * @param startingPosition The position to start searching from. If this position is not overlapping
+ * with anything, then it will be returned.
+ * @param avoidActiveEntities Optional. False by default.
  */
-export declare function findFreePosition(startingPosition: Vector): Vector;
+export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean): Vector;

package/dist/functions/position.lua

@@ -7,7 +7,10 @@ local anyEntityCloserThan = ____entity.anyEntityCloserThan
 local getEffects = ____entity.getEffects
 local ____player = require("functions.player")
 local getPlayerCloserThan = ____player.getPlayerCloserThan
-function ____exports.findFreePosition(self, startingPosition)
+function ____exports.findFreePosition(self, startingPosition, avoidActiveEntities)
+    if avoidActiveEntities == nil then
+        avoidActiveEntities = false
+    end
     local game = Game()
     local room = game:GetRoom()
     local heavenDoors = getEffects(nil, EffectVariant.HEAVEN_LIGHT_DOOR, 0)
@@ -15,7 +18,7 @@ function ____exports.findFreePosition(self, startingPosition)
         local i = 0
         while i < 100 do
             do
-                local position = room:FindFreePickupSpawnPosition(startingPosition, i)
+                local position = room:FindFreePickupSpawnPosition(startingPosition, i, avoidActiveEntities)
                 local closePlayer = getPlayerCloserThan(nil, position, DISTANCE_OF_GRID_TILE)
                 if closePlayer ~= nil then
                     goto __continue3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.584",
+  "version": "1.0.588",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.327",
+    "isaac-typescript-definitions": "^1.0.329",
     "isaacscript-lint": "^1.0.77",
     "typedoc": "^0.22.10",
     "typescript": "^4.5.4",