Struct flat_commands::ChildCommands

pub struct ChildCommands<'w, 's, 'a> { /* private fields */ }

Implementations

impl<'w, 's, 'a> ChildCommands<'w, 's, 'a>

pub fn with_sibling<T>(&mut self, bundle: T) -> &mut Self where
    T: Bundle, 

Create a new entity with bundle components and the same parent as the current entity. Then move to the new entity.

pub fn with_empty_sibling<T>(&mut self) -> &mut Self

Create a new empty entity and move to it.

pub fn parent_id(&self) -> Entity

return the id of the current entities parent.

Trait Implementations

impl<'w, 's, 'a> ChildPusher<'w, 's, 'a> for ChildCommands<'w, 's, 'a>

fn push_children(&mut self, children: &[Entity]) -> &mut Self

Add multiple children to the current entity by id.

impl<'w, 's, 'a> ParentCommands<'w, 's, 'a> for ChildCommands<'w, 's, 'a>

fn root_id(&self) -> Entity

returns the id of the root entity of the current hierarchy

fn id(&self) -> Entity

returns the id of the current entity

fn commands(&mut self) -> &mut Commands<'w, 's>

returns Commands

fn insert(&mut self, component: impl Component) -> &mut Self

add a component to the current entity

fn insert_bundle(&mut self, bundle: impl Bundle) -> &mut Self

add a bundle of components to the current entity

fn with_child<T>(&mut self, bundle: T) -> ChildCommands<'w, 's, '_> where
    T: Bundle, 

Create a child entity with components from bundle with the current entity as its parent. Then make it the current entity

fn with_empty_child<T>(&mut self) -> ChildCommands<'w, 's, '_>

create a child entity and make it the current entity

fn with_descendants(
    &mut self,
    local_root: impl FnOnce(&mut RootCommands<'_, '_, '_>)
) -> &mut Self

makes the current entity the root of a new local hierachy

fn add_child(&mut self, child: Entity) -> &mut Self

create a child entity but don’t advance to it.

fn with_child_batch<I>(&mut self, bundles_iter: I) -> &mut Self where
    I: IntoIterator + Send + Sync + 'static,
    I::Item: Bundle, 

create multiple children each spawned with the same bundle of components.

impl<'w, 's, 'a> WithId<'w, 's, 'a> for ChildCommands<'w, 's, 'a>

fn with_id(&mut self, f: impl FnMut(Entity)) -> &mut Self

Allows access to the current entity id in a closure.