Enum CollisionEvent

pub enum CollisionEvent {
    Started(CollisionData, CollisionData),
    Stopped(CollisionData, CollisionData),
}

An event fired when the collision state between two entities changed

Example

fn detect_collisions(mut events: EventReader<CollisionEvent>) {
    for event in events.iter() {
        match event {
            CollisionEvent::Started(data1, data2) => {
                println!("Entity {:?} and {:?} started to collide", data1.rigid_body_entity(), data2.rigid_body_entity())
            }
            CollisionEvent::Stopped(data1, data2) => {
                println!("Entity {:?} and {:?} stopped to collide", data1.rigid_body_entity(), data2.rigid_body_entity())
            }
        }
    }
}

Variants

Started(CollisionData, CollisionData)

The two entities started to collide

Stopped(CollisionData, CollisionData)

The two entities no longer collide

Implementations

impl CollisionEvent

pub fn is_started(&self) -> bool

Returns true if the event represent the “start” of a collision

pub fn is_stopped(&self) -> bool

Returns true if the event represent the “end” of a collision

pub fn data(self) -> (CollisionData, CollisionData)

Returns the data for the two entities that collided

pub fn collision_shape_entities(&self) -> (Entity, Entity)

Returns the entities containing the CollisionShape involved in the collision

pub fn rigid_body_entities(&self) -> (Entity, Entity)

Returns the entities containing the RigidBody involved in the collision

pub fn collision_layers(&self) -> (CollisionLayers, CollisionLayers)

Returns the two CollisionLayers involved in the collision

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 From<CollisionEvent> for (CollisionData, CollisionData)

fn from(event: CollisionEvent) -> Self

Converts to this type from the input type.