Trait oxygengine_core::ecs::prelude::Builder

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

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>(self, c: C) -> Self where
    C: Component, 

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.

Implementors

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

pub fn with<T>(self, c: T) -> EntityBuilder<'a> where
    T: Component, 

Inserts a component for this entity.

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

pub 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>

pub fn with<C>(self, component: C) -> LazyBuilder<'a> where
    C: Component, 

Inserts a component using LazyUpdate.

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

pub 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.