OceanWeatherKey
Since 0.6
A sea state at a moment of simulation time, as a Beaufort force or explicit layers.
Consecutive keys blend, so a storm can build.
Fields
| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
timeS | number | yes | Simulation seconds since the scene started (sim.now, which stands still while the world is held), 0 or more. Keys must be strictly ascending (ocean-weather-not-ascending). | ||
beaufort | number | no | Shorthand: Beaufort force 0..12, expanding to a wind layer (and from force 4 a swell). Ignored when layers is present. | ||
layers | OceanWaveLayer[] | no | The sea at this key, at most 6 layers. Wins over beaufort. |