isaacscript-common 30.9.0 → 30.10.0

package/dist/index.rollup.d.ts

@@ -491,7 +491,7 @@ declare interface AddCallbackParametersCustom {
     character?: PlayerType
     ];
     [ModCallbackCustom.POST_PLAYER_CHANGE_STAT]: [
-    callback: <T extends StatType>(player: EntityPlayer, statType: StatType, difference: int, oldValue: StatTypeType[T], newValue: StatTypeType[T]) => void,
+    callback: <T extends PlayerStat>(player: EntityPlayer, playerStat: PlayerStat, difference: int, oldValue: PlayerStats[T], newValue: PlayerStats[T]) => void,
     playerVariant?: PlayerVariant,
     character?: PlayerType
     ];
@@ -3877,6 +3877,32 @@ export declare function easeOutQuint(time: number): number;
  */
 export declare function easeOutSine(time: number): number;
 
+declare class EdenStartingStats extends Feature {
+    /**
+     * We must use the `POST_PLAYER_INIT` callback since the two random collectibles have not been
+     * granted yet.
+     */
+    private postPlayerInit;
+    /**
+     * Helper function to get the value of the randomized starting stat for Eden. (At the beginning of
+     * a run, Eden starts with randomized stats.)
+     *
+     * 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`.
+     */
+    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.
+     *
+     * 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`.
+     */
+    getEdenStartingStats(player: EntityPlayer): Readonly<PlayerStats> | undefined;
+}
+
 /**
  * When Eggies take fatal damage, they go into NPCState.STATE_SUICIDE and spawn 14 Swarm Spiders
  * while their StateFrame ticks upwards. The 14th spider appears when the StateFrame is at this
@@ -5968,7 +5994,10 @@ export declare function getPlayersOnKeyboard(): EntityPlayer[];
 export declare function getPlayerSoulHearts(player: EntityPlayer): int;
 
 /** Helper function to get the stat for a player corresponding to the `StatType`. */
-export declare function getPlayerStat<T extends StatType>(player: EntityPlayer, statType: T): StatTypeType[T];
+export declare function getPlayerStat<T extends PlayerStat>(player: EntityPlayer, playerStat: T): PlayerStats[T];
+
+/** Helper function to get all of the stat for a player. */
+export declare function getPlayerStats(player: EntityPlayer): PlayerStats;
 
 /**
  * Helper function to get only the players that have a certain collectible.
@@ -7752,34 +7781,35 @@ export declare enum ISCFeature {
     DEPLOY_JSON_ROOM = 24,
     DISABLE_ALL_SOUND = 25,
     DISABLE_INPUTS = 26,
-    FADE_IN_REMOVER = 27,
-    FAST_RESET = 28,
-    FLYING_DETECTION = 29,
-    FORGOTTEN_SWITCH = 30,
-    EXTRA_CONSOLE_COMMANDS = 31,
-    ITEM_POOL_DETECTION = 32,
-    MODDED_ELEMENT_DETECTION = 33,
-    MODDED_ELEMENT_SETS = 34,
-    NO_SIREN_STEAL = 35,
-    PAUSE = 36,
-    PERSISTENT_ENTITIES = 37,
-    PICKUP_INDEX_CREATION = 38,
-    PLAYER_INVENTORY = 39,
-    PONY_DETECTION = 40,
-    PRESS_INPUT = 41,
-    PREVENT_CHILD_ENTITIES = 42,
-    PREVENT_COLLECTIBLE_ROTATION = 43,
-    PREVENT_GRID_ENTITY_RESPAWN = 44,
-    ROOM_CLEAR_FRAME = 45,
-    ROOM_HISTORY = 46,
-    RUN_IN_N_FRAMES = 47,
-    RUN_NEXT_ROOM = 48,
-    SAVE_DATA_MANAGER = 49,
-    SPAWN_ALT_ROCK_REWARDS = 50,
-    SPAWN_COLLECTIBLE = 51,
-    STAGE_HISTORY = 52,
-    START_AMBUSH = 53,
-    TAINTED_LAZARUS_PLAYERS = 54
+    EDEN_STARTING_STATS = 27,
+    FADE_IN_REMOVER = 28,
+    FAST_RESET = 29,
+    FLYING_DETECTION = 30,
+    FORGOTTEN_SWITCH = 31,
+    EXTRA_CONSOLE_COMMANDS = 32,
+    ITEM_POOL_DETECTION = 33,
+    MODDED_ELEMENT_DETECTION = 34,
+    MODDED_ELEMENT_SETS = 35,
+    NO_SIREN_STEAL = 36,
+    PAUSE = 37,
+    PERSISTENT_ENTITIES = 38,
+    PICKUP_INDEX_CREATION = 39,
+    PLAYER_INVENTORY = 40,
+    PONY_DETECTION = 41,
+    PRESS_INPUT = 42,
+    PREVENT_CHILD_ENTITIES = 43,
+    PREVENT_COLLECTIBLE_ROTATION = 44,
+    PREVENT_GRID_ENTITY_RESPAWN = 45,
+    ROOM_CLEAR_FRAME = 46,
+    ROOM_HISTORY = 47,
+    RUN_IN_N_FRAMES = 48,
+    RUN_NEXT_ROOM = 49,
+    SAVE_DATA_MANAGER = 50,
+    SPAWN_ALT_ROCK_REWARDS = 51,
+    SPAWN_COLLECTIBLE = 52,
+    STAGE_HISTORY = 53,
+    START_AMBUSH = 54,
+    TAINTED_LAZARUS_PLAYERS = 55
 }
 
 /**
@@ -7816,6 +7846,7 @@ declare interface ISCFeatureToClass {
     [ISCFeature.DEPLOY_JSON_ROOM]: DeployJSONRoom;
     [ISCFeature.DISABLE_ALL_SOUND]: DisableAllSound;
     [ISCFeature.DISABLE_INPUTS]: DisableInputs;
+    [ISCFeature.EDEN_STARTING_STATS]: EdenStartingStats;
     [ISCFeature.FADE_IN_REMOVER]: FadeInRemover;
     [ISCFeature.FAST_RESET]: FastReset;
     [ISCFeature.FLYING_DETECTION]: FlyingDetection;
@@ -12702,8 +12733,8 @@ export declare class ModUpgraded implements Mod {
     private callbacks;
     private features;
     constructor(mod: Mod, debug: boolean, timeThreshold?: float);
-    AddCallback<T extends ModCallback | string>(modCallback: T, ...args: T extends ModCallback ? AddCallbackParameters[T] : unknown[]): void;
-    AddPriorityCallback<T extends ModCallback | string>(modCallback: T, priority: CallbackPriority | int, ...args: T extends ModCallback ? AddCallbackParameters[T] : unknown[]): void;
+    AddCallback<T extends keyof AddCallbackParameters | string>(modCallback: T, ...args: T extends keyof AddCallbackParameters ? AddCallbackParameters[T] : unknown[]): void;
+    AddPriorityCallback<T extends keyof AddCallbackParameters | string>(modCallback: T, priority: CallbackPriority | int, ...args: T extends keyof AddCallbackParameters ? AddCallbackParameters[T] : unknown[]): void;
     HasData(): boolean;
     LoadData(): string;
     RemoveCallback<T extends ModCallback>(modCallback: T, callback: AddCallbackParameters[T][0]): void;
@@ -13463,6 +13494,56 @@ declare class PlayerReorderedCallbacks extends Feature {
     private postGameStartedReorderedLast;
 }
 
+/** This represents the kinds of stats that a player can have. */
+export declare enum PlayerStat {
+    /** Corresponds to `CacheFlag.DAMAGE` (1 << 0) and `EntityPlayer.Damage`. */
+    DAMAGE = 0,
+    /** Corresponds to `CacheFlag.FIRE_DELAY` (1 << 1) and `EntityPlayer.MaxFireDelay`. */
+    FIRE_DELAY = 1,
+    /** Corresponds to `CacheFlag.SHOT_SPEED` (1 << 2) and `EntityPlayer.ShotSpeed`. */
+    SHOT_SPEED = 2,
+    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearHeight`. */
+    TEAR_HEIGHT = 3,
+    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearRange`. */
+    TEAR_RANGE = 4,
+    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearFallingAcceleration`. */
+    TEAR_FALLING_ACCELERATION = 5,
+    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearFallingSpeed`. */
+    TEAR_FALLING_SPEED = 6,
+    /** Corresponds to `CacheFlag.SPEED` (1 << 4) and `EntityPlayer.MoveSpeed`. */
+    MOVE_SPEED = 7,
+    /** Corresponds to `CacheFlag.TEAR_FLAG` (1 << 5) and `EntityPlayer.TearFlags`. */
+    TEAR_FLAG = 8,
+    /** Corresponds to `CacheFlag.TEAR_COLOR` (1 << 6) and `EntityPlayer.TearColor`. */
+    TEAR_COLOR = 9,
+    /** Corresponds to `CacheFlag.FLYING` (1 << 7) and `EntityPlayer.CanFly`. */
+    FLYING = 10,
+    /** Corresponds to `CacheFlag.LUCK` (1 << 10) and `EntityPlayer.Luck`. */
+    LUCK = 11,
+    /** Corresponds to `CacheFlag.SIZE` (1 << 11) and `EntityPlayer.SpriteScale`. */
+    SIZE = 12
+}
+
+/**
+ * Contains every player stat along with its corresponding data type. For example, `StatType.DAMAGE`
+ * is a `float` type.
+ */
+export declare interface PlayerStats {
+    [PlayerStat.DAMAGE]: float;
+    [PlayerStat.FIRE_DELAY]: float;
+    [PlayerStat.SHOT_SPEED]: float;
+    [PlayerStat.TEAR_HEIGHT]: float;
+    [PlayerStat.TEAR_RANGE]: float;
+    [PlayerStat.TEAR_FALLING_ACCELERATION]: float;
+    [PlayerStat.TEAR_FALLING_SPEED]: float;
+    [PlayerStat.MOVE_SPEED]: float;
+    [PlayerStat.TEAR_FLAG]: BitFlags<TearFlag>;
+    [PlayerStat.TEAR_COLOR]: Color;
+    [PlayerStat.FLYING]: boolean;
+    [PlayerStat.LUCK]: float;
+    [PlayerStat.SIZE]: Vector;
+}
+
 /** This is used by the `getPocketItems` and related helper functions. */
 export declare interface PocketItemDescription {
     slot: PocketItemSlot;
@@ -15568,7 +15649,7 @@ source: EntityRef,
 countdownFrames: int
 ] | [
 player: EntityPlayer,
-statType: StatType,
+playerStat: PlayerStat,
 difference: int,
 oldValue: PossibleStatType,
 newValue: PossibleStatType
@@ -16340,56 +16421,6 @@ export declare type StartsWithLowercase<S> = S extends string ? Extract<S, Uncap
 /** Helper type to ensure that the given string starts with an uppercase letter. */
 export declare type StartsWithUppercase<S> = S extends string ? Extract<S, Capitalize<S>> : never;
 
-/** This represents the kinds of stats that a player can have. */
-export declare enum StatType {
-    /** Corresponds to `CacheFlag.DAMAGE` (1 << 0) and `EntityPlayer.Damage`. */
-    DAMAGE = 0,
-    /** Corresponds to `CacheFlag.FIRE_DELAY` (1 << 1) and `EntityPlayer.MaxFireDelay`. */
-    FIRE_DELAY = 1,
-    /** Corresponds to `CacheFlag.SHOT_SPEED` (1 << 2) and `EntityPlayer.ShotSpeed`. */
-    SHOT_SPEED = 2,
-    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearHeight`. */
-    TEAR_HEIGHT = 3,
-    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearRange`. */
-    TEAR_RANGE = 4,
-    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearFallingAcceleration`. */
-    TEAR_FALLING_ACCELERATION = 5,
-    /** Corresponds to `CacheFlag.RANGE` (1 << 3) and `EntityPlayer.TearFallingSpeed`. */
-    TEAR_FALLING_SPEED = 6,
-    /** Corresponds to `CacheFlag.SPEED` (1 << 4) and `EntityPlayer.MoveSpeed`. */
-    MOVE_SPEED = 7,
-    /** Corresponds to `CacheFlag.TEAR_FLAG` (1 << 5) and `EntityPlayer.TearFlags`. */
-    TEAR_FLAG = 8,
-    /** Corresponds to `CacheFlag.TEAR_COLOR` (1 << 6) and `EntityPlayer.TearColor`. */
-    TEAR_COLOR = 9,
-    /** Corresponds to `CacheFlag.FLYING` (1 << 7) and `EntityPlayer.CanFly`. */
-    FLYING = 10,
-    /** Corresponds to `CacheFlag.LUCK` (1 << 10) and `EntityPlayer.Luck`. */
-    LUCK = 11,
-    /** Corresponds to `CacheFlag.SIZE` (1 << 11) and `EntityPlayer.SpriteScale`. */
-    SIZE = 12
-}
-
-/**
- * This is an interface mapping a stat type to the data type. For example, `StatType.DAMAGE` is a
- * `float` type.
- */
-export declare interface StatTypeType {
-    [StatType.DAMAGE]: float;
-    [StatType.FIRE_DELAY]: float;
-    [StatType.SHOT_SPEED]: float;
-    [StatType.TEAR_HEIGHT]: float;
-    [StatType.TEAR_RANGE]: float;
-    [StatType.TEAR_FALLING_ACCELERATION]: float;
-    [StatType.TEAR_FALLING_SPEED]: float;
-    [StatType.MOVE_SPEED]: float;
-    [StatType.TEAR_FLAG]: BitFlags<TearFlag>;
-    [StatType.TEAR_COLOR]: Color;
-    [StatType.FLYING]: boolean;
-    [StatType.LUCK]: float;
-    [StatType.SIZE]: Vector;
-}
-
 /**
  * Helper function to manually stop every vanilla sound effect. If you also want to stop custom
  * sound effects in addition to vanilla ones, then pass the `SoundEffectCustom` enum for your mod.