pub struct ActiveStatusEffects { /* private fields */ }
Expand description
[Component
] that stores the ActiveStatusEffect
s of an [Entity
].
Implementations§
source§impl ActiveStatusEffects
impl ActiveStatusEffects
sourcepub fn apply(&mut self, effect: ActiveStatusEffect)
pub fn apply(&mut self, effect: ActiveStatusEffect)
Applies a new ActiveStatusEffect
.
If the ActiveStatusEffect
is already active:
- 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.
- 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
- 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.
sourcepub fn replace(&mut self, effect: ActiveStatusEffect)
pub fn replace(&mut self, effect: ActiveStatusEffect)
Replace an existing ActiveStatusEffect
.
sourcepub fn remove(&mut self, effect: StatusEffect)
pub fn remove(&mut self, effect: StatusEffect)
Removes an ActiveStatusEffect
.
sourcepub fn remove_all(&mut self)
pub fn remove_all(&mut self)
Removes all ActiveStatusEffect
s.
sourcepub fn no_effect(&self, effect: StatusEffect) -> bool
pub fn no_effect(&self, effect: StatusEffect) -> bool
Returns true if there are no effects of the given type.
sourcepub fn has_effect(&self, effect: StatusEffect) -> bool
pub fn has_effect(&self, effect: StatusEffect) -> bool
Returns true if there is an effect of the given type.
sourcepub fn no_effects(&self) -> bool
pub fn no_effects(&self) -> bool
Returns true if there are no effects.
sourcepub fn has_effects(&self) -> bool
pub fn has_effects(&self) -> bool
Returns true if there are any effects.
sourcepub fn max_duration(&self, effect: StatusEffect) -> DurationResult
pub fn max_duration(&self, effect: StatusEffect) -> DurationResult
Returns the maximum duration of the given effect.
sourcepub fn get_current_effect(
&self,
effect: StatusEffect,
) -> Option<&ActiveStatusEffect>
pub fn get_current_effect( &self, effect: StatusEffect, ) -> Option<&ActiveStatusEffect>
Gets the current effect of the given type.
sourcepub fn get_all_effect(
&self,
effect: StatusEffect,
) -> Option<&Vec<ActiveStatusEffect>>
pub fn get_all_effect( &self, effect: StatusEffect, ) -> Option<&Vec<ActiveStatusEffect>>
Gets all the effects of the given type.
sourcepub fn get_current_effects(&self) -> Vec<&ActiveStatusEffect>
pub fn get_current_effects(&self) -> Vec<&ActiveStatusEffect>
Gets all the current effects.
sourcepub fn get_all_effects(
&self,
) -> &IndexMap<StatusEffect, Vec<ActiveStatusEffect>>
pub fn get_all_effects( &self, ) -> &IndexMap<StatusEffect, Vec<ActiveStatusEffect>>
Gets all the effects.
Trait Implementations§
source§impl Component for ActiveStatusEffects
impl Component for ActiveStatusEffects
source§const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table
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)
fn register_component_hooks(_hooks: &mut ComponentHooks)
Called when registering this component, allowing mutable access to its [
ComponentHooks
].source§impl Debug for ActiveStatusEffects
impl Debug for ActiveStatusEffects
source§impl Default for ActiveStatusEffects
impl Default for ActiveStatusEffects
source§fn default() -> ActiveStatusEffects
fn default() -> ActiveStatusEffects
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for ActiveStatusEffects
impl RefUnwindSafe for ActiveStatusEffects
impl Send for ActiveStatusEffects
impl Sync for ActiveStatusEffects
impl Unpin for ActiveStatusEffects
impl UnwindSafe for ActiveStatusEffects
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<C> Bundle for Cwhere
C: Component,
impl<C> Bundle for Cwhere
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
§fn get_component_ids(
components: &Components,
ids: &mut impl FnMut(Option<ComponentId>),
)
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 Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn 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>
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)
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)
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
impl<T> DowncastSync for T
§impl<C> DynamicBundle for Cwhere
C: Component,
impl<C> DynamicBundle for Cwhere
C: Component,
fn get_components(self, func: &mut impl FnMut(StorageType, OwningPtr<'_>))
§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given [World
].