pub struct ChildBuilder<'a> { /* private fields */ }Expand description
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§
Source§impl ChildBuild for ChildBuilder<'_>
impl ChildBuild for ChildBuilder<'_>
Source§type SpawnOutput<'a> = EntityCommands<'a>
where
Self: 'a
type SpawnOutput<'a> = EntityCommands<'a> where Self: '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.Source§fn spawn(&mut self, bundle: impl Bundle) -> EntityCommands<'_>
fn spawn(&mut self, bundle: impl Bundle) -> EntityCommands<'_>
Source§fn spawn_empty(&mut self) -> EntityCommands<'_>
fn spawn_empty(&mut self) -> EntityCommands<'_>
Source§fn parent_entity(&self) -> Entity
fn parent_entity(&self) -> Entity
Returns the parent entity.
Source§fn enqueue_command<C: Command>(&mut self, command: C) -> &mut Self
fn enqueue_command<C: Command>(&mut self, command: C) -> &mut Self
Adds a command to be executed, like
Commands::queue.Auto Trait Implementations§
impl<'a> Freeze for ChildBuilder<'a>
impl<'a> RefUnwindSafe for ChildBuilder<'a>
impl<'a> Send for ChildBuilder<'a>
impl<'a> Sync for ChildBuilder<'a>
impl<'a> Unpin for ChildBuilder<'a>
impl<'a> !UnwindSafe for ChildBuilder<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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.