Struct Commands

pub struct Commands<'a> { /* private fields */ }

Available on crate feature ecs only.

A SystemParameter that allows you to create/destroy Entitys, add/remove Components, etc

Implementations

impl Commands<'_>

pub fn create_entity<B>(&mut self, bundle: B)

where B: ComponentBundle,

Creates an Entity

pub fn destroy_entity(&mut self, entity: Entity)

Schedules an Entity to be destroyed along with all its attached components This does not error if the Entity is already destroyed

pub fn add_components<B>(&mut self, entity: Entity, bundle: B)

where B: ComponentBundle,

Adds a bundle of Components to an Entity, any Components that are already attached will be replaced This does not error if the Entity is invalid/destroyed

pub fn remove_components<B>(&mut self, entity: Entity)

where B: ComponentBundle,

Removes a bundle of Components from an Entity This does not error if the Entity is invalid/destroyed or any of the Components are not attached to this Entity

pub fn schedule(&mut self, f: impl FnOnce(&mut App) + Send + 'static)

Schedules an arbitrary closure to be run after the current SystemSet has finished

Trait Implementations

impl<'a> SystemParameter for Commands<'a>

type This<'this> = Commands<'this>

The type that this trait is implemented on, but with a different lifetime

type Lock<'state> = &'state Sender<Box<dyn FnOnce(&mut App) + Send>>

The lock returned by SystemParameter::lock

fn lock<'state>( state: &SystemRunState<'state>, ) -> <Commands<'a> as SystemParameter>::Lock<'state>

Locks any state required for this SystemParameter

fn construct<'this>( state: &'this mut <Commands<'a> as SystemParameter>::Lock<'_>, last_run_tick: u64, ) -> <Commands<'a> as SystemParameter>::This<'this>

Constructs the SystemParameter from a lock

fn get_resource_types() -> impl Iterator<Item = Borrow>

Returns an iterator over all Resource types that this system parameter will lock

fn get_component_types() -> impl Iterator<Item = Borrow>

Returns an iterator over all Component types that this system parameter will lock