Struct AsyncEntity

pub struct AsyncEntity { /* private fields */ }

Represents an Entity that can be manipulated asynchronously.

The easiest way to get an AsyncEntity is with AsyncWorld::spawn_empty().

Dropping the AsyncEntity WILL NOT despawn the corresponding entity in the synchronous world. Use AsyncEntity::despawn to despawn an entity asynchronously.

Implementations

impl AsyncEntity

pub fn id(&self) -> Entity

Returns the underlying Entity being represented.

pub fn sender(&self) -> CommandQueueSender

Returns a copy of the underlying CommandQueueSender.

pub async fn despawn(self)

Recursively despawns the represented entity.

pub async fn insert<B: Bundle>(&self, bundle: B)

Adds a Bundle of components to the entity. This will overwrite any previous value(s) of the same component type.

pub async fn remove<B: Bundle>(&self)

Removes a Bundle of components from the entity.

pub async fn start_waiting_for<C: Component + Clone>(&self) -> AsyncComponent<C>

Start waiting for the Component of a given type. Returns an AsyncComponent which can be further waited to receive the value of the component.

AsyncComponent::wait_for().await is equivalent to AsyncComponent::start_waiting_for().await.wait().await.

pub async fn wait_for<C: Component + Clone>(&self) -> C

Wait for the Component of a given type. Returns the value of the component, once it exists on the represented entity.

AsyncComponent::wait_for().await is equivalent to AsyncComponent::start_waiting_for().await.wait().await.

pub async fn insert_wait_remove<I: Component, WR: Component + Clone>( &self, component: I, ) -> WR

Insert the given Component of type I onto the entity, then immediately wait for a component of type WR to be added to the entity. After one is received, this will then remove the component of type WR.

Trait Implementations

impl Debug for AsyncEntity

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

Formats the value using the given formatter.