pub struct QueryBuilder<'w, D: QueryData = (), F: QueryFilter = ()> { /* private fields */ }
Expand description
Builder struct to create QueryState
instances at runtime.
let mut world = World::new();
let entity_a = world.spawn((A, B)).id();
let entity_b = world.spawn((A, C)).id();
// Instantiate the builder using the type signature of the iterator you will consume
let mut query = QueryBuilder::<(Entity, &B)>::new(&mut world)
// Add additional terms through builder methods
.with::<A>()
.without::<C>()
.build();
// Consume the QueryState
let (entity, b) = query.single(&world);
Implementations§
Source§impl<'w, D: QueryData, F: QueryFilter> QueryBuilder<'w, D, F>
impl<'w, D: QueryData, F: QueryFilter> QueryBuilder<'w, D, F>
Sourcepub fn new(world: &'w mut World) -> Self
pub fn new(world: &'w mut World) -> Self
Creates a new builder with the accesses required for Q
and F
Sourcepub fn world_mut(&mut self) -> &mut World
pub fn world_mut(&mut self) -> &mut World
Returns a mutable reference to the world passed to Self::new
.
Sourcepub fn extend_access(&mut self, access: FilteredAccess<ComponentId>)
pub fn extend_access(&mut self, access: FilteredAccess<ComponentId>)
Adds access to self’s underlying FilteredAccess
respecting Self::or
and Self::and
Sourcepub fn filter<T: QueryFilter>(&mut self) -> &mut Self
pub fn filter<T: QueryFilter>(&mut self) -> &mut Self
Adds filter from T
to self.
Sourcepub fn with<T: Component>(&mut self) -> &mut Self
pub fn with<T: Component>(&mut self) -> &mut Self
Adds With<T>
to the FilteredAccess
of self.
Sourcepub fn with_id(&mut self, id: ComponentId) -> &mut Self
pub fn with_id(&mut self, id: ComponentId) -> &mut Self
Adds With<T>
to the FilteredAccess
of self from a runtime ComponentId
.
Sourcepub fn without<T: Component>(&mut self) -> &mut Self
pub fn without<T: Component>(&mut self) -> &mut Self
Adds Without<T>
to the FilteredAccess
of self.
Sourcepub fn without_id(&mut self, id: ComponentId) -> &mut Self
pub fn without_id(&mut self, id: ComponentId) -> &mut Self
Adds Without<T>
to the FilteredAccess
of self from a runtime ComponentId
.
Sourcepub fn ref_id(&mut self, id: ComponentId) -> &mut Self
pub fn ref_id(&mut self, id: ComponentId) -> &mut Self
Adds &T
to the FilteredAccess
of self.
Sourcepub fn mut_id(&mut self, id: ComponentId) -> &mut Self
pub fn mut_id(&mut self, id: ComponentId) -> &mut Self
Adds &mut T
to the FilteredAccess
of self.
Sourcepub fn optional(&mut self, f: impl Fn(&mut QueryBuilder<'_>)) -> &mut Self
pub fn optional(&mut self, f: impl Fn(&mut QueryBuilder<'_>)) -> &mut Self
Takes a function over mutable access to a QueryBuilder
, calls that function
on an empty builder and then adds all accesses from that builder to self as optional.
Sourcepub fn and(&mut self, f: impl Fn(&mut QueryBuilder<'_>)) -> &mut Self
pub fn and(&mut self, f: impl Fn(&mut QueryBuilder<'_>)) -> &mut Self
Takes a function over mutable access to a QueryBuilder
, calls that function
on an empty builder and then adds all accesses from that builder to self.
Primarily used when inside a Self::or
closure to group several terms.
Sourcepub fn or(&mut self, f: impl Fn(&mut QueryBuilder<'_>)) -> &mut Self
pub fn or(&mut self, f: impl Fn(&mut QueryBuilder<'_>)) -> &mut Self
Takes a function over mutable access to a QueryBuilder
, calls that function
on an empty builder, all accesses added to that builder will become terms in an or expression.
QueryBuilder::<Entity>::new(&mut world).or(|builder| {
builder.with::<A>();
builder.with::<B>();
});
// is equivalent to
QueryBuilder::<Entity>::new(&mut world).filter::<Or<(With<A>, With<B>)>>();
Sourcepub fn access(&self) -> &FilteredAccess<ComponentId>
pub fn access(&self) -> &FilteredAccess<ComponentId>
Returns a reference to the FilteredAccess
that will be provided to the built Query
.
Sourcepub fn transmute<NewD: QueryData>(&mut self) -> &mut QueryBuilder<'w, NewD>
pub fn transmute<NewD: QueryData>(&mut self) -> &mut QueryBuilder<'w, NewD>
Transmute the existing builder adding required accesses. This will maintain all existing accesses.
If including a filter type see Self::transmute_filtered
Sourcepub fn transmute_filtered<NewD: QueryData, NewF: QueryFilter>(
&mut self,
) -> &mut QueryBuilder<'w, NewD, NewF>
pub fn transmute_filtered<NewD: QueryData, NewF: QueryFilter>( &mut self, ) -> &mut QueryBuilder<'w, NewD, NewF>
Transmute the existing builder adding required accesses. This will maintain all existing accesses.
Sourcepub fn build(&mut self) -> QueryState<D, F>
pub fn build(&mut self) -> QueryState<D, F>
Create a QueryState
with the accesses of the builder.
Takes &mut self
to access the innner world reference while initializing
state for the new QueryState