Struct bevy::ecs::system::EntityCommands

pub struct EntityCommands<'w, 's, 'a> { /* private fields */ }

A list of commands that will be run to modify an entity.

Implementations

impl<'w, 's, 'a> EntityCommands<'w, 's, 'a>

pub fn id(&self) -> Entity

Returns the Entity id of the entity.

Example

fn my_system(mut commands: Commands) {
    let entity_id = commands.spawn().id();
}

pub fn insert_bundle(
    &mut self,
    bundle: impl Bundle
) -> &mut EntityCommands<'w, 's, 'a>

Adds a Bundle of components to the entity.

Example

fn add_combat_stats_system(mut commands: Commands, player: Res<PlayerEntity>) {
    commands.entity(player.entity).insert_bundle(CombatBundle {
        health: Health(100),
        strength: Strength(40),
        defense: Defense(20),
    });
}

pub fn insert(
    &mut self,
    component: impl Component
) -> &mut EntityCommands<'w, 's, 'a>

Adds a single Component to the entity.

Example

Self::insert can be chained with Commands::spawn.

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

    // The following statements are equivalent to above one.
    commands.spawn().insert_bundle((Component1, Component2));
    commands.spawn_bundle((Component1, Component2));
}

pub fn remove_bundle<T>(&mut self) -> &mut EntityCommands<'w, 's, 'a> where
    T: Bundle, 

Removes a Bundle of components from the entity.

See EntityMut::remove_bundle for more details.

Example

struct Dummy;
fn remove_combat_stats_system(mut commands: Commands, player: Res<PlayerEntity>) {
    commands.entity(player.entity).remove_bundle::<CombatBundle>();
}

pub fn remove<T>(&mut self) -> &mut EntityCommands<'w, 's, 'a> where
    T: Component, 

Removes a single component from the entity.

See EntityMut::remove for more details.

Example

fn convert_enemy_system(mut commands: Commands, enemy: Res<TargetEnemy>) {
    commands.entity(enemy.entity).remove::<Enemy>();
}

pub fn despawn(&mut self)

Despawns the entity.

See World::despawn for more details.

Example

fn remove_character_system(
    mut commands: Commands,
    character_to_remove: Res<CharacterToRemove>
)
{
    commands.entity(character_to_remove.entity).despawn();
}

pub fn log_components(&mut self)

Logs the components of the entity at the info level.

pub fn commands(&mut self) -> &mut Commands<'w, 's>

Returns the underlying Commands.

Trait Implementations

impl<'w, 's, 'a> BuildChildren for EntityCommands<'w, 's, 'a>

fn with_children(
    &mut self,
    spawn_children: impl FnOnce(&mut ChildBuilder<'_, '_, '_>)
) -> &mut EntityCommands<'w, 's, 'a>

Creates a ChildBuilder with the given children built in the given closure

fn add_children<T>(
    &mut self,
    spawn_children: impl FnOnce(&mut ChildBuilder<'_, '_, '_>) -> T
) -> T

Creates a ChildBuilder with the given children built in the given closure

fn push_children(
    &mut self,
    children: &[Entity]
) -> &mut EntityCommands<'w, 's, 'a>

Pushes children to the back of the builder’s children

fn insert_children(
    &mut self,
    index: usize,
    children: &[Entity]
) -> &mut EntityCommands<'w, 's, 'a>

Inserts children at the given index

fn remove_children(
    &mut self,
    children: &[Entity]
) -> &mut EntityCommands<'w, 's, 'a>

Removes the given children

fn add_child(&mut self, child: Entity) -> &mut EntityCommands<'w, 's, 'a>

Adds a single child

impl<'w, 's, 'a> DespawnRecursiveExt for EntityCommands<'w, 's, 'a>

fn despawn_recursive(self)

Despawns the provided entity and its children.

fn despawn_descendants(&mut self)

Despawns all descendants of the given entity.