FieldSample
Defined in: sdk/src/water/zone.ts:126
What WaterField.sample answers about the water at a point.
Properties
Section titled “Properties”amp:
number
Defined in: sdk/src/water/zone.ts:131
calm:
number
Defined in: sdk/src/water/zone.ts:132
depth:
number
Defined in: sdk/src/water/zone.ts:139
exposure
Section titled “exposure”exposure:
number
Defined in: sdk/src/water/zone.ts:145
How open it is to the wind, 0 to 1: how far the weather raises its waves (see ZoneOcean.exposure).
flowX:
number
Defined in: sdk/src/water/zone.ts:135
flowZ:
number
Defined in: sdk/src/water/zone.ts:136
height
Section titled “height”height:
number
Defined in: sdk/src/water/zone.ts:130
Its surface’s height at rest, the height its waves stand to (and the share of its body’s that is, calmed toward the shore), and its current.
key:
number
Defined in: sdk/src/water/zone.ts:128
The body that owns the most of it.
shore:
number
Defined in: sdk/src/water/zone.ts:138
The signed distance to the nearest shore (positive on the water) and how deep the water is over the ground.
still:
number
Defined in: sdk/src/water/zone.ts:143
How much of the surf a current leaves: 0 in a river, rising away from its mouth over half the surf’s length.
surf:
number
Defined in: sdk/src/water/zone.ts:141
The distance the surf runs in by: the shore’s, a river’s water taken for land, smoothed over the surf’s length.
swell:
number
Defined in: sdk/src/water/zone.ts:134
The height its body’s waves stand to away from any shore: what the surf breaking on the shore is measured against.