Task-oriented pages with examples that are compiled and run by the test suite. For the exact members, read the XML documentation in your editor. The normative, bit-level descriptions for ports live in ../spec.
| Page | Read it to |
|---|---|
| Install | add the package, know the targets |
| Quick start | step a world, react to a collision, cast a ray, move a character |
| The three tiers | choose between one-liners, definitions and the raw tier |
| Events | pick per-body handlers or polled events; know the order |
| Queries, layers and filters | decide what collides and what a query sees |
| Rollback and lockstep | snapshot into a ring, restore, resimulate, hash |
| Determinism | know exactly what is guaranteed, and the coordinate rule |
| Units and sizes | avoid half-extent and degree mistakes |
| Names and conventions | handles, joint one-liners and definitions, callbacks across restore |
| Soft bodies | make a cloth, a jelly or a pressurised ball; know what they collide with and how they push rigid bodies |
| Input limits | know what is refused |
| Coming from Unity | find the name of the thing you know |