Struct UnsafeEntityCell

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

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

Implementations

impl<'w> UnsafeEntityCell<'w>

pub fn id(self) -> Entity

Returns the ID of the current entity.

pub fn location(self) -> EntityLocation

Gets metadata indicating the location where the current entity is stored.

pub fn archetype(self) -> &'w Archetype

Returns the archetype that the current entity belongs to.

pub fn world(self) -> UnsafeWorldCell<'w>

Gets the world that the current entity belongs to.

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.

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 its ComponentId, consider using Self::contains_type_id.

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 a TypeId, consider using Self::contains_id.

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

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

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

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

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

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

impl<'w> UnsafeEntityCell<'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

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

impl<'w> Clone for UnsafeEntityCell<'w>

fn clone(&self) -> UnsafeEntityCell<'w>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'w> Copy for UnsafeEntityCell<'w>