isaacscript-common 44.0.0 → 45.0.0

package/dist/index.rollup.d.ts

@@ -4068,15 +4068,26 @@ export declare function easeOutQuint(time: number): number;
  */
 export declare function easeOutSine(time: number): number;
 
-declare class EdenStartingStats extends Feature {
+declare class EdenStartingStatsHealth extends Feature {
     /**
      * We must use the `POST_PLAYER_INIT` callback since the two random collectibles have not been
      * granted yet.
      */
     private readonly postPlayerInit;
+    private getEdenStats;
+    private getEdenHealth;
     /**
-     * Helper function to get the value of the randomized starting stat for Eden. (At the beginning of
-     * a run, Eden starts with randomized stats.)
+     * Helper function to get the health that Eden started with at the beginning of the run before any
+     * of the random collectibles were added.
+     *
+     * Returns undefined if passed a player that is not Eden.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.EDEN_STARTING_STATS`.
+     */
+    getEdenStartingHealth(player: EntityPlayer): Readonly<PlayerHealth> | undefined;
+    /**
+     * Helper function to get the value of the randomized starting stat for Eden that was assigned at
+     * the beginning of the run before any of the random collectibles were added.
      *
      * Returns undefined if passed a player that is not Eden.
      *
@@ -4085,7 +4096,7 @@ declare class EdenStartingStats extends Feature {
     getEdenStartingStat<T extends PlayerStat>(player: EntityPlayer, playerStat: T): PlayerStats[T] | undefined;
     /**
      * Helper function to get all of the stat values that Eden started with at the beginning of the
-     * run.
+     * run before any of the random collectibles were added.
      *
      * Returns undefined if passed a player that is not Eden.
      *
@@ -4917,7 +4928,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
@@ -6232,7 +6251,7 @@ export declare function getPlayerFromPtr(entityPtr: EntityPtr): EntityPlayer | u
  *
  * This is based on the `REVEL.StoreHealth` function in the Revelations mod.
  */
-export declare function getPlayerHealth(player: EntityPlayer): PlayerHealth;
+export declare function getPlayerHealth(player: EntityPlayer): Readonly<PlayerHealth>;
 
 export declare function getPlayerHealthType(player: EntityPlayer, healthType: HealthType): int;
 
@@ -6339,9 +6358,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.
@@ -8322,7 +8341,7 @@ export declare enum ISCFeature {
     DEPLOY_JSON_ROOM = 24,
     DISABLE_ALL_SOUND = 25,
     DISABLE_INPUTS = 26,
-    EDEN_STARTING_STATS = 27,
+    EDEN_STARTING_STATS_HEALTH = 27,
     FADE_IN_REMOVER = 28,
     FAST_RESET = 29,
     FLYING_DETECTION = 30,
@@ -8387,7 +8406,7 @@ declare interface ISCFeatureToClass {
     [ISCFeature.DEPLOY_JSON_ROOM]: DeployJSONRoom;
     [ISCFeature.DISABLE_ALL_SOUND]: DisableAllSound;
     [ISCFeature.DISABLE_INPUTS]: DisableInputs;
-    [ISCFeature.EDEN_STARTING_STATS]: EdenStartingStats;
+    [ISCFeature.EDEN_STARTING_STATS_HEALTH]: EdenStartingStatsHealth;
     [ISCFeature.FADE_IN_REMOVER]: FadeInRemover;
     [ISCFeature.FAST_RESET]: FastReset;
     [ISCFeature.FLYING_DETECTION]: FlyingDetection;
@@ -15600,6 +15619,7 @@ export declare function roomUpdateSafe(): void;
 
 /**
  * If rounding fails, this function returns 0.
+ *
  * From: http://lua-users.org/wiki/SimpleRound
  *
  * @param num The number to round.