Pills
Functions
getAllPillColors
▸ getAllPillColors(): readonly PillColor[]
Helper function to get an array with every non-null pill color. This includes all gold colors and all horse colors.
Returns
readonly PillColor[]
Defined in
packages/isaacscript-common/src/functions/pills.ts:47
getFalsePHDPillEffect
▸ getFalsePHDPillEffect(pillEffect): PillEffect
Helper function to get the associated pill effect after False PHD is acquired. If a pill effect is not altered by False PHD, then the same pill effect will be returned.
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
PillEffect
Defined in
packages/isaacscript-common/src/functions/pills.ts:55
getHorsePillColor
▸ getHorsePillColor(pillColor): PillColor
Helper function to get the corresponding horse pill color from a normal pill color.
For example, passing PillColor.BLUE_BLUE would result in 2049, which is the value that
corresponds to the horse pill color for blue/blue.
If passed a horse pill color, this function will return the unmodified pill color.
Parameters
| Name | Type |
|---|---|
pillColor | PillColor |
Returns
PillColor
Defined in
packages/isaacscript-common/src/functions/pills.ts:68
getHorsePillColors
▸ getHorsePillColors(): readonly PillColor[]
Helper function to get an array with every non-gold horse pill color.
Returns
readonly PillColor[]
Defined in
packages/isaacscript-common/src/functions/pills.ts:75
getNormalPillColorFromHorse
▸ getNormalPillColorFromHorse(pillColor): PillColor
Helper function to get the corresponding normal pill color from a horse pill color.
For example, passing 2049 would result in PillColor.BLUE_BLUE.
If called with a non-horse pill color, this function will return back the same color.
Parameters
| Name | Type |
|---|---|
pillColor | PillColor |
Returns
PillColor
Defined in
packages/isaacscript-common/src/functions/pills.ts:86
getNormalPillColors
▸ getNormalPillColors(): readonly PillColor[]
Helper function to get an array with every non-gold and non-horse pill color.
Returns
readonly PillColor[]
Defined in
packages/isaacscript-common/src/functions/pills.ts:93
getPHDPillEffect
▸ getPHDPillEffect(pillEffect): PillEffect
Helper function to get the associated pill effect after PHD is acquired. If a pill effect is not altered by PHD, then the same pill effect will be returned.
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
PillEffect
Defined in
packages/isaacscript-common/src/functions/pills.ts:101
getPillColorFromEffect
▸ getPillColorFromEffect(pillEffect): PillColor
Helper function to get the corresponding pill color from an effect by repeatedly using the
ItemPool.GetPillEffect method.
Note that this will return the corresponding effect even if the passed pill color is not yet identified by the player.
Returns PillColor.NULL if there is the corresponding pill color cannot be found.
This function is especially useful in the POST_USE_PILL callback, since at that point, the used
pill is already consumed, and the callback only passes the effect. In this specific circumstance,
consider using the POST_USE_PILL_FILTER callback instead of the POST_USE_PILL callback, since
it correctly passes the color and handles the case of horse pills.
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
PillColor
Defined in
packages/isaacscript-common/src/functions/pills.ts:120
getPillEffectClass
▸ getPillEffectClass(pillEffect): ItemConfigPillEffectClass
Helper function to get a pill effect class from a PillEffect enum value. In this context, the
class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
getPillEffectType helper function to determine whether the pill effect is positive, negative,
or neutral.
Due to limitations in the API, this function will not work properly for modded pill effects, and
will always return DEFAULT_PILL_EFFECT_CLASS in those cases.
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
ItemConfigPillEffectClass
Defined in
packages/isaacscript-common/src/functions/pills.ts:142
getPillEffectName
▸ getPillEffectName(pillEffect): string
Helper function to get a pill effect name from a PillEffect. Returns "Unknown" if the provided
pill effect is not valid.
This function works for both vanilla and modded pill effects.
For example, getPillEffectName(PillEffect.BAD_GAS) would return "Bad Gas".
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
string
Defined in
packages/isaacscript-common/src/functions/pills.ts:162
getPillEffectType
▸ getPillEffectType(pillEffect): ItemConfigPillEffectType
Helper function to get a pill effect type from a PillEffect enum value. In this context, the
type is equal to positive, negative, or neutral. This is derived from the suffix of the "class"
tag in the "pocketitems.xml" file. Use the getPillEffectClass helper function to determine the
"power" of the pill.
Due to limitations in the API, this function will not work properly for modded pill effects, and
will always return DEFAULT_PILL_EFFECT_TYPE in those cases.
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
ItemConfigPillEffectType
Defined in
packages/isaacscript-common/src/functions/pills.ts:189
getVanillaPillEffectsOfType
▸ getVanillaPillEffectsOfType(pillEffectType): readonly PillEffect[]
Parameters
| Name | Type |
|---|---|
pillEffectType | ItemConfigPillEffectType |
Returns
readonly PillEffect[]
Defined in
packages/isaacscript-common/src/functions/pills.ts:201
isGoldPill
▸ isGoldPill(pillColor): boolean
Helper function to see if the given pill color is either a gold pill or a horse gold pill.
Parameters
| Name | Type |
|---|---|
pillColor | PillColor |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/pills.ts:208
isHorsePill
▸ isHorsePill(pillColor): boolean
Helper function to see if the given pill color is a horse pill.
Under the hood, this checks for pillColor > 2048.
Parameters
| Name | Type |
|---|---|
pillColor | PillColor |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/pills.ts:217
isModdedPillEffect
▸ isModdedPillEffect(pillEffect): boolean
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/pills.ts:221
isNormalPillColor
▸ isNormalPillColor(pillColor): boolean
Helper function to see if the given pill color is not a gold pill and not a horse pill and not the null value.
Under the hood, this checks using the FIRST_PILL_COLOR and LAST_NORMAL_PILL_COLOR constants.
Parameters
| Name | Type |
|---|---|
pillColor | PillColor |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/pills.ts:231
isValidPillEffect
▸ isValidPillEffect(pillEffect): pillEffect is PillEffect
Parameters
| Name | Type |
|---|---|
pillEffect | int |
Returns
pillEffect is PillEffect
Defined in
packages/isaacscript-common/src/functions/pills.ts:235
isVanillaPillEffect
▸ isVanillaPillEffect(pillEffect): boolean
Parameters
| Name | Type |
|---|---|
pillEffect | PillEffect |
Returns
boolean