Struct legion::world::Entry

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

Provides safe read and write access to an entity’s components, and the ability to modify the entity.

Implementations

impl<'a> Entry<'a>

pub fn archetype(&self) -> &Archetype

Returns the entity’s archetype.

pub fn location(&self) -> EntityLocation

Returns the entity’s location.

pub fn into_component<T: Component>(self) -> Result<&'a T, ComponentError>

Returns a reference to one of the entity’s components.

pub fn into_component_mut<T: Component>(
    self
) -> Result<&'a mut T, ComponentError>

Returns a mutable reference to one of the entity’s components.

pub unsafe fn into_component_unchecked<T: Component>(
    self
) -> Result<&'a mut T, ComponentError>

Returns a mutable reference to one of the entity’s components.

Safety

This function bypasses static borrow checking. The caller must ensure that the component reference will not be mutably aliased.

pub fn get_component<T: Component>(&self) -> Result<&T, ComponentError>

Returns a reference to one of the entity’s components.

pub fn get_component_mut<T: Component>(
    &mut self
) -> Result<&mut T, ComponentError>

Returns a mutable reference to one of the entity’s components.

pub unsafe fn get_component_unchecked<T: Component>(
    &self
) -> Result<&mut T, ComponentError>

Returns a mutable reference to one of the entity’s components.

Safety

This function bypasses static borrow checking. The caller must ensure that the component reference will not be mutably aliased.

pub fn add_component<T: Component>(&mut self, component: T)

Adds a new component to the entity. If the component already exists, its value will be replaced.

pub fn remove_component<T: Component>(&mut self)

Removes a component from the entity. Does nothing if the entity does not have the component.