WaterZoneData
Defined in: sdk/src/water/zone.ts:27
The fields of the WaterZone component.
Properties
Section titled “Properties”cells:
number
Defined in: sdk/src/water/zone.ts:44
cellSize
Section titled “cellSize”cellSize:
number
Defined in: sdk/src/water/zone.ts:43
The surface’s mesh: the cell size of its finest ring, cells along a ring’s side, and how many rings (each twice as coarse) follow the camera.
foamFade
Section titled “foamFade”foamFade:
number
Defined in: sdk/src/water/zone.ts:52
material
Section titled “material”material:
number
Defined in: sdk/src/water/zone.ts:34
A material on the Water shader for the whole surface. Empty uses the stock water.
resolution
Section titled “resolution”resolution:
number
Defined in: sdk/src/water/zone.ts:32
Texels along the longer side of the region.
rings:
number
Defined in: sdk/src/water/zone.ts:45
rippleDamping
Section titled “rippleDamping”rippleDamping:
number
Defined in: sdk/src/water/zone.ts:51
ripples
Section titled “ripples”ripples:
number
Defined in: sdk/src/water/zone.ts:47
Cells along a side of the ripple grid; 0 keeps none. The grid is a window of rippleSize that follows the camera.
rippleSize
Section titled “rippleSize”rippleSize:
number
Defined in: sdk/src/water/zone.ts:48
rippleSpeed
Section titled “rippleSpeed”rippleSpeed:
number
Defined in: sdk/src/water/zone.ts:50
How fast a ripple spreads (world units a second), how much of its height it loses a second, and how fast the foam it leaves fades a second.
sizeX:
number
Defined in: sdk/src/water/zone.ts:29
The region baked, along x and z, centred on the entity. Bodies (or the parts of them) outside it are not drawn; an ocean goes on past it.
sizeZ:
number
Defined in: sdk/src/water/zone.ts:30
surf:
number
Defined in: sdk/src/water/zone.ts:40
The surf: how high a breaker stands against its body’s waves (0 draws none), and how long the surf’s waves are, in world units.
surfLength
Section titled “surfLength”surfLength:
number
Defined in: sdk/src/water/zone.ts:41
waveDirection
Section titled “waveDirection”waveDirection:
number
Defined in: sdk/src/water/zone.ts:38
waveLength
Section titled “waveLength”waveLength:
number
Defined in: sdk/src/water/zone.ts:36
The waves every body shares (each sets only how high they stand): the length of the longest, a multiplier on their speed, their heading in degrees.
waveSpeed
Section titled “waveSpeed”waveSpeed:
number
Defined in: sdk/src/water/zone.ts:37