Struct PotionContents 

pub struct PotionContents {
    potion: Option<RegistryReference<Potion>>,
    custom_color: Option<i32>,
    custom_effects: Vec<MobEffectInstance>,
    custom_name: Option<String>,
}

A registered base potion plus optional custom display and effect data.

Fields

potion: Option<RegistryReference<Potion>>

custom_color: Option<i32>

custom_effects: Vec<MobEffectInstance>

custom_name: Option<String>

Implementations

impl PotionContents

const MAX_NETWORK_STRING_LENGTH: usize = 32_767

pub const fn empty() -> Self

pub const fn new( potion: Option<RegistryReference<Potion>>, custom_color: Option<i32>, custom_effects: Vec<MobEffectInstance>, custom_name: Option<String>, ) -> Self

pub const fn of(potion: PotionRef) -> Self

pub fn create_item_stack(item: ItemRef, potion: PotionRef) -> ItemStack

pub const fn potion(&self) -> Option<RegistryReference<Potion>>

pub const fn custom_color(&self) -> Option<i32>

pub fn custom_effects(&self) -> &[MobEffectInstance]

pub fn custom_name(&self) -> Option<&str>

pub fn is(&self, potion: &Potion) -> bool

pub fn is_in_tag(&self, tag: &Identifier) -> bool

Whether the base potion is in tag and there are no custom effects.

pub fn all_effects(&self) -> Vec<MobEffectInstance>

Returns vanilla PotionContents.getAllEffects(): the base potion’s effects followed by the custom effects.

pub fn has_effects(&self) -> bool

Whether the base potion or the custom effects contain any effect.

pub fn get_color(&self) -> i32

Returns the display color, falling back to BASE_POTION_COLOR.

pub fn get_color_or(&self, default_color: i32) -> i32

Returns the custom color, else the color blended from the effects, else default_color.

fn color_from_effects(effects: &[MobEffectInstance]) -> Option<i32>

Blends visible effect colors weighted by amplifier + 1 and returns None when no effect is visible

fn to_nbt_tag_ref(&self) -> NbtTag

fn from_owned_nbt(tag: &NbtTag) -> Option<Self>

Trait Implementations

impl Clone for PotionContents

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PotionContents

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PotionContents

fn default() -> Self

Returns the “default value” for a type.

impl DowncastType for PotionContents

const TYPE_KEY: DowncastTypeKey

The process-wide key for this concrete type.

impl FromNbtTag for PotionContents

fn from_nbt_tag(tag: NbtTag<'_, '_>) -> Option<Self>

fn from_optional_nbt_tag( tag: Option<NbtTag<'_, '_>>, ) -> Result<Option<Self>, DeserializeError>

impl HashComponent for PotionContents

fn hash_component(&self, hasher: &mut ComponentHasher)

Hashes this value into the given hasher.

fn compute_hash(&self) -> i32

Computes the hash of this value.

impl PartialEq for PotionContents

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl ReadFrom for PotionContents

fn read(data: &mut Cursor<&[u8]>) -> Result<Self>

Reads data from a cursor.

impl StructuralPartialEq for PotionContents

impl ToNbtTag for PotionContents

fn to_nbt_tag(self) -> NbtTag

fn to_optional_nbt_tag(self) -> Option<NbtTag>

impl WriteTo for PotionContents

fn write(&self, writer: &mut impl Write) -> Result<()>

Writes data to a writer.

fn write_slice(values: &[Self], writer: &mut impl Write) -> Result<(), Error>

where Self: Sized,

writes a slice as consecutive values without a length prefix