Struct ChildBuilder

pub struct ChildBuilder<'a> { /* private fields */ }

Struct for building children entities and adding them to a parent entity.

Example

This example creates three entities, a parent and two children.

commands.spawn(MyBundle {}).with_children(|child_builder| {
    child_builder.spawn(MyChildBundle {});
    child_builder.spawn(MyChildBundle {});
});

Trait Implementations

impl ChildBuild for ChildBuilder<'_>

type SpawnOutput<'a> = EntityCommands<'a> where ChildBuilder<'_>: 'a

Spawn output type. Both spawn and spawn_empty return an implementation of this type so that children can be operated on via method-chaining. Implementations of ChildBuild reborrow self when spawning entities (see Commands::spawn_empty and World::get_entity_mut). Lifetime 'a corresponds to this reborrowed self, and Self outlives it.

fn spawn(&mut self, bundle: impl Bundle) -> EntityCommands<'_>

Spawns an entity with the given bundle and inserts it into the parent entity’s Children. Also adds Parent component to the created entity.

fn spawn_empty(&mut self) -> EntityCommands<'_>

Spawns an Entity with no components and inserts it into the parent entity’s Children. Also adds Parent component to the created entity.

fn parent_entity(&self) -> Entity

Returns the parent entity.

fn enqueue_command<C>(&mut self, command: C) -> &mut ChildBuilder<'_>

where C: Command,

Adds a command to be executed, like Commands::queue.