pub struct EntityMut<'w> { /* private fields */ }
Expand description
A mutable reference to a particular Entity
and all of its components
Implementations
impl<'w> EntityMut<'w>
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<&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,
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,
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
ordespawn
operation on this world (non-exhaustive list).
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,
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 fn update_location(&mut self)
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>
impl<'w> EntityMut<'w>
pub fn get_by_id(&self, component_id: ComponentId) -> Option<Ptr<'_>>
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<'_>>
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>
impl<'w> BuildWorldChildren for EntityMut<'w>
fn with_children(
&mut self,
spawn_children: impl FnOnce(&mut WorldChildBuilder<'_>)
) -> &mut 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>
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>
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>
fn remove_children(&mut self, children: &[Entity]) -> &mut EntityMut<'w>
Removes the given children
impl<'w> DespawnRecursiveExt for EntityMut<'w>
impl<'w> DespawnRecursiveExt for EntityMut<'w>
fn despawn_recursive(self)
fn despawn_recursive(self)
Despawns the provided entity and its children.
fn despawn_descendants(&mut self)
fn despawn_descendants(&mut self)
Despawns all descendants of the given entity.
Auto Trait Implementations
impl<'w> !RefUnwindSafe for EntityMut<'w>
impl<'w> Send for EntityMut<'w>
impl<'w> Sync for EntityMut<'w>
impl<'w> Unpin for EntityMut<'w>
impl<'w> !UnwindSafe for EntityMut<'w>
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
Return the T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
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. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more