isaacscript-common 9.3.0 → 9.5.0

package/dist/functions/pickupVariants.lua

@@ -1,47 +1,47 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
---- For `PickupVariant.HEART` (10)
+--- For `PickupVariant.HEART` (10).
 function ____exports.isHeart(self, pickup)
     return pickup.Variant == PickupVariant.HEART
 end
---- For `PickupVariant.COIN` (20)
+--- For `PickupVariant.COIN` (20).
 function ____exports.isCoin(self, pickup)
     return pickup.Variant == PickupVariant.COIN
 end
---- For `PickupVariant.KEY` (30)
+--- For `PickupVariant.KEY` (30).
 function ____exports.isKey(self, pickup)
     return pickup.Variant == PickupVariant.KEY
 end
---- For `PickupVariant.BOMB` (40)
+--- For `PickupVariant.BOMB` (40).
 function ____exports.isBombPickup(self, pickup)
     return pickup.Variant == PickupVariant.BOMB
 end
---- For `PickupVariant.POOP` (42)
+--- For `PickupVariant.POOP` (42).
 function ____exports.isPoopPickup(self, pickup)
     return pickup.Variant == PickupVariant.POOP
 end
---- For `PickupVariant.SACK` (69)
+--- For `PickupVariant.SACK` (69).
 function ____exports.isSack(self, pickup)
     return pickup.Variant == PickupVariant.SACK
 end
---- For `PickupVariant.PILL` (70)
+--- For `PickupVariant.PILL` (70).
 function ____exports.isPill(self, pickup)
     return pickup.Variant == PickupVariant.PILL
 end
---- For `PickupVariant.LIL_BATTERY` (90)
+--- For `PickupVariant.LIL_BATTERY` (90).
 function ____exports.isBattery(self, pickup)
     return pickup.Variant == PickupVariant.LIL_BATTERY
 end
---- For `PickupVariant.COLLECTIBLE` (100)
+--- For `PickupVariant.COLLECTIBLE` (100).
 function ____exports.isCollectible(self, pickup)
     return pickup.Variant == PickupVariant.COLLECTIBLE
 end
---- For `PickupVariant.TAROT_CARD` (300)
+--- For `PickupVariant.TAROT_CARD` (300).
 function ____exports.isCardPickup(self, pickup)
     return pickup.Variant == PickupVariant.TAROT_CARD
 end
---- For `PickupVariant.TRINKET` (350)
+--- For `PickupVariant.TRINKET` (350).
 function ____exports.isTrinket(self, pickup)
     return pickup.Variant == PickupVariant.TRINKET
 end

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

@@ -1748,7 +1748,7 @@ export declare function deserializeRNG(rng: SerializedRNG): RNG;
  */
 export declare function deserializeVector(vector: SerializedVector): Vector;
 
-/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76) */
+/** For `EntityType.EFFECT` (1000), `EffectVariant.DICE_FLOOR` (76). */
 export declare const DICE_FLOOR_TRIGGER_SQUARE_SIZE = 75;
 
 export declare function directionToDegrees(direction: Direction): int;
@@ -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[];
 
@@ -5559,7 +5568,7 @@ export declare function isArrayContiguous(array: int[]): boolean;
 /** Checks if an array is in the provided 2-dimensional array. */
 export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], parentArray: Array<T[] | readonly T[]>): boolean;
 
-/** For `PickupVariant.LIL_BATTERY` (90) */
+/** For `PickupVariant.LIL_BATTERY` (90). */
 export declare function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery;
 
 /**
@@ -5578,7 +5587,7 @@ export declare function isBlindCollectible(collectible: EntityPickup): boolean;
 /** Helper function to detect if a variable is of type `EntityBomb`. */
 export declare function isBomb(variable: unknown): variable is EntityBomb;
 
-/** For `PickupVariant.BOMB` (40) */
+/** For `PickupVariant.BOMB` (40). */
 export declare function isBombPickup(pickup: EntityPickup): pickup is EntityPickupBomb;
 
 export declare function isBoolean(variable: unknown): variable is boolean;
@@ -5592,7 +5601,7 @@ export declare function isBoolean(variable: unknown): variable is boolean;
  */
 export declare function isCard(cardType: CardType): boolean;
 
-/** For `PickupVariant.TAROT_CARD` (300) */
+/** For `PickupVariant.TAROT_CARD` (300). */
 export declare function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard;
 
 /** Returns whether or not the given card type matches the specified item config card type. */
@@ -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;
 
 /**
@@ -5622,10 +5632,10 @@ export declare function isCircleIntersectingRectangle(circleCenter: Vector, circ
 /** Helper function to see if a player is close enough to activate a Dice Room floor. */
 export declare function isCloseEnoughToTriggerDiceFloor(player: EntityPlayer, diceFloor: EntityEffect): boolean;
 
-/** For `PickupVariant.COIN` (20) */
+/** For `PickupVariant.COIN` (20). */
 export declare function isCoin(pickup: EntityPickup): pickup is EntityPickupCoin;
 
-/** For `PickupVariant.COLLECTIBLE` (100) */
+/** For `PickupVariant.COLLECTIBLE` (100). */
 export declare function isCollectible(pickup: EntityPickup): pickup is EntityPickupCollectible;
 
 /**
@@ -5784,6 +5794,10 @@ export declare function isEntity(variable: unknown): variable is Entity;
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *
+ * Use this helper function over checking if the velocity length is equal to 0 because entities can
+ * look like they are completely immobile but yet still have a non zero velocity. Thus, using a
+ * threshold is needed.
+ *
  * @param entity The entity whose velocity to measure.
  * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
  */
@@ -5836,7 +5850,7 @@ export declare function isGridEntityBreakableByExplosion(gridEntity: GridEntity)
  */
 export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
 
-/** For `PickupVariant.HEART` (10) */
+/** For `PickupVariant.HEART` (10). */
 export declare function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart;
 
 /**
@@ -5880,7 +5894,7 @@ export declare function isKColor(object: unknown): object is KColor;
  */
 export declare function isKeeper(player: EntityPlayer): boolean;
 
-/** For `PickupVariant.KEY` (30) */
+/** For `PickupVariant.KEY` (30). */
 export declare function isKey(pickup: EntityPickup): pickup is EntityPickupKey;
 
 /**
@@ -5979,7 +5993,7 @@ export declare function isPickingUpItemTrinket(pickingUpItem: PickingUpItem): pi
 /** Helper function to detect if a variable is of type `EntityPickup`. */
 export declare function isPickup(variable: unknown): variable is EntityPickup;
 
-/** For `PickupVariant.PILL` (70) */
+/** For `PickupVariant.PILL` (70). */
 export declare function isPill(pickup: EntityPickup): pickup is EntityPickupPill;
 
 /** Helper function to detect if a variable is of type `GridEntityPit`. */
@@ -6000,7 +6014,7 @@ export declare function isPocketItemObject(cardType: CardType): boolean;
 /** Helper function to detect if a variable is of type `GridEntityPoop`. */
 export declare function isPoop(variable: unknown): variable is GridEntityPoop;
 
-/** For `PickupVariant.POOP` (42) */
+/** For `PickupVariant.POOP` (42). */
 export declare function isPoopPickup(pickup: EntityPickup): pickup is EntityPickupPoop;
 
 /**
@@ -6028,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;
 
 /**
@@ -6085,7 +6100,7 @@ export declare function isRoomShapeDoubleCharge(roomShape: RoomShape): boolean;
 /** Returns true for cards that have `CardType.RUNE`. */
 export declare function isRune(cardType: CardType): boolean;
 
-/** For `PickupVariant.SACK` (69) */
+/** For `PickupVariant.SACK` (69). */
 export declare function isSack(pickup: EntityPickup): pickup is EntityPickupSack;
 
 /**
@@ -6156,7 +6171,7 @@ export declare function isSin(npc: EntityNPC): boolean;
  */
 export declare function isSingleUseCollectible(collectibleType: CollectibleType): boolean;
 
-/** For `EntityType.SLOT` (6) */
+/** For `EntityType.SLOT` (6). */
 export declare function isSlot(entity: Entity): entity is EntitySlot;
 
 /** Returns true for cards that have `CardType.SPECIAL`. */
@@ -6196,7 +6211,7 @@ export declare function isTNT(variable: unknown): variable is GridEntityTNT;
 
 export declare function isTransformationFlying(playerForm: PlayerForm): boolean;
 
-/** For `PickupVariant.TRINKET` (350) */
+/** For `PickupVariant.TRINKET` (350). */
 export declare function isTrinket(pickup: EntityPickup): pickup is EntityPickupTrinket;
 
 /**
@@ -7019,8 +7034,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_BROKEN` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityBroken(gridEntity: GridEntity): void {}
@@ -7035,8 +7052,14 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_COLLISION` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided (for the grid entity).
+     * - When registering the callback, takes an optional fourth argument that will make the callback
+     *   only fire if the colliding entity matches the `EntityType` provided.
+     * - When registering the callback, takes an optional fifth argument that will make the callback
+     *   only fire if the colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCollision(
@@ -7051,7 +7074,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomBroken(
@@ -7065,8 +7089,13 @@ export declare enum ModCallbackCustom {
      * The same as the `POST_GRID_ENTITY_COLLISION` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     *   variants, so there is no need for an optional third argument to filter by variant.)
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if the the colliding entity matches the `EntityType` provided.
+     * - When registering the callback, takes an optional fourth argument that will make the callback
+     *   only fire if the the colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCustomCollision(
@@ -7082,7 +7111,8 @@ export declare enum ModCallbackCustom {
      * the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomInit(
@@ -7097,7 +7127,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRemove(
@@ -7112,7 +7143,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRender(
@@ -7127,7 +7159,8 @@ export declare enum ModCallbackCustom {
      * created with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomStateChanged(
@@ -7144,7 +7177,8 @@ export declare enum ModCallbackCustom {
      * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * only fire if it matches the `GridEntityType` provided. (Custom grid entities do not have
+     * variants, so there is no need for an optional third argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomUpdate(
@@ -7165,8 +7199,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
      * callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityInit(gridEntity: GridEntity): void {}
@@ -7184,8 +7220,10 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_REMOVE` callback instead.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
      *
      * ```ts
      * function postGridEntityRemove(
@@ -7198,14 +7236,14 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
+     *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if it matches the `GridEntityType` provided.
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
-     * For grid entities created with `spawnCustomGridEntity`, use the
-     * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
-     *
      * ```ts
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
@@ -7215,12 +7253,14 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
      * "state" refers to the `GridEntity.State` field.)
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `GridEntityType` provided.
-     *
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_STATE_CHANGED` callback instead.
      *
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `GridEntityType` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if it matches the variant provided.
+     *
      * ```ts
      * function postGridEntityStateChanged(
      *   gridEntity: GridEntity,
@@ -7233,14 +7273,14 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
+     *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if it matches the `GridEntityType` provided.
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
-     * For grid entities created with `spawnCustomGridEntity`, use the
-     * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
-     *
      * ```ts
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
@@ -7862,7 +7902,8 @@ export declare enum ModCallbackCustom {
      * certain conditions, like if the slot entity is playing the "Idle" animation, and so on.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * only fire if it matches the `SlotVariant` provided. (There is no need for any additional
+     * arguments, since only players will cause this callback to fire.)
      *
      * ```ts
      * function postSlotCollision(
@@ -8580,7 +8621,9 @@ gridEntityVariant?: int
 declare type PostGridEntityCollisionRegisterParameters = [
 callback: (gridEntity: GridEntity, entity: Entity) => void,
 gridEntityType?: GridEntityType,
-gridEntityVariant?: int
+gridEntityVariant?: int,
+entityType?: EntityType,
+entityVariant?: int
 ];
 
 declare type PostGridEntityCustomBrokenRegisterParameters = [
@@ -8590,7 +8633,9 @@ gridEntityTypeCustom?: GridEntityType
 
 declare type PostGridEntityCustomCollisionRegisterParameters = [
 callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType, entity: Entity) => void,
-gridEntityTypeCustom?: GridEntityType
+gridEntityTypeCustom?: GridEntityType,
+entityType?: EntityType,
+entityVariant?: int
 ];
 
 declare type PostGridEntityCustomInitRegisterParameters = [
@@ -9430,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.
  *
@@ -11137,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.3.0",
+  "version": "9.5.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/index",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^4.0.0"
+    "isaac-typescript-definitions": "^4.0.1"
   }
 }

package/src/callbacks/subscriptions/postGridEntityCollision.ts

@@ -1,9 +1,11 @@
-import { GridEntityType } from "isaac-typescript-definitions";
+import { EntityType, GridEntityType } from "isaac-typescript-definitions";
 
 export type PostGridEntityCollisionRegisterParameters = [
   callback: (gridEntity: GridEntity, entity: Entity) => void,
   gridEntityType?: GridEntityType,
   gridEntityVariant?: int,
+  entityType?: EntityType,
+  entityVariant?: int,
 ];
 
 const subscriptions: PostGridEntityCollisionRegisterParameters[] = [];
@@ -29,6 +31,8 @@ export function postGridEntityCollisionFire(
     callback,
     callbackGridEntityType,
     callbackGridEntityVariant,
+    callbackEntityType,
+    callbackEntityVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -46,6 +50,22 @@ export function postGridEntityCollisionFire(
       continue;
     }
 
+    // Handle the optional 4th callback argument.
+    if (
+      callbackEntityType !== undefined &&
+      callbackEntityType !== entity.Type
+    ) {
+      continue;
+    }
+
+    // Handle the optional 5th callback argument.
+    if (
+      callbackEntityVariant !== undefined &&
+      callbackEntityVariant !== entity.Variant
+    ) {
+      continue;
+    }
+
     callback(gridEntity, entity);
   }
 }

package/src/callbacks/subscriptions/postGridEntityCustomCollision.ts

@@ -1,4 +1,4 @@
-import { GridEntityType } from "isaac-typescript-definitions";
+import { EntityType, GridEntityType } from "isaac-typescript-definitions";
 
 export type PostGridEntityCustomCollisionRegisterParameters = [
   callback: (
@@ -7,6 +7,8 @@ export type PostGridEntityCustomCollisionRegisterParameters = [
     entity: Entity,
   ) => void,
   gridEntityTypeCustom?: GridEntityType,
+  entityType?: EntityType,
+  entityVariant?: int,
 ];
 
 const subscriptions: PostGridEntityCustomCollisionRegisterParameters[] = [];
@@ -26,7 +28,12 @@ export function postGridEntityCustomCollisionFire(
   gridEntityTypeCustom: GridEntityType,
   entity: Entity,
 ): void {
-  for (const [callback, callbackGridEntityTypeCustom] of subscriptions) {
+  for (const [
+    callback,
+    callbackGridEntityTypeCustom,
+    callbackEntityType,
+    callbackEntityVariant,
+  ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
       callbackGridEntityTypeCustom !== undefined &&
@@ -35,6 +42,22 @@ export function postGridEntityCustomCollisionFire(
       continue;
     }
 
+    // Handle the optional 3rd callback argument.
+    if (
+      callbackEntityType !== undefined &&
+      callbackEntityType !== entity.Type
+    ) {
+      continue;
+    }
+
+    // Handle the optional 4th callback argument.
+    if (
+      callbackEntityVariant !== undefined &&
+      callbackEntityVariant !== entity.Variant
+    ) {
+      continue;
+    }
+
     callback(gridEntity, gridEntityTypeCustom, entity);
   }
 }