Struct FlushContactStatusChangeQueue 

pub struct FlushContactStatusChangeQueue;

A Command that immediately applies all queued ContactStatusChanges to the ConstraintGraph and PhysicsIslands, rather than waiting for the next physics step.

The narrow phase and the collider/body lifecycle observers record contact status changes into the ContactStatusChangeQueue, which is normally drained during the physics step. Queuing this command forces those changes to be applied right away.

This can be useful if the constraint graph and islands need to be consistent immediately after despawning colliders or bodies outside of the physics schedule. In general however, it is best to let the physics step handle this automatically.

Example

use avian3d::{dynamics::solver::FlushContactStatusChangeQueue, prelude::*};
use bevy::prelude::*;

fn clear_scene(mut commands: Commands, bodies: Query<Entity, With<RigidBody>>) {
    for entity in &bodies {
        commands.entity(entity).despawn();
    }

    // Apply the resulting constraint graph and island changes immediately.
    commands.queue(FlushContactStatusChangeQueue);
}

Trait Implementations

impl Command for FlushContactStatusChangeQueue

type Out = ()

The return type of apply.

fn apply(self, world: &mut World)

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

fn handle_error_with( self, error_handler: impl FnOnce(BevyError, ErrorContext) + Send + 'static, ) -> impl Command<Out = ()>

where Self: Sized,

Takes a Command that returns a Result and uses a given error handler function to convert it into a Command that internally handles an error if it occurs and returns ().

fn handle_error(self) -> impl Command<Out = ()>

where Self: Sized,

Takes a Command that returns a Result and uses the fallback error handler function to convert it into a Command that internally handles an error if it occurs and returns ().

fn ignore_error(self) -> impl Command<Out = ()>

where Self: Sized,

Takes a Command that returns a Result and ignores any error that occurs.