PropagateEntityTrigger

Struct PropagateEntityTrigger 

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

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§

Source§

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

Source§

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

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

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

Source§

fn default() -> Self

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

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

Source§

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. Read more

Auto Trait Implementations§

§

impl<const AUTO_PROPAGATE: bool, E, T> Freeze for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>

§

impl<const AUTO_PROPAGATE: bool, E, T> RefUnwindSafe for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>

§

impl<const AUTO_PROPAGATE: bool, E, T> Send for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>
where T: Send,

§

impl<const AUTO_PROPAGATE: bool, E, T> Sync for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>
where T: Sync,

§

impl<const AUTO_PROPAGATE: bool, E, T> Unpin for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>
where E: Unpin, T: Unpin,

§

impl<const AUTO_PROPAGATE: bool, E, T> UnwindSafe for PropagateEntityTrigger<AUTO_PROPAGATE, E, T>
where E: UnwindSafe, T: UnwindSafe,

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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

Creates Self using default().

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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
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.
Source§

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