Class Potions

Used for accessing all potion effect types, delivery types, and creating potions.

Index

Methods

getAllDeliveryTypes getAllEffectTypes getDeliveryType getEffectType resolve

Methods

`Static`getAllDeliveryTypes

getAllDeliveryTypes(): PotionDeliveryType[]
Returns PotionDeliveryType[]
Array of all registered delivery type handles.

Remarks
Retrieves handles for all registered potion delivery types.
- Defined in @minecraft/server.d.ts:17358

`Static`getAllEffectTypes

getAllEffectTypes(): PotionEffectType[]
Returns PotionEffectType[]
Array of all registered effect type handles.

Remarks
Retrieves all type handle for all registered potion effects.
- Defined in @minecraft/server.d.ts:17366

`Static`getDeliveryType

getDeliveryType(potionDeliveryId: string): PotionDeliveryType
Parameters
- potionDeliveryId: string
Returns PotionDeliveryType
A type handle wrapping the valid delivery id, or undefined for an invalid delivery id.

Remarks
Retrieves a type handle for a specified potion delivery id.
- Defined in @minecraft/server.d.ts:17375

`Static`getEffectType

getEffectType(potionEffectId: string): PotionEffectType
Parameters
- potionEffectId: string
  A valid potion effect id. See @minecraft/vanilla-data.MinecraftPotionEffectTypes
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.
- Defined in @minecraft/server.d.ts:17387

`Static`resolve

resolve<
    T extends string = MinecraftPotionEffectTypes,
    U extends string = MinecraftPotionDeliveryTypes,
>(
    potionEffectType: PotionEffectType | T,
    potionDeliveryType: PotionDeliveryType | U,
): ItemStack
Type Parameters
- T extends string = MinecraftPotionEffectTypes
- U extends string = MinecraftPotionDeliveryTypes
Parameters
- potionEffectType: PotionEffectType | T
- potionDeliveryType: PotionDeliveryType | U
Returns ItemStack
Remarks
Creates a potion given an effect and delivery type.

Throws
This function can throw errors.

EngineError

InvalidPotionDeliveryTypeError

InvalidPotionEffectTypeError
- Defined in @minecraft/server.d.ts:17400