isaacscript-common 56.0.0 → 57.0.0

package/dist/index.rollup.d.ts

@@ -4954,6 +4954,12 @@ export declare function getBossID(): BossID | 0;
 
 export declare function getBossIDFromEntityTypeVariant(entityType: EntityType, variant: int): BossID | undefined;
 
+/**
+ * Helper function to get the proper English name for a boss. For example, the name for
+ * `BossID.WRETCHED` (36) is "The Wretched".
+ */
+export declare function getBossName(bossID: BossID): string;
+
 /**
  * Helper function to get the path to the name file that corresponds to the graphic shown on the
  * versus screen for the particular boss.
@@ -15172,8 +15178,8 @@ export declare function PriorityCallbackCustom<T extends ModCallbackCustom>(modC
 export declare type PublicInterface<T> = Pick<T, keyof T>;
 
 /**
- * An array representing every valid collectible type quality. Specifically, this is `[0, 1, 2, 3,
- * 4]`.
+ * An array representing every valid collectible type quality. Specifically, this is: `[0, 1, 2, 3,
+ * 4]`
  */
 export declare const QUALITIES: readonly Quality[];
 
@@ -15201,13 +15207,40 @@ declare interface ReadonlySetConstructor {
     readonly prototype: ReadonlySet<any>;
 }
 
+/**
+ * Helper function to let the Rebirth Item Tracker know that it should remove a collectible from its
+ * list.
+ *
+ * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
+ * external Python program.
+ *
+ * This function is variadic, meaning that you can pass as many collectible types as you want to
+ * remove.
+ *
+ * Note that calling this function is not normally necessary when removing collectibles from
+ * players. For example, when you remove a collectible with the `EntityPlayer.RemoveCollectible`
+ * method, a proper message is sent to the log file by the game the item tracker will automatically
+ * remove it. However, in some cases, this function can be useful:
+ *
+ * - We may be giving the player a "fake" collectible (e.g. 1-Up for the purposes of an extra life)
+ *   and do not want the fake collectible to show up on the tracker.
+ * - We may be removing a starting active item. Since active items are never removed from the
+ *   tracker, we want to tell the item tracker that the player never had a particular active item to
+ *   begin with.
+ *
+ * @see https://github.com/Rchardon/RebirthItemTracker
+ */
+export declare function rebirthItemTrackerRemoveCollectible(...collectibleTypes: CollectibleType[]): void;
+
 /**
  * Helper function to let the Rebirth Item Tracker know that it should write the submitted text
  * string to a file. This is useful for capturing text in programs like Open Broadcaster Software
  * (OBS).
  *
  * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
+ * external Python program.
+ *
+ * @see https://github.com/Rchardon/RebirthItemTracker
  */
 export declare function rebirthItemTrackerWriteToFile(msg: string): void;
 
@@ -15683,23 +15716,6 @@ export declare function removeCollectibleCostume(player: EntityPlayer, collectib
  */
 export declare function removeCollectibleFromAllPlayers(...collectibleTypes: CollectibleType[]): void;
 
-/**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
- * should remove an item.
- *
- * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
- *
- * This function is useful when you need to add a "fake" collectible to a player. Note that calling
- * this function is not necessary when removing items from players. For example, when you remove a
- * collectible with the `EntityPlayer.RemoveCollectible` method, a proper message is sent to the log
- * the item tracker will automatically remove it.
- *
- * This function is variadic, meaning that you can pass as many collectible types as you want to
- * remove.
- */
-export declare function removeCollectibleFromItemTracker(...collectibleTypes: CollectibleType[]): void;
-
 /**
  * Helper function to remove one or more collectibles from all item pools.
  *