Struct CollisionEnded

pub struct CollisionEnded(pub Entity, pub Entity);

A buffered collision event that is sent when two colliders stop touching.

The event is only sent if one of the entities has the CollisionEventsEnabled component.

Unlike OnCollisionEnd, this event is not triggered for observers. Instead, you must use an EventReader to read the event in a system. This makes it good for efficiently processing large numbers of collision events between pairs of entities.

Example

use avian3d::prelude::*;
use bevy::prelude::*;

fn print_ended_collisions(mut collision_event_reader: EventReader<CollisionEnded>) {
    for CollisionEnded(entity1, entity2) in collision_event_reader.read() {
        println!("{entity1} and {entity2} stopped colliding");
    }
}

Scheduling

The CollisionEnded event is sent in the NarrowPhaseSet::Update system set, but can be read at any time.

Note that if one of the colliders was removed or the bounding boxes of the colliders stopped overlapping, the ContactPair between the entities was also removed, and the contact data will not be available through Collisions.

Tuple Fields

0: Entity

1: Entity

Trait Implementations

impl Clone for CollisionEnded

fn clone(&self) -> CollisionEnded

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CollisionEnded

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Event for CollisionEnded

where Self: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.

fn register_component_id(world: &mut World) -> ComponentId

Generates the ComponentId for this event type.

fn component_id(world: &World) -> Option<ComponentId>

Fetches the ComponentId for this event type, if it has already been generated.

impl PartialEq for CollisionEnded

fn eq(&self, other: &CollisionEnded) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CollisionEnded

impl StructuralPartialEq for CollisionEnded