Merge pull request #451 from daboross/patch-1

Document that CollidingEntities requires ActiveEvents::COLLISION_EVENTS
dimforge · Dec 10, 2023 · c6bcce4 · c6bcce4
2 parents ec1a6f7 + 58717c3
commit c6bcce4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/geometry/collider.rs b/src/geometry/collider.rs
@@ -493,7 +493,9 @@ impl Default for ContactForceEventThreshold {
 /// Component which will be filled (if present) with a list of entities with which the current
 /// entity is currently in contact.
 ///
-/// This currently only updates when on an entity with a `Collider`.
+/// This currently only updates when on an entity with a `Collider`, and if the
+/// [`ActiveEvents::COLLISION_EVENTS`] is set on this entity or the entity it
+/// collided with.
 #[derive(Component, Default, Reflect)]
 #[reflect(Component)]
 pub struct CollidingEntities(pub(crate) HashSet<Entity>);