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

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

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

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

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

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 unsafe fn get_unchecked_mut<T>(&self) -> Option<Mut<'_, T>>where
    T: Component,

Gets a mutable reference to the component of type T associated with this entity without ensuring there are no other borrows active and without ensuring that the returned reference will stay valid.

Safety

• The returned reference must never alias a mutable borrow of this component.
• The returned reference must not be used after this component is moved which may happen from any insert_component, remove_component or despawn operation on this world (non-exhaustive list).

pub fn insert_bundle<T>(&mut self, bundle: T) -> &mut EntityMut<'w>where
    T: Bundle,

👎Deprecated since 0.9.0: Use insert instead, which now accepts bundles, components, and tuples of bundles and components.

pub fn insert<T>(&mut self, bundle: T) -> &mut EntityMut<'w>where
    T: Bundle,

Adds a Bundle of components to the entity.

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

pub fn remove_bundle<T>(&mut self) -> Option<T>where
    T: Bundle,

👎Deprecated since 0.9.0: Use remove instead, which now accepts bundles, components, and tuples of bundles and components.

pub fn remove<T>(&mut self) -> Option<T>where
    T: Bundle,

Removes a Bundle of components from the entity and returns the bundle.

Returns None if the entity does not contain the bundle.

pub fn remove_bundle_intersection<T>(&mut self)where
    T: Bundle,

👎Deprecated since 0.9.0: Use remove_intersection instead, which now accepts bundles, components, and tuples of bundles and components.

pub fn remove_intersection<T>(&mut self)where
    T: Bundle,

Remove any components in the bundle that the entity has.

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(&mut self, f: impl FnOnce(&mut World))

Gives mutable access to this EntityMut’s World in a temporary scope.

pub fn update_location(&mut self)

Updates the internal entity location to match the current location in the internal World. This is only needed if the user called EntityMut::world, 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> BuildWorldChildren for EntityMut<'w>

fn with_children(
    &mut self,
    spawn_children: impl FnOnce(&mut WorldChildBuilder<'_>)
) -> &mut EntityMut<'w>

Creates a WorldChildBuilder with the given children built in the given closure

fn push_children(&mut self, children: &[Entity]) -> &mut EntityMut<'w>

Pushes children to the back of the builder’s children

fn insert_children(
    &mut self,
    index: usize,
    children: &[Entity]
) -> &mut EntityMut<'w>

Inserts children at the given index

fn remove_children(&mut self, children: &[Entity]) -> &mut EntityMut<'w>

Removes the given children

impl<'w> DespawnRecursiveExt for EntityMut<'w>

fn despawn_recursive(self)

Despawns the provided entity and its children.

fn despawn_descendants(&mut self)

Despawns all descendants of the given entity.

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

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

Converts to this type from the input type.