Struct EntityBuilder

Source

pub struct EntityBuilder<'w> { /* private fields */ }

Expand description

Fluent builder for constructing entities with components and tags

Obtained via world.spawn(). Allows method chaining.

§Example

let player = world.spawn()
    .insert(Health(100))
    .insert(Position { x: 0.0, y: 0.0 })
    .tag("player")
    .tag("friendly")
    .id();

Implementations§

Source §

impl<'w> EntityBuilder<'w>

Source

pub fn insert<C>(self, component: C) -> EntityBuilder<'w>
where C: Component,

Attaches a component to the entity

Components can be any type implementing Component (Debug + Send + Sync + ’static)

Source

pub fn tag(self, tag: &str) -> EntityBuilder<'w>

Attaches a tag to the entity

Tags are lightweight string labels for filtering queries. Uses a bitmask system internally for O(1) filtering.

Source

pub fn id(self) -> Entity

Completes the builder and returns the entity handle

Auto Trait Implementations§

§

impl<'w> !UnwindSafe for EntityBuilder<'w>

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §