Struct ambient_api::ecs::GeneralQuery

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

An ECS query used to find entities in the world.

Implementations

impl<Components> GeneralQuery<Components>

where Components: ComponentsTuple + Copy + Clone + 'static,

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 as ComponentsTuple>::Data)>

Evaluate the query and return the results.

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

where R: CallbackReturn,

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

Trait Implementations

impl<Components> Clone for GeneralQuery<Components>

where Components: Clone + ComponentsTuple + Copy + 'static,

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 for GeneralQuery<Components>

where Components: Debug + ComponentsTuple + Copy + Clone + 'static,

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

Formats the value using the given formatter.

impl<Components> Copy for GeneralQuery<Components>

where Components: Copy + ComponentsTuple + Clone + 'static,