Struct bevy::prelude::Query

pub struct Query<'a, Q> where
    Q: Query,  { /* fields omitted */ }

Provides scoped access to a World according to a given [HecsQuery]

Implementations

impl<'a, Q> Query<'a, Q> where
    Q: Query, 

pub fn new(
    world: &'a World,
    archetype_access: &'a ArchetypeAccess
) -> Query<'a, Q>

pub fn iter(&mut self) -> QueryBorrowChecked<'_, Q>

pub fn get<T>(&self, entity: Entity) -> Result<Ref<'_, T>, QueryError> where
    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 entity(
    &mut self,
    entity: Entity
) -> Result<QueryOneChecked<'_, Q>, QueryError>

pub fn get_mut<T>(&self, entity: Entity) -> Result<RefMut<'_, 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 fn removed<C>(&self) -> &[Entity] where
    C: Component, 

pub fn set<T>(&mut self, entity: Entity, component: T) -> Result<(), QueryError> where
    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.