Struct NavEventReader

pub struct NavEventReader<'w, 's, 'a> { /* private fields */ }

A wrapper for EventReader<NavEvent> to simplify dealing with NavEvents.

Implementations

impl<'w, 's, 'a> NavEventReader<'w, 's, 'a>

pub fn with_request( &mut self, request: NavRequest, ) -> impl Iterator<Item = Entity> + '_

Iterate over NavEvent::NoChanges focused entity triggered by request type requests.

pub fn activated(&mut self) -> impl Iterator<Item = Entity> + '_

Iterate over activated Focusables.

A Focusable is activated when a NavRequest::Action is sent while it is focused, and it doesn’t lead to a new menu.

pub fn types(&mut self) -> impl Iterator<Item = (&NavEvent, Entity)> + '_

Iterate over NavEvents, associating them with the “relevant” entity of the event.

pub fn activated_in_query<'b, 'c: 'b, Q: ReadOnlyWorldQuery, F: ReadOnlyWorldQuery>( &'b mut self, query: &'c Query<'_, '_, Q, F>, ) -> impl Iterator<Item = Q::Item<'c>> + 'b

Iterate over query items of activated focusables.

See Self::activated for meaning of “activated”.

pub fn activated_in_query_foreach_mut<Q: WorldQuery, F: ReadOnlyWorldQuery>( &mut self, query: &mut Query<'_, '_, Q, F>, for_each: impl FnMut(Q::Item<'_>), )

Run for_each with result of query for each activated entity.

Unlike Self::activated_in_query this works with mutable queries. see Self::activated for meaning of “activated”.