isaacscript-common 30.11.1 → 30.11.4

package/dist/index.rollup.d.ts

@@ -3244,8 +3244,6 @@ export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
  *   However, if a factory function was provided during instantiation, and the factory function has
  *   one or more arguments, then you must call this method instead (and provide the corresponding
  *   arguments).
- * - `getWithoutDefault` - Calls the original `Map.get` function (without setting the default
- *   value).
  * - `getDefaultValue` - Returns the default value to be used for a new key. (If a factory function
  *   was provided during instantiation, this will execute the factory function.)
  * - `getConstructorArg` - Helper method for cloning the map. Returns either the default value or
@@ -3336,7 +3334,8 @@ declare class DeployJSONRoom extends Feature {
     /**
      * Helper function to deconstruct a vanilla room and set up a custom room in its place.
      * Specifically, this will clear the current room of all entities and grid entities, and then
-     * spawn all of the entries and grid entities in the provided JSON room.
+     * spawn all of the entries and grid entities in the provided JSON room. For this reason, you must
+     * be in the actual room in order to use this function.
      *
      * A JSON room is simply an XML file converted to JSON. You can create JSON rooms by using the
      * Basement Renovator room editor to create an XML file, and then convert it to JSON using the
@@ -5757,6 +5756,22 @@ export declare function getPHDPillEffect(pillEffect: PillEffect): PillEffect;
  */
 export declare function getPickups(pickupVariant?: PickupVariant | -1, subType?: number): EntityPickup[];
 
+/**
+ * Helper function to get the corresponding pill color from an effect by repeatedly using the
+ * `ItemPool.GetPillEffect` method.
+ *
+ * Note that this will return the corresponding effect even if the passed pill color is not yet
+ * identified by the player.
+ *
+ * Returns `PillColor.NULL` if there is the corresponding pill color cannot be found.
+ *
+ * This function is especially useful in the `POST_USE_PILL` callback, since at that point, the used
+ * pill is already consumed, and the callback only passes the effect. In this specific circumstance,
+ * consider using the `POST_USE_PILL_FILTER` callback instead of the `POST_USE_PILL` callback, since
+ * it correctly passes the color and handles the case of horse pills.
+ */
+export declare function getPillColorFromEffect(pillEffect: PillEffect): PillColor;
+
 /**
  * Helper function to get a pill effect class from a PillEffect enum value. In this context, the
  * class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
@@ -5776,10 +5791,10 @@ export declare function getPillEffectClass(pillEffect: PillEffect): ItemConfigPi
 export declare function getPillEffectName(pillEffect: PillEffect): string;
 
 /**
- * Helper function to get a pill effect type from a PillEffect enum value. In this context, the type
- * is equal to positive, negative, or neutral. This is derived from the suffix of the "class" tag in
- * the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the "power"
- * of the pill.
+ * Helper function to get a pill effect type from a `PillEffect` enum value. In this context, the
+ * type is equal to positive, negative, or neutral. This is derived from the suffix of the "class"
+ * tag in the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the
+ * "power" of the pill.
  *
  * Due to limitations in the API, this function will not work properly for modded pill effects, and
  * will always return `DEFAULT_PILL_EFFECT_TYPE` in those cases.
@@ -13551,6 +13566,9 @@ export declare interface PocketItemDescription {
     subType: int;
 }
 
+/** Helper function to see if two sets of pocket item descriptions are identical. */
+export declare function pocketItemsEquals(pocketItems1: PocketItemDescription[], pocketItems2: PocketItemDescription[]): boolean;
+
 /** This is used in the various pocket item helper functions. */
 export declare enum PocketItemType {
     EMPTY = 0,