Struct AnyOf

pub struct AnyOf<T>(/* private fields */);

The AnyOf query parameter fetches entities with any of the component types included in T.

Query<AnyOf<(&A, &B, &mut C)>> is equivalent to Query<(Option<&A>, Option<&B>, Option<&mut C>), Or<(With<A>, With<B>, With<C>)>>. Each of the components in T is returned as an Option, as with Option<A> queries. Entities are guaranteed to have at least one of the components in T.

Trait Implementations

impl QueryData for AnyOf<()>

const IS_READ_ONLY: bool = true

True if this query is read-only and may not perform mutable access.

type ReadOnly = AnyOf<()>

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.

type Item<'w> = ()

The item returned by this WorldQuery This will be the data retrieved by the query, and is visible to the end user when calling e.g. Query<Self>::get.

fn shrink<'wlong, 'wshort>( item: <AnyOf<()> as QueryData>::Item<'wlong>, ) -> <AnyOf<()> as QueryData>::Item<'wshort>

where 'wlong: 'wshort,

This function manually implements subtyping for the query items.

unsafe fn fetch<'w>( _fetch: &mut <AnyOf<()> as WorldQuery>::Fetch<'w>, _entity: Entity, _table_row: TableRow, ) -> <AnyOf<()> as QueryData>::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 an entity in the current archetype. Accesses components registered in WorldQuery::update_component_access.

impl<F> QueryData for AnyOf<(F₁, F₂, …, Fₙ)>

where F: QueryData,

This trait is implemented for tuples up to 16 items long.

const IS_READ_ONLY: bool

True if this query is read-only and may not perform mutable access.

type ReadOnly = AnyOf<(<F as QueryData>::ReadOnly,)>

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.

type Item<'w> = (Option<<F as QueryData>::Item<'w>>,)

The item returned by this WorldQuery This will be the data retrieved by the query, and is visible to the end user when calling e.g. Query<Self>::get.

fn shrink<'wlong, 'wshort>( item: <AnyOf<(F,)> as QueryData>::Item<'wlong>, ) -> <AnyOf<(F,)> as QueryData>::Item<'wshort>

where 'wlong: 'wshort,

This function manually implements subtyping for the query items.

unsafe fn fetch<'w>( _fetch: &mut <AnyOf<(F,)> as WorldQuery>::Fetch<'w>, _entity: Entity, _table_row: TableRow, ) -> <AnyOf<(F,)> as QueryData>::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 an entity in the current archetype. Accesses components registered in WorldQuery::update_component_access.

impl WorldQuery for AnyOf<()>

SAFETY: fetch accesses are a subset of the subqueries’ accesses This is sound because update_component_access and update_archetype_component_access adds accesses according to the implementations of all the subqueries. update_component_access replaces the filters with a disjunction where every element is a conjunction of the previous filters and the filters of one of the subqueries. This is sound because matches_component_set returns a disjunction of the results of the subqueries’ implementations.

const IS_DENSE: bool = true

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components.

type Fetch<'w> = ()

Per archetype/table state retrieved by this WorldQuery to compute Self::Item for each entity.

type State = ()

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.

fn shrink_fetch<'wlong, 'wshort>( fetch: <AnyOf<()> as WorldQuery>::Fetch<'wlong>, ) -> <AnyOf<()> as WorldQuery>::Fetch<'wshort>

where 'wlong: 'wshort,

This function manually implements subtyping for the query fetches.

unsafe fn init_fetch<'w>( _world: UnsafeWorldCell<'w>, state: &<AnyOf<()> as WorldQuery>::State, _last_run: Tick, _this_run: Tick, ) -> <AnyOf<()> as WorldQuery>::Fetch<'w>

Creates a new instance of Self::Fetch, by combining data from the World with the cached Self::State. Readonly accesses resources registered in WorldQuery::update_component_access.

unsafe fn set_archetype<'w>( _fetch: &mut <AnyOf<()> as WorldQuery>::Fetch<'w>, _state: &<AnyOf<()> as WorldQuery>::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 <AnyOf<()> as WorldQuery>::Fetch<'w>, _state: &<AnyOf<()> as WorldQuery>::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: &<AnyOf<()> as WorldQuery>::State, access: &mut FilteredAccess<ComponentId>, )

Adds any component accesses used by this WorldQuery to access.

fn init_state(world: &mut World) -> <AnyOf<()> as WorldQuery>::State

Creates and initializes a State for this WorldQuery type.

fn get_state( components: &Components, ) -> Option<<AnyOf<()> as WorldQuery>::State>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.

fn matches_component_set( _state: &<AnyOf<()> as WorldQuery>::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.

fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)

Sets available accesses for implementors with dynamic access such as FilteredEntityRef or FilteredEntityMut.

impl<F> WorldQuery for AnyOf<(F₁, F₂, …, Fₙ)>

where F: WorldQuery,

This trait is implemented for tuples up to 16 items long. SAFETY: fetch accesses are a subset of the subqueries’ accesses This is sound because update_component_access and update_archetype_component_access adds accesses according to the implementations of all the subqueries. update_component_access replaces the filters with a disjunction where every element is a conjunction of the previous filters and the filters of one of the subqueries. This is sound because matches_component_set returns a disjunction of the results of the subqueries’ implementations.

const IS_DENSE: bool

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components.

type Fetch<'w> = ((<F as WorldQuery>::Fetch<'w>, bool),)

Per archetype/table state retrieved by this WorldQuery to compute Self::Item for each entity.

type State = (<F as WorldQuery>::State,)

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.

fn shrink_fetch<'wlong, 'wshort>( fetch: <AnyOf<(F,)> as WorldQuery>::Fetch<'wlong>, ) -> <AnyOf<(F,)> as WorldQuery>::Fetch<'wshort>

where 'wlong: 'wshort,

This function manually implements subtyping for the query fetches.

unsafe fn init_fetch<'w>( _world: UnsafeWorldCell<'w>, state: &<AnyOf<(F,)> as WorldQuery>::State, _last_run: Tick, _this_run: Tick, ) -> <AnyOf<(F,)> as WorldQuery>::Fetch<'w>

Creates a new instance of Self::Fetch, by combining data from the World with the cached Self::State. Readonly accesses resources registered in WorldQuery::update_component_access.

unsafe fn set_archetype<'w>( _fetch: &mut <AnyOf<(F,)> as WorldQuery>::Fetch<'w>, _state: &<AnyOf<(F,)> as WorldQuery>::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 <AnyOf<(F,)> as WorldQuery>::Fetch<'w>, _state: &<AnyOf<(F,)> as WorldQuery>::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: &<AnyOf<(F,)> as WorldQuery>::State, access: &mut FilteredAccess<ComponentId>, )

Adds any component accesses used by this WorldQuery to access.

fn init_state(world: &mut World) -> <AnyOf<(F,)> as WorldQuery>::State

Creates and initializes a State for this WorldQuery type.

fn get_state( components: &Components, ) -> Option<<AnyOf<(F,)> as WorldQuery>::State>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.

fn matches_component_set( _state: &<AnyOf<(F,)> as WorldQuery>::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.

fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)

Sets available accesses for implementors with dynamic access such as FilteredEntityRef or FilteredEntityMut.

impl ReadOnlyQueryData for AnyOf<()>

SAFETY: each item in the tuple is read only

impl<F> ReadOnlyQueryData for AnyOf<(F₁, F₂, …, Fₙ)>

where F: ReadOnlyQueryData,

This trait is implemented for tuples up to 16 items long. SAFETY: each item in the tuple is read only