Struct valence::entity::active_status_effects::ActiveStatusEffect

pub struct ActiveStatusEffect { /* private fields */ }

Represents an active status effect.

Implementations

impl ActiveStatusEffect

pub fn from_effect(effect: StatusEffect) -> ActiveStatusEffect

Creates a new ActiveStatusEffect.

pub fn with_amplifier(self, amplifier: u8) -> ActiveStatusEffect

Sets the amplifier of the ActiveStatusEffect.

pub fn with_duration(self, duration: i32) -> ActiveStatusEffect

Sets the duration of the ActiveStatusEffect in ticks.

pub fn with_duration_seconds(self, duration: f32) -> ActiveStatusEffect

Sets the duration of the ActiveStatusEffect in seconds.

pub fn with_infinite(self) -> ActiveStatusEffect

Sets the duration of the ActiveStatusEffect to infinite.

pub fn with_ambient(self, ambient: bool) -> ActiveStatusEffect

Sets whether the ActiveStatusEffect is ambient.

pub fn with_show_particles(self, show_particles: bool) -> ActiveStatusEffect

Sets whether the ActiveStatusEffect shows particles.

pub fn with_show_icon(self, show_icon: bool) -> ActiveStatusEffect

Sets whether the ActiveStatusEffect shows an icon.

pub fn increment_active_ticks(&mut self)

Increments the active ticks of the ActiveStatusEffect by one.

pub fn status_effect(&self) -> StatusEffect

Returns the StatusEffect of the ActiveStatusEffect.

pub fn amplifier(&self) -> u8

Returns the amplifier of the ActiveStatusEffect.

pub fn initial_duration(&self) -> Option<i32>

Returns the initial duration of the ActiveStatusEffect in ticks. Returns None if the ActiveStatusEffect is infinite.

pub fn remaining_duration(&self) -> Option<i32>

Returns the remaining duration of the ActiveStatusEffect in ticks. Returns None if the ActiveStatusEffect is infinite.

pub fn active_ticks(&self) -> i32

Returns the active ticks of the ActiveStatusEffect.

pub fn ambient(&self) -> bool

Returns true if the ActiveStatusEffect is ambient.

pub fn show_particles(&self) -> bool

Returns true if the ActiveStatusEffect shows particles.

pub fn show_icon(&self) -> bool

Returns true if the ActiveStatusEffect shows an icon.

pub fn expired(&self) -> bool

Returns true if the ActiveStatusEffect has expired or if it is instant.

Trait Implementations

impl Clone for ActiveStatusEffect

fn clone(&self) -> ActiveStatusEffect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActiveStatusEffect

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

Formats the value using the given formatter.

impl Hash for ActiveStatusEffect

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ActiveStatusEffect

fn cmp(&self, other: &ActiveStatusEffect) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ActiveStatusEffect

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ActiveStatusEffect

fn partial_cmp(&self, other: &ActiveStatusEffect) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ActiveStatusEffect

impl StructuralPartialEq for ActiveStatusEffect