Struct WithRelated 

pub struct WithRelated<I>(pub I);

A SpawnableList that links already spawned entities to the root entity via relations of type I.

This is useful if the entity has already been spawned earlier or if you spawn multiple relationships link to the same entity at the same time. If you only need to do this for a single entity, consider using WithOneRelated.

let mut world = World::new();

let child2 = world.spawn(Name::new("Child2")).id();
let child3 = world.spawn(Name::new("Child3")).id();

world.spawn((
    Name::new("Root"),
    Children::spawn((
        Spawn(Name::new("Child1")),
        // This adds the already existing entities as children of Root.
        WithRelated::new([child2, child3]),
    )),
));

Tuple Fields

0: I

Implementations

impl<I> WithRelated<I>

pub fn new(iter: impl IntoIterator<IntoIter = I>) -> Self

Creates a new WithRelated from a collection of entities.

Trait Implementations

impl<R: Relationship, I: Iterator<Item = Entity>> SpawnableList<R> for WithRelated<I>

fn spawn(this: MovingPtr<'_, Self>, world: &mut World, entity: Entity)

Spawn this list of changes in a given World and relative to a given Entity. This is generally used for spawning “related” entities, such as children.

fn size_hint(&self) -> usize

Returns a size hint, which is used to reserve space for this list in a RelationshipTarget. This should be less than or equal to the actual size of the list. When in doubt, just use 0.