Player Effects
Functions
anyPlayerHasCollectibleEffect
▸ anyPlayerHasCollectibleEffect(collectibleType
): boolean
Helper function to check to see if any player has a temporary collectible effect.
Parameters
Name | Type |
---|---|
collectibleType | CollectibleType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/playerEffects.ts:11
anyPlayerHasNullEffect
▸ anyPlayerHasNullEffect(nullItemID
): boolean
Helper function to check to see if any player has a temporary null effect.
Parameters
Name | Type |
---|---|
nullItemID | NullItemID |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/playerEffects.ts:23
anyPlayerHasTrinketEffect
▸ anyPlayerHasTrinketEffect(trinketType
): boolean
Helper function to check to see if any player has a temporary trinket effect.
Parameters
Name | Type |
---|---|
trinketType | TrinketType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/playerEffects.ts:33
getEffectsList
▸ getEffectsList(player
): readonly TemporaryEffect
[]
Helper function to get an array of temporary effects for a player. This is helpful so that you
don't have to manually create an array from an EffectsList
object.
Parameters
Name | Type |
---|---|
player | EntityPlayer |
Returns
readonly TemporaryEffect
[]
Defined in
packages/isaacscript-common/src/functions/playerEffects.ts:46
shouldWhoreOfBabylonBeActive
▸ shouldWhoreOfBabylonBeActive(player
): boolean
Helper function to check if a player should have Whore of Babylon active at their current health level.
- For most characters, Whore of Babylon activates when the red hearts are at 1/2 or less.
- For Eve, Whore of Babylon activates when the red hearts are at 1 or less.
Parameters
Name | Type |
---|---|
player | EntityPlayer |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/playerEffects.ts:70