Struct ChildBundle

pub struct ChildBundle<B: Bundle>(pub B);

A component that, when added to an entity, will add a child entity with the given bundle.

This component will be removed from the entity, as its data is moved into the child entity.

You can add multiple children in this way, if and only if their bundle types are distinct. See ChildBundles for a version that supports adding multiple children of the same type.

Under the hood, this is done using component lifecycle hooks.

use bevy_ecs::prelude::*;
use bevy_bundletree::ChildBundle;

#[derive(Component)]
struct A;

#[derive(Component)]
struct B(u8);

fn spawn_hierarchy(mut commands: Commands) {
  commands.spawn(
   (A, // Parent
    ChildBundle( // This component is removed on spawn
      (A, B(3)) // Child
    )
  ));
}

Tuple Fields

0: B

Trait Implementations

impl<B: Clone + Bundle> Clone for ChildBundle<B>

fn clone(&self) -> ChildBundle<B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B: Bundle> Component for ChildBundle<B>

const STORAGE_TYPE: StorageType = StorageType::SparseSet

This is a sparse set component as it’s only ever added and removed, never iterated over.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn register_required_components( _component_id: ComponentId, _components: &mut Components, _storages: &mut Storages, _required_components: &mut RequiredComponents, _inheritance_depth: u16, )

Registers required components.

impl<B: Debug + Bundle> Debug for ChildBundle<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: Default + Bundle> Default for ChildBundle<B>

fn default() -> ChildBundle<B>

Returns the “default value” for a type.