Struct EffectBundle 

pub struct EffectBundle<B: Bundle> {
    pub name: Name,
    pub mode: EffectMode,
    pub bundle: B,
}

A “bundle” of components/settings used when applying an effect. Due to technical limitations, this doesn’t actually implement Bundle. Instead, purpose build commands (with_effect) or related spawners (EffectedBy::spawn) should be used.

Examples

with_effect

commands.entity(target).with_effect(EffectBundle {
    name: Name::new("Effect"),
    bundle: MyEffect,
    ..default()
});

with_effects + EffectSpawner

commands.entity(target).with_effects(|effects| {
    effects.spawn(EffectBundle {
        name: Name::new("EffectA"),
        bundle: MyEffect,
        ..default()
    });

    effects.spawn(EffectBundle {
        name: Name::new("EffectB"),
        bundle: MyEffect,
        ..default()
    });
});

EffectedBy::spawn

commands.spawn((
    Name::new("Target"),
    EffectedBy::spawn(EffectBundle {
        name: Name::new("Effect"),
        bundle: MyEffect,
        ..default()
    }),
));

Fields

name: Name

The name/ID of the effect. Effects with different IDs have no effect on one another.

mode: EffectMode

Describes the logic used when new effect collides with an existing one.

bundle: B

Components that will be added to the effect. This is where the actual effect components get added.

Trait Implementations

impl<B: Default + Bundle> Default for EffectBundle<B>

fn default() -> EffectBundle<B>

Returns the “default value” for a type.

impl<B: Bundle> SpawnableList<Effecting> for EffectBundle<B>

fn spawn(this: MovingPtr<'_, Self>, world: &mut World, target: Entity)

Spawn this list of changes in a given World and relative to a given Entity. This is generally used for spawning “related” entities, such as children.

fn size_hint(&self) -> usize

Returns a size hint, which is used to reserve space for this list in a RelationshipTarget. This should be less than or equal to the actual size of the list. When in doubt, just use 0.