WaterBodyData

The fields of the WaterBody component.

Properties

bedDepth: number

How deep a river cuts its bed into the terrain under its surface, at its middle; 0 leaves the ground as it is.

bodyId: string

What the game calls the body, the same in every session (an entity’s number is not): what a query names the water by.

boundary: Point2[]

A lake’s outline: three points or more round it on its own xz plane (x, y is x, z). Empty is the rectangle of sizeX by sizeZ.

flowSpeed: number

A river’s current, in world units a second where the river is as wide as its widest; a narrower reach runs faster.

form: number

shoreWidth: number

How far in from the shore, and how deep, the waves take to come to full height; 0 leaves them whole to the edge.

sizeX: number

A lake’s extent along x and z, centred on its entity, when it has no outline of its own. An ocean has none: it goes on past the zone.

sizeZ: number

waveHeight: number

The height of the tallest wave, in world units. Their length, speed and heading are the zone’s, which every body shares.