pub struct EntityRef<'w>(/* private fields */);
Expand description

A read-only reference to a particular Entity and all of its components.

Examples

Read-only access disjoint with mutable access.

fn disjoint_system(
    query1: Query<&mut A>,
    query2: Query<EntityRef, Without<A>>,
) {
    // ...
}

Implementations§

source§

impl<'w> EntityRef<'w>

source

pub fn id(&self) -> Entity

Returns the ID of the current entity.

source

pub fn location(&self) -> EntityLocation

Gets metadata indicating the location where the current entity is stored.

source

pub fn archetype(&self) -> &Archetype

Returns the archetype that the current entity belongs to.

source

pub fn contains<T>(&self) -> bool
where T: Component,

Returns true if the current entity has a component of type T. Otherwise, this returns false.

Notes

If you do not know the concrete type of a component, consider using Self::contains_id or Self::contains_type_id.

source

pub fn contains_id(&self, component_id: ComponentId) -> bool

Returns true if the current entity has a component identified by component_id. Otherwise, this returns false.

Notes
source

pub fn contains_type_id(&self, type_id: TypeId) -> bool

Returns true if the current entity has a component with the type identified by type_id. Otherwise, this returns false.

Notes
source

pub fn get<T>(&self) -> Option<&'w T>
where T: Component,

Gets access to the component of type T for the current entity. Returns None if the entity does not have a component of type T.

source

pub fn get_ref<T>(&self) -> Option<Ref<'w, T>>
where T: Component,

Gets access to the component of type T for the current entity, including change detection information as a Ref.

Returns None if the entity does not have a component of type T.

source

pub fn get_change_ticks<T>(&self) -> Option<ComponentTicks>
where T: Component,

Retrieves the change ticks for the given component. This can be useful for implementing change detection in custom runtimes.

source

pub fn get_change_ticks_by_id( &self, component_id: ComponentId ) -> Option<ComponentTicks>

Retrieves the change ticks for the given ComponentId. This can be useful for implementing change detection in custom runtimes.

You should prefer to use the typed API EntityRef::get_change_ticks where possible and only use this in cases where the actual component types are not known at compile time.

source

pub fn get_by_id(&self, component_id: ComponentId) -> Option<Ptr<'w>>

Gets the component of the given ComponentId from the entity.

You should prefer to use the typed API where possible and only use this in cases where the actual component types are not known at compile time.

Unlike EntityRef::get, this returns a raw pointer to the component, which is only valid while the 'w borrow of the lifetime is active.

Trait Implementations§

source§

impl<'w> Clone for EntityRef<'w>

source§

fn clone(&self) -> EntityRef<'w>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> From<&'a EntityMut<'_>> for EntityRef<'a>

source§

fn from(value: &'a EntityMut<'_>) -> EntityRef<'a>

Converts to this type from the input type.
source§

impl<'a> From<&'a EntityRef<'_>> for FilteredEntityRef<'a>

source§

fn from(entity: &'a EntityRef<'_>) -> FilteredEntityRef<'a>

Converts to this type from the input type.
source§

impl<'a> From<&'a EntityWorldMut<'_>> for EntityRef<'a>

source§

fn from(value: &'a EntityWorldMut<'_>) -> EntityRef<'a>

Converts to this type from the input type.
source§

impl<'w> From<EntityMut<'w>> for EntityRef<'w>

source§

fn from(value: EntityMut<'w>) -> EntityRef<'w>

Converts to this type from the input type.
source§

impl<'a> From<EntityRef<'a>> for FilteredEntityRef<'a>

source§

fn from(entity: EntityRef<'a>) -> FilteredEntityRef<'a>

Converts to this type from the input type.
source§

impl<'w> From<EntityWorldMut<'w>> for EntityRef<'w>

source§

fn from(entity_mut: EntityWorldMut<'w>) -> EntityRef<'w>

Converts to this type from the input type.
source§

impl<'a> QueryData for EntityRef<'a>

SAFETY: Self is the same as Self::ReadOnly

§

type ReadOnly = EntityRef<'a>

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

impl<'a> TryFrom<&'a FilteredEntityMut<'_>> for EntityRef<'a>

§

type Error = TryFromFilteredError

The type returned in the event of a conversion error.
source§

fn try_from( value: &'a FilteredEntityMut<'_> ) -> Result<EntityRef<'a>, <EntityRef<'a> as TryFrom<&'a FilteredEntityMut<'_>>>::Error>

Performs the conversion.
source§

impl<'a> TryFrom<&'a FilteredEntityRef<'_>> for EntityRef<'a>

§

type Error = TryFromFilteredError

The type returned in the event of a conversion error.
source§

fn try_from( value: &'a FilteredEntityRef<'_> ) -> Result<EntityRef<'a>, <EntityRef<'a> as TryFrom<&'a FilteredEntityRef<'_>>>::Error>

Performs the conversion.
source§

impl<'a> TryFrom<FilteredEntityMut<'a>> for EntityRef<'a>

§

type Error = TryFromFilteredError

The type returned in the event of a conversion error.
source§

fn try_from( value: FilteredEntityMut<'a> ) -> Result<EntityRef<'a>, <EntityRef<'a> as TryFrom<FilteredEntityMut<'a>>>::Error>

Performs the conversion.
source§

impl<'a> TryFrom<FilteredEntityRef<'a>> for EntityRef<'a>

§

type Error = TryFromFilteredError

The type returned in the event of a conversion error.
source§

fn try_from( value: FilteredEntityRef<'a> ) -> Result<EntityRef<'a>, <EntityRef<'a> as TryFrom<FilteredEntityRef<'a>>>::Error>

Performs the conversion.
source§

impl<'a> WorldQuery for EntityRef<'a>

SAFETY: fetch accesses all components in a readonly way. This is sound because update_component_access and update_archetype_component_access set read access for all components and panic when appropriate. Filters are unchanged.

§

type Item<'w> = EntityRef<'w>

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> = UnsafeWorldCell<'w>

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

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

fn shrink<'wlong, 'wshort>( item: <EntityRef<'a> as WorldQuery>::Item<'wlong> ) -> <EntityRef<'a> as WorldQuery>::Item<'wshort>
where 'wlong: 'wshort,

This function manually implements subtyping for the query items.
source§

unsafe fn init_fetch<'w>( world: UnsafeWorldCell<'w>, _state: &<EntityRef<'a> as WorldQuery>::State, _last_run: Tick, _this_run: Tick ) -> <EntityRef<'a> as WorldQuery>::Fetch<'w>

Creates a new instance of this fetch. Read more
source§

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

unsafe fn set_archetype<'w>( _fetch: &mut <EntityRef<'a> as WorldQuery>::Fetch<'w>, _state: &<EntityRef<'a> 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. Read more
source§

unsafe fn set_table<'w>( _fetch: &mut <EntityRef<'a> as WorldQuery>::Fetch<'w>, _state: &<EntityRef<'a> 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. Read more
source§

unsafe fn fetch<'w>( world: &mut <EntityRef<'a> as WorldQuery>::Fetch<'w>, entity: Entity, _table_row: TableRow ) -> <EntityRef<'a> 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. Read more
source§

fn update_component_access( _state: &<EntityRef<'a> as WorldQuery>::State, access: &mut FilteredAccess<ComponentId> )

Adds any component accesses used by this WorldQuery to access.
source§

fn init_state(_world: &mut World)

Creates and initializes a State for this WorldQuery type.
source§

fn get_state(_world: &World) -> Option<()>

Attempts to initializes a State for this WorldQuery type.
source§

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

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

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

Sets available accesses for implementors with dynamic access such as FilteredEntityRef or FilteredEntityMut. Read more
source§

impl<'w> Copy for EntityRef<'w>

source§

impl ReadOnlyQueryData for EntityRef<'_>

SAFETY: access is read only

Auto Trait Implementations§

§

impl<'w> !RefUnwindSafe for EntityRef<'w>

§

impl<'w> Send for EntityRef<'w>

§

impl<'w> Sync for EntityRef<'w>

§

impl<'w> Unpin for EntityRef<'w>

§

impl<'w> !UnwindSafe for EntityRef<'w>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,