isaacscript-common 43.1.0 → 44.1.0

package/dist/index.rollup.d.ts

@@ -4917,7 +4917,15 @@ export declare function getCharacters(): PlayerType[];
  *
  * Note that this will return an empty array for Eden and Tainted Eden.
  */
-export declare function getCharacterStartingCollectibles(character: PlayerType): readonly CollectibleType[];
+export declare function getCharacterStartingCollectibleTypes(character: PlayerType): readonly CollectibleType[];
+
+/**
+ * Helper function to get the trinket that is granted to a particular character at the beginning of
+ * a run. Returns undefined if the character does not start with a trinket.
+ *
+ * Note that this will return undefined for Eden and Tainted Eden.
+ */
+export declare function getCharacterStartingTrinketType(character: PlayerType): TrinketType | undefined;
 
 /**
  * Helper function to get the amount of charges away from the maximum charge that a particular
@@ -6339,9 +6347,9 @@ export declare function getPlayers(performCharacterExclusions?: boolean): Entity
 export declare function getPlayersOfType(...characters: PlayerType[]): EntityPlayer[];
 
 /**
- * Helper function to get all of the players that match the provided controller index. This function
- * returns an array of players because it is possible that there is more than one player with the
- * same controller index (e.g. Jacob & Esau).
+ * Helper function to get all of the players that are using keyboard (i.e.
+ * `ControllerIndex.KEYBOARD`). This function returns an array of players because it is possible
+ * that there is more than one player with the same controller index (e.g. Jacob & Esau).
  *
  * Note that this function includes players with a non-undefined parent like e.g. the Strawman
  * Keeper.
@@ -8335,7 +8343,7 @@ export declare enum ISCFeature {
     PAUSE = 37,
     PERSISTENT_ENTITIES = 38,
     PICKUP_INDEX_CREATION = 39,
-    PLAYER_INVENTORY = 40,
+    PLAYER_COLLECTIBLE_TRACKING = 40,
     PONY_DETECTION = 41,
     PRESS_INPUT = 42,
     PREVENT_CHILD_ENTITIES = 43,
@@ -8400,7 +8408,7 @@ declare interface ISCFeatureToClass {
     [ISCFeature.PAUSE]: Pause;
     [ISCFeature.PERSISTENT_ENTITIES]: PersistentEntities;
     [ISCFeature.PICKUP_INDEX_CREATION]: PickupIndexCreation;
-    [ISCFeature.PLAYER_INVENTORY]: PlayerInventory;
+    [ISCFeature.PLAYER_COLLECTIBLE_TRACKING]: PlayerCollectibleTracking;
     [ISCFeature.PONY_DETECTION]: PonyDetection;
     [ISCFeature.PRESS_INPUT]: PressInput;
     [ISCFeature.PREVENT_CHILD_ENTITIES]: PreventChildEntities;
@@ -14248,6 +14256,45 @@ declare class PlayerCollectibleDetection extends Feature {
     private checkActiveItemsChanged;
 }
 
+declare class PlayerCollectibleTracking extends Feature {
+    private readonly postPlayerCollectibleAdded;
+    private readonly postPlayerCollectibleRemoved;
+    /**
+     * Helper function to get all of the collectible types that the player has gotten so far on this
+     * run, in order.
+     *
+     * In the case of items given on the first frame of the run or the case where the player rerolls
+     * their build in the middle of the run (e.g. with D4), the order of the collectible types will
+     * not correspond to the order that the items were actually given to the player. In this case, the
+     * order will be from the lowest `CollectibleType` to the highest.
+     *
+     * Under the hood, this feature works by tracking the number of collectibles that a player has on
+     * every frame. Thus, in a situation where a collectible was both added and removed to the player
+     * on the same frame, the amount of total collectibles would stay the same, and the collectible
+     * types would not be updated. In vanilla, this situation would never happen, but another mod
+     * might do this for some reason. (With that said, the next time that a collectible is normally
+     * added or removed, it would trigger a re-scan, and the previous changes would be picked up.)
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.PLAYER_COLLECTIBLE_TRACKING`.
+     *
+     * @param player The player to get the collectible types for.
+     * @param includeActiveCollectibles Optional. If true, will include all active collectibles.
+     *                                Default is true.
+     */
+    getPlayerCollectibleTypes(player: EntityPlayer, includeActiveCollectibles?: boolean): readonly CollectibleType[];
+    /**
+     * Helper function to get the last passive collectible type that the player picked up. In most
+     * cases, this will be the passive that would be removed if the player used Clicker.
+     *
+     * Returns undefined if the player does not have any passive collectibles.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.PLAYER_COLLECTIBLE_TRACKING`.
+     */
+    getPlayerLastPassiveCollectibleType(player: EntityPlayer): CollectibleType | undefined;
+}
+
 /**
  * Helper function to remove all of a player's black hearts and add the corresponding amount of soul
  * hearts.
@@ -14303,43 +14350,6 @@ export declare type PlayerIndex = int & {
     readonly __playerIndexBrand: symbol;
 };
 
-declare class PlayerInventory extends Feature {
-    private readonly postCollectibleAdded;
-    private readonly postCollectibleRemoved;
-    /**
-     * Helper function to get all of the collectibles that the player has gotten so far on this run,
-     * in order.
-     *
-     * In the case of inventory initialization or the case where the player rerolls their build in the
-     * middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
-     * that the items were actually given to the player. In this case, the inventory will be in the
-     * order of the lowest `CollectibleType` to the highest.
-     *
-     * Under the hood, the inventory tracking works by tracking the number of collectibles that a
-     * player has on every frame. Thus, in a situation where a collectible was both added and removed
-     * to the player on the same frame, the amount of total collectibles would stay the same, and the
-     * inventory would not be updated. In vanilla, this situation would never happen, but another mod
-     * might do this for some reason. (With that said, the next time that a collectible is normally
-     * added or removed, it would trigger a re-scan, and the previous changes would be picked up.)
-     *
-     * In order to use this function, you must upgrade your mod with `ISCFeature.PLAYER_INVENTORY`.
-     *
-     * @param player The player to get the inventory for.
-     * @param includeActiveCollectibles Optional. If true, will include all active collectibles.
-     *                                Default is true.
-     */
-    getPlayerInventory(player: EntityPlayer, includeActiveCollectibles?: boolean): CollectibleType[];
-    /**
-     * Helper function to get the last passive collectible that the player picked up. In most cases,
-     * this will be the passive that is removed when the player would use Clicker.
-     *
-     * Returns undefined if the player does not have any passive collectibles.
-     *
-     * In order to use this function, you must upgrade your mod with `ISCFeature.PLAYER_INVENTORY`.
-     */
-    getPlayerLastPassiveCollectible(player: EntityPlayer): CollectibleType | undefined;
-}
-
 declare class PlayerReorderedCallbacks extends Feature {
     v: {
         run: {