Enum CollisionEvent 

pub enum CollisionEvent {
    Started(ColliderHandle, ColliderHandle, CollisionEventFlags),
    Stopped(ColliderHandle, ColliderHandle, CollisionEventFlags),
}

Events triggered when two colliders start or stop touching.

Receive these through an EventHandler implementation. At least one collider must have ActiveEvents::COLLISION_EVENTS enabled.

Use for:

• Trigger zones (player entered/exited area)
• Collectible items (player touched coin)
• Sound effects (objects started colliding)
• Game logic based on contact state

Example

match event {
    CollisionEvent::Started(h1, h2, flags) => {
        println!("Colliders {:?} and {:?} started touching", h1, h2);
        if flags.contains(CollisionEventFlags::SENSOR) {
            println!("At least one is a sensor!");
        }
    }
    CollisionEvent::Stopped(h1, h2, _) => {
        println!("Colliders {:?} and {:?} stopped touching", h1, h2);
    }
}

Variants

Started(ColliderHandle, ColliderHandle, CollisionEventFlags)

Two colliders just started touching this frame.

Stopped(ColliderHandle, ColliderHandle, CollisionEventFlags)

Two colliders just stopped touching this frame.

Implementations

impl CollisionEvent

pub fn started(self) -> bool

Returns true if this is a Started event (colliders began touching).

pub fn stopped(self) -> bool

Returns true if this is a Stopped event (colliders stopped touching).

pub fn collider1(self) -> ColliderHandle

Returns the handle of the first collider in this collision.

pub fn collider2(self) -> ColliderHandle

Returns the handle of the second collider in this collision.

pub fn sensor(self) -> bool

Was at least one of the colliders involved in the collision a sensor?

pub fn removed(self) -> bool

Was at least one of the colliders involved in the collision removed?

Trait Implementations

impl Clone for CollisionEvent

fn clone(&self) -> CollisionEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollisionEvent

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

Formats the value using the given formatter.

impl Hash for CollisionEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Copy for CollisionEvent