Struct WithOneRelated

pub struct WithOneRelated(pub Entity);

A wrapper over an Entity indicating that an entity should be added. This is intended to be used for hierarchical spawning via traits like SpawnableList and SpawnRelated.

Unlike WithRelated this only adds one entity.

Also see the children and related macros that abstract over the Spawn API.

let mut world = World::new();

let child1 = world.spawn(Name::new("Child1")).id();

world.spawn((
    Name::new("Root"),
    Children::spawn((
        // This adds the already existing entity as a child of Root.
        WithOneRelated(child1),
    )),
));

Tuple Fields

0: Entity

Trait Implementations

impl<R: Relationship> SpawnableList<R> for WithOneRelated

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.