Struct EntityBuilder

pub struct EntityBuilder<'a, TS = (), CS = ()> { /* private fields */ }

A builder type which can be retrieved from the command buffer. This is the ideal use case for inserted complex entities with multiple components and tags from a command buffer. Although add_component will perform a new move operation on every addition, this allows the construction of a single insert command for an entity, but without using the actual insert command provided by the CommandBuffer

Examples

Inserting an entity using the EntityBuilder:

let mut command_buffer = CommandBuffer::new(&world);
command_buffer.start_entity()
    .with_component(Position(123.0))
    .with_component(Rotation(456.0))
    .build();
command_buffer.write(&mut world);

Implementations

impl<'a, TS, CS> EntityBuilder<'a, TS, CS>

where TS: 'static + Send + ConsFlatten, CS: 'static + Send + ConsFlatten,

pub fn with_component<C: Component>( self, component: C, ) -> EntityBuilder<'a, TS, <CS as ConsAppend<C>>::Output>

where CS: ConsAppend<C>, <CS as ConsAppend<C>>::Output: ConsFlatten,

Adds a component to this builder, returning a new builder type containing that component type and its data.

pub fn with_tag<T: Tag>( self, tag: T, ) -> EntityBuilder<'a, <TS as ConsAppend<T>>::Output, CS>

where TS: ConsAppend<T>, <TS as ConsAppend<T>>::Output: ConsFlatten,

Adds a tag to this builder, returning a new builder type containing that component type and its data.

pub fn build(self) -> Entity

where <TS as ConsFlatten>::Output: TagSet + TagLayout + for<'b> Filter<ChunksetFilterData<'b>>, ComponentTupleSet<<CS as ConsFlatten>::Output, Once<<CS as ConsFlatten>::Output>>: ComponentSource,

Finalizes this builder type and submits it to the CommandBuffer.