Struct ambient_api_core::ecs::GeneralQuery

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

An ECS query used to find entities in the world.

Implementations

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

pub fn create(components: Components) -> GeneralQueryBuilder<Components>

Creates a new GeneralQueryBuilder that will find entities that have the specified components and can be built to create a GeneralQuery.

Building a query is somewhat expensive, but they are cheap to copy and evaluate, so it’s recommended that you build your queries once and reuse them elsewhere.

pub fn evaluate(&self) -> Vec<(EntityId, Components::Data)>

Evaluate the query and return the results.

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

Consume this query and call callback (fn) each frame with the result of the query.

Trait Implementations

impl<Components: Clone + ComponentsTuple + Copy + Clone + 'static> Clone for GeneralQuery<Components>

fn clone(&self) -> GeneralQuery<Components>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Components: Debug + ComponentsTuple + Copy + Clone + 'static> Debug for GeneralQuery<Components>

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

Formats the value using the given formatter.

impl<Components: Copy + ComponentsTuple + Copy + Clone + 'static> Copy for GeneralQuery<Components>