waterWake
Since next
How a hull's wake looks: how much foam its arms, trail and fill carry, how wide the trail runs and how long each lasts.
Absent fields keep the engine's own wake. It also gives a wake to a hull with no buoyancy, from the entity's pose and velocity, so a script-driven boat leaves one. A script can feed thrust, planing and the bow with ctx.entity.setWaterWake. Render only.
Use it in a scene entity's components list as { "type": "waterWake", … }. The contract writes the fields flat and refuses unknown keys.
Fields
| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
strength | number | no | 1 | Scale on what the hull itself makes: the arms' waves and foam and the collar at its waterline, 0..1. The trail is churn, from thrust and speed: trailFoam scales it. Default 1. Outside is clamped (water-wake-out-of-range). | |
halfLength | number | no | Half the hull's length at the waterline, metres, 0.05..200. Default: what its buoyancy probes span, or 2.5 with none. Outside is clamped (water-wake-out-of-range). | ||
halfWidth | number | no | Half the hull's width at the waterline, metres, 0.05..100. Default: what its buoyancy probes span, or 1 with none. Outside is clamped (water-wake-out-of-range). | ||
draft | number | no | 0 | How far the hull reaches below the entity's origin, metres, 0.01..50: with no buoyancy, the wake stops once the water has stayed below that for 0.6 s. Default 0.5. Outside is clamped (water-wake-out-of-range). | |
armFoam | number | no | 1 | Scale on the foam of the V's two arms, 0..4: 0 leaves their waves with no white. Default 1. Outside is clamped (water-wake-out-of-range). | |
trailFoam | number | no | 1 | Scale on the foam of the trail behind the stern, 0..4. Default 1. Outside is clamped (water-wake-out-of-range). | |
fillFoam | number | no | 1 | Scale on the whitewater filling the young V behind the transom, 0..4. Default 1. Outside is clamped (water-wake-out-of-range). | |
trailWidth | number | no | 0 | The trail's half width at the stern, in hull half widths, 0..50. Default 0.7. Outside is clamped (water-wake-out-of-range). | |
trailGrowth | number | no | 0 | What the trail's half width grows by each second, in hull half widths, 0..50. Default 0.35. Outside is clamped (water-wake-out-of-range). | |
trailMaxWidth | number | no | 5 | The most the trail's half width reaches, in hull half widths, 0..100. Default 5. Outside is clamped (water-wake-out-of-range). | |
armLife | number | no | 7 | Seconds the arms' foam takes to fade to about a third, 0.05..60. Default 7. Outside is clamped (water-wake-out-of-range). | |
trailLife | number | no | 5 | Seconds the trail's foam takes to fade to about a third, 0.05..60. Default 5. Outside is clamped (water-wake-out-of-range). | |
fillLife | number | no | 1 | Seconds the whitewater in the V takes to fade to about a third, 0.05..60. Default 1.2. Outside is clamped (water-wake-out-of-range). | |
solve | WaterWakeSolve | no | Solve this hull's waves instead of drawing them (HD). Absent: off, and the frame is as without it. |