Trait specs::world::Builder

pub trait Builder {
    fn with<C: Component + Send + Sync>(self, c: C) -> Self;
    fn build(self) -> Entity;

    fn maybe_with<C: Component + Send + Sync>(self, c: Option<C>) -> Self
    where
        Self: Sized,
    { ... }
}

A common trait for EntityBuilder and LazyBuilder, allowing either to be used. Entity is definitely alive, but the components may or may not exist before a call to World::maintain.

Required methods

fn with<C: Component + Send + Sync>(self, c: C) -> Self

Appends a component and associates it with the entity.

If a component was already associated with the entity, it should overwrite the previous component.

Panics

Panics if the component hasn’t been register()ed in the World.

fn build(self) -> Entity

Finishes the building and returns the entity.

Provided methods

fn maybe_with<C: Component + Send + Sync>(self, c: Option<C>) -> Self where
    Self: Sized, 

Convenience method that calls self.with(component) if Some(component) is provided

Panics

Panics if the component hasn’t been register()ed in the World.

Implementors

impl<'a> Builder for EntityBuilder<'a>

fn with<T: Component>(self, c: T) -> Self

Inserts a component for this entity.

If a component was already associated with the entity, it will overwrite the previous component.

fn build(self) -> Entity

Finishes the building and returns the entity. As opposed to LazyBuilder, the components are available immediately.

impl<'a> Builder for LazyBuilder<'a>

fn with<C>(self, component: C) -> Self where
    C: Send + Sync + Component, 

Inserts a component using LazyUpdate.

If a component was already associated with the entity, it will overwrite the previous component.

fn build(self) -> Entity

Finishes the building and returns the built entity. Please note that no component is associated to this entity until you call World::maintain.