isaacscript-common 11.0.1 → 11.2.0

package/dist/index.d.ts

@@ -2692,6 +2692,8 @@ export declare function getCollectibleChargeType(collectibleType: CollectibleTyp
 /**
  * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
  * provided collectible type was not valid.
+ *
+ * This function works for both vanilla and modded collectibles.
  */
 export declare function getCollectibleDescription(collectibleType: CollectibleType): string;
 
@@ -2799,6 +2801,8 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  * type is not valid.
  *
  * For example, `getCollectibleName(CollectibleType.SAD_ONION)` would return "Sad Onion".
+ *
+ * This function works for both vanilla and modded collectibles.
  */
 export declare function getCollectibleName(collectibleType: CollectibleType): string;
 
@@ -3611,7 +3615,7 @@ export declare function getLatestRoomDescription(): RoomDescription;
  *   ["bar", 456],
  * ]);
  * const searchText = "f";
- * const match = getMapPartialMatch(map, searchText); // match is now equal to 123
+ * const match = getMapPartialMatch(map, searchText); // match is now equal to ["foo", 123]
  *
  * @returns If a match was found, returns a tuple of the map key and value. If a match was not
  * found, returns undefined.
@@ -5210,6 +5214,8 @@ export declare function getTrinketArray(): readonly TrinketType[];
 /**
  * Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
  * trinket type was not valid.
+ *
+ * This function works for both vanilla and modded trinkets.
  */
 export declare function getTrinketDescription(trinketType: TrinketType): string;
 
@@ -5228,6 +5234,8 @@ export declare function getTrinketGfxFilename(trinketType: TrinketType): string;
  * not valid.
  *
  * For example, `getTrinketName(TrinketType.SWALLOWED_PENNY)` would return "Swallowed Penny".
+ *
+ * This function works for both vanilla and modded trinkets.
  */
 export declare function getTrinketName(trinketType: TrinketType): string;
 
@@ -6453,6 +6461,9 @@ export declare function isTear(variable: unknown): variable is EntityTear;
  * only use this function in the `POST_TEAR_INIT_VERY_LATE` callback or on frame 1+.
  *
  * If this function is called on frame 0, it will throw a run-time error.
+ *
+ * Note that this function does not work properly when the tear is from a Lead Pencil barrage. In
+ * this case, it will always appear as if the tear is coming from a player.
  */
 export declare function isTearFromFamiliar(tear: EntityTear): boolean;
 
@@ -6466,6 +6477,9 @@ export declare function isTearFromFamiliar(tear: EntityTear): boolean;
  * only use this function in the `POST_TEAR_INIT_VERY_LATE` callback or on frame 1+.
  *
  * If this function is called on frame 0, it will throw a run-time error.
+ *
+ * Note that this function does not work properly when the tear is from a Lead Pencil barrage. In
+ * this case, it will always appear as if the tear is coming from a player.
  */
 export declare function isTearFromPlayer(tear: EntityTear): boolean;