Struct PropagateEntityTrigger

pub struct PropagateEntityTrigger<const AUTO_PROPAGATE: bool, E: EntityEvent, T: Traversal<E>> {
    pub original_event_target: Entity,
    pub propagate: bool,
    /* private fields */
}

An EntityEvent Trigger that behaves like EntityTrigger, but “propagates” the event using an Entity Traversal. At each step in the propagation, the EntityTrigger logic will be run, until PropagateEntityTrigger::propagate is false, or there are no entities left to traverse.

This is used by the EntityEvent derive when #[entity_event(propagate)] is enabled. It is usable by every EntityEvent type.

If AUTO_PROPAGATE is true, PropagateEntityTrigger::propagate will default to true.

Fields

original_event_target: Entity

The original Entity the Event was first triggered for.

propagate: bool

Whether or not to continue propagating using the T Traversal. If this is false, The Traversal will stop on the current entity.

Trait Implementations

impl<const AUTO_PROPAGATE: bool, E: EntityEvent, T: Traversal<E>> Debug for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>

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

Formats the value using the given formatter.

impl<const AUTO_PROPAGATE: bool, E: EntityEvent, T: Traversal<E>> Default for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>

fn default() -> Self

Returns the “default value” for a type.

impl<const AUTO_PROPAGATE: bool, E: EntityEvent + for<'a> Event<Trigger<'a> = Self>, T: Traversal<E>> Trigger<E> for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>

unsafe fn trigger( &mut self, world: DeferredWorld<'_>, observers: &CachedObservers, trigger_context: &TriggerContext, event: &mut E, )

Trigger the given event, running every Observer that matches the event, as defined by this Trigger and the state stored on self.