Struct EntityBuilder

pub struct EntityBuilder { /* private fields */ }

Build entities when exact set of components is not known at compile time.

Components can be added to EntityBuilder at runtime using EntityBuilder::add or EntityBuilder::with. EntityBuilder then can be used to insert components into entity or spawn a new entity.

Implementations

impl EntityBuilder

pub fn new() -> Self

Creates new empty entity builder.

pub fn with<T>(self, value: T) -> Self

where T: Component + Send,

Adds component to the builder. If builder already had this component, old value is replaced.

pub fn add<T>(&mut self, value: T) -> &mut Self

where T: Component + Send,

Adds component to the builder. If builder already had this component, old value is replaced.

pub fn get<T>(&self) -> Option<&T>

where T: 'static,

Returns reference to component from builder.

pub fn get_mut<T>(&mut self) -> Option<&mut T>

where T: 'static,

Returns mutable reference to component from builder.

pub fn component_types(&self) -> impl Iterator<Item = &ComponentInfo>

Returns iterator over component types in this builder.

pub fn is_empty(&self) -> bool

Returns true of the builder is empty.

Trait Implementations

impl Debug for EntityBuilder

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

Formats the value using the given formatter.

impl Drop for EntityBuilder

fn drop(&mut self)

Executes the destructor for this type.

impl DynamicBundle for EntityBuilder

fn valid(&self) -> bool

Returns true if given bundle is valid.

fn contains_id(&self, ty: TypeId) -> bool

Returns true if bundle has specified type id.

fn with_ids<R>(&self, f: impl FnOnce(&[TypeId]) -> R) -> R

Calls provided closure with slice of ids of types that this bundle contains.

fn put(self, f: impl FnMut(NonNull<u8>, TypeId, usize))

Calls provided closure with pointer to a component, its type and size. Closure is expected to read components from the pointer and take ownership.

fn key() -> Option<TypeId>

Returns static key if the bundle type have one.

impl DynamicComponentBundle for EntityBuilder

fn with_components<R>(&self, f: impl FnOnce(&[ComponentInfo]) -> R) -> R

Calls provided closure with slice of component infos of types that this bundle contains.

impl Send for EntityBuilder