Query

Struct Query 

Source
pub struct Query<'w, T> { /* private fields */ }
Expand description

Immutable query builder

§Example

world.select::<(Position, Velocity)>()
    .tagged("player")
    .not_tagged("frozen")
    .each(|entity, (pos, vel)| {
        println!("{:?}", pos);
    });

Implementations§

Source§

impl<'w, T> Query<'w, T>
where T: QueryTuple<'w>,

Source

pub fn tagged(self, tag: &str) -> Query<'w, T>

Require entities to have this tag

Source

pub fn not_tagged(self, tag: &str) -> Query<'w, T>

Exclude entities with this tag

Source

pub fn with<C>(self) -> Query<'w, T>
where C: Component,

Filters entities that have this component without fetching it

Useful when you need to check component existence but don’t need the data.

§Example
// Find all entities with Health that also have Velocity
world.select::<(Health,)>()
    .with::<Velocity>()
    .each(|entity, (health,)| {
        println!("Fast entity: {}", health.0);
    });
Source

pub fn without<C>(self) -> Query<'w, T>
where C: Component,

Filters entities that don’t have this component

§Example
// Find all entities with Health but no Shield
world.select::<(Health,)>()
    .without::<Shield>()
    .each(|entity, (health,)| {
        println!("Vulnerable: {}", health.0);
    });
Source

pub fn each<F>(self, f: F)
where F: FnMut(Entity, <T as QueryTuple<'w>>::Item),

Iterate over all matching entities

Auto Trait Implementations§

§

impl<'w, T> Freeze for Query<'w, T>

§

impl<'w, T> !RefUnwindSafe for Query<'w, T>

§

impl<'w, T> Send for Query<'w, T>
where T: Send,

§

impl<'w, T> Sync for Query<'w, T>
where T: Sync,

§

impl<'w, T> Unpin for Query<'w, T>
where T: Unpin,

§

impl<'w, T> !UnwindSafe for Query<'w, T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Event for T
where T: Any + Send + Sync + 'static,