Struct bevy_ecs::world::unsafe_world_cell::UnsafeEntityCell
source · pub struct UnsafeEntityCell<'w> { /* private fields */ }
Expand description
A interior-mutable reference to a particular Entity
and all of its components
Implementations§
source§impl<'w> UnsafeEntityCell<'w>
impl<'w> UnsafeEntityCell<'w>
sourcepub fn location(self) -> EntityLocation
pub fn location(self) -> EntityLocation
Gets metadata indicating the location where the current entity is stored.
sourcepub fn archetype(self) -> &'w Archetype
pub fn archetype(self) -> &'w Archetype
Returns the archetype that the current entity belongs to.
sourcepub fn world(self) -> UnsafeWorldCell<'w>
pub fn world(self) -> UnsafeWorldCell<'w>
Gets the world that the current entity belongs to.
sourcepub fn contains<T: Component>(self) -> bool
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
.
sourcepub fn contains_id(self, component_id: ComponentId) -> bool
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 itsComponentId
, consider usingSelf::contains_type_id
.
sourcepub fn contains_type_id(self, type_id: TypeId) -> bool
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 aTypeId
, consider usingSelf::contains_id
.
sourcepub unsafe fn get<T: Component>(self) -> Option<&'w T>
pub unsafe fn get<T: Component>(self) -> Option<&'w T>
§Safety
It is the callers responsibility to ensure that
- the
UnsafeEntityCell
has permission to access the component - no other mutable references to the component exist at the same time
sourcepub unsafe fn get_ref<T: Component>(self) -> Option<Ref<'w, T>>
pub unsafe fn get_ref<T: Component>(self) -> Option<Ref<'w, T>>
§Safety
It is the callers responsibility to ensure that
- the
UnsafeEntityCell
has permission to access the component - no other mutable references to the component exist at the same time
sourcepub unsafe fn get_change_ticks<T: Component>(self) -> Option<ComponentTicks>
pub unsafe 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.
§Safety
It is the callers responsibility to ensure that
- the
UnsafeEntityCell
has permission to access the component - no other mutable references to the component exist at the same time
sourcepub unsafe fn get_change_ticks_by_id(
&self,
component_id: ComponentId
) -> Option<ComponentTicks>
pub unsafe 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 UnsafeEntityCell::get_change_ticks
where possible and only
use this in cases where the actual component types are not known at
compile time.
§Safety
It is the callers responsibility to ensure that
- the
UnsafeEntityCell
has permission to access the component - no other mutable references to the component exist at the same time
source§impl<'w> UnsafeEntityCell<'w>
impl<'w> UnsafeEntityCell<'w>
sourcepub unsafe fn get_by_id(self, component_id: ComponentId) -> Option<Ptr<'w>>
pub unsafe fn get_by_id(self, component_id: ComponentId) -> Option<Ptr<'w>>
Gets the component of the given ComponentId
from the entity.
You should prefer to use the typed API where possible and only use this in cases where the actual component types are not known at compile time.
Unlike UnsafeEntityCell::get
, this returns a raw pointer to the component,
which is only valid while the 'w
borrow of the lifetime is active.
§Safety
It is the callers responsibility to ensure that
- the
UnsafeEntityCell
has permission to access the component - no other mutable references to the component exist at the same time
sourcepub unsafe fn get_mut_by_id(
self,
component_id: ComponentId
) -> Option<MutUntyped<'w>>
pub unsafe fn get_mut_by_id( self, component_id: ComponentId ) -> Option<MutUntyped<'w>>
Retrieves a mutable untyped reference to the given entity
’s Component
of the given ComponentId
.
Returns None
if the entity
does not have a Component
of the given type.
You should prefer to use the typed API UnsafeEntityCell::get_mut
where possible and only
use this in cases where the actual types are not known at compile time.
§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
Trait Implementations§
source§impl<'w> Clone for UnsafeEntityCell<'w>
impl<'w> Clone for UnsafeEntityCell<'w>
source§fn clone(&self) -> UnsafeEntityCell<'w>
fn clone(&self) -> UnsafeEntityCell<'w>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreimpl<'w> Copy for UnsafeEntityCell<'w>
Auto Trait Implementations§
impl<'w> Freeze for UnsafeEntityCell<'w>
impl<'w> !RefUnwindSafe for UnsafeEntityCell<'w>
impl<'w> Send for UnsafeEntityCell<'w>
impl<'w> Sync for UnsafeEntityCell<'w>
impl<'w> Unpin for UnsafeEntityCell<'w>
impl<'w> !UnwindSafe for UnsafeEntityCell<'w>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.