isaacscript-common 1.0.585 → 1.0.586

package/dist/functions/gridEntity.d.ts

@@ -93,6 +93,25 @@ 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 and it 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 and it 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

@@ -183,4 +183,9 @@ 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)
+    local sprite = voidPortal:GetSprite()
+    sprite:Load("gfx/grid/voidtrapdoor.anm2", true)
+end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.585",
+  "version": "1.0.586",
   "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",