Struct bevy::ecs::world::FilteredEntityRef

pub struct FilteredEntityRef<'w> { /* private fields */ }
Expand description

Provides read-only access to a single entity and some of its components defined by the contained Access.

Implementations§

§

impl<'w> FilteredEntityRef<'w>

pub fn id(&self) -> Entity

Returns the ID of the current entity.

pub fn location(&self) -> EntityLocation

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

pub fn archetype(&self) -> &Archetype

Returns the archetype that the current entity belongs to.

pub fn components(&self) -> impl Iterator<Item = ComponentId>

Returns an iterator over the component ids that are accessed by self.

pub fn access(&self) -> &Access<ComponentId>

Returns a reference to the underlying Access.

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.

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

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

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.

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.

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.

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 Self::get_change_ticks where possible and only use this in cases where the actual component types are not known at compile time.

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 Self::get where possible and only use this in cases where the actual component types are not known at compile time.

Unlike FilteredEntityRef::get, this returns a raw pointer to the component, which is only valid while the FilteredEntityRef is alive.

Trait Implementations§

§

impl<'w> Clone for FilteredEntityRef<'w>

§

fn clone(&self) -> FilteredEntityRef<'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
§

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

§

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

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

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

§

fn from(entity_mut: &'a FilteredEntityMut<'_>) -> FilteredEntityRef<'a>

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

impl<'w> From<FilteredEntityMut<'w>> for FilteredEntityRef<'w>

§

fn from(entity_mut: FilteredEntityMut<'w>) -> FilteredEntityRef<'w>

Converts to this type from the input type.
§

impl<'a> QueryData for FilteredEntityRef<'a>

SAFETY: Self is the same as Self::ReadOnly

§

type ReadOnly = FilteredEntityRef<'a>

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

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

§

type Error = TryFromFilteredError

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

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

Performs the conversion.
§

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

§

type Error = TryFromFilteredError

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

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

Performs the conversion.
§

impl<'a> WorldQuery for FilteredEntityRef<'a>

SAFETY: The accesses of Self::ReadOnly are a subset of the accesses of Self

§

type Fetch<'w> = (UnsafeWorldCell<'w>, Access<ComponentId>)

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

type Item<'w> = FilteredEntityRef<'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 State = FilteredAccess<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: <FilteredEntityRef<'a> as WorldQuery>::Item<'wlong>, ) -> <FilteredEntityRef<'a> as WorldQuery>::Item<'wshort>
where 'wlong: 'wshort,

This function manually implements subtyping for the query items.
§

const IS_DENSE: bool = false

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 init_fetch<'w>( world: UnsafeWorldCell<'w>, _state: &<FilteredEntityRef<'a> as WorldQuery>::State, _last_run: Tick, _this_run: Tick, ) -> <FilteredEntityRef<'a> as WorldQuery>::Fetch<'w>

Creates a new instance of this fetch. Read more
§

unsafe fn set_archetype<'w>( fetch: &mut <FilteredEntityRef<'a> as WorldQuery>::Fetch<'w>, state: &<FilteredEntityRef<'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
§

unsafe fn set_table<'w>( fetch: &mut <FilteredEntityRef<'a> as WorldQuery>::Fetch<'w>, state: &<FilteredEntityRef<'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
§

fn set_access<'w>( state: &mut <FilteredEntityRef<'a> as WorldQuery>::State, access: &FilteredAccess<ComponentId>, )

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

unsafe fn fetch<'w>( _: &mut <FilteredEntityRef<'a> as WorldQuery>::Fetch<'w>, entity: Entity, _table_row: TableRow, ) -> <FilteredEntityRef<'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
§

fn update_component_access( state: &<FilteredEntityRef<'a> as WorldQuery>::State, filtered_access: &mut FilteredAccess<ComponentId>, )

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

fn init_state( _world: &mut World, ) -> <FilteredEntityRef<'a> as WorldQuery>::State

Creates and initializes a State for this WorldQuery type.
§

fn get_state( _components: &Components, ) -> Option<<FilteredEntityRef<'a> as WorldQuery>::State>

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

fn matches_component_set( _state: &<FilteredEntityRef<'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. Read more
§

impl ReadOnlyQueryData for FilteredEntityRef<'_>

SAFETY: Access is read-only.

Auto Trait Implementations§

§

impl<'w> Freeze for FilteredEntityRef<'w>

§

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

§

impl<'w> Send for FilteredEntityRef<'w>

§

impl<'w> Sync for FilteredEntityRef<'w>

§

impl<'w> Unpin for FilteredEntityRef<'w>

§

impl<'w> !UnwindSafe for FilteredEntityRef<'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
§

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

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> 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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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

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

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

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

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

§

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

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.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
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
§

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

§

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

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

§

fn clone_type_data(&self) -> Box<dyn TypeData>

§

impl<T> Upcast<T> for T

§

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

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

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

§

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

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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