isaacscript-common 8.8.2 → 9.0.0

package/src/functions/gridEntitiesSpecific.ts

@@ -1,18 +1,38 @@
 import {
+  CrawlSpaceVariant,
   DoorVariant,
   GridEntityType,
   PitVariant,
   PoopGridEntityVariant,
   PressurePlateVariant,
   RockVariant,
+  TrapdoorVariant,
 } from "isaac-typescript-definitions";
 import {
   getGridEntities,
+  getMatchingGridEntities,
   removeGridEntities,
   spawnGridEntityWithVariant,
 } from "./gridEntities";
 import { asNumber } from "./types";
 
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.CRAWL_SPACE` (18) in the
+ * room.
+ *
+ * @param crawlSpaceVariant Optional. If specified, will only get the crawl spaces that match the
+ *                          variant. Default is -1, which matches every variant.
+ */
+export function getCrawlSpaces(
+  crawlSpaceVariant: CrawlSpaceVariant = -1,
+): GridEntity[] {
+  if (asNumber(crawlSpaceVariant) === -1) {
+    return getGridEntities(GridEntityType.CRAWL_SPACE);
+  }
+
+  return getMatchingGridEntities(GridEntityType.CRAWL_SPACE, crawlSpaceVariant);
+}
+
 // The `getDoors` function is not located here because doors are collected via the `Room.GetDoor`
 // method instead, which is faster.
 
@@ -153,6 +173,38 @@ export function getTNT(variant = -1): GridEntityTNT[] {
   return tntArray;
 }
 
+/**
+ * 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.
+ */
+export function getTrapdoors(trapdoorVariant?: TrapdoorVariant): GridEntity[] {
+  if (trapdoorVariant === undefined) {
+    return getGridEntities(GridEntityType.TRAPDOOR);
+  }
+
+  return getMatchingGridEntities(GridEntityType.TRAPDOOR, trapdoorVariant);
+}
+
+/**
+ * Helper function to remove all of the `GridEntityType.CRAWL_SPACE` (18) in the room.
+ *
+ * @param crawlSpaceVariant Optional. If specified, will only remove the crawl spaces that match
+ *                          this variant. Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the crawl spaces 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 crawl spaces.
+ * @returns The crawl spaces that were removed.
+ */
+export function removeAllCrawlSpaces(
+  crawlSpaceVariant: CrawlSpaceVariant = -1,
+  updateRoom = false,
+  cap?: int,
+): GridEntity[] {
+  const crawlSpaces = getCrawlSpaces(crawlSpaceVariant);
+  return removeGridEntities(crawlSpaces, updateRoom, cap);
+}
+
 // The `removeAllDoors` function is not located here because doors are removed via the
 // `Room.RemoveDoor` method instead.
 
@@ -281,14 +333,56 @@ export function removeAllTNT(
   return removeGridEntities(tnt, updateRoom, cap);
 }
 
-/** Helper function to spawn a `GridEntityType.DOOR` (16). */
+/**
+ * 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
+ *                        variant. Default is -1, which matches every variant.
+ * @param updateRoom Optional. Whether or not to update the room after the trapdoors 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 trapdoors.
+ * @returns The trapdoors that were removed.
+ */
+export function removeAllTrapdoors(
+  trapdoorVariant: TrapdoorVariant = -1,
+  updateRoom = false,
+  cap?: int,
+): GridEntity[] {
+  const trapdoors = getTrapdoors(trapdoorVariant);
+  return removeGridEntities(trapdoors, updateRoom, cap);
+}
+
+/** Helper function to spawn a `GridEntityType.CRAWL_SPACE` (18). */
+export function spawnCrawlSpace(
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnCrawlSpaceWithVariant(
+    CrawlSpaceVariant.NORMAL,
+    gridIndexOrPosition,
+  );
+}
+
+/** Helper function to spawn a `GridEntityType.CRAWL_SPACE` (18) with a specific variant. */
+export function spawnCrawlSpaceWithVariant(
+  crawlSpaceVariant: CrawlSpaceVariant,
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnGridEntityWithVariant(
+    GridEntityType.CRAWL_SPACE,
+    crawlSpaceVariant,
+    gridIndexOrPosition,
+  );
+}
+
+/** Helper function to spawn a `GridEntityType.PIT` (7) with a specific variant. */
 export function spawnDoor(
   gridIndexOrPosition: int | Vector,
 ): GridEntityDoor | undefined {
   return spawnDoorWithVariant(DoorVariant.UNSPECIFIED, gridIndexOrPosition);
 }
 
-/** Helper function to spawn a `GridEntityType.DOOR` (16) with a specific variant. */
+/** Helper function to spawn a `GridEntityType.DOOR` (16). */
 export function spawnDoorWithVariant(
   doorVariant: DoorVariant,
   gridIndexOrPosition: int | Vector,
@@ -310,7 +404,7 @@ export function spawnDoorWithVariant(
   return door;
 }
 
-/** Helper function to spawn a `GridEntityType.PIT` (7). */
+/** Helper function to spawn a `GridEntityType.DOOR` (16) with a specific variant. */
 export function spawnPit(
   gridIndexOrPosition: int | Vector,
 ): GridEntityPit | undefined {
@@ -489,3 +583,25 @@ export function spawnTNTWithVariant(
 
   return tnt;
 }
+
+/** Helper function to spawn a `GridEntityType.TRAPDOOR` (17). */
+export function spawnTrapdoor(
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnCrawlSpaceWithVariant(
+    CrawlSpaceVariant.NORMAL,
+    gridIndexOrPosition,
+  );
+}
+
+/** Helper function to spawn a `GridEntityType.TRAPDOOR` (17) with a specific variant. */
+export function spawnTrapdoorWithVariant(
+  trapdoorVariant: TrapdoorVariant,
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnGridEntityWithVariant(
+    GridEntityType.TRAPDOOR,
+    trapdoorVariant,
+    gridIndexOrPosition,
+  );
+}

package/src/functions/pickupsSpecific.ts

@@ -1,7 +1,7 @@
 import {
   BatterySubType,
   BombSubType,
-  Card,
+  CardType,
   CoinSubType,
   CollectibleType,
   HeartSubType,
@@ -45,11 +45,11 @@ export function getBombPickups(
 /**
  * Helper function to get all of the card entities in the room.
  *
- * @param card Optional. If specified, will only get the cards that match the sub-type. Default is
- *             -1, which matches every sub-type.
+ * @param cardType Optional. If specified, will only get the cards that match the sub-type. Default
+ *                 is -1, which matches every sub-type.
  */
-export function getCards(card: Card = -1): EntityPickupCard[] {
-  return getPickups(PickupVariant.TAROT_CARD, card) as EntityPickupCard[];
+export function getCards(cardType: CardType = -1): EntityPickupCard[] {
+  return getPickups(PickupVariant.TAROT_CARD, cardType) as EntityPickupCard[];
 }
 
 /**
@@ -176,15 +176,18 @@ export function removeAllBombPickups(
 /**
  * Helper function to remove all of the cards in the room.
  *
- * @param card Optional. If specified, will only remove cards that match this sub-type. Default is
- *             -1, which matches every sub-type.
+ * @param cardType Optional. If specified, will only remove cards that match this sub-type. Default
+ *                 is -1, which matches every sub-type.
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns The cards that were removed.
  */
-export function removeAllCards(card: Card = -1, cap?: int): EntityPickupCard[] {
+export function removeAllCards(
+  cardType: CardType = -1,
+  cap?: int,
+): EntityPickupCard[] {
   return removeAllPickups(
     PickupVariant.TAROT_CARD,
-    card,
+    cardType,
     cap,
   ) as EntityPickupCard[];
 }
@@ -392,7 +395,7 @@ export function spawnBombPickupWithSeed(
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
  */
 export function spawnCard(
-  card: Card,
+  cardType: CardType,
   position: Vector,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
@@ -400,7 +403,7 @@ export function spawnCard(
 ): EntityPickupCard {
   return spawnPickup(
     PickupVariant.TAROT_CARD,
-    card,
+    cardType,
     position,
     velocity,
     spawner,
@@ -413,13 +416,13 @@ export function spawnCard(
  * and a specific seed.
  */
 export function spawnCardWithSeed(
-  card: Card,
+  cardType: CardType,
   position: Vector,
   seedOrRNG: Seed | RNG,
   velocity: Vector = VectorZero,
   spawner: Entity | undefined = undefined,
 ): EntityPickupCard {
-  return spawnCard(card, position, velocity, spawner, seedOrRNG);
+  return spawnCard(cardType, position, velocity, spawner, seedOrRNG);
 }
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */

package/src/functions/pills.ts

@@ -128,12 +128,7 @@ export function getPillEffectClass(
 /**
  * Helper function to get a pill effect name from a PillEffect enum value.
  *
- * For example:
- *
- * ```ts
- * const pillEffect = PillEffect.BAD_GAS;
- * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"
- * ```
+ * For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
  */
 export function getPillEffectName(pillEffect: PillEffect): string {
   // `ItemConfigPillEffect.Name` is bugged with vanilla pill effects on patch v1.7.6, so we use a

package/src/functions/pocketItems.ts

@@ -1,6 +1,6 @@
 import {
   ActiveSlot,
-  Card,
+  CardType,
   CollectibleType,
   PillColor,
   PlayerType,
@@ -64,14 +64,14 @@ export function getPocketItems(player: EntityPlayer): PocketItemDescription[] {
   let pocketItemIdentified = false;
   let pocketItem2Identified = false;
   for (const slot of pocketItemSlots) {
-    const card = player.GetCard(slot);
+    const cardType = player.GetCard(slot);
     const pillColor = player.GetPill(slot);
 
-    if (card !== Card.NULL) {
+    if (cardType !== CardType.NULL) {
       pocketItems.push({
         slot,
         type: PocketItemType.CARD,
-        subType: card,
+        subType: cardType,
       });
     } else if (pillColor !== PillColor.NULL) {
       pocketItems.push({

package/src/functions/rockAlt.ts

@@ -1,5 +1,5 @@
 import {
-  Card,
+  CardType,
   CoinSubType,
   CollectibleType,
   EffectVariant,
@@ -278,7 +278,7 @@ function spawnRockAltRewardSkull(position: Vector, rng: RNG): boolean {
 
   totalChance += ROCK_ALT_CHANCES.BASIC_DROP;
   if (chance < totalChance) {
-    spawnCardWithSeed(Card.NULL, position, rng);
+    spawnCardWithSeed(CardType.NULL, position, rng);
     return true;
   }
 

package/src/functions/trinkets.ts

@@ -118,12 +118,7 @@ export function getTrinketGfxFilename(trinketType: TrinketType): string {
  * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
  * not valid.
  *
- * For example:
- *
- * ```ts
- * const trinketType = TrinketType.SWALLOWED_PENNY;
- * const trinketName = getTrinketName(trinketType); // trinketName is "Swallowed Penny"
- * ```
+ * For example, `getTrinketName(TrinketType.SWALLOWED_PENNY)` would return "Swallowed Penny".
  */
 export function getTrinketName(trinketType: TrinketType): string {
   // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded map

package/src/functions/types.ts

@@ -1,5 +1,5 @@
 import {
-  Card,
+  CardType,
   CollectibleType,
   LevelStage,
   NpcState,
@@ -10,12 +10,12 @@ import {
 } from "isaac-typescript-definitions";
 
 /**
- * Helper function to safely cast a `number` to a `Card`. (This is better than using the `as`
+ * Helper function to safely cast a `number` to a `CardType`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
  * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
  */
-export function asCard(num: number): Card {
+export function asCardType(num: number): CardType {
   return num;
 }