Struct ActiveStatusEffects 

pub struct ActiveStatusEffects { /* private fields */ }

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

Implementations

impl ActiveStatusEffects

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.

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

Replace an existing ActiveStatusEffect.

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

Removes an ActiveStatusEffect.

pub fn remove_all(&mut self)

Removes all ActiveStatusEffects.

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

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

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

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

pub fn no_effects(&self) -> bool

Returns true if there are no effects.

pub fn has_effects(&self) -> bool

Returns true if there are any effects.

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

Returns the maximum duration of the given effect.

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

Gets the current effect of the given type.

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

Gets all the effects of the given type.

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

Gets all the current effects.

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

Gets all the effects.

Trait Implementations

impl Component for ActiveStatusEffects

where Self: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Debug for ActiveStatusEffects

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

Formats the value using the given formatter.

impl Default for ActiveStatusEffects

fn default() -> ActiveStatusEffects

Returns the “default value” for a type.