Skip to main content

Query

Struct Query 

Source
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>

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn get( &self, entity: LogicEntity, ) -> Result<ROQueryItem<'_, 's, D>, QueryEntityError>

Reads one matching enabled entity after checking application and World provenance.

Source

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,

Source§

type Item = <<D as QueryData>::ReadOnly as QueryData>::Item<'w, 's>

The type of the elements being iterated over.
Source§

type IntoIter = QueryIterator<'w, 's, <D as QueryData>::ReadOnly, F>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'w, 's, D, F> IntoIterator for &'w mut Query<'_, 's, D, F>
where D: IterQueryData + 'static, F: QueryFilter + 'static,

Source§

type Item = <D as QueryData>::Item<'w, 's>

The type of the elements being iterated over.
Source§

type IntoIter = QueryIterator<'w, 's, D, F>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'w, 's, D: QueryData + 'static, F: QueryFilter + 'static> ReadOnlySystemParam for Query<'w, 's, D, F>
where BevyQuery<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: ReadOnlySystemParam, BevyQuery<'w, 's, &'static ManagedEntity, ((), Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: ReadOnlySystemParam, Res<'w, WorldIdentityState>: ReadOnlySystemParam,

Source§

impl<D: QueryData + 'static, F: QueryFilter + 'static> SystemParam for Query<'_, '_, D, F>

Source§

type State = FetchState<D, F>

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = Query<'w, 's, D, F>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state(world: &mut World) -> Self::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next 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>

Creates a parameter to be passed into a SystemParamFunction. Read more

Auto 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>
where Query<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Freeze,

§

impl<'w, 's, D, F> Send for Query<'w, 's, D, F>
where Query<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Send,

§

impl<'w, 's, D, F> Sync for Query<'w, 's, D, F>
where Query<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Sync,

§

impl<'w, 's, D, F> Unpin for Query<'w, 's, D, F>
where Query<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Unpin,

§

impl<'w, 's, D, F> UnsafeUnpin for Query<'w, 's, D, F>
where Query<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more