[−][src]Struct bevy::ecs::prelude::Query
Provides scoped access to a World according to a given HecsQuery
Implementations
impl<'a, Q> Query<'a, Q> where
Q: Query, [src]
Q: Query,
pub fn new(
world: &'a World,
component_access: &'a TypeAccess<ArchetypeComponent>
) -> Query<'a, Q>[src]
world: &'a World,
component_access: &'a TypeAccess<ArchetypeComponent>
) -> Query<'a, Q>
pub fn iter(&self) -> QueryIter<'_, Q>ⓘ where
<Q as Query>::Fetch: ReadOnlyFetch, [src]
<Q as Query>::Fetch: ReadOnlyFetch,
Iterates over the query results. This can only be called for read-only queries
pub fn iter_mut(&mut self) -> QueryIter<'_, Q>ⓘ[src]
Iterates over the query results
pub unsafe fn iter_unsafe(&self) -> QueryIter<'_, Q>ⓘ[src]
Iterates over the query results
Safety
This allows aliased mutability. You must make sure this call does not result in multiple mutable references to the same component
pub fn par_iter(&self, batch_size: usize) -> ParIter<'_, Q> where
<Q as Query>::Fetch: ReadOnlyFetch, [src]
<Q as Query>::Fetch: ReadOnlyFetch,
pub fn par_iter_mut(&mut self, batch_size: usize) -> ParIter<'_, Q>[src]
pub fn get(
&self,
entity: Entity
) -> Result<<<Q as Query>::Fetch as Fetch<'_>>::Item, QueryError> where
<Q as Query>::Fetch: ReadOnlyFetch, [src]
&self,
entity: Entity
) -> Result<<<Q as Query>::Fetch as Fetch<'_>>::Item, QueryError> where
<Q as Query>::Fetch: ReadOnlyFetch,
Gets the query result for the given entity
pub fn get_mut(
&mut self,
entity: Entity
) -> Result<<<Q as Query>::Fetch as Fetch<'_>>::Item, QueryError>[src]
&mut self,
entity: Entity
) -> Result<<<Q as Query>::Fetch as Fetch<'_>>::Item, QueryError>
Gets the query result for the given entity
pub unsafe fn entity_unsafe(
&self,
entity: Entity
) -> Result<<<Q as Query>::Fetch as Fetch<'_>>::Item, QueryError>[src]
&self,
entity: Entity
) -> Result<<<Q as Query>::Fetch as Fetch<'_>>::Item, QueryError>
Gets the query result for the given entity
Safety
This allows aliased mutability. You must make sure this call does not result in multiple mutable references to the same component
pub fn get_component<T>(&self, entity: Entity) -> Result<&T, QueryError> where
T: Component, [src]
T: Component,
Gets a reference to the entity's component of the given type. This will fail if the entity does not have the given component type or if the given component type does not match this query.
pub fn get_component_mut<T>(
&mut self,
entity: Entity
) -> Result<Mut<'_, T>, QueryError> where
T: Component, [src]
&mut self,
entity: Entity
) -> Result<Mut<'_, T>, QueryError> where
T: Component,
Gets a mutable reference to the entity's component of the given type. This will fail if the entity does not have the given component type or if the given component type does not match this query.
pub unsafe fn get_unsafe<T>(
&self,
entity: Entity
) -> Result<Mut<'_, T>, QueryError> where
T: Component, [src]
&self,
entity: Entity
) -> Result<Mut<'_, T>, QueryError> where
T: Component,
Gets a mutable reference to the entity's component of the given type. This will fail if the entity does not have the given component type
Safety
This allows aliased mutability. You must make sure this call does not result in multiple mutable references to the same component
pub fn removed<C>(&self) -> &[Entity]ⓘ where
C: Component, [src]
C: Component,
pub fn set<T>(&mut self, entity: Entity, component: T) -> Result<(), QueryError> where
T: Component, [src]
T: Component,
Sets the entity's component to the given value. This will fail if the entity does not already have the given component type or if the given component type does not match this query.
Trait Implementations
Auto Trait Implementations
impl<'a, Q> !RefUnwindSafe for Query<'a, Q>
impl<'a, Q> Send for Query<'a, Q> where
Q: Send,
Q: Send,
impl<'a, Q> Sync for Query<'a, Q> where
Q: Sync,
Q: Sync,
impl<'a, Q> Unpin for Query<'a, Q> where
Q: Unpin,
Q: Unpin,
impl<'a, Q> !UnwindSafe for Query<'a, Q>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Any for T where
T: Any,
T: Any,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> Component for T where
T: 'static + Send + Sync,
T: 'static + Send + Sync,
impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T>) -> Box<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> DowncastSync for T where
T: Send + Sync + Any,
T: Send + Sync + Any,
impl<T> From<T> for T[src]
impl<T> Instrument for T[src]
fn instrument(self, span: Span) -> Instrumented<Self>[src]
fn in_current_span(self) -> Instrumented<Self>[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> Resource for T where
T: 'static + Send + Sync, [src]
T: 'static + Send + Sync,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,