Trait valence::ecs::world::Command

pub trait Command: Send + 'static {
    // Required method
    fn apply(self, world: &mut World);
}
Expand description

A World mutation.

Should be used with Commands::add.

§Usage

// Our world resource
#[derive(Resource, Default)]
struct Counter(u64);

// Our custom command
struct AddToCounter(u64);

impl Command for AddToCounter {
    fn apply(self, world: &mut World) {
        let mut counter = world.get_resource_or_insert_with(Counter::default);
        counter.0 += self.0;
    }
}

fn some_system(mut commands: Commands) {
    commands.add(AddToCounter(42));
}

Required Methods§

fn apply(self, world: &mut World)

Applies this command, causing it to mutate the provided world.

This method is used to define what a command “does” when it is ultimately applied. Because this method takes self, you can store data or settings on the type that implements this trait. This data is set by the system or other source of the command, and then ultimately read in this method.

Implementations on Foreign Types§

§

impl Command for ClearChildren

§

fn apply(self, world: &mut World)

§

impl Command for DespawnChildrenRecursive

§

fn apply(self, world: &mut World)

§

impl Command for DespawnRecursive

§

fn apply(self, world: &mut World)

§

impl Command for InsertChildren

§

fn apply(self, world: &mut World)

§

impl Command for PushChild

§

fn apply(self, world: &mut World)

§

impl Command for PushChildren

§

fn apply(self, world: &mut World)

§

impl Command for RemoveChildren

§

fn apply(self, world: &mut World)

§

impl Command for RemoveParent

§

fn apply(self, world: &mut World)

§

impl Command for ReplaceChildren

§

fn apply(self, world: &mut World)

Implementors§

source§

impl Command for DisconnectClient

§

impl<E, Targets> Command for EmitDynamicTrigger<E, Targets>
where E: Event, Targets: TriggerTargets,

§

impl<E, Targets> Command for TriggerEvent<E, Targets>
where E: Event, Targets: TriggerTargets,

§

impl<F> Command for F
where F: FnOnce(&mut World) + Send + 'static,

§

impl<I> Command for RunSystemWithInput<I>
where I: 'static + Send,

§

impl<I, O> Command for RegisterSystem<I, O>
where I: 'static + Send, O: 'static + Send,

§

impl<M, C> Command for WithEntity<M, C>
where C: EntityCommand<M>, M: 'static,