pub struct Query<'w, 's, D: QueryData + 'static, F: QueryFilter + 'static = ()> { /* private fields */ }Expand description
Typed component access for one active Sim;Logic World generation.
Iteration follows Bevy ECS borrowing and filtering rules, but never yields
a raw Bevy entity identifier. Use crate::identity::LogicEntityRef in the
query data when a stable managed handle is needed. Point lookup accepts only
LogicEntity and rejects handles from a retired or foreign World before
touching component storage. Within the active World, it also requires the
exact live managed identity at that ECS row before fetching user data.
Disabled entities are always excluded in this first slice, independently of Bevy’s mutable global default-query-filter Resource.
Implementations§
Source§impl<'s, D: QueryData + 'static, F: QueryFilter + 'static> Query<'_, 's, D, F>
impl<'s, D: QueryData + 'static, F: QueryFilter + 'static> Query<'_, 's, D, F>
Sourcepub fn iter(&self) -> QueryIterator<'_, 's, D::ReadOnly, F> ⓘ
pub fn iter(&self) -> QueryIterator<'_, 's, D::ReadOnly, F> ⓘ
Iterates over read-only forms of all matching enabled entities.
Iteration order is not stable API.
Sourcepub fn iter_mut(&mut self) -> QueryIterator<'_, 's, D, F> ⓘwhere
D: IterQueryData,
pub fn iter_mut(&mut self) -> QueryIterator<'_, 's, D, F> ⓘwhere
D: IterQueryData,
Iterates over all matching enabled entities with the access declared by
D. Iteration order is not stable API.
Sourcepub fn single(&self) -> Result<ROQueryItem<'_, 's, D>, QuerySingleError>
pub fn single(&self) -> Result<ROQueryItem<'_, 's, D>, QuerySingleError>
Reads the only matching enabled managed entity.
Returns QuerySingleError::NoEntities or
QuerySingleError::MultipleEntities when cardinality is not exactly
one.
Sourcepub fn single_mut(&mut self) -> Result<D::Item<'_, 's>, QuerySingleError>where
D: IterQueryData,
pub fn single_mut(&mut self) -> Result<D::Item<'_, 's>, QuerySingleError>where
D: IterQueryData,
Accesses the only matching enabled managed entity mutably.
Returns QuerySingleError::NoEntities or
QuerySingleError::MultipleEntities when cardinality is not exactly
one.
Sourcepub fn get(
&self,
entity: LogicEntity,
) -> Result<ROQueryItem<'_, 's, D>, QueryEntityError>
pub fn get( &self, entity: LogicEntity, ) -> Result<ROQueryItem<'_, 's, D>, QueryEntityError>
Reads one matching enabled entity after checking application and World provenance.
Sourcepub fn get_mut(
&mut self,
entity: LogicEntity,
) -> Result<D::Item<'_, 's>, QueryEntityError>
pub fn get_mut( &mut self, entity: LogicEntity, ) -> Result<D::Item<'_, 's>, QueryEntityError>
Accesses one matching enabled entity mutably after checking application and World provenance.
Trait Implementations§
Source§impl<'w, 's, D, F> IntoIterator for &'w Query<'_, 's, D, F>where
D: QueryData + 'static,
F: QueryFilter + 'static,
impl<'w, 's, D, F> IntoIterator for &'w Query<'_, 's, D, F>where
D: QueryData + 'static,
F: QueryFilter + 'static,
Source§impl<'w, 's, D, F> IntoIterator for &'w mut Query<'_, 's, D, F>where
D: IterQueryData + 'static,
F: QueryFilter + 'static,
impl<'w, 's, D, F> IntoIterator for &'w mut Query<'_, 's, D, F>where
D: IterQueryData + 'static,
F: QueryFilter + 'static,
impl<'w, 's, D: QueryData + 'static, F: QueryFilter + 'static> ReadOnlySystemParam for Query<'w, 's, D, F>
Source§impl<D: QueryData + 'static, F: QueryFilter + 'static> SystemParam for Query<'_, '_, D, F>
impl<D: QueryData + 'static, F: QueryFilter + 'static> SystemParam for Query<'_, '_, D, F>
Source§type State = FetchState<D, F>
type State = FetchState<D, F>
Source§type Item<'w, 's> = Query<'w, 's, D, F>
type Item<'w, 's> = Query<'w, 's, D, F>
Self, instantiated with new lifetimes. Read moreSource§fn init_access(
state: &Self::State,
system_meta: &mut SystemMeta,
component_access_set: &mut FilteredAccessSet,
world: &mut World,
)
fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )
Source§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
SystemParam’s state.
This is used to apply Commands during ApplyDeferred.Source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>,
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )
ApplyDeferred.Source§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick,
) -> Result<Self::Item<'w, 's>, SystemParamValidationError>
unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<Self::Item<'w, 's>, SystemParamValidationError>
SystemParamFunction. Read moreAuto Trait Implementations§
impl<'w, 's, D, F = ()> !RefUnwindSafe for Query<'w, 's, D, F>
impl<'w, 's, D, F = ()> !UnwindSafe for Query<'w, 's, D, F>
impl<'w, 's, D, F> Freeze for Query<'w, 's, D, F>
impl<'w, 's, D, F> Send for Query<'w, 's, D, F>
impl<'w, 's, D, F> Sync for Query<'w, 's, D, F>
impl<'w, 's, D, F> Unpin for Query<'w, 's, D, F>
impl<'w, 's, D, F> UnsafeUnpin for Query<'w, 's, D, F>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.