Struct ActiveEffect 

#[non_exhaustive]
pub struct ActiveEffect {
    pub id: EffectKey,
    pub duration: i32,
    pub amplifier: i32,
    pub ambient: bool,
    pub visible: bool,
    pub show_icon: bool,
}

A living entity’s active effect (vanilla’s MobEffectInstance), as LivingRef reads its effects and as add_effect gives one: the effect’s id, an Identifier namespaced as the registry has it (minecraft:speed, a content mod’s mod:custom), the ticks left (-1 is infinite), the amplifier from 0, and the flags a beacon-style effect carries: ambient (an ambient one gives no particles), visible (whether its particles show) and show_icon (whether the HUD and inventory list it).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: EffectKey

The effect’s load-owned registry key; id.id(host) reads its canonical name.

duration: i32

The ticks left; -1 is infinite.

amplifier: i32

The amplifier, from 0.

ambient: bool

MobEffectInstance.isAmbient: an ambient effect shows no particles.

visible: bool

MobEffectInstance.isVisible: whether its particles show.

show_icon: bool

MobEffectInstance.showIcon: whether the HUD and the inventory list it. Vanilla keeps it apart from visible.

Implementations

impl ActiveEffect

pub fn new( id: EffectKey, duration: i32, amplifier: i32, ambient: bool, visible: bool, show_icon: bool, ) -> ActiveEffect

Construct an effect with its duration, amplifier and visual flags, as vanilla’s six-argument MobEffectInstance constructor takes them.

Trait Implementations

impl Clone for ActiveEffect

fn clone(&self) -> ActiveEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActiveEffect

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

Formats the value using the given formatter.

impl Eq for ActiveEffect

impl From<ActiveEffect> for ActiveEffect

fn from(v: ActiveEffect) -> ActiveEffect

Converts to this type from the input type.

impl PartialEq for ActiveEffect

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ActiveEffect

impl Wire for ActiveEffect

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<ActiveEffect, WireError>

Decodes one value, leaving any following bytes for the caller.