isaacscript-common 80.2.0 → 80.2.1

package/dist/index.rollup.d.ts

@@ -10583,24 +10583,47 @@ export declare const LAST_ROOM_TYPE: RoomType;
 
 export declare const LAST_STAGE: LevelStage;
 
-/** Calculated from the `Card` enum. */
+/**
+ * Calculated from the `CardType` enum.
+ *
+ * Note that this could be calculated from the length of the enum, because card types are
+ * contiguous. However, we instead get the highest enum value to be safer and to make the code more
+ * consistent with collectibles and trinkets.
+ */
 export declare const LAST_VANILLA_CARD_TYPE: CardType;
 
-/** Calculated from the `PlayerType` enum. */
+/**
+ * Calculated from the `PlayerType` enum.
+ *
+ * Note that this could be calculated from the length of the enum, because characters are
+ * contiguous. However, we instead get the highest enum value to be safer and to make the code more
+ * consistent with collectibles and trinkets.
+ */
 export declare const LAST_VANILLA_CHARACTER: PlayerType;
 
 /**
  * Calculated from the `CollectibleType` enum.
  *
- * Note that this cannot be calculated from the length of the enum, because unlike all of the other
- * enums, collectible types are not contiguous.
+ * Note that this cannot be calculated from the length of the enum, because collectible types are
+ * not contiguous.
  */
 export declare const LAST_VANILLA_COLLECTIBLE_TYPE: CollectibleType;
 
-/** Calculated from the `PillEffect` enum. */
+/**
+ * Calculated from the `PillEffect` enum.
+ *
+ * Note that this could be calculated from the length of the enum, because pill effects are
+ * contiguous. However, we instead get the highest enum value to be safer and to make the code more
+ * consistent with collectibles and trinkets.
+ */
 export declare const LAST_VANILLA_PILL_EFFECT: PillEffect;
 
-/** Calculated from the `TrinketType` enum. */
+/**
+ * Calculated from the `TrinketType` enum.
+ *
+ * Note that this cannot be calculated from the length of the enum, because trinket types are not
+ * contiguous.
+ */
 export declare const LAST_VANILLA_TRINKET_TYPE: TrinketType;
 
 declare type Length<T extends unknown[]> = T extends {
@@ -13623,7 +13646,7 @@ declare class ModdedElementDetection extends Feature {
      * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles, like
      * 666. We subtract one to account for `CollectibleType.NULL`.)
      *
-     * If there are no mods present that add any custom items, this function will return
+     * If there are no mods present that add any custom collectibles, this function will return
      * `CollectibleType.MOMS_RING` (732).
      *
      * This function can only be called if at least one callback has been executed. This is because
@@ -13638,7 +13661,7 @@ declare class ModdedElementDetection extends Feature {
     getLastCollectibleType(): CollectibleType;
     /**
      * Returns the total number of collectibles in the item config, including both vanilla and modded
-     * items. If you just need the number of vanilla collectible types, use the
+     * collectibles. If you just need the number of vanilla collectible types, use the
      * `NUM_VANILLA_COLLECTIBLE_TYPES` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
@@ -13696,7 +13719,7 @@ declare class ModdedElementDetection extends Feature {
     getLastTrinketType(): TrinketType;
     /**
      * Returns the total number of trinkets in the item config, including both vanilla and modded
-     * items. If you just need the number of vanilla trinket types, use the
+     * trinkets. If you just need the number of vanilla trinket types, use the
      * `NUM_VANILLA_TRINKET_TYPES` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
@@ -13735,11 +13758,14 @@ declare class ModdedElementDetection extends Feature {
     /**
      * Will change depending on how many modded cards there are.
      *
-     * This is equal to the number of cards, since all card sub-types are contiguous (unlike
-     * collectibles).
+     * Equal to `itemConfig.GetCards().Size - 1`. (`Size` includes invalid cards, but since cards are
+     * contiguous, there are no invalid cards. We subtract one to account for `CardType.NULL`.)
+     *
+     * If there are no mods present that add any custom cards, this function will return
+     * `CardType.SOUL_OF_JACOB_AND_ESAU` (97).
      *
      * This function can only be called if at least one callback has been executed. This is because
-     * not all cards will necessarily be present when a mod first loads (due to mod load order).
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.
@@ -13748,9 +13774,8 @@ declare class ModdedElementDetection extends Feature {
      */
     getLastCardType(): CardType;
     /**
-     * Will change depending on how many modded cards there are.
-     *
-     * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
+     * Returns the total number of cards in the item config, including both vanilla and modded cards.
+     * If you just need the number of vanilla card types, use the `NUM_VANILLA_CARD_TYPES` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all cards will necessarily be present when a mod first loads (due to mod load order).
@@ -13762,8 +13787,10 @@ declare class ModdedElementDetection extends Feature {
      */
     getNumCardTypes(): int;
     /**
+     * Like vanilla card types, modded card types are always contiguous.
+     *
      * This function can only be called if at least one callback has been executed. This is because
-     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     * not all cards will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.
@@ -13787,8 +13814,12 @@ declare class ModdedElementDetection extends Feature {
     /**
      * Will change depending on how many modded pill effects there are.
      *
-     * This is equal to the number of pill effects, since all pill effects are contiguous (unlike
-     * collectibles).
+     * Equal to `itemConfig.GetPillEffects().Size - 1`. (`Size` includes invalid pill effects, but
+     * since pill effects are contiguous, there are no invalid pill effects. We subtract one to
+     * account for the enum starting at 0 instead of 1.)
+     *
+     * If there are no mods present that add any custom pill effects, this function will return
+     * `PillEffect.EXPERIMENTAL` (49).
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all pill effects will necessarily be present when a mod first loads (due to mod load
@@ -13801,14 +13832,12 @@ declare class ModdedElementDetection extends Feature {
      */
     getLastPillEffect(): PillEffect;
     /**
-     * Will change depending on how many modded pill effects there are.
-     *
-     * Equal to `itemConfig.GetPillEffects().Size`. (We do not have to subtract one, because the first
-     * pill effect has an ID of 0 and there is no `PillEffect.NULL`.)
+     * Returns the total number of pill effects in the item config, including both vanilla and modded
+     * pill effects. If you just need the number of vanilla pill effects, use the
+     * `NUM_VANILLA_PILL_EFFECTS` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
-     * not all pill effects will necessarily be present when a mod first loads (due to mod load
-     * order).
+     * not all cards will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.
@@ -13817,9 +13846,10 @@ declare class ModdedElementDetection extends Feature {
      */
     getNumPillEffects(): int;
     /**
+     * Like vanilla pill effects, modded pill effects are always contiguous.
+     *
      * This function can only be called if at least one callback has been executed. This is because
-     * not all pill effects will necessarily be present when a mod first loads (due to mod load
-     * order).
+     * not all cards will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.