Struct WithKind 

pub struct WithKind<T: EntityKind> { /* private fields */ }

A WorldQuery filter for entities with some given EntityKind.

Similar to With in usage.

Trait Implementations

impl<T: EntityKind> WorldQuery for WithKind<T>

unsafe fn set_archetype<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &Self::State, _archetype: &'__w Archetype, _table: &'__w Table, )

SAFETY: we call set_archetype for each member that implements Fetch

unsafe fn set_table<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &Self::State, _table: &'__w Table, )

SAFETY: we call set_table for each member that implements Fetch

unsafe fn fetch<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow, ) -> <Self as WorldQuery>::Item<'__w>

SAFETY: we call fetch for each member that implements Fetch.

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. 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 = true

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

type Item<'__w> = WithKindItem<'__w, T>

The item returned by this WorldQuery

type Fetch<'__w> = WithKindFetch<'__w, T>

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

type ReadOnly = WithKind<T>

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

type State = WithKindState<T>

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<'__wlong: '__wshort, '__wshort>( item: <WithKind<T> as WorldQuery>::Item<'__wlong>, ) -> <WithKind<T> as WorldQuery>::Item<'__wshort>

This function manually implements subtyping for the query items.

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

Creates a new instance of this fetch.

unsafe fn clone_fetch<'__w>( _fetch: &<Self as WorldQuery>::Fetch<'__w>, ) -> <Self as WorldQuery>::Fetch<'__w>

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

unsafe fn filter_fetch<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow, ) -> bool

Safety

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

Adds any component accesses used by this WorldQuery to access.

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

For the given archetype, adds any component accessed used by this WorldQuery to access.

fn init_state(world: &mut World) -> WithKindState<T>

Creates and initializes a State for this WorldQuery type.

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

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

impl<T: EntityKind> ReadOnlyWorldQuery for WithKind<T>

SAFETY: we assert fields are readonly below