@origingame/engine 0.4.0 → 0.5.0

package/knowledge/wiki/physics.md

@@ -18,7 +18,7 @@ module physics {
   # declarations follow, each quoted below
 ```
 
-<sub>`api.ogt` line 5763</sub>
+<sub>`api.ogt` line 5808</sub>
 
 ## Contents
 
@@ -46,7 +46,7 @@ module physics {
 | [`og.Collider`](#record-Collider) | component | The shape an entity collides with, attached to its RigidBody (or, without one, a static collider at its Transform). Sizes are scaled by og.Transform.scale. |
 | [`og.Velocity`](#record-Velocity) | component | Linear and angular velocity. Written for dynamic bodies every tick (added to them by the step when missing); a kinematic body moves by it each tick (never added, never written). Set it to launch or stop a body; push one with og.physics.applyForce, applyImpulse, applyTorque or applyTorqueImpulse. |
 | [`og.Physics`](#record-Physics) | resource | The physics settings of the world. The profile is the project's; the same components serve both profiles. |
-| [`og.CollisionStarted`](#record-CollisionStarted) | event | Two solid colliders started touching during the tick. |
+| [`og.CollisionStarted`](#record-CollisionStarted) | event | Two solid colliders started touching during the tick. Read in the tick after, when og.Velocity already holds the solver's answer (the bodies parting): how hard they met is `impulse` and `relativeVelocity`, taken in the step itself. |
 | [`og.CollisionEnded`](#record-CollisionEnded) | event | Two solid colliders stopped touching, or one of them went away. |
 | [`og.SensorEntered`](#record-SensorEntered) | event | A collider started overlapping a sensor. |
 | [`og.SensorExited`](#record-SensorExited) | event | A collider stopped overlapping a sensor, or one of them went away. |
@@ -149,7 +149,7 @@ fn raycast {
 }
 ```
 
-<sub>`api.ogt` line 7086</sub>
+<sub>`api.ogt` line 7140</sub>
 
 <a id="fn-shapeCast"></a>
 
@@ -179,7 +179,7 @@ fn shapeCast {
 }
 ```
 
-<sub>`api.ogt` line 7093</sub>
+<sub>`api.ogt` line 7147</sub>
 
 <a id="fn-overlap"></a>
 
@@ -209,7 +209,7 @@ fn overlap {
 }
 ```
 
-<sub>`api.ogt` line 7100</sub>
+<sub>`api.ogt` line 7154</sub>
 
 <a id="fn-applyForce"></a>
 
@@ -245,7 +245,7 @@ fn applyForce {
 }
 ```
 
-<sub>`api.ogt` line 7107</sub>
+<sub>`api.ogt` line 7161</sub>
 
 <a id="fn-applyImpulse"></a>
 
@@ -281,7 +281,7 @@ fn applyImpulse {
 }
 ```
 
-<sub>`api.ogt` line 7118</sub>
+<sub>`api.ogt` line 7172</sub>
 
 <a id="fn-applyTorque"></a>
 
@@ -313,7 +313,7 @@ fn applyTorque {
 }
 ```
 
-<sub>`api.ogt` line 7129</sub>
+<sub>`api.ogt` line 7183</sub>
 
 <a id="fn-applyTorqueImpulse"></a>
 
@@ -345,7 +345,7 @@ fn applyTorqueImpulse {
 }
 ```
 
-<sub>`api.ogt` line 7137</sub>
+<sub>`api.ogt` line 7191</sub>
 
 <a id="fn-setMesh"></a>
 
@@ -377,7 +377,7 @@ fn setMesh {
 }
 ```
 
-<sub>`api.ogt` line 7145</sub>
+<sub>`api.ogt` line 7199</sub>
 
 <a id="fn-ropePoints"></a>
 
@@ -407,7 +407,7 @@ fn ropePoints {
 }
 ```
 
-<sub>`api.ogt` line 7206</sub>
+<sub>`api.ogt` line 7260</sub>
 
 <a id="fn-clothPoints"></a>
 
@@ -437,7 +437,7 @@ fn clothPoints {
 }
 ```
 
-<sub>`api.ogt` line 7213</sub>
+<sub>`api.ogt` line 7267</sub>
 
 <a id="fn-fluidParticles"></a>
 
@@ -467,7 +467,7 @@ fn fluidParticles {
 }
 ```
 
-<sub>`api.ogt` line 7220</sub>
+<sub>`api.ogt` line 7274</sub>
 
 <a id="fn-fluid3dParticles"></a>
 
@@ -497,7 +497,7 @@ fn fluid3dParticles {
 }
 ```
 
-<sub>`api.ogt` line 7227</sub>
+<sub>`api.ogt` line 7281</sub>
 
 <a id="fn-waterHeight"></a>
 
@@ -531,7 +531,7 @@ fn waterHeight {
 }
 ```
 
-<sub>`api.ogt` line 7234</sub>
+<sub>`api.ogt` line 7288</sub>
 
 <a id="fn-vehicleWheels"></a>
 
@@ -561,7 +561,7 @@ fn vehicleWheels {
 }
 ```
 
-<sub>`api.ogt` line 7243</sub>
+<sub>`api.ogt` line 7297</sub>
 
 <a id="fn-ragdollRigFromSkeleton"></a>
 
@@ -591,7 +591,7 @@ fn ragdollRigFromSkeleton {
 }
 ```
 
-<sub>`api.ogt` line 7250</sub>
+<sub>`api.ogt` line 7304</sub>
 
 <a id="fn-setRagdollRig"></a>
 
@@ -623,7 +623,7 @@ fn setRagdollRig {
 }
 ```
 
-<sub>`api.ogt` line 7257</sub>
+<sub>`api.ogt` line 7311</sub>
 
 <a id="fn-ragdollPose"></a>
 
@@ -653,7 +653,7 @@ fn ragdollPose {
 }
 ```
 
-<sub>`api.ogt` line 7265</sub>
+<sub>`api.ogt` line 7319</sub>
 
 <a id="fn-stats"></a>
 
@@ -681,7 +681,7 @@ fn stats {
 }
 ```
 
-<sub>`api.ogt` line 7293</sub>
+<sub>`api.ogt` line 7347</sub>
 
 ## Components, resources and events
 
@@ -753,7 +753,7 @@ component RigidBody {
 }
 ```
 
-<sub>`api.ogt` line 5788</sub>
+<sub>`api.ogt` line 5833</sub>
 
 <a id="record-Collider"></a>
 
@@ -840,7 +840,7 @@ component Collider {
 }
 ```
 
-<sub>`api.ogt` line 5833</sub>
+<sub>`api.ogt` line 5878</sub>
 
 <a id="record-Velocity"></a>
 
@@ -869,7 +869,7 @@ component Velocity {
 }
 ```
 
-<sub>`api.ogt` line 5892</sub>
+<sub>`api.ogt` line 5937</sub>
 
 <a id="record-Physics"></a>
 
@@ -923,13 +923,13 @@ resource Physics {
 }
 ```
 
-<sub>`api.ogt` line 5904</sub>
+<sub>`api.ogt` line 5949</sub>
 
 <a id="record-CollisionStarted"></a>
 
 ### `og.CollisionStarted` (event)
 
-Two solid colliders started touching during the tick.
+Two solid colliders started touching during the tick. Read in the tick after, when og.Velocity already holds the solver's answer (the bodies parting): how hard they met is `impulse` and `relativeVelocity`, taken in the step itself.
 
 Token `og.CollisionStarted`, registered under the schema name `og.CollisionStarted`; its value type is `CollisionStarted`.
 
@@ -937,20 +937,31 @@ Token `og.CollisionStarted`, registered under the schema name `og.CollisionStart
 |---|---|---|---|---|---|---|
 | `a` | `Entity` | `0` | — | — | — | The entity with the lower id. |
 | `b` | `Entity` | `0` | — | — | — | The entity with the higher id. |
-| `point` | `Vector3` | `{ x: 0, y: 0, z: 0 }` | — | — | — | The deepest contact point in world space (z is 0 in 2D). |
+| `point` | `Vector3` | `{ x: 0, y: 0, z: 0 }` | — | `m` | — | The deepest contact point in world space (z is 0 in 2D). |
 | `normal` | `Vector3` | `{ x: 0, y: 0, z: 0 }` | — | — | — | The contact normal, from a towards b. |
+| `impulse` | `number` | `0` | ≥ 0 | `newtonSecond` | — | The normal impulse the solver gave the pair in the step that made the contact (every substep, every contact point), in newton-seconds: b took `impulse` along `normal`, a the same against it. Its momentum answer to the hit, at least 0; heavier and faster hits give more. |
+| `relativeVelocity` | `Vector3` | `{ x: 0, y: 0, z: 0 }` | — | `mps` | — | a's velocity relative to b at `point` as that step began, before the solver answered: each body's linear velocity plus its angular velocity crossed with the point's offset from its centre of mass (a static collider is still; z is 0 in 2D). Along `normal` it is the closing speed, positive while they approach: max(0, relativeVelocity · normal) is how hard they hit, in m/s. |
 
 ```ogt
 event CollisionStarted {
-  doc "Two solid colliders started touching during the tick."
+  doc "Two solid colliders started touching during the tick. Read in the tick after, when og.Velocity already holds the solver's answer (the bodies parting): how hard they met is `impulse` and `relativeVelocity`, taken in the step itself."
   field a Entity "The entity with the lower id."
   field b Entity "The entity with the higher id."
-  field point Vector3 "The deepest contact point in world space (z is 0 in 2D)."
+  field point Vector3 "The deepest contact point in world space (z is 0 in 2D)." {
+    unit m
+  }
   field normal Vector3 "The contact normal, from a towards b."
+  field impulse f32 "The normal impulse the solver gave the pair in the step that made the contact (every substep, every contact point), in newton-seconds: b took `impulse` along `normal`, a the same against it. Its momentum answer to the hit, at least 0; heavier and faster hits give more." {
+    min 0
+    unit newtonSecond
+  }
+  field relativeVelocity Vector3 "a's velocity relative to b at `point` as that step began, before the solver answered: each body's linear velocity plus its angular velocity crossed with the point's offset from its centre of mass (a static collider is still; z is 0 in 2D). Along `normal` it is the closing speed, positive while they approach: max(0, relativeVelocity · normal) is how hard they hit, in m/s." {
+    unit mps
+  }
 }
 ```
 
-<sub>`api.ogt` line 5938</sub>
+<sub>`api.ogt` line 5983</sub>
 
 <a id="record-CollisionEnded"></a>
 
@@ -973,7 +984,7 @@ event CollisionEnded {
 }
 ```
 
-<sub>`api.ogt` line 5946</sub>
+<sub>`api.ogt` line 6000</sub>
 
 <a id="record-SensorEntered"></a>
 
@@ -996,7 +1007,7 @@ event SensorEntered {
 }
 ```
 
-<sub>`api.ogt` line 5952</sub>
+<sub>`api.ogt` line 6006</sub>
 
 <a id="record-SensorExited"></a>
 
@@ -1019,7 +1030,7 @@ event SensorExited {
 }
 ```
 
-<sub>`api.ogt` line 5958</sub>
+<sub>`api.ogt` line 6012</sub>
 
 <a id="record-Contact"></a>
 
@@ -1044,7 +1055,7 @@ event Contact {
 }
 ```
 
-<sub>`api.ogt` line 5964</sub>
+<sub>`api.ogt` line 6018</sub>
 
 <a id="record-Joint"></a>
 
@@ -1149,7 +1160,7 @@ component Joint {
 }
 ```
 
-<sub>`api.ogt` line 5981</sub>
+<sub>`api.ogt` line 6035</sub>
 
 <a id="record-CharacterController"></a>
 
@@ -1270,7 +1281,7 @@ component CharacterController {
 }
 ```
 
-<sub>`api.ogt` line 6051</sub>
+<sub>`api.ogt` line 6105</sub>
 
 <a id="record-PlatformerController"></a>
 
@@ -1522,7 +1533,7 @@ component PlatformerController {
 }
 ```
 
-<sub>`api.ogt` line 6138</sub>
+<sub>`api.ogt` line 6192</sub>
 
 <a id="record-CharacterEvent"></a>
 
@@ -1552,7 +1563,7 @@ event CharacterEvent {
 }
 ```
 
-<sub>`api.ogt` line 6340</sub>
+<sub>`api.ogt` line 6394</sub>
 
 <a id="record-Vehicle"></a>
 
@@ -1711,7 +1722,7 @@ component Vehicle {
 }
 ```
 
-<sub>`api.ogt` line 6356</sub>
+<sub>`api.ogt` line 6410</sub>
 
 <a id="record-Rope"></a>
 
@@ -1800,7 +1811,7 @@ component Rope {
 }
 ```
 
-<sub>`api.ogt` line 6474</sub>
+<sub>`api.ogt` line 6528</sub>
 
 <a id="record-Cloth"></a>
 
@@ -1906,7 +1917,7 @@ component Cloth {
 }
 ```
 
-<sub>`api.ogt` line 6540</sub>
+<sub>`api.ogt` line 6594</sub>
 
 <a id="record-Fluid2D"></a>
 
@@ -2030,7 +2041,7 @@ component Fluid2D {
 }
 ```
 
-<sub>`api.ogt` line 6616</sub>
+<sub>`api.ogt` line 6670</sub>
 
 <a id="record-Fluid3D"></a>
 
@@ -2199,7 +2210,7 @@ component Fluid3D {
 }
 ```
 
-<sub>`api.ogt` line 6705</sub>
+<sub>`api.ogt` line 6759</sub>
 
 <a id="record-WaterSurface"></a>
 
@@ -2264,7 +2275,7 @@ component WaterSurface {
 }
 ```
 
-<sub>`api.ogt` line 6831</sub>
+<sub>`api.ogt` line 6885</sub>
 
 <a id="record-WaterLine"></a>
 
@@ -2341,7 +2352,7 @@ component WaterLine {
 }
 ```
 
-<sub>`api.ogt` line 6874</sub>
+<sub>`api.ogt` line 6928</sub>
 
 <a id="record-Splash"></a>
 
@@ -2372,7 +2383,7 @@ event Splash {
 }
 ```
 
-<sub>`api.ogt` line 6927</sub>
+<sub>`api.ogt` line 6981</sub>
 
 <a id="record-Ragdoll"></a>
 
@@ -2440,7 +2451,7 @@ component Ragdoll {
 }
 ```
 
-<sub>`api.ogt` line 6939</sub>
+<sub>`api.ogt` line 6993</sub>
 
 ## Types
 
@@ -2468,7 +2479,7 @@ struct QueryFilter {
 }
 ```
 
-<sub>`api.ogt` line 6984</sub>
+<sub>`api.ogt` line 7038</sub>
 
 <a id="type-RaycastDesc"></a>
 
@@ -2503,7 +2514,7 @@ struct RaycastDesc {
 }
 ```
 
-<sub>`api.ogt` line 6992</sub>
+<sub>`api.ogt` line 7046</sub>
 
 <a id="type-RaycastHit"></a>
 
@@ -2530,7 +2541,7 @@ struct RaycastHit {
 }
 ```
 
-<sub>`api.ogt` line 7008</sub>
+<sub>`api.ogt` line 7062</sub>
 
 <a id="type-ShapeDesc"></a>
 
@@ -2572,7 +2583,7 @@ struct ShapeDesc {
 }
 ```
 
-<sub>`api.ogt` line 7018</sub>
+<sub>`api.ogt` line 7072</sub>
 
 <a id="type-ShapeCastDesc"></a>
 
@@ -2611,7 +2622,7 @@ struct ShapeCastDesc {
 }
 ```
 
-<sub>`api.ogt` line 7040</sub>
+<sub>`api.ogt` line 7094</sub>
 
 <a id="type-ShapeCastHit"></a>
 
@@ -2638,7 +2649,7 @@ struct ShapeCastHit {
 }
 ```
 
-<sub>`api.ogt` line 7058</sub>
+<sub>`api.ogt` line 7112</sub>
 
 <a id="type-OverlapDesc"></a>
 
@@ -2668,7 +2679,7 @@ struct OverlapDesc {
 }
 ```
 
-<sub>`api.ogt` line 7068</sub>
+<sub>`api.ogt` line 7122</sub>
 
 <a id="type-MeshDesc"></a>
 
@@ -2692,7 +2703,7 @@ struct MeshDesc {
 }
 ```
 
-<sub>`api.ogt` line 7079</sub>
+<sub>`api.ogt` line 7133</sub>
 
 <a id="type-WheelPose"></a>
 
@@ -2726,7 +2737,7 @@ struct WheelPose {
 }
 ```
 
-<sub>`api.ogt` line 7153</sub>
+<sub>`api.ogt` line 7207</sub>
 
 <a id="type-RagdollBoneDesc"></a>
 
@@ -2769,7 +2780,7 @@ struct RagdollBoneDesc {
 }
 ```
 
-<sub>`api.ogt` line 7169</sub>
+<sub>`api.ogt` line 7223</sub>
 
 <a id="type-RagdollRigDesc"></a>
 
@@ -2793,7 +2804,7 @@ struct RagdollRigDesc {
 }
 ```
 
-<sub>`api.ogt` line 7191</sub>
+<sub>`api.ogt` line 7245</sub>
 
 <a id="type-BonePose"></a>
 
@@ -2816,7 +2827,7 @@ struct BonePose {
 }
 ```
 
-<sub>`api.ogt` line 7198</sub>
+<sub>`api.ogt` line 7252</sub>
 
 <a id="type-PhysicsPhase"></a>
 
@@ -2841,7 +2852,7 @@ struct PhysicsPhase {
 }
 ```
 
-<sub>`api.ogt` line 7272</sub>
+<sub>`api.ogt` line 7326</sub>
 
 <a id="type-PhysicsStats"></a>
 
@@ -2872,7 +2883,7 @@ struct PhysicsStats {
 }
 ```
 
-<sub>`api.ogt` line 7281</sub>
+<sub>`api.ogt` line 7335</sub>
 
 ## Constants
 
@@ -2923,238 +2934,238 @@ struct PhysicsStats {
 const BODY_DYNAMIC u32 0 "RigidBody.kind: moved by the solver; its Transform and Velocity are written back every tick."
 ```
 
-<sub>`api.ogt` line 5769</sub>
+<sub>`api.ogt` line 5814</sub>
 
 ```ogt
 const BODY_STATIC u32 1 "RigidBody.kind: never moves; collides with dynamic bodies."
 ```
 
-<sub>`api.ogt` line 5770</sub>
+<sub>`api.ogt` line 5815</sub>
 
 ```ogt
 const BODY_KINEMATIC u32 2 "RigidBody.kind: not moved by the solver. With an og.Velocity the step moves it by it each tick and writes its Transform back (a lift, a conveyor, a turning gear); a Transform game code writes moves it there first (a teleport). Without one it stays where its Transform puts it. Either way it pushes dynamic bodies and carries the controllers standing on it."
 ```
 
-<sub>`api.ogt` line 5771</sub>
+<sub>`api.ogt` line 5816</sub>
 
 ```ogt
 const LOCK_TRANSLATION_X u32 1 "RigidBody.lock bit: no translation along x."
 ```
 
-<sub>`api.ogt` line 5772</sub>
+<sub>`api.ogt` line 5817</sub>
 
 ```ogt
 const LOCK_TRANSLATION_Y u32 2 "RigidBody.lock bit: no translation along y."
 ```
 
-<sub>`api.ogt` line 5773</sub>
+<sub>`api.ogt` line 5818</sub>
 
 ```ogt
 const LOCK_TRANSLATION_Z u32 4 "RigidBody.lock bit: no translation along z."
 ```
 
-<sub>`api.ogt` line 5774</sub>
+<sub>`api.ogt` line 5819</sub>
 
 ```ogt
 const LOCK_ROTATION_X u32 8 "RigidBody.lock bit: no rotation about x."
 ```
 
-<sub>`api.ogt` line 5775</sub>
+<sub>`api.ogt` line 5820</sub>
 
 ```ogt
 const LOCK_ROTATION_Y u32 16 "RigidBody.lock bit: no rotation about y."
 ```
 
-<sub>`api.ogt` line 5776</sub>
+<sub>`api.ogt` line 5821</sub>
 
 ```ogt
 const LOCK_ROTATION_Z u32 32 "RigidBody.lock bit: no rotation about z (the 2D profile's only rotation)."
 ```
 
-<sub>`api.ogt` line 5777</sub>
+<sub>`api.ogt` line 5822</sub>
 
 ```ogt
 const SHAPE_BOX u32 0 "Collider.shape: a box of `size` (both profiles)."
 ```
 
-<sub>`api.ogt` line 5778</sub>
+<sub>`api.ogt` line 5823</sub>
 
 ```ogt
 const SHAPE_SPHERE u32 1 "Collider.shape: a sphere of `radius` (a circle in 2D)."
 ```
 
-<sub>`api.ogt` line 5779</sub>
+<sub>`api.ogt` line 5824</sub>
 
 ```ogt
 const SHAPE_CAPSULE u32 2 "Collider.shape: a capsule along y of `radius`, with `height` between the cap centres (both profiles)."
 ```
 
-<sub>`api.ogt` line 5780</sub>
+<sub>`api.ogt` line 5825</sub>
 
 ```ogt
 const SHAPE_CYLINDER u32 3 "Collider.shape: a cylinder along y of `radius` and `height` (3D only)."
 ```
 
-<sub>`api.ogt` line 5781</sub>
+<sub>`api.ogt` line 5826</sub>
 
 ```ogt
 const SHAPE_CONVEX u32 4 "Collider.shape: the convex hull of the vertices of `mesh` (3D), or of their xy (a convex polygon, 2D)."
 ```
 
-<sub>`api.ogt` line 5782</sub>
+<sub>`api.ogt` line 5827</sub>
 
 ```ogt
 const SHAPE_TRIMESH u32 5 "Collider.shape: the triangles of `mesh` (3D only; for static and kinematic bodies)."
 ```
 
-<sub>`api.ogt` line 5783</sub>
+<sub>`api.ogt` line 5828</sub>
 
 ```ogt
 const SHAPE_HEIGHTFIELD u32 6 "Collider.shape: the height field registered as `mesh`, centred on the entity (3D only; a terrain: og.terrain.load's TerrainInfo.geometry)."
 ```
 
-<sub>`api.ogt` line 5784</sub>
+<sub>`api.ogt` line 5829</sub>
 
 ```ogt
 const PROFILE_2D u32 2 "Physics.profile: rapier2d, bodies in the xy plane rotating about z."
 ```
 
-<sub>`api.ogt` line 5785</sub>
+<sub>`api.ogt` line 5830</sub>
 
 ```ogt
 const PROFILE_3D u32 3 "Physics.profile: rapier3d."
 ```
 
-<sub>`api.ogt` line 5786</sub>
+<sub>`api.ogt` line 5831</sub>
 
 ```ogt
 const JOINT_FIXED u32 0 "`Joint.kind`: the two bodies move as one."
 ```
 
-<sub>`api.ogt` line 5971</sub>
+<sub>`api.ogt` line 6025</sub>
 
 ```ogt
 const JOINT_REVOLUTE u32 1 "`Joint.kind`: a hinge about `axis` (2D: about z), with optional limits and a motor."
 ```
 
-<sub>`api.ogt` line 5972</sub>
+<sub>`api.ogt` line 6026</sub>
 
 ```ogt
 const JOINT_PRISMATIC u32 2 "`Joint.kind`: a slider along `axis`, with optional limits and a motor."
 ```
 
-<sub>`api.ogt` line 5973</sub>
+<sub>`api.ogt` line 6027</sub>
 
 ```ogt
 const JOINT_SPRING u32 3 "`Joint.kind`: a damped spring pulling the anchors to `restLength` apart."
 ```
 
-<sub>`api.ogt` line 5974</sub>
+<sub>`api.ogt` line 6028</sub>
 
 ```ogt
 const JOINT_ROPE u32 4 "`Joint.kind`: a rope: the anchors stay at most `length` apart, free inside it."
 ```
 
-<sub>`api.ogt` line 5975</sub>
+<sub>`api.ogt` line 6029</sub>
 
 ```ogt
 const JOINT_BALL u32 5 "`Joint.kind`: a ball and socket (3D; the 2D profile treats it as a hinge)."
 ```
 
-<sub>`api.ogt` line 5976</sub>
+<sub>`api.ogt` line 6030</sub>
 
 ```ogt
 const MOTOR_NONE u32 0 "`Joint.motor`: no motor."
 ```
 
-<sub>`api.ogt` line 5977</sub>
+<sub>`api.ogt` line 6031</sub>
 
 ```ogt
 const MOTOR_VELOCITY u32 1 "`Joint.motor`: drive towards `motorTarget` speed (rad/s or m/s)."
 ```
 
-<sub>`api.ogt` line 5978</sub>
+<sub>`api.ogt` line 6032</sub>
 
 ```ogt
 const MOTOR_POSITION u32 2 "`Joint.motor`: spring towards `motorTarget` angle or position (a servo)."
 ```
 
-<sub>`api.ogt` line 5979</sub>
+<sub>`api.ogt` line 6033</sub>
 
 ```ogt
 const CHARACTER_JUMPED u32 1 "`CharacterEvent.kind`: a jump from the ground (or in coyote time)."
 ```
 
-<sub>`api.ogt` line 6333</sub>
+<sub>`api.ogt` line 6387</sub>
 
 ```ogt
 const CHARACTER_LANDED u32 2 "`CharacterEvent.kind`: touched the ground after being in the air."
 ```
 
-<sub>`api.ogt` line 6334</sub>
+<sub>`api.ogt` line 6388</sub>
 
 ```ogt
 const CHARACTER_WALL_JUMPED u32 3 "`CharacterEvent.kind`: a jump off a wall."
 ```
 
-<sub>`api.ogt` line 6335</sub>
+<sub>`api.ogt` line 6389</sub>
 
 ```ogt
 const CHARACTER_AIR_JUMPED u32 4 "`CharacterEvent.kind`: a jump in the air (PlatformerController.airJumps)."
 ```
 
-<sub>`api.ogt` line 6336</sub>
+<sub>`api.ogt` line 6390</sub>
 
 ```ogt
 const CHARACTER_LEFT_GROUND u32 5 "`CharacterEvent.kind`: left the ground without jumping (ran off an edge)."
 ```
 
-<sub>`api.ogt` line 6337</sub>
+<sub>`api.ogt` line 6391</sub>
 
 ```ogt
 const CHARACTER_BUMPED u32 6 "`CharacterEvent.kind`: hit a ceiling while rising."
 ```
 
-<sub>`api.ogt` line 6338</sub>
+<sub>`api.ogt` line 6392</sub>
 
 ```ogt
 const DRIVE_REAR u32 0 "`Vehicle.drive`: the rear wheels drive."
 ```
 
-<sub>`api.ogt` line 6352</sub>
+<sub>`api.ogt` line 6406</sub>
 
 ```ogt
 const DRIVE_FRONT u32 1 "`Vehicle.drive`: the front wheels drive."
 ```
 
-<sub>`api.ogt` line 6353</sub>
+<sub>`api.ogt` line 6407</sub>
 
 ```ogt
 const DRIVE_ALL u32 2 "`Vehicle.drive`: every wheel drives."
 ```
 
-<sub>`api.ogt` line 6354</sub>
+<sub>`api.ogt` line 6408</sub>
 
 ```ogt
 const PIN_TOP u32 1 "`Cloth.pins` bit: the whole top row is pinned."
 ```
 
-<sub>`api.ogt` line 6535</sub>
+<sub>`api.ogt` line 6589</sub>
 
 ```ogt
 const PIN_TOP_CORNERS u32 2 "`Cloth.pins` bit: the top-left and top-right corners are pinned."
 ```
 
-<sub>`api.ogt` line 6536</sub>
+<sub>`api.ogt` line 6590</sub>
 
 ```ogt
 const PIN_LEFT u32 4 "`Cloth.pins` bit: the whole left column is pinned (a flag on a pole)."
 ```
 
-<sub>`api.ogt` line 6537</sub>
+<sub>`api.ogt` line 6591</sub>
 
 ```ogt
 const PIN_TOP_RINGS u32 8 "`Cloth.pins` bit: every fourth point of the top row (curtain rings)."
 ```
 
-<sub>`api.ogt` line 6538</sub>
+<sub>`api.ogt` line 6592</sub>