Struct EntityMut

pub struct EntityMut<'w> { /* private fields */ }

Provides mutable access to a single entity and all of its components.

Contrast with EntityWorldMut, which allows adding and removing components, despawning the entity, and provides mutable access to the entire world. Because of this, EntityWorldMut cannot coexist with any other world accesses.

Examples

Disjoint mutable access.

fn disjoint_system(
    query1: Query<EntityMut, With<A>>,
    query2: Query<EntityMut, Without<A>>,
) {
    // ...
}

Implementations

impl<'w> EntityMut<'w>

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

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

pub fn into_readonly(self) -> EntityRef<'w>

Consumes self and returns read-only access to all of the entity’s components, with the world 'w lifetime.

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

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

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

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

• If you know the concrete type of the component, you should prefer Self::contains.
• If you know the component’s TypeId but not its ComponentId, consider using Self::contains_type_id.

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

• If you know the concrete type of the component, you should prefer Self::contains.
• If you have a ComponentId instead of a TypeId, consider using Self::contains_id.

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.

pub fn components<Q: ReadOnlyQueryData>(&self) -> Q::Item<'_>

Returns read-only components for the current entity that match the query Q.

Panics

If the entity does not have the components required by the query Q.

pub fn get_components<Q: ReadOnlyQueryData>(&self) -> Option<Q::Item<'_>>

Returns read-only components for the current entity that match the query Q, or None if the entity does not have the components required by the query Q.

pub fn into_borrow<T: Component>(self) -> Option<&'w T>

Consumes self and gets 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.

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.

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

Consumes self and gets access to the component of type T with world 'w lifetime for the current entity, including change detection information as a [Ref<'w>].

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

pub fn get_mut<T: Component<Mutability = Mutable>>( &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.

pub unsafe fn get_mut_assume_mutable<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.

Safety

• T must be a mutable component

pub fn into_mut<T: Component<Mutability = Mutable>>(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.

pub unsafe fn into_mut_assume_mutable<T: Component>(self) -> Option<Mut<'w, 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.

Safety

• T must be a mutable component

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.

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 EntityWorldMut::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<F: DynamicComponentFetch>( &self, component_ids: F, ) -> Result<F::Ref<'_>, EntityComponentError>

Returns untyped read-only reference(s) to component(s) for the current entity, based on the given ComponentIds.

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

Unlike EntityMut::get, this returns untyped reference(s) to component(s), and it’s the job of the caller to ensure the correct type(s) are dereferenced (if necessary).

Errors

Returns EntityComponentError::MissingComponent if the entity does not have a component.

Examples

For examples on how to use this method, see EntityRef::get_by_id.

pub fn into_borrow_by_id<F: DynamicComponentFetch>( self, component_ids: F, ) -> Result<F::Ref<'w>, EntityComponentError>

Consumes self and returns untyped read-only reference(s) to component(s) with lifetime 'w for the current entity, based on the given ComponentIds.

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

Unlike EntityMut::into_borrow, this returns untyped reference(s) to component(s), and it’s the job of the caller to ensure the correct type(s) are dereferenced (if necessary).

Errors

Returns EntityComponentError::MissingComponent if the entity does not have a component.

Examples

For examples on how to use this method, see EntityRef::get_by_id.

pub fn get_mut_by_id<F: DynamicComponentFetch>( &mut self, component_ids: F, ) -> Result<F::Mut<'_>, EntityComponentError>

Returns untyped mutable reference(s) to component(s) for the current entity, based on the given ComponentIds.

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

Unlike EntityMut::get_mut, this returns untyped reference(s) to component(s), and it’s the job of the caller to ensure the correct type(s) are dereferenced (if necessary).

Errors

• Returns EntityComponentError::MissingComponent if the entity does not have a component.
• Returns EntityComponentError::AliasedMutability if a component is requested multiple times.

Examples

Single ComponentId

let entity = world.spawn(Foo(42)).id();

// Grab the component ID for `Foo` in whatever way you like.
let component_id = world.register_component::<Foo>();

// Then, get the component by ID.
let mut entity_mut = world.entity_mut(entity);
let mut ptr = entity_mut.get_mut_by_id(component_id)

Array of ComponentIds

let entity = world.spawn((X(42), Y(10))).id();

// Grab the component IDs for `X` and `Y` in whatever way you like.
let x_id = world.register_component::<X>();
let y_id = world.register_component::<Y>();

// Then, get the components by ID. You'll receive a same-sized array.
let mut entity_mut = world.entity_mut(entity);
let Ok([mut x_ptr, mut y_ptr]) = entity_mut.get_mut_by_id([x_id, y_id]) else {
    // Up to you to handle if a component is missing from the entity.
};

Slice of ComponentIds

let entity = world.spawn((X(42), Y(10))).id();

// Grab the component IDs for `X` and `Y` in whatever way you like.
let x_id = world.register_component::<X>();
let y_id = world.register_component::<Y>();

// Then, get the components by ID. You'll receive a vec of ptrs.
let mut entity_mut = world.entity_mut(entity);
let ptrs = entity_mut.get_mut_by_id(&[x_id, y_id] as &[ComponentId])

HashSet of ComponentIds

let entity = world.spawn((X(42), Y(10))).id();

// Grab the component IDs for `X` and `Y` in whatever way you like.
let x_id = world.register_component::<X>();
let y_id = world.register_component::<Y>();

// Then, get the components by ID. You'll receive a `HashMap` of ptrs.
let mut entity_mut = world.entity_mut(entity);
let mut ptrs = entity_mut.get_mut_by_id(&HashSet::from_iter([x_id, y_id]))

pub unsafe fn get_mut_assume_mutable_by_id<F: DynamicComponentFetch>( &mut self, component_ids: F, ) -> Result<F::Mut<'_>, EntityComponentError>

Returns untyped mutable reference(s) to component(s) for the current entity, based on the given ComponentIds. Assumes the given ComponentIds refer to mutable components.

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

Unlike EntityMut::get_mut_assume_mutable, this returns untyped reference(s) to component(s), and it’s the job of the caller to ensure the correct type(s) are dereferenced (if necessary).

Errors

• Returns EntityComponentError::MissingComponent if the entity does not have a component.
• Returns EntityComponentError::AliasedMutability if a component is requested multiple times.

Safety

It is the callers responsibility to ensure that

• the provided ComponentIds must refer to mutable components.

pub unsafe fn get_mut_by_id_unchecked<F: DynamicComponentFetch>( &self, component_ids: F, ) -> Result<F::Mut<'_>, EntityComponentError>

Returns untyped mutable reference to component for the current entity, based on the given ComponentId.

Unlike EntityMut::get_mut_by_id, this method borrows &self instead of &mut self, allowing the caller to access multiple components simultaneously.

Errors

• Returns EntityComponentError::MissingComponent if the entity does not have a component.
• Returns EntityComponentError::AliasedMutability if a component is requested multiple times.

Safety

It is the callers responsibility to ensure that

• the UnsafeEntityCell has permission to access the component mutably
• no other references to the component exist at the same time

pub unsafe fn get_mut_assume_mutable_by_id_unchecked<F: DynamicComponentFetch>( &self, component_ids: F, ) -> Result<F::Mut<'_>, EntityComponentError>

Returns untyped mutable reference to component for the current entity, based on the given ComponentId. Assumes the given ComponentIds refer to mutable components.

Unlike EntityMut::get_mut_assume_mutable_by_id, this method borrows &self instead of &mut self, allowing the caller to access multiple components simultaneously.

Errors

• Returns EntityComponentError::MissingComponent if the entity does not have a component.
• Returns EntityComponentError::AliasedMutability if a component is requested multiple times.

Safety

It is the callers responsibility to ensure that

• the UnsafeEntityCell has permission to access the component mutably
• no other references to the component exist at the same time
• the provided ComponentIds must refer to mutable components.

pub fn into_mut_by_id<F: DynamicComponentFetch>( self, component_ids: F, ) -> Result<F::Mut<'w>, EntityComponentError>

Consumes self and returns untyped mutable reference(s) to component(s) with lifetime 'w for the current entity, based on the given ComponentIds.

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

Unlike EntityMut::into_mut, this returns untyped reference(s) to component(s), and it’s the job of the caller to ensure the correct type(s) are dereferenced (if necessary).

Errors

• Returns EntityComponentError::MissingComponent if the entity does not have a component.
• Returns EntityComponentError::AliasedMutability if a component is requested multiple times.

Examples

For examples on how to use this method, see EntityMut::get_mut_by_id.

pub unsafe fn into_mut_assume_mutable_by_id<F: DynamicComponentFetch>( self, component_ids: F, ) -> Result<F::Mut<'w>, EntityComponentError>

Consumes self and returns untyped mutable reference(s) to component(s) with lifetime 'w for the current entity, based on the given ComponentIds. Assumes the given ComponentIds refer to mutable components.

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

Unlike EntityMut::into_mut_assume_mutable, this returns untyped reference(s) to component(s), and it’s the job of the caller to ensure the correct type(s) are dereferenced (if necessary).

Errors

• Returns EntityComponentError::MissingComponent if the entity does not have a component.
• Returns EntityComponentError::AliasedMutability if a component is requested multiple times.

Safety

It is the callers responsibility to ensure that

• the provided ComponentIds must refer to mutable components.

pub fn spawned_by(&self) -> MaybeLocation

Returns the source code location from which this entity has been spawned.

Trait Implementations

impl ContainsEntity for EntityMut<'_>

fn entity(&self) -> Entity

Returns the contained entity.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'w> From<&'w mut EntityMut<'_>> for EntityMut<'w>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for EntityMut<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EntityMut<'_>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EntityMut<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for EntityMut<'_>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

EntityMut’s comparison trait implementations match the underlying Entity, and cannot discern between different worlds.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> QueryData for EntityMut<'a>

SAFETY: access of EntityRef is a subset of EntityMut

const IS_READ_ONLY: bool = false

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

type ReadOnly = EntityRef<'a>

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

type Item<'w> = EntityMut<'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.

unsafe fn fetch<'w>( world: &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 an entity in the current archetype. Accesses components registered in WorldQuery::update_component_access.

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

type Error = TryFromFilteredError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromFilteredError

The type returned in the event of a conversion error.

fn try_from(entity: FilteredEntityMut<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> WorldQuery for EntityMut<'a>

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

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

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

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.

fn shrink_fetch<'wlong: 'wshort, 'wshort>( fetch: Self::Fetch<'wlong>, ) -> Self::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::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.

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.

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.

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)

Creates and initializes a State for this WorldQuery type.

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

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 EntityEquivalent for EntityMut<'_>

impl Eq for EntityMut<'_>