Struct EntityRefExcept

pub struct EntityRefExcept<'w, B>
where
    B: Bundle,
{ /* private fields */ }

Provides read-only access to a single entity and all its components, save for an explicitly-enumerated set.

Implementations

impl<'w, B> EntityRefExcept<'w, B>

where B: Bundle,

pub fn id(&self) -> Entity

Returns the ID of the current entity.

pub fn get<C>(&self) -> Option<&'w C>

where C: Component,

Gets access to the component of type C for the current entity. Returns None if the component doesn’t have a component of that type or if the type is one of the excluded components.

pub fn get_ref<C>(&self) -> Option<Ref<'w, C>>

where C: Component,

Gets access to the component of type C for the current entity, including change detection information. Returns None if the component doesn’t have a component of that type or if the type is one of the excluded components.

Trait Implementations

impl<'w, B> Clone for EntityRefExcept<'w, B>

where B: Bundle + Clone,

fn clone(&self) -> EntityRefExcept<'w, B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, B> From<&'a EntityMutExcept<'_, B>> for EntityRefExcept<'a, B>

where B: Bundle,

fn from(entity_mut: &'a EntityMutExcept<'_, B>) -> Self

Converts to this type from the input type.

impl<'a, B> QueryData for EntityRefExcept<'a, B>

where B: Bundle,

SAFETY: Self is the same as Self::ReadOnly.

type ReadOnly = EntityRefExcept<'a, B>

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

impl<'a, B> WorldQuery for EntityRefExcept<'a, B>

where B: Bundle,

SAFETY: EntityRefExcept guards access to all components in the bundle B and populates Access values so that queries that conflict with this access are rejected.

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.

type Fetch<'w> = UnsafeWorldCell<'w>

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

type Item<'w> = EntityRefExcept<'w, B>

The item returned by this WorldQuery For QueryData this will be the item returned by the query. For QueryFilter this will be either (), or a bool indicating whether the entity should be included or a tuple of such things.

type State = SmallVec<[ComponentId; 4]>

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: Self::Item<'wlong>, ) -> Self::Item<'wshort>

This function manually implements subtyping for the query items.

fn shrink_fetch<'wlong: 'wshort, 'wshort>( fetch: Self::Fetch<'wlong>, ) -> Self::Fetch<'wshort>

This function manually implements subtyping for the query fetches.

unsafe fn init_fetch<'w>( world: UnsafeWorldCell<'w>, _: &Self::State, _: Tick, _: Tick, ) -> Self::Fetch<'w>

Creates a new instance of this fetch.

unsafe fn set_archetype<'w>( _: &mut Self::Fetch<'w>, _: &Self::State, _: &'w Archetype, _: &'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>(_: &mut Self::Fetch<'w>, _: &Self::State, _: &'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>( world: &mut Self::Fetch<'w>, entity: Entity, _: TableRow, ) -> 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, filtered_access: &mut FilteredAccess<ComponentId>, )

Adds any component accesses used by this WorldQuery to access.

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

Creates and initializes a State for this WorldQuery type.

fn get_state(components: &Components) -> Option<Self::State>

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

fn matches_component_set( _: &Self::State, _: &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<'a, B> ReadOnlyQueryData for EntityRefExcept<'a, B>

where B: Bundle,

SAFETY: EntityRefExcept enforces read-only access to its contained components.