isaacscript-common 1.0.489 → 1.0.490

package/dist/functions/cards.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * This is a helper function to get a card name from a Card.
+ * Helper function to get a card name from a Card.
  *
  * Example:
  * ```
@@ -10,7 +10,7 @@
  */
 export declare function getCardDescription(card: Card | int): string;
 /**
- * This is a helper function to get a card name from a Card.
+ * Helper function to get a card name from a Card.
  *
  * Example:
  * ```

package/dist/functions/collectibles.d.ts

@@ -1,18 +1,38 @@
 /// <reference types="isaac-typescript-definitions" />
 export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
-/** This is a helper function to get a description from a CollectibleType. */
+/**
+ * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
+ * provided collectible type was not valid.
+ */
 export declare function getCollectibleDescription(collectibleType: CollectibleType | int): string;
 /**
  * Helper function to get the heart cost that a collectible item would be if it were being offered
  * in a Devil Room deal. Returns 0 if passed CollectibleType.COLLECTIBLE_NULL.
  */
 export declare function getCollectibleDevilHeartPrice(collectibleType: CollectibleType | int, player: EntityPlayer): PickupPrice;
+/**
+ * Helper function to get the path to a collectible's sprite. Returns
+ * "gfx/items/collectibles/questionmark.png" if the provided collectible type was not valid.
+ */
 export declare function getCollectibleGfxFilename(collectibleType: CollectibleType | int): string;
+/**
+ * Helper function to get the initial amount of charges that a collectible has. Returns 0 if the
+ * provided collectible type was not valid.
+ */
 export declare function getCollectibleInitCharges(collectibleType: CollectibleType | int): int;
+/**
+ * Helper function to get the `ItemType` of a collectible. Returns `ItemType.ITEM_NULL` if the
+ * provided collectible type was not valid.
+ */
 export declare function getCollectibleItemType(collectibleType: CollectibleType | int): ItemType;
+/**
+ * Helper function to get the maximum amount of charges that a collectible has. Returns 0 if the
+ * provided collectible type was not valid.
+ */
 export declare function getCollectibleMaxCharges(collectibleType: CollectibleType | int): int;
 /**
- * This is a helper function to get an item name from a CollectibleType.
+ * Helper function to get the name of a collectible. Returns "Unknown" if the provided collectible
+ * type is not valid.
  *
  * Example:
  * ```

package/dist/functions/pills.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * This is a helper function to get a pill effect name from a PillEffect.
+ * Helper function to get a pill effect name from a PillEffect.
  *
  * Example:
  * ```

package/dist/functions/trinkets.d.ts

@@ -16,10 +16,14 @@ export declare function getMaxTrinketID(): int;
 export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefined;
 /** Helper function to get all of the trinket entities in the room. */
 export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
-/** This is a helper function to get a trinket description from a TrinketType. */
+/**
+ * Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
+ * trinket type was not valid.
+ */
 export declare function getTrinketDescription(trinketType: TrinketType | int): string;
 /**
- * This is a helper function to get a trinket name from a TrinketType.
+ * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
+ * not valid.
  *
  * Example:
  * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.489",
+  "version": "1.0.490",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",