Struct ambient_api_core::ecs::EventQuery

pub struct EventQuery<Components: ComponentsTuple + Copy + Clone + 'static>(/* private fields */);

An ECS query that calls a callback when its associated event occurs.

Implementations

impl<Components: ComponentsTuple + Copy + Clone + 'static> EventQuery<Components>

pub fn create(event: QueryEvent, components: Components) -> Self

Creates a new EventQuery that will find entities that have the specified components that will call its bound function when the event occurs.

pub fn requires(self, requires: impl ComponentsTuple) -> Self

The entities must include the components in requires.

pub fn excludes(self, excludes: impl ComponentsTuple) -> Self

The entities must not include the components in excludes.

pub fn bind<R: CallbackReturn>( self, callback: impl FnMut(Vec<(EntityId, Components::Data)>) -> R + 'static ) -> Listener

Each time the entity associated with components experiences the event, the callback (fn) is called with the result of the query.