Struct valence::ecs::system::Deferred

pub struct Deferred<'a, T>(/* private fields */)
where
    T: SystemBuffer;

A SystemParam that stores a buffer which gets applied to the World during apply_deferred. This is used internally by Commands to defer World mutations.

Examples

By using this type to defer mutations, you can avoid mutable World access within a system, which allows it to run in parallel with more systems.

Note that deferring mutations is not free, and should only be used if the gains in parallelization outweigh the time it takes to apply deferred mutations. In general, Deferred should only be used for mutations that are infrequent, or which otherwise take up a small portion of a system’s run-time.

// Tracks whether or not there is a threat the player should be aware of.
#[derive(Resource, Default)]
pub struct Alarm(bool);

#[derive(Component)]
pub struct Settlement {
    // ...
}

// A threat from inside the settlement.
#[derive(Component)]
pub struct Criminal;

// A threat from outside the settlement.
#[derive(Component)]
pub struct Monster;


use bevy_ecs::system::{Deferred, SystemBuffer, SystemMeta};

// Uses deferred mutations to allow signalling the alarm from multiple systems in parallel.
#[derive(Resource, Default)]
struct AlarmFlag(bool);

impl AlarmFlag {
    /// Sounds the alarm the next time buffers are applied via apply_deferred.
    pub fn flag(&mut self) {
        self.0 = true;
    }
}

impl SystemBuffer for AlarmFlag {
    // When `AlarmFlag` is used in a system, this function will get
    // called the next time buffers are applied via apply_deferred.
    fn apply(&mut self, system_meta: &SystemMeta, world: &mut World) {
        if self.0 {
            world.resource_mut::<Alarm>().0 = true;
            self.0 = false;
        }
    }
}

// Sound the alarm if there are any criminals who pose a threat.
fn alert_criminal(
    settlements: Query<&Settlement>,
    criminals: Query<&Criminal>,
    mut alarm: Deferred<AlarmFlag>
) {
    let settlement = settlements.single();
    for criminal in &criminals {
        // Only sound the alarm if the criminal is a threat.
        // For this example, assume that this check is expensive to run.
        // Since the majority of this system's run-time is dominated
        // by calling `is_threat()`, we defer sounding the alarm to
        // allow this system to run in parallel with other alarm systems.
        if criminal.is_threat(settlement) {
            alarm.flag();
        }
    }
}

// Sound the alarm if there is a monster.
fn alert_monster(
    monsters: Query<&Monster>,
    mut alarm: ResMut<Alarm>
) {
    if monsters.iter().next().is_some() {
        // Since this system does nothing except for sounding the alarm,
        // it would be pointless to defer it, so we sound the alarm directly.
        alarm.0 = true;
    }
}

let mut world = World::new();
world.init_resource::<Alarm>();
world.spawn(Settlement {
    // ...
});

let mut schedule = Schedule::default();
// These two systems have no conflicts and will run in parallel.
schedule.add_systems((alert_criminal, alert_monster));

// There are no criminals or monsters, so the alarm is not sounded.
schedule.run(&mut world);
assert_eq!(world.resource::<Alarm>().0, false);

// Spawn a monster, which will cause the alarm to be sounded.
let m_id = world.spawn(Monster).id();
schedule.run(&mut world);
assert_eq!(world.resource::<Alarm>().0, true);

// Remove the monster and reset the alarm.
world.entity_mut(m_id).despawn();
world.resource_mut::<Alarm>().0 = false;

// Spawn a criminal, which will cause the alarm to be sounded.
world.spawn(Criminal);
schedule.run(&mut world);
assert_eq!(world.resource::<Alarm>().0, true);

Implementations

impl<T> Deferred<'_, T>

where T: SystemBuffer,

pub fn reborrow(&mut self) -> Deferred<'_, T>

Returns a Deferred<T> with a smaller lifetime. This is useful if you have &mut Deferred<T> but need Deferred<T>.

Trait Implementations

impl<'a, T> Deref for Deferred<'a, T>

where T: SystemBuffer,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Deferred<'a, T> as Deref>::Target

Dereferences the value.

impl<'a, T> DerefMut for Deferred<'a, T>

where T: SystemBuffer,

fn deref_mut(&mut self) -> &mut <Deferred<'a, T> as Deref>::Target

Mutably dereferences the value.

impl<T> SystemParam for Deferred<'_, T>

where T: SystemBuffer,

type State = SyncCell<T>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = Deferred<'s, T>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state( world: &mut World, system_meta: &mut SystemMeta, ) -> <Deferred<'_, T> as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn apply( state: &mut <Deferred<'_, T> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

fn queue( state: &mut <Deferred<'_, T> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

unsafe fn get_param<'w, 's>( state: &'s mut <Deferred<'_, T> as SystemParam>::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, _change_tick: Tick, ) -> <Deferred<'_, T> as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

impl<T> ReadOnlySystemParam for Deferred<'_, T>

where T: SystemBuffer,