pub struct EntityRef<'w> { /* private fields */ }
Expand description
A read-only reference to a particular Entity
and all of its components
Implementations§
source§impl<'w> EntityRef<'w>
impl<'w> EntityRef<'w>
pub fn id(&self) -> Entity
pub fn location(&self) -> EntityLocation
pub fn archetype(&self) -> &Archetype
pub fn world(&self) -> &'w World
pub fn contains<T: Component>(&self) -> bool
pub fn contains_id(&self, component_id: ComponentId) -> bool
pub fn contains_type_id(&self, type_id: TypeId) -> bool
pub fn get<T: Component>(&self) -> Option<&'w T>
sourcepub fn get_change_ticks<T: Component>(&self) -> Option<&'w ComponentTicks>
pub fn get_change_ticks<T: Component>(&self) -> Option<&'w ComponentTicks>
Retrieves the change ticks for the given component. This can be useful for implementing change detection in custom runtimes.
sourcepub unsafe fn get_unchecked_mut<T: Component>(
&self,
last_change_tick: u32,
change_tick: u32
) -> Option<Mut<'w, T>>
pub unsafe fn get_unchecked_mut<T: Component>(
&self,
last_change_tick: u32,
change_tick: u32
) -> Option<Mut<'w, T>>
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).
source§impl<'w> EntityRef<'w>
impl<'w> EntityRef<'w>
sourcepub fn get_by_id(&self, component_id: ComponentId) -> Option<Ptr<'w>>
pub 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 EntityRef::get
, this returns a raw pointer to the component,
which is only valid while the 'w
borrow of the lifetime is active.
Trait Implementations§
impl<'w> Copy for EntityRef<'w>
Auto Trait Implementations§
impl<'w> !RefUnwindSafe for EntityRef<'w>
impl<'w> Send for EntityRef<'w>
impl<'w> Sync for EntityRef<'w>
impl<'w> Unpin for EntityRef<'w>
impl<'w> !UnwindSafe for EntityRef<'w>
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§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 moresource§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 moresource§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 moresource§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