Struct ApplyDeferred

pub struct ApplyDeferred;

A special System that instructs the executor to call System::apply_deferred on the systems that have run but not applied their Deferred system parameters (like Commands) or other system buffers.

Scheduling

ApplyDeferred systems are scheduled by default

• later in the same schedule run (for example, if a system with Commands param is scheduled in Update, all the changes will be visible in PostUpdate)
• between systems with dependencies if the dependency has deferred buffers (if system bar directly or indirectly depends on foo, and foo uses Commands param, changes to the world in foo will be visible in bar)

Notes

• This system (currently) does nothing if it’s called manually or wrapped inside a PipeSystem.
• Modifying a Schedule may change the order buffers are applied.

Trait Implementations

impl IntoSystemSet<()> for ApplyDeferred

type Set = SystemTypeSet<ApplyDeferred>

The type of SystemSet this instance converts into.

fn into_system_set(self) -> <ApplyDeferred as IntoSystemSet<()>>::Set

Converts this instance to its associated SystemSet type.

impl System for ApplyDeferred

type In = ()

The system’s input.

type Out = Result<(), BevyError>

The system’s output.

fn name(&self) -> Cow<'static, str>

Returns the system’s name.

fn component_access(&self) -> &Access<ComponentId>

Returns the system’s component Access.

fn archetype_component_access(&self) -> &Access<ArchetypeComponentId>

Returns the system’s archetype component Access.

fn is_send(&self) -> bool

Returns true if the system is Send.

fn is_exclusive(&self) -> bool

Returns true if the system must be run exclusively.

fn has_deferred(&self) -> bool

Returns true if system has deferred buffers.

unsafe fn run_unsafe( &mut self, _input: <<ApplyDeferred as System>::In as SystemInput>::Inner<'_>, _world: UnsafeWorldCell<'_>, ) -> <ApplyDeferred as System>::Out

Runs the system with the given input in the world. Unlike System::run, this function can be called in parallel with other systems and may break Rust’s aliasing rules if used incorrectly, making it unsafe to call.

fn run( &mut self, _input: <<ApplyDeferred as System>::In as SystemInput>::Inner<'_>, _world: &mut World, ) -> <ApplyDeferred as System>::Out

Runs the system with the given input in the world.

fn apply_deferred(&mut self, _world: &mut World)

Applies any Deferred system parameters (or other system buffers) of this system to the world.

fn queue_deferred(&mut self, _world: DeferredWorld<'_>)

Enqueues any Deferred system parameters (or other system buffers) of this system into the world’s command buffer.

unsafe fn validate_param_unsafe( &mut self, _world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>

Validates that all parameters can be acquired and that system can run without panic. Built-in executors use this to prevent invalid systems from running.

fn initialize(&mut self, _world: &mut World)

Initialize the system.

fn update_archetype_component_access(&mut self, _world: UnsafeWorldCell<'_>)

Update the system’s archetype component Access.

fn check_change_tick(&mut self, _change_tick: Tick)

Checks any Ticks stored on this system and wraps their value if they get too old.

fn default_system_sets(&self) -> Vec<Interned<dyn SystemSet>>

Returns the system’s default system sets.

fn get_last_run(&self) -> Tick

Gets the tick indicating the last time this system ran.

fn set_last_run(&mut self, _last_run: Tick)

Overwrites the tick indicating the last time this system ran.

fn type_id(&self) -> TypeId

Returns the TypeId of the underlying system type.

fn run_without_applying_deferred( &mut self, input: <Self::In as SystemInput>::Inner<'_>, world: &mut World, ) -> Self::Out

Runs the system with the given input in the world.

fn validate_param( &mut self, world: &World, ) -> Result<(), SystemParamValidationError>

Safe version of System::validate_param_unsafe. that runs on exclusive, single-threaded world pointer.