pub struct EntityRef<'w> { /* private fields */ }
Expand description
A read-only reference to a particular Entity
and all of its components
Implementations§
§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>(&self) -> boolwhere 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<&'w 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 fn get_change_ticks_by_id(
&self,
component_id: ComponentId
) -> Option<ComponentTicks>
pub 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 EntityRef::get_change_ticks
where possible and only
use this in cases where the actual component types are not known at
compile time.
§impl<'w> EntityRef<'w>
impl<'w> EntityRef<'w>
pub fn get_by_id(&self, component_id: ComponentId) -> Option<Ptr<'w, Aligned>>
pub 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 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§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere 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>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§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.§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.