Eden Starting Stats Health
Classes
Section titled “Classes”EdenStartingStatsHealth
Section titled “EdenStartingStatsHealth”Defined in: packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:29
Extends
Section titled “Extends”Feature
Methods
Section titled “Methods”getEdenStartingActiveCollectible()
Section titled “getEdenStartingActiveCollectible()”getEdenStartingActiveCollectible(
player):CollectibleType|undefined
Defined in: packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:115
Helper function to get the active collectible that Eden started with at the beginning of the run.
Returns undefined if passed a player that is not Eden or if the starting collectibles are not
yet added. (Eden’s starting collectibles are added after the POST_PLAYER_INIT callback has
fired.)
Parameters
Section titled “Parameters”player
Section titled “player”EntityPlayer
Returns
Section titled “Returns”CollectibleType | undefined
getEdenStartingCollectibles()
Section titled “getEdenStartingCollectibles()”getEdenStartingCollectibles(
player): readonlyCollectibleType[]
Defined in: packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:133
Helper function to get an array containing the active collectible and the passive collectible that Eden started with at the beginning of the run. The active collectible will be the first element and the passive collectible will be the second element.
Returns an empty array if passed a player that is not Eden or if the starting collectibles are
not yet added. (Eden’s starting collectibles are added after the POST_PLAYER_INIT callback
has fired.)
Parameters
Section titled “Parameters”player
Section titled “player”EntityPlayer
Returns
Section titled “Returns”readonly CollectibleType[]
getEdenStartingHealth()
Section titled “getEdenStartingHealth()”getEdenStartingHealth(
player):Readonly<PlayerHealth> |undefined
Defined in: packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:170
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.
Parameters
Section titled “Parameters”player
Section titled “player”EntityPlayer
Returns
Section titled “Returns”Readonly<PlayerHealth> | undefined
getEdenStartingPassiveCollectible()
Section titled “getEdenStartingPassiveCollectible()”getEdenStartingPassiveCollectible(
player):CollectibleType|undefined
Defined in: packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:187
Helper function to get the passive collectible that Eden started with at the beginning of the run.
Returns undefined if passed a player that is not Eden or if the starting collectibles are not
yet added. (Eden’s starting collectibles are added after the POST_PLAYER_INIT callback has
fired.)
Parameters
Section titled “Parameters”player
Section titled “player”EntityPlayer
Returns
Section titled “Returns”CollectibleType | undefined
getEdenStartingStat()
Section titled “getEdenStartingStat()”getEdenStartingStat<
T>(player,playerStat):PlayerStats[T] |undefined
Defined in: packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:204
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.
In order to use this function, you must upgrade your mod with ISCFeature.EDEN_STARTING_STATS.
Type Parameters
Section titled “Type Parameters”T extends PlayerStat
Parameters
Section titled “Parameters”player
Section titled “player”EntityPlayer
playerStat
Section titled “playerStat”T
Returns
Section titled “Returns”PlayerStats[T] | undefined
getEdenStartingStats()
Section titled “getEdenStartingStats()”getEdenStartingStats(
player):Readonly<PlayerStats> |undefined
Defined in: packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:227
Helper function to get all of the stat values 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.
Parameters
Section titled “Parameters”player
Section titled “player”EntityPlayer
Returns
Section titled “Returns”Readonly<PlayerStats> | undefined