pub struct ActiveStatusEffects { /* private fields */ }
Expand description

[Component] that stores the ActiveStatusEffects of an [Entity].

Implementations§

source§

impl ActiveStatusEffects

source

pub fn apply(&mut self, effect: ActiveStatusEffect)

Applies a new ActiveStatusEffect.

If the ActiveStatusEffect is already active:

  1. if the new effect is the same as the old one and its duration is longer, it replaces the old effect. Otherwise, it does nothing.
  2. if the new effect is stronger than the old one:
    • if the new effect’s duration is longer, it replaces the old effect.
    • if the new effect’s duration is shorter, it overrides the old
  3. if the new effect is weaker than the old one and if the new effect’s duration is longer, it will be overridden by the old effect until the old effect’s duration is over.
source

pub fn replace(&mut self, effect: ActiveStatusEffect)

Replace an existing ActiveStatusEffect.

source

pub fn remove(&mut self, effect: StatusEffect)

Removes an ActiveStatusEffect.

source

pub fn remove_all(&mut self)

Removes all ActiveStatusEffects.

source

pub fn no_effect(&self, effect: StatusEffect) -> bool

Returns true if there are no effects of the given type.

source

pub fn has_effect(&self, effect: StatusEffect) -> bool

Returns true if there is an effect of the given type.

source

pub fn no_effects(&self) -> bool

Returns true if there are no effects.

source

pub fn has_effects(&self) -> bool

Returns true if there are any effects.

source

pub fn max_duration(&self, effect: StatusEffect) -> DurationResult

Returns the maximum duration of the given effect.

source

pub fn get_current_effect( &self, effect: StatusEffect, ) -> Option<&ActiveStatusEffect>

Gets the current effect of the given type.

source

pub fn get_all_effect( &self, effect: StatusEffect, ) -> Option<&Vec<ActiveStatusEffect>>

Gets all the effects of the given type.

source

pub fn get_current_effects(&self) -> Vec<&ActiveStatusEffect>

Gets all the current effects.

source

pub fn get_all_effects( &self, ) -> &IndexMap<StatusEffect, Vec<ActiveStatusEffect>>

Gets all the effects.

Trait Implementations§

source§

impl Component for ActiveStatusEffects
where Self: Send + Sync + 'static,

source§

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.
§

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its [ComponentHooks].
source§

impl Debug for ActiveStatusEffects

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ActiveStatusEffects

source§

fn default() -> ActiveStatusEffects

Returns the “default value” for a type. Read more

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
§

impl<C> Bundle for C
where C: Component,

§

fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId), )

§

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

§

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>), )

Gets this [Bundle]’s component ids. This will be None if the component has not been registered.
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<C> DynamicBundle for C
where C: Component,

§

fn get_components(self, func: &mut impl FnMut(StorageType, OwningPtr<'_>))

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromWorld for T
where T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World].
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ConditionalSend for T
where T: Send,