Struct bevy_ecs::world::FilteredEntityMut

source ·
pub struct FilteredEntityMut<'w> { /* private fields */ }
Expand description

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

Implementations§

source§

impl<'w> FilteredEntityMut<'w>

source

pub fn reborrow(&mut self) -> FilteredEntityMut<'_>

Returns a new instance with a shorter lifetime. This is useful if you have &mut FilteredEntityMut, but you need FilteredEntityMut.

source

pub fn as_readonly(&self) -> FilteredEntityRef<'_>

Gets read-only access to all of the entity’s components.

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 components(&self) -> impl Iterator<Item = ComponentId> + '_

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

source

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

Returns a reference to the underlying Access.

source

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

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: Component>(&self) -> Option<&T>

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: Component>(&self) -> Option<Ref<'_, T>>

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_mut<T: Component>(&mut self) -> Option<Mut<'_, T>>

Gets mutable 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 into_mut<T: Component>(self) -> Option<Mut<'w, T>>

Consumes self and gets mutable access to the component of type T with the world 'w lifetime for the current entity. Returns None if the entity does not have a component of type T.

source

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

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 Self::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<'_>>

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 FilteredEntityMut::get, this returns a raw pointer to the component, which is only valid while the FilteredEntityMut is alive.

source

pub fn get_mut_by_id( &mut self, component_id: ComponentId ) -> Option<MutUntyped<'_>>

Gets a MutUntyped of the component of the given ComponentId from the entity.

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

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

Trait Implementations§

source§

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

source§

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

Converts to this type from the input type.
source§

impl<'a> From<&'a mut EntityMut<'_>> for FilteredEntityMut<'a>

source§

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

Converts to this type from the input type.
source§

impl<'a> From<&'a mut EntityWorldMut<'_>> for FilteredEntityMut<'a>

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl<'a> QueryData for FilteredEntityMut<'a>

SAFETY: access of FilteredEntityRef is a subset of FilteredEntityMut

§

type ReadOnly = FilteredEntityRef<'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<Self, Self::Error>

Performs the conversion.
source§

impl<'a> TryFrom<&'a mut FilteredEntityMut<'_>> for EntityMut<'a>

§

type Error = TryFromFilteredError

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

fn try_from(value: &'a mut FilteredEntityMut<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

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

§

type Error = TryFromFilteredError

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

fn try_from(value: FilteredEntityMut<'a>) -> Result<Self, Self::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<Self, Self::Error>

Performs the conversion.
source§

impl<'a> WorldQuery for FilteredEntityMut<'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> = FilteredEntityMut<'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.
source§

fn shrink<'wlong: 'wshort, 'wshort>( item: Self::Item<'wlong> ) -> Self::Item<'wshort>

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

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

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

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

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

fn set_access<'w>(state: &mut Self::State, access: &FilteredAccess<ComponentId>)

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

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

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

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

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

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

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

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

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

Auto Trait Implementations§

§

impl<'w> Freeze for FilteredEntityMut<'w>

§

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

§

impl<'w> Send for FilteredEntityMut<'w>

§

impl<'w> Sync for FilteredEntityMut<'w>

§

impl<'w> Unpin for FilteredEntityMut<'w>

§

impl<'w> !UnwindSafe for FilteredEntityMut<'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> 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 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 + 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.

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, 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> 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<T> ConditionalSend for T
where T: Send,