Struct valence::prelude::Has

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

Returns a bool that describes if an entity has the component T.

This can be used in a Query if you want to know whether or not entities have the component T but don’t actually care about the component’s value.

Footguns

Note that a Query<Has<T>> will match all existing entities. Beware! Even if it matches all entities, it doesn’t mean that query.get(entity) will always return Ok(bool).

In the case of a non-existent entity, such as a despawned one, it will return Err. A workaround is to replace query.get(entity).unwrap() by query.get(entity).unwrap_or_default().

Examples

fn food_entity_system(query: Query<(&Name, Has<IsHungry>) >) {
    for (name, is_hungry) in &query {
        if is_hungry{
            println!("{} would like some food.", name.name);
        } else {
            println!("{} has had sufficient.", name.name);
        }
    }
}

// Unlike `Option<&T>`, `Has<T>` is compatible with `&mut T`
// as it does not actually access any data.
fn alphabet_entity_system(mut alphas: Query<(&mut Alpha, Has<Beta>)>, mut betas: Query<(&mut Beta, Has<Alpha>)>) {
    for (mut alpha, has_beta) in alphas.iter_mut() {
        alpha.has_beta = has_beta;
    }
    for (mut beta, has_alpha) in betas.iter_mut() {
        beta.has_alpha = has_alpha;
    }
}

Trait Implementations

impl<T> Debug for Has<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> QueryData for Has<T>

where T: Component,

SAFETY: Self is the same as Self::ReadOnly

type ReadOnly = Has<T>

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

impl<T> WorldQuery for Has<T>

where T: Component,

SAFETY: update_component_access and update_archetype_component_access do nothing. This is sound because fetch does not access components.

type Item<'w> = bool

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 Fetch<'w> = bool

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

type State = ComponentId

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>( item: <Has<T> as WorldQuery>::Item<'wlong>, ) -> <Has<T> as WorldQuery>::Item<'wshort>

where 'wlong: 'wshort,

This function manually implements subtyping for the query items.

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

Creates a new instance of this fetch.

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

unsafe fn set_archetype<'w>( fetch: &mut <Has<T> as WorldQuery>::Fetch<'w>, state: &<Has<T> as WorldQuery>::State, archetype: &'w Archetype, _table: &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 <Has<T> as WorldQuery>::Fetch<'w>, state: &<Has<T> 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.

unsafe fn fetch<'w>( fetch: &mut <Has<T> as WorldQuery>::Fetch<'w>, _entity: Entity, _table_row: TableRow, ) -> <Has<T> as WorldQuery>::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( _: &<Has<T> as WorldQuery>::State, access: &mut FilteredAccess<ComponentId>, )

Adds any component accesses used by this WorldQuery to access.

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

Creates and initializes a State for this WorldQuery type.

fn get_state(components: &Components) -> Option<<Has<T> as WorldQuery>::State>

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

fn matches_component_set( _state: &<Has<T> 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<T> ReadOnlyQueryData for Has<T>

where T: Component,

SAFETY: Has is read only