Class Potions`Beta`

Used for accessing all potion effects, liquids, and modifiers currently available for use within the world.

Index

Methods

getPotionEffectType getPotionLiquidType getPotionModifierType

Methods

`Static`getPotionEffectType

getPotionEffectType(potionEffectId: string): PotionEffectType
Beta
Parameters
- potionEffectId: string
Returns PotionEffectType
A type handle wrapping the valid effect id, or undefined for an invalid effect id.

Remarks
Retrieves a type handle for a specified potion effect id.

`Static`getPotionLiquidType

getPotionLiquidType(potionLiquidId: string): PotionLiquidType
Beta
Parameters
- potionLiquidId: string
Returns PotionLiquidType
A type handle wrapping the valid liquid id, or undefined for an invalid liquid id.

Remarks
Retrieves a type handle for a specified potion liquid id.

`Static`getPotionModifierType

getPotionModifierType(potionModifierId: string): PotionModifierType
Beta
Parameters
- potionModifierId: string
Returns PotionModifierType
A type handle wrapping the valid modifier id, or undefined for an invalid modifier id.

Remarks
Retrieves a type handle for a specified potion modifier id.