Struct bevy_ecs::world::EntityMut

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

A mutable reference to a particular Entity and all of its components

Implementations

impl<'w> EntityMut<'w>

pub fn id(&self) -> Entity

pub fn location(&self) -> EntityLocation

pub fn archetype(&self) -> &Archetype

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

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

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

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

pub fn get_mut<T: Component>(&mut self) -> Option<Mut<'_, T>>

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

pub fn insert<T: Bundle>(&mut self, bundle: T) -> &mut Self

Adds a Bundle of components to the entity.

This will overwrite any previous value(s) of the same component type.

pub fn take<T: Bundle>(&mut self) -> Option<T>

Removes all components in the Bundle from the entity and returns their previous values.

Note: If the entity does not have every component in the bundle, this method will not remove any of them.

pub fn remove<T: Bundle>(&mut self) -> &mut Self

Removes any components in the Bundle from the entity.

pub fn despawn(self)

pub fn world(&self) -> &World

pub unsafe fn world_mut(&mut self) -> &mut World

Returns this EntityMut’s world.

See EntityMut::world_scope or EntityMut::into_world_mut for a safe alternative.

Safety

Caller must not modify the world in a way that changes the current entity’s location If the caller does do something that could change the location, self.update_location() must be called before using any other methods on this EntityMut.

pub fn into_world_mut(self) -> &'w mut World

Return this EntityMut’s World, consuming itself.

pub fn world_scope<U>(&mut self, f: impl FnOnce(&mut World) -> U) -> U

Gives mutable access to this EntityMut’s World in a temporary scope. This is a safe alternative to using Self::world_mut.

Examples

#[derive(Resource, Default, Clone, Copy)]
struct R(u32);

// This closure gives us temporary access to the world.
let new_r = entity.world_scope(|world: &mut World| {
    // Mutate the world while we have access to it.
    let mut r = world.resource_mut::<R>();
    r.0 += 1;
     
    // Return a value from the world before giving it back to the `EntityMut`.
    *r
});

pub fn update_location(&mut self)

Updates the internal entity location to match the current location in the internal World.

This is only required when using the unsafe function EntityMut::world_mut, which enables the location to change.

impl<'w> EntityMut<'w>

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 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 a raw pointer to the component, which is only valid while the EntityMut is alive.

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 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 a raw pointer to the component, which is only valid while the EntityMut is alive.

Trait Implementations

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

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

Converts to this type from the input type.