Skip to content

Commit

Permalink
Document that CollidingEntities requires ActiveEvents::COLLISION_EVENTS
Browse files Browse the repository at this point in the history
Looks like this may not have been the case before. I ran into this trying to use CollidingEntities, and was only able to find the cause after looking into its implementation.
  • Loading branch information
daboross committed Nov 23, 2023
1 parent cec05c3 commit 58717c3
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/geometry/collider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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>);
Expand Down

0 comments on commit 58717c3

Please sign in to comment.