Trait bevy::ecs::bundle::Bundle

pub unsafe trait Bundle: 'static + Send + Sync {
    fn component_ids(
        components: &mut Components, 
        storages: &mut Storages
    ) -> Vec<ComponentId, Global>;
    unsafe fn from_components(func: impl FnMut() -> *mut u8) -> Self;
    fn get_components(self, func: impl FnMut(*mut u8));
}

An ordered collection of Components.

Commonly used for spawning entities and adding and removing components in bulk. This trait is automatically implemented for tuples of components: (ComponentA, ComponentB) is a very convenient shorthand when working with one-off collections of components. Note that both the unit type () and (ComponentA, ) are valid bundles. The unit bundle is particularly useful for spawning multiple empty entities by using Commands::spawn_batch.

Examples

Typically, you will simply use #[derive(Bundle)] when creating your own Bundle. Each struct field is a component:

#[derive(Bundle)]
struct MyBundle {
    a: ComponentA,
    b: ComponentB,
    c: ComponentC,
}

You can nest bundles using the #[bundle] attribute:

#[derive(Component)]
struct X(i32);
#[derive(Component)]
struct Y(u64);
#[derive(Component)]
struct Z(String);

#[derive(Bundle)]
struct A {
    x: X,
    y: Y,
}

#[derive(Bundle)]
struct B {
    #[bundle]
    a: A,
    z: Z,
}

Safety

• Bundle::component_ids must return the ComponentId for each component type in the bundle, in the exact order that Bundle::get_components is called.
• Bundle::from_components must call func exactly once for each ComponentId returned by Bundle::component_ids.

Required Methods

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

Gets this Bundle’s component ids, in the order of this bundle’s Components

unsafe fn from_components(func: impl FnMut() -> *mut u8) -> Self

Calls func, which should return data for each component in the bundle, in the order of this bundle’s Components

Safety

Caller must return data for each component in the bundle, in the order of this bundle’s Components

fn get_components(self, func: impl FnMut(*mut u8))

Calls func on each value, in the order of this bundle’s Components. This will std::mem::forget the bundle fields, so callers are responsible for dropping the fields if that is desirable.

Implementations on Foreign Types

impl<C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component,
    C8: Component,
    C9: Component,
    C10: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6, C7, C8> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7, C8) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component,
    C8: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7, C8)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0> Bundle for (C0,) where
    C0: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(func: impl FnMut() -> *mut u8) -> (C0,)

fn get_components(self, func: impl FnMut(*mut u8))

impl Bundle for ()

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(func: impl FnMut() -> *mut u8)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component,
    C8: Component,
    C9: Component,
    C10: Component,
    C11: Component,
    C12: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6, C7, C8, C9> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component,
    C8: Component,
    C9: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1> Bundle for (C0, C1) where
    C0: Component,
    C1: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(func: impl FnMut() -> *mut u8) -> (C0, C1)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2> Bundle for (C0, C1, C2) where
    C0: Component,
    C1: Component,
    C2: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(func: impl FnMut() -> *mut u8) -> (C0, C1, C2)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5> Bundle for (C0, C1, C2, C3, C4, C5) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6> Bundle for (C0, C1, C2, C3, C4, C5, C6) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12, C13, C14> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12, C13, C14) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component,
    C8: Component,
    C9: Component,
    C10: Component,
    C11: Component,
    C12: Component,
    C13: Component,
    C14: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12, C13, C14)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12, C13> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12, C13) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component,
    C8: Component,
    C9: Component,
    C10: Component,
    C11: Component,
    C12: Component,
    C13: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11, C12, C13)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3> Bundle for (C0, C1, C2, C3) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(func: impl FnMut() -> *mut u8) -> (C0, C1, C2, C3)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6, C7> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4> Bundle for (C0, C1, C2, C3, C4) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(func: impl FnMut() -> *mut u8) -> (C0, C1, C2, C3, C4)

fn get_components(self, func: impl FnMut(*mut u8))

impl<C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11> Bundle for (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11) where
    C0: Component,
    C1: Component,
    C2: Component,
    C3: Component,
    C4: Component,
    C5: Component,
    C6: Component,
    C7: Component,
    C8: Component,
    C9: Component,
    C10: Component,
    C11: Component, 

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> (C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, C11)

fn get_components(self, func: impl FnMut(*mut u8))

Implementors

impl Bundle for DirectionalLightBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for PointLightBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for SpriteBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for SpriteSheetBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for Text2dBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for TransformBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for ButtonBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for ImageBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for NodeBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl Bundle for TextBundle

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl<M> Bundle for MaterialMeshBundle<M> where
    M: SpecializedMaterial, 

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl<M> Bundle for OrthographicCameraBundle<M> where
    M: Component, 

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl<M> Bundle for PerspectiveCameraBundle<M> where
    M: Component, 

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl<M> Bundle for MaterialMesh2dBundle<M> where
    M: SpecializedMaterial2d, 

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

impl<M> Bundle for UiCameraBundle<M> where
    M: Component, 

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order