Struct NameOrEntity

pub struct NameOrEntity {
    pub name: Option<&'static Name>,
    pub entity: Entity,
}

Convenient query for giving a human friendly name to an entity.

fn increment_score(mut scores: Query<(NameOrEntity, &mut Score)>) {
    for (name, mut score) in &mut scores {
        score.0 += 1.0;
        if score.0.is_nan() {
            log::error!("Score for {name} is invalid");
        }
    }
}

Implementation

The Display impl for NameOrEntity returns the Name where there is one or {index}v{generation} for entities without one.

Fields

name: Option<&'static Name>

A Name that the entity might have that is displayed if available.

entity: Entity

The unique identifier of the entity as a fallback.

Trait Implementations

impl QueryData for NameOrEntity

SAFETY: we assert fields are readonly below

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

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

const IS_READ_ONLY: bool = true

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

type ReadOnly = NameOrEntity

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

type Item<'__w> = NameOrEntityItem<'__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, '__wshort>( item: Self::Item<'__wlong>, ) -> Self::Item<'__wshort>

This function manually implements subtyping for the query items.

impl WorldQuery for NameOrEntity

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

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> = NameOrEntityFetch<'__w>

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

type State = NameOrEntityState

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, '__wshort>( fetch: <NameOrEntity as WorldQuery>::Fetch<'__wlong>, ) -> <NameOrEntity as WorldQuery>::Fetch<'__wshort>

This function manually implements subtyping for the query fetches.

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 Self::Fetch, by combining data from the World with the cached Self::State. Readonly accesses resources registered in WorldQuery::update_component_access.

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

Adds any component accesses used by this WorldQuery to access.

fn init_state(world: &mut World) -> NameOrEntityState

Creates and initializes a State for this WorldQuery type.

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

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

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.

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 NameOrEntity

SAFETY: we assert fields are readonly below