Struct bevy_eventlistener::callbacks::ListenerInput

pub struct ListenerInput<E: EntityEvent> { /* private fields */ }

Data from an event that triggered an On<Event> listener, and is currently bubbling through the entity hierarchy.

This is accessed as a bevy resource in the callback system. This resource is only available to callback systems.

fn my_callback(mut event: ListenerMut<MyEvent>) {
    event.foo += 1; // Mutate the event that is being bubbled
    event.target(); // The entity that was originally targeted
    event.listener(); // The entity that was listening for this event
    event.stop_propagation(); // Stop the event from bubbling further
}

Implementations

impl<E: EntityEvent> ListenerInput<E>

pub fn listener(&self) -> Entity

The entity that was listening for this event. Call target() to get the entity that this event originally targeted before it started bubbling through the hierarchy. Note that the target and listener can be the same entity.

pub fn stop_propagation(&mut self)

When called, the event will stop bubbling up the hierarchy to its parent.

Trait Implementations

impl<E: Clone + EntityEvent> Clone for ListenerInput<E>

fn clone(&self) -> ListenerInput<E>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug + EntityEvent> Debug for ListenerInput<E>

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

Formats the value using the given formatter.

impl<E: EntityEvent> Deref for ListenerInput<E>

type Target = E

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<E: EntityEvent> DerefMut for ListenerInput<E>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<E: PartialEq + EntityEvent> PartialEq for ListenerInput<E>

fn eq(&self, other: &ListenerInput<E>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E: EntityEvent> Resource for ListenerInput<E>

where Self: Send + Sync + 'static,

impl<E: EntityEvent> StructuralPartialEq for ListenerInput<E>