Prozi / detect-collisions

Points, Lines, Boxes, Polygons (also hollow), Ellipses, Circles. RayCasting, offsets, rotation, scaling, bounding box padding, flags for static and ghost/trigger bodies
https://prozi.github.io/detect-collisions/
MIT License
206 stars 22 forks source link

Add docs for group property on bodies #82

Closed RedPhoenixQ closed 1 month ago

RedPhoenixQ commented 2 months ago

This addresses #80 .

The documentation on the property has been kept short with links to other explanations. The example from #80 has been added to the canInteract function. A link to this function has been made from the group property to get more context of how the property is used internally.

The example will have to be kept up to date manually if the code changes, but since the functionality if already defined this is unlikely to happen.

I have intentionally not ran the pre-commit script as there seems to be code formatted with other setting currently committed. This touches almost every file and I did not want to add that.

Sorry for the long wait and lack of communication since I brough this up, but here it is.