Eden Starting Stats Health
Hierarchy
-
Feature↳
EdenStartingStatsHealth
Methods
getEdenStartingActiveCollectible
▸ getEdenStartingActiveCollectible(player): undefined | CollectibleType
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
| Name | Type |
|---|---|
player | EntityPlayer |
Returns
undefined | CollectibleType
Defined in
packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:115
getEdenStartingCollectibles
▸ getEdenStartingCollectibles(player): CollectibleType[]
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
| Name | Type |
|---|---|
player | EntityPlayer |
Returns
CollectibleType[]
Defined in
packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:133
getEdenStartingHealth
▸ getEdenStartingHealth(player): undefined | Readonly<PlayerHealth>
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
| Name | Type |
|---|---|
player | EntityPlayer |
Returns
undefined | Readonly<PlayerHealth>
Defined in
packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:168
getEdenStartingPassiveCollectible
▸ getEdenStartingPassiveCollectible(player): undefined | CollectibleType
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
| Name | Type |
|---|---|
player | EntityPlayer |
Returns
undefined | CollectibleType
Defined in
packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:185
getEdenStartingStat
▸ getEdenStartingStat<T>(player, playerStat): undefined | PlayerStats[T]
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
| Name | Type |
|---|---|
T | extends PlayerStat |
Parameters
| Name | Type |
|---|---|
player | EntityPlayer |
playerStat | T |
Returns
undefined | PlayerStats[T]
Defined in
packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:202
getEdenStartingStats
▸ getEdenStartingStats(player): undefined | Readonly<PlayerStats>
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
| Name | Type |
|---|---|
player | EntityPlayer |
Returns
undefined | Readonly<PlayerStats>
Defined in
packages/isaacscript-common/src/classes/features/other/EdenStartingStatsHealth.ts:225