isaacscript-common 9.4.1 → 9.5.0

package/dist/functions/gridEntitiesSpecific.d.ts

@@ -41,6 +41,14 @@ export declare function getRocks(variant?: number): GridEntityRock[];
 export declare function getSpikes(variant?: number): GridEntitySpikes[];
 /** Helper function to get all of the `GridEntityTNT` in the room. */
 export declare function getTNT(variant?: number): GridEntityTNT[];
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.TELEPORTER` (23) in the
+ * room.
+ *
+ * @param variant Optional. If specified, will only get the teleporters that match the variant.
+ *                Default is -1, which matches every variant.
+ */
+export declare function getTeleporters(variant?: number): GridEntity[];
 /**
  * Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` (17) in the
  * room. Specify a specific trapdoor variant to select only trapdoors of that variant.
@@ -135,6 +143,18 @@ export declare function removeAllSpikes(variant?: number, updateRoom?: boolean,
  * @returns The TNTs that were removed.
  */
 export declare function removeAllTNT(variant?: number, updateRoom?: boolean, cap?: int): GridEntityTNT[];
+/**
+ * Helper function to remove all of the `GridEntityType.TELEPORTER` (23) in the room.
+ *
+ * @param variant Optional. If specified, will only remove the teleporters that match this variant.
+ *                Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the teleporters are removed.
+ *                   Default is false. For more information, see the description of the
+ *                   `removeGridEntities` helper function.
+ * @param cap Optional. If specified, will only remove the given amount of teleporters.
+ * @returns The teleporters that were removed.
+ */
+export declare function removeAllTeleporters(variant?: number, updateRoom?: boolean, cap?: int): GridEntity[];
 /**
  * Helper function to remove all of the `GridEntityType.TRAPDOOR` (17) in the room.
  *
@@ -179,6 +199,10 @@ export declare function spawnSpikesWithVariant(variant: int, gridIndexOrPosition
 export declare function spawnTNT(gridIndexOrPosition: int | Vector): GridEntityTNT | undefined;
 /** Helper function to spawn a `GridEntityType.TNT` (12) with a specific variant. */
 export declare function spawnTNTWithVariant(variant: int, gridIndexOrPosition: int | Vector): GridEntityTNT | undefined;
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23). */
+export declare function spawnTeleporter(gridIndexOrPosition: int | Vector): GridEntity | undefined;
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23) with a specific variant. */
+export declare function spawnTeleporterWithVariant(variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
 /** Helper function to spawn a `GridEntityType.TRAPDOOR` (17). */
 export declare function spawnTrapdoor(gridIndexOrPosition: int | Vector): GridEntity | undefined;
 /** Helper function to spawn a `GridEntityType.TRAPDOOR` (17) with a specific variant. */

package/dist/functions/gridEntitiesSpecific.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gridEntitiesSpecific.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntitiesSpecific.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,WAAW,EAEX,UAAU,EACV,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACX,eAAe,EAChB,MAAM,8BAA8B,CAAC;AAStC;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,iBAAiB,GAAE,iBAAsB,GACxC,UAAU,EAAE,CAMd;AAKD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,UAAU,GAAE,UAAe,GAAG,aAAa,EAAE,CAepE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,WAAW,GAAE,qBAA0B,GACtC,cAAc,EAAE,CAelB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,oBAAoB,GAAE,oBAAyB,GAC9C,uBAAuB,EAAE,CAkB3B;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,OAAO,SAAK,GAAG,cAAc,EAAE,CAevD;AAED,wEAAwE;AACxE,wBAAgB,SAAS,CAAC,OAAO,SAAK,GAAG,gBAAgB,EAAE,CAe1D;AAED,qEAAqE;AACrE,wBAAgB,MAAM,CAAC,OAAO,SAAK,GAAG,aAAa,EAAE,CAepD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,UAAU,EAAE,CAM5E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,iBAAiB,GAAE,iBAAsB,EACzC,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,UAAU,EAAE,CAGd;AAKD;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,EAAE,CAGjB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,WAAW,GAAE,qBAA0B,EACvC,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,cAAc,EAAE,CAGlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,oBAAoB,GAAE,oBAAyB,EAC/C,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,uBAAuB,EAAE,CAG3B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAC5B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,cAAc,EAAE,CAGlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAGpB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,EAAE,CAGjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,GAAE,eAAoB,EACrC,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,UAAU,EAAE,CAGd;AAED,oEAAoE;AACpE,wBAAgB,eAAe,CAC7B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAKxB;AAED,4FAA4F;AAC5F,wBAAgB,0BAA0B,CACxC,iBAAiB,EAAE,iBAAiB,EACpC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAMxB;AAED,mFAAmF;AACnF,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAE5B;AAED,6DAA6D;AAC7D,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,qFAAqF;AACrF,wBAAgB,QAAQ,CACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAE3B;AAED,mFAAmF;AACnF,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,UAAU,EACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAgB3B;AAED,6DAA6D;AAC7D,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAK5B;AAED,qFAAqF;AACrF,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,qBAAqB,EAClC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,uEAAuE;AACvE,wBAAgB,kBAAkB,CAChC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,uBAAuB,GAAG,SAAS,CAKrC;AAED,+FAA+F;AAC/F,wBAAgB,6BAA6B,CAC3C,oBAAoB,EAAE,oBAAoB,EAC1C,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,uBAAuB,GAAG,SAAS,CAgBrC;AAED,4DAA4D;AAC5D,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAE5B;AAED,oFAAoF;AACpF,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,8DAA8D;AAC9D,wBAAgB,WAAW,CACzB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,gBAAgB,GAAG,SAAS,CAE9B;AAED,sFAAsF;AACtF,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,gBAAgB,GAAG,SAAS,CAgB9B;AAED,4DAA4D;AAC5D,wBAAgB,QAAQ,CACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAE3B;AAED,oFAAoF;AACpF,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAgB3B;AAED,iEAAiE;AACjE,wBAAgB,aAAa,CAC3B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAKxB;AAED,yFAAyF;AACzF,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,EAChC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAMxB"}
+{"version":3,"file":"gridEntitiesSpecific.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntitiesSpecific.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,WAAW,EAEX,UAAU,EACV,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACX,eAAe,EAChB,MAAM,8BAA8B,CAAC;AAStC;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,iBAAiB,GAAE,iBAAsB,GACxC,UAAU,EAAE,CAMd;AAKD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,UAAU,GAAE,UAAe,GAAG,aAAa,EAAE,CAepE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,WAAW,GAAE,qBAA0B,GACtC,cAAc,EAAE,CAelB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,oBAAoB,GAAE,oBAAyB,GAC9C,uBAAuB,EAAE,CAkB3B;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,OAAO,SAAK,GAAG,cAAc,EAAE,CAevD;AAED,wEAAwE;AACxE,wBAAgB,SAAS,CAAC,OAAO,SAAK,GAAG,gBAAgB,EAAE,CAe1D;AAED,qEAAqE;AACrE,wBAAgB,MAAM,CAAC,OAAO,SAAK,GAAG,aAAa,EAAE,CAepD;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,SAAK,GAAG,UAAU,EAAE,CAMzD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,UAAU,EAAE,CAM5E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,iBAAiB,GAAE,iBAAsB,EACzC,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,UAAU,EAAE,CAGd;AAKD;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,EAAE,CAGjB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,WAAW,GAAE,qBAA0B,EACvC,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,cAAc,EAAE,CAGlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,oBAAoB,GAAE,oBAAyB,EAC/C,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,uBAAuB,EAAE,CAG3B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAC5B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,cAAc,EAAE,CAGlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,gBAAgB,EAAE,CAGpB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,EAAE,CAGjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,SAAK,EACZ,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,UAAU,EAAE,CAGd;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,GAAE,eAAoB,EACrC,UAAU,UAAQ,EAClB,GAAG,CAAC,EAAE,GAAG,GACR,UAAU,EAAE,CAGd;AAED,oEAAoE;AACpE,wBAAgB,eAAe,CAC7B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAKxB;AAED,4FAA4F;AAC5F,wBAAgB,0BAA0B,CACxC,iBAAiB,EAAE,iBAAiB,EACpC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAMxB;AAED,mFAAmF;AACnF,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAE5B;AAED,6DAA6D;AAC7D,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,qFAAqF;AACrF,wBAAgB,QAAQ,CACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAE3B;AAED,mFAAmF;AACnF,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,UAAU,EACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAgB3B;AAED,6DAA6D;AAC7D,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAK5B;AAED,qFAAqF;AACrF,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,qBAAqB,EAClC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,uEAAuE;AACvE,wBAAgB,kBAAkB,CAChC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,uBAAuB,GAAG,SAAS,CAKrC;AAED,+FAA+F;AAC/F,wBAAgB,6BAA6B,CAC3C,oBAAoB,EAAE,oBAAoB,EAC1C,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,uBAAuB,GAAG,SAAS,CAgBrC;AAED,4DAA4D;AAC5D,wBAAgB,SAAS,CACvB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAE5B;AAED,oFAAoF;AACpF,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,cAAc,GAAG,SAAS,CAgB5B;AAED,8DAA8D;AAC9D,wBAAgB,WAAW,CACzB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,gBAAgB,GAAG,SAAS,CAE9B;AAED,sFAAsF;AACtF,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,gBAAgB,GAAG,SAAS,CAgB9B;AAED,4DAA4D;AAC5D,wBAAgB,QAAQ,CACtB,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAE3B;AAED,oFAAoF;AACpF,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,aAAa,GAAG,SAAS,CAgB3B;AAED,mEAAmE;AACnE,wBAAgB,eAAe,CAC7B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED,2FAA2F;AAC3F,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAMxB;AAED,iEAAiE;AACjE,wBAAgB,aAAa,CAC3B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAKxB;AAED,yFAAyF;AACzF,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,EAChC,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAMxB"}

package/dist/functions/gridEntitiesSpecific.lua

@@ -102,6 +102,10 @@ function ____exports.spawnTNTWithVariant(self, variant, gridIndexOrPosition)
     end
     return tnt
 end
+--- Helper function to spawn a `GridEntityType.TELEPORTER` (23) with a specific variant.
+function ____exports.spawnTeleporterWithVariant(self, variant, gridIndexOrPosition)
+    return spawnGridEntityWithVariant(nil, GridEntityType.TELEPORTER, variant, gridIndexOrPosition)
+end
 --- Helper function to get all of the grid entities of type `GridEntityType.CRAWL_SPACE` (18) in the
 -- room.
 -- 
@@ -238,6 +242,20 @@ function ____exports.getTNT(self, variant)
     end
     return tntArray
 end
+--- Helper function to get all of the grid entities of type `GridEntityType.TELEPORTER` (23) in the
+-- room.
+-- 
+-- @param variant Optional. If specified, will only get the teleporters that match the variant.
+-- Default is -1, which matches every variant.
+function ____exports.getTeleporters(self, variant)
+    if variant == nil then
+        variant = -1
+    end
+    if variant == -1 then
+        return getGridEntities(nil, GridEntityType.TELEPORTER)
+    end
+    return getMatchingGridEntities(nil, GridEntityType.TELEPORTER, variant)
+end
 --- Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` (17) in the
 -- room. Specify a specific trapdoor variant to select only trapdoors of that variant.
 function ____exports.getTrapdoors(self, trapdoorVariant)
@@ -384,6 +402,25 @@ function ____exports.removeAllTNT(self, variant, updateRoom, cap)
     local tnt = ____exports.getTNT(nil, variant)
     return removeGridEntities(nil, tnt, updateRoom, cap)
 end
+--- Helper function to remove all of the `GridEntityType.TELEPORTER` (23) in the room.
+-- 
+-- @param variant Optional. If specified, will only remove the teleporters that match this variant.
+-- Default is -1, which matches every variant.
+-- @param updateRoom Optional. Whether or not to update the room after the teleporters are removed.
+-- Default is false. For more information, see the description of the
+-- `removeGridEntities` helper function.
+-- @param cap Optional. If specified, will only remove the given amount of teleporters.
+-- @returns The teleporters that were removed.
+function ____exports.removeAllTeleporters(self, variant, updateRoom, cap)
+    if variant == nil then
+        variant = -1
+    end
+    if updateRoom == nil then
+        updateRoom = false
+    end
+    local teleporters = ____exports.getTeleporters(nil, variant)
+    return removeGridEntities(nil, teleporters, updateRoom, cap)
+end
 --- Helper function to remove all of the `GridEntityType.TRAPDOOR` (17) in the room.
 -- 
 -- @param trapdoorVariant Optional. If specified, will only remove the trapdoors that match this
@@ -435,6 +472,10 @@ end
 function ____exports.spawnTNT(self, gridIndexOrPosition)
     return ____exports.spawnTNTWithVariant(nil, 0, gridIndexOrPosition)
 end
+--- Helper function to spawn a `GridEntityType.TELEPORTER` (23).
+function ____exports.spawnTeleporter(self, gridIndexOrPosition)
+    return ____exports.spawnTeleporterWithVariant(nil, 0, gridIndexOrPosition)
+end
 --- Helper function to spawn a `GridEntityType.TRAPDOOR` (17).
 function ____exports.spawnTrapdoor(self, gridIndexOrPosition)
     return ____exports.spawnCrawlSpaceWithVariant(nil, CrawlSpaceVariant.NORMAL, gridIndexOrPosition)

package/dist/functions/pickups.d.ts

@@ -6,7 +6,9 @@ import { CoinSubType } from "isaac-typescript-definitions";
 export declare function getCoinValue(coinSubType: CoinSubType): int;
 /** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickupHeart[];
+/** Helper function to test if the provided pickup matches one of the various chest variants. */
 export declare function isChest(pickup: EntityPickup): boolean;
+/** Helper function to test if the provided pickup matches on of the various red heart sub types. */
 export declare function isRedHeart(pickup: EntityPickup): boolean;
 /**
  * Helper function to remove all of the red heart pickup entities in the room.

package/dist/functions/pickups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pickups.d.ts","sourceRoot":"","sources":["../../src/functions/pickups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAW3D;;;GAGG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,GAAG,CAK1D;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,IAAI,iBAAiB,EAAE,CAGlD;AAED,wBAAgB,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAErD;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAExD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE,CAGjE"}
+{"version":3,"file":"pickups.d.ts","sourceRoot":"","sources":["../../src/functions/pickups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAW3D;;;GAGG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,GAAG,CAK1D;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,IAAI,iBAAiB,EAAE,CAGlD;AAED,gGAAgG;AAChG,wBAAgB,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAErD;AAED,oGAAoG;AACpG,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAExD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE,CAGjE"}

package/dist/functions/pickups.lua

@@ -28,9 +28,11 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
+--- Helper function to test if the provided pickup matches one of the various chest variants.
 function ____exports.isChest(self, pickup)
     return CHEST_PICKUP_VARIANTS:has(pickup.Variant)
 end
+--- Helper function to test if the provided pickup matches on of the various red heart sub types.
 function ____exports.isRedHeart(self, pickup)
     return isHeart(nil, pickup) and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
 end

package/dist/index.d.ts

@@ -4969,6 +4969,15 @@ export declare function getTears(tearVariant?: TearVariant, subType?: number): E
  */
 export declare function getTearsStat(fireDelay: float): float;
 
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.TELEPORTER` (23) in the
+ * room.
+ *
+ * @param variant Optional. If specified, will only get the teleporters that match the variant.
+ *                Default is -1, which matches every variant.
+ */
+export declare function getTeleporters(variant?: number): GridEntity[];
+
 /** Helper function to get all of the `GridEntityTNT` in the room. */
 export declare function getTNT(variant?: number): GridEntityTNT[];
 
@@ -5606,6 +5615,7 @@ export declare function isCardType(cardType: CardType, itemConfigCardType: ItemC
  */
 export declare function isCharacter(player: EntityPlayer, ...characters: PlayerType[]): boolean;
 
+/** Helper function to test if the provided pickup matches one of the various chest variants. */
 export declare function isChest(pickup: EntityPickup): boolean;
 
 /**
@@ -6032,6 +6042,7 @@ export declare function isQuestCollectible(collectibleType: CollectibleType): bo
  */
 export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
 
+/** Helper function to test if the provided pickup matches on of the various red heart sub types. */
 export declare function isRedHeart(pickup: EntityPickup): boolean;
 
 /**
@@ -9464,6 +9475,19 @@ export declare function removeAllSpikes(variant?: number, updateRoom?: boolean,
  */
 export declare function removeAllTears(tearVariant?: TearVariant, subType?: number, cap?: int): EntityTear[];
 
+/**
+ * Helper function to remove all of the `GridEntityType.TELEPORTER` (23) in the room.
+ *
+ * @param variant Optional. If specified, will only remove the teleporters that match this variant.
+ *                Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the teleporters are removed.
+ *                   Default is false. For more information, see the description of the
+ *                   `removeGridEntities` helper function.
+ * @param cap Optional. If specified, will only remove the given amount of teleporters.
+ * @returns The teleporters that were removed.
+ */
+export declare function removeAllTeleporters(variant?: number, updateRoom?: boolean, cap?: int): GridEntity[];
+
 /**
  * Helper function to remove all of the `GridEntityTNT` in the room.
  *
@@ -11171,6 +11195,12 @@ export declare function spawnTear(tearVariant: TearVariant, subType: int, positi
 /** Helper function to spawn a `EntityType.EntityType` (2) with a specific seed. */
 export declare function spawnTearWithSeed(tearVariant: TearVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityTear;
 
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23). */
+export declare function spawnTeleporter(gridIndexOrPosition: int | Vector): GridEntity | undefined;
+
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23) with a specific variant. */
+export declare function spawnTeleporterWithVariant(variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+
 /** Helper function to spawn a `GridEntityType.TNT` (12). */
 export declare function spawnTNT(gridIndexOrPosition: int | Vector): GridEntityTNT | undefined;
 

package/package.json

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

package/src/functions/gridEntitiesSpecific.ts

@@ -173,6 +173,21 @@ export function getTNT(variant = -1): GridEntityTNT[] {
   return tntArray;
 }
 
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.TELEPORTER` (23) in the
+ * room.
+ *
+ * @param variant Optional. If specified, will only get the teleporters that match the variant.
+ *                Default is -1, which matches every variant.
+ */
+export function getTeleporters(variant = -1): GridEntity[] {
+  if (variant === -1) {
+    return getGridEntities(GridEntityType.TELEPORTER);
+  }
+
+  return getMatchingGridEntities(GridEntityType.TELEPORTER, variant);
+}
+
 /**
  * Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` (17) in the
  * room. Specify a specific trapdoor variant to select only trapdoors of that variant.
@@ -333,6 +348,26 @@ export function removeAllTNT(
   return removeGridEntities(tnt, updateRoom, cap);
 }
 
+/**
+ * Helper function to remove all of the `GridEntityType.TELEPORTER` (23) in the room.
+ *
+ * @param variant Optional. If specified, will only remove the teleporters that match this variant.
+ *                Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the teleporters are removed.
+ *                   Default is false. For more information, see the description of the
+ *                   `removeGridEntities` helper function.
+ * @param cap Optional. If specified, will only remove the given amount of teleporters.
+ * @returns The teleporters that were removed.
+ */
+export function removeAllTeleporters(
+  variant = -1,
+  updateRoom = false,
+  cap?: int,
+): GridEntity[] {
+  const teleporters = getTeleporters(variant);
+  return removeGridEntities(teleporters, updateRoom, cap);
+}
+
 /**
  * Helper function to remove all of the `GridEntityType.TRAPDOOR` (17) in the room.
  *
@@ -584,6 +619,25 @@ export function spawnTNTWithVariant(
   return tnt;
 }
 
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23). */
+export function spawnTeleporter(
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnTeleporterWithVariant(0, gridIndexOrPosition);
+}
+
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23) with a specific variant. */
+export function spawnTeleporterWithVariant(
+  variant: int,
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnGridEntityWithVariant(
+    GridEntityType.TELEPORTER,
+    variant,
+    gridIndexOrPosition,
+  );
+}
+
 /** Helper function to spawn a `GridEntityType.TRAPDOOR` (17). */
 export function spawnTrapdoor(
   gridIndexOrPosition: int | Vector,

package/src/functions/pickups.ts

@@ -26,10 +26,12 @@ export function getRedHearts(): EntityPickupHeart[] {
   return hearts.filter((heart) => RED_HEART_SUB_TYPES_SET.has(heart.SubType));
 }
 
+/** Helper function to test if the provided pickup matches one of the various chest variants. */
 export function isChest(pickup: EntityPickup): boolean {
   return CHEST_PICKUP_VARIANTS.has(pickup.Variant);
 }
 
+/** Helper function to test if the provided pickup matches on of the various red heart sub types. */
 export function isRedHeart(pickup: EntityPickup): boolean {
   return isHeart(pickup) && RED_HEART_SUB_TYPES_SET.has(pickup.SubType);
 }