Struct CollisionStarted

pub struct CollisionStarted(pub Entity, pub Entity);

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

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

Unlike OnCollisionStart, 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 avian2d::prelude::*;
use bevy::prelude::*;

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

Scheduling

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

Tuple Fields

0: Entity

1: Entity

Trait Implementations

impl Clone for CollisionStarted

fn clone(&self) -> CollisionStarted

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollisionStarted

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

Formats the value using the given formatter.

impl Event for CollisionStarted

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 CollisionStarted

fn eq(&self, other: &CollisionStarted) -> 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 CollisionStarted

impl StructuralPartialEq for CollisionStarted