Struct bevy_ecs::system::EntityCommands

pub struct EntityCommands<'a, 'b> { /* fields omitted */ }

Implementations

impl<'a, 'b> EntityCommands<'a, 'b>

pub fn id(&self) -> Entity

Retrieves the current entity’s unique Entity id.

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

Adds a bundle of components to the current entity.

See [Self::with], [Self::current_entity].

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

Adds a single component to the current entity.

See Self::insert_bundle, Self::id.

Warning

It’s possible to call this with a bundle, but this is likely not intended and Self::insert_bundle should be used instead. If with is called with a bundle, the bundle itself will be added as a component instead of the bundles’ inner components each being added.

Example

Self::insert can be chained with [Self::spawn].

use bevy_ecs::prelude::*;

struct Component1;
struct Component2;

fn example_system(mut commands: Commands) {
    // Create a new entity with `Component1` and `Component2`
    commands.spawn()
        .insert(Component1)
        .insert(Component2);

    // Psst! These are also equivalent to the expression above!
    commands.spawn().insert_bundle((Component1, Component2));
    commands.spawn_bundle((Component1, Component2));
}

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

See crate::world::EntityMut::remove_bundle.

pub fn remove<T>(&mut self) -> &mut Self where
    T: Component, 

See crate::world::EntityMut::remove.

pub fn despawn(&mut self)

Despawns only the specified entity, not including its children.

pub fn commands(&mut self) -> &mut Commands<'a>