Struct bevy_trait_query::All

pub struct All<T: ?Sized>(_);

WorldQuery adapter that fetches all implementations of a given trait for an entity.

You can usually just use &dyn Trait or &mut dyn Trait as a WorldQuery directly.

Trait Implementations

impl<'a, Trait: ?Sized + TraitQuery> WorldQuery for All<&'a Trait>

SAFETY: We only access the components registered in the trait registry. This is known to match the set of components in the DynQueryState, which is used to match archetypes and register world access.

type Item<'w> = ReadTraits<'w, Trait>

The item returned by this [WorldQuery]

type Fetch<'w> = ReadAllTraitsFetch<'w, Trait>

Per archetype/table state used by this [WorldQuery] to fetch Self::Item

type ReadOnly = All<&'a Trait>

The read-only variant of this [WorldQuery], which satisfies the [ReadOnlyWorldQuery] trait.

type State = TraitQueryState<Trait>

State used to construct a Self::Fetch. This will be cached inside QueryState, so it is best to move as much data / computation here as possible to reduce the cost of constructing Self::Fetch.

unsafe fn init_fetch<'w>(
    world: &'w World,
    _state: &Self::State,
    _last_change_tick: u32,
    _change_tick: u32
) -> ReadAllTraitsFetch<'w, Trait>

Creates a new instance of this fetch.

unsafe fn clone_fetch<'w>(fetch: &Self::Fetch<'w>) -> Self::Fetch<'w>

While this function can be called for any query, it is always safe to call if Self: ReadOnlyWorldQuery holds.

fn shrink<'wlong: 'wshort, 'wshort>(
    item: QueryItem<'wlong, Self>
) -> QueryItem<'wshort, Self>

This function manually implements subtyping for the query items.

const IS_DENSE: bool = false

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components. This is used to select a more efficient “table iterator” for “dense” queries. If this returns true, [WorldQuery::set_table] must be used before [WorldQuery::fetch] can be called for iterators. If this returns false, [WorldQuery::set_archetype] must be used before [WorldQuery::fetch] can be called for iterators.

const IS_ARCHETYPAL: bool = false

Returns true if (and only if) this Fetch relies strictly on archetypes to limit which components are accessed by the Query.

unsafe fn set_archetype<'w>(
    fetch: &mut ReadAllTraitsFetch<'w, Trait>,
    _state: &Self::State,
    _archetype: &'w Archetype,
    table: &'w Table
)

Adjusts internal state to account for the next [Archetype]. This will always be called on archetypes that match this [WorldQuery].

unsafe fn set_table<'w>(
    fetch: &mut ReadAllTraitsFetch<'w, Trait>,
    _state: &Self::State,
    table: &'w Table
)

Adjusts internal state to account for the next [Table]. This will always be called on tables that match this [WorldQuery].

unsafe fn fetch<'w>(
    fetch: &mut Self::Fetch<'w>,
    _entity: Entity,
    table_row: usize
) -> Self::Item<'w>

Fetch Self::Item for either the given entity in the current [Table], or for the given entity in the current [Archetype]. This must always be called after [WorldQuery::set_table] with a table_row in the range of the current [Table] or after [WorldQuery::set_archetype] with a entity in the current archetype.

fn update_component_access(
    state: &Self::State,
    access: &mut FilteredAccess<ComponentId>
)

fn update_archetype_component_access(
    state: &Self::State,
    archetype: &Archetype,
    access: &mut Access<ArchetypeComponentId>
)

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

fn matches_component_set(
    state: &Self::State,
    set_contains_id: &impl Fn(ComponentId) -> bool
) -> bool

unsafe fn filter_fetch(
    fetch: &mut Self::Fetch<'_>,
    entity: Entity,
    table_row: usize
) -> bool

Safety

impl<'a, Trait: ?Sized + TraitQuery> WorldQuery for All<&'a mut Trait>

SAFETY: We only access the components registered in the trait registry. This is known to match the set of components in the DynQueryState, which is used to match archetypes and register world access.

type Item<'w> = WriteTraits<'w, Trait>

The item returned by this [WorldQuery]

type Fetch<'w> = WriteAllTraitsFetch<'w, Trait>

Per archetype/table state used by this [WorldQuery] to fetch Self::Item

type ReadOnly = All<&'a Trait>

The read-only variant of this [WorldQuery], which satisfies the [ReadOnlyWorldQuery] trait.

type State = TraitQueryState<Trait>

State used to construct a Self::Fetch. This will be cached inside QueryState, so it is best to move as much data / computation here as possible to reduce the cost of constructing Self::Fetch.

unsafe fn init_fetch<'w>(
    world: &'w World,
    _state: &Self::State,
    last_change_tick: u32,
    change_tick: u32
) -> WriteAllTraitsFetch<'w, Trait>

Creates a new instance of this fetch.

unsafe fn clone_fetch<'w>(fetch: &Self::Fetch<'w>) -> Self::Fetch<'w>

While this function can be called for any query, it is always safe to call if Self: ReadOnlyWorldQuery holds.

fn shrink<'wlong: 'wshort, 'wshort>(
    item: QueryItem<'wlong, Self>
) -> QueryItem<'wshort, Self>

This function manually implements subtyping for the query items.

const IS_DENSE: bool = false

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components. This is used to select a more efficient “table iterator” for “dense” queries. If this returns true, [WorldQuery::set_table] must be used before [WorldQuery::fetch] can be called for iterators. If this returns false, [WorldQuery::set_archetype] must be used before [WorldQuery::fetch] can be called for iterators.

const IS_ARCHETYPAL: bool = false

Returns true if (and only if) this Fetch relies strictly on archetypes to limit which components are accessed by the Query.

unsafe fn set_archetype<'w>(
    fetch: &mut WriteAllTraitsFetch<'w, Trait>,
    _state: &Self::State,
    _archetype: &'w Archetype,
    table: &'w Table
)

Adjusts internal state to account for the next [Archetype]. This will always be called on archetypes that match this [WorldQuery].

unsafe fn fetch<'w>(
    fetch: &mut Self::Fetch<'w>,
    _entity: Entity,
    table_row: usize
) -> Self::Item<'w>

Fetch Self::Item for either the given entity in the current [Table], or for the given entity in the current [Archetype]. This must always be called after [WorldQuery::set_table] with a table_row in the range of the current [Table] or after [WorldQuery::set_archetype] with a entity in the current archetype.

unsafe fn set_table<'w>(
    fetch: &mut WriteAllTraitsFetch<'w, Trait>,
    _state: &Self::State,
    table: &'w Table
)

Adjusts internal state to account for the next [Table]. This will always be called on tables that match this [WorldQuery].

fn update_component_access(
    state: &Self::State,
    access: &mut FilteredAccess<ComponentId>
)

fn update_archetype_component_access(
    state: &Self::State,
    archetype: &Archetype,
    access: &mut Access<ArchetypeComponentId>
)

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

fn matches_component_set(
    state: &Self::State,
    set_contains_id: &impl Fn(ComponentId) -> bool
) -> bool

unsafe fn filter_fetch(
    fetch: &mut Self::Fetch<'_>,
    entity: Entity,
    table_row: usize
) -> bool

Safety

impl<'a, Trait: ?Sized + TraitQuery> ReadOnlyWorldQuery for All<&'a Trait>