Some more related to colliders

src/geometry/collider.rs

@@ -67,6 +67,8 @@ pub enum ComputedColliderShape {
 /// - [`CollisionGroups`]
 /// - [`SolverGroups`]
 /// - [`ActiveCollisionTypes`]
+/// - [`ActiveEvents`]
+/// - [`ContactForceEventThreshold`]
 /// - [`CollidingEntities`]
 /// - [`ColliderScale`]
 /// - [`ColliderDisabled`]
@@ -453,16 +455,16 @@ impl From<ActiveHooks> for rapier::pipeline::ActiveHooks {
 #[derive(Default, Component, Reflect, Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
 #[reflect(Component)]
 #[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))]
-/// Flags affecting the events generated for this collider.
+/// Flags affecting the events generated for this [`Collider`].
 pub struct ActiveEvents(u32);
 
 bitflags::bitflags! {
     impl ActiveEvents: u32 {
         /// If set, Rapier will call `EventHandler::handle_collision_event`
-        /// whenever relevant for this collider.
+        /// whenever relevant for this [`Collider`].
         const COLLISION_EVENTS = 0b0001;
         /// If set, Rapier will call `EventHandler::handle_contact_force_event`
-        /// whenever relevant for this collider.
+        /// whenever relevant for this [`Collider`].
         const CONTACT_FORCE_EVENTS = 0b0010;
     }
 }
@@ -474,7 +476,10 @@ impl From<ActiveEvents> for rapier::pipeline::ActiveEvents {
     }
 }
 
-/// The total force magnitude beyond which a contact force event can be emitted.
+/// The total force magnitude beyond which a [`ContactForceEvent`] can be emitted.
+/// 
+/// This requires that the [`ActiveEvents::CONTACT_FORCE_EVENTS`] flag is set on the
+/// entity.
 #[derive(Copy, Clone, PartialEq, Component, Reflect)]
 #[reflect(Component)]
 pub struct ContactForceEventThreshold(pub f32);

src/pipeline/events.rs

@@ -10,6 +10,9 @@ use std::collections::HashMap;
 use std::sync::RwLock;
 
 /// Events occurring when two colliders start or stop colliding
+/// 
+/// This will only get triggered if the entity has the
+/// [`ActiveEvent::COLLISION_EVENTS`] flag enabled.
 #[derive(Event, Copy, Clone, Debug, PartialEq, Eq)]
 pub enum CollisionEvent {
     /// Event occurring when two colliders start colliding
@@ -19,7 +22,10 @@ pub enum CollisionEvent {
 }
 
 /// Event occurring when the sum of the magnitudes of the contact forces
-/// between two colliders exceed a threshold.
+/// between two colliders exceed a threshold ([`ContactForceEventThreshold`]).
+/// 
+/// This will only get triggered if the entity has the
+/// [`ActiveEvent::CONTACT_FORCE_EVENTS`] flag enabled.
 #[derive(Event, Copy, Clone, Debug, PartialEq)]
 pub struct ContactForceEvent {
     /// The first collider involved in the contact.