Struct bevy::ecs::world::EntityMut

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

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) -> bool where
    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<&'w T> where
    T: Component, 

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

pub unsafe fn get_unchecked_mut<T>(&self) -> Option<Mut<'w, T>> where
    T: Component, 

Safety

This allows aliased mutability. You must make sure this call does not result in multiple mutable references to the same component

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

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

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

Remove any components in the bundle that the entity has.

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

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

pub fn despawn(self)

pub fn world(&mut self) -> &World

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

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 in EntityMut

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.

Trait Implementations

impl<'w> BuildWorldChildren for EntityMut<'w>

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

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

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

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

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

pub fn despawn_recursive(self)

Despawns the provided entity and its children.

pub fn despawn_descendants(&mut self)

Despawns all descendants of the given entity.