Struct EntityRef

pub struct EntityRef { /* private fields */ }

A handle to an entity. Provides access to components.

This handle cannot be sent to another thread, as it requires access to the main server state. To persist entity handles across thread boundaries, you may use EntityId instead.

Implementations

impl EntityRef

pub fn get<T: Component>(self) -> Result<ComponentRef<T>, ComponentError>

Gets a component of this entity.

Returns an error if the entity does not have this component or if the entity no longer exists.

pub fn get_mut<T: Component>(self) -> Result<ComponentRefMut<T>, ComponentError>

Gets a mutable reference to a component of this entity.

Returns an error if the entity does not have this component or if the entity no longer exists.

pub fn add<T: Component>(self, _component: T) -> Result<(), EntityDead>

Adds a component to this entity.

If the entity already has a component of type T, then the component is overwritten.

pub fn send_message(self, _message: &str) -> Result<(), ComponentError>

Sends a message to this entity.

Returns an error if this entity cannot receive a message. (Usually, only players and the console are capable of receiving messages.)

pub fn id(self) -> EntityId

Returns the ID of this entity. This ID can be stored for later use, usually through State::entity.

pub fn position(self) -> Result<Position, ComponentError>

Returns this entity’s Position component.

pub fn name(self) -> Result<Name, ComponentError>

Returns this entity’s Name component.

pub fn uuid(self) -> Result<Uuid, ComponentError>

Returns this entity’s Uuid component.

Trait Implementations

impl Clone for EntityRef

fn clone(&self) -> EntityRef

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EntityRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for EntityRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EntityRef

fn eq(&self, other: &EntityRef) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EntityRef

impl Eq for EntityRef

impl StructuralPartialEq for EntityRef