Struct oxygengine_core::ecs::EntityRef[−][src]

pub struct EntityRef<'a> { /* fields omitted */ }

Expand description

Handle to an entity with any component types

Implementations

[src]

impl<'a> EntityRef<'a>

[src]

pub fn entity(&self) -> Entity

Get the Entity handle associated with this entity

[src]

pub fn has<T>(&self) -> bool where
T: Component,

Determine whether this entity has a T component without borrowing it

[src]

pub fn get<T>(&self) -> Option<Ref<'a, T>> where
T: Component,

Borrow the component of type T, if it exists

Panics if the component is already uniquely borrowed from another entity with the same components.

[src]

pub fn get_mut<T>(&self) -> Option<RefMut<'a, T>> where
T: Component,

Uniquely borrow the component of type T, if it exists

Panics if the component is already borrowed from another entity with the same components.

[src]

pub fn query<Q>(&self) -> QueryOne<'a, Q> where
Q: Query,

Run a query against this entity

Equivalent to invoking World::query_one on the entity. May outlive self.

Example

let mut world = World::new();
let a = world.spawn((123, true, "abc"));
// The returned query must outlive the borrow made by `get`
let mut query = world.entity(a).unwrap().query::<(&mut i32, &bool)>();
let (number, flag) = query.get().unwrap();
if *flag { *number *= 2; }
assert_eq!(*number, 246);

[src]

pub fn component_types(&self) -> impl Iterator<Item = TypeId> + 'a

Enumerate the types of the entity’s components

Convenient for dispatching component-specific logic for a single entity. For example, this can be combined with a HashMap<TypeId, Box<dyn Handler>> where Handler is some user-defined trait with methods for serialization, or to be called after spawning or before despawning to maintain secondary indices.

[src]