Struct bevy::ecs::world::unsafe_world_cell::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

pub fn location(self) -> EntityLocation

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

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

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

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>(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.

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>(self) -> Option<Mut<'w, T>>where T: Component,

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, Aligned>>

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>