Skip to main content

ApplyEffectTickEvent

Struct ApplyEffectTickEvent 

pub struct ApplyEffectTickEvent<'a> {
    pub effect: EffectKey,
    pub dimension: &'a str,
    pub entity: Option<i32>,
    pub amplifier: i32,
    pub holder: LivingRef,
    pub health: f32,
    pub max_health: f32,
    pub food: Option<PlayerFood>,
    pub keep: bool,
    /* private fields */
}
Expand description

What Hooks::apply_effect_tick is told. Each field is that hook’s argument of the same name, described in the hook’s doc.

Fields§

§effect: EffectKey§dimension: &'a str§entity: Option<i32>§amplifier: i32§holder: LivingRef§health: f32§max_health: f32§food: Option<PlayerFood>§keep: bool

Implementations§

§

impl ApplyEffectTickEvent<'_>

pub fn heal(&mut self, amount: f32)

Queue LivingEntity.heal on the holder.

pub fn hurt(&mut self, damage_type: &str, amount: f32)

Queue damage of a registered damage type on the holder: a vanilla one (minecraft:magic, minecraft:wither) or a datapack’s (demo:heat). It reaches the holder’s hurt hooks with that type; an unregistered type hurts nothing.

pub fn add_exhaustion(&mut self, amount: f32)

Queue food exhaustion; a non-player holder ignores it.

pub fn eat(&mut self, nutrition: i32, saturation_modifier: f32)

Queue FoodData.eat; a non-player holder ignores it.

Trait Implementations§

§

impl Put for ApplyEffectTickEvent<'_>

§

fn put_to(&self, w: &mut Writer)

Writes it.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.