WaterSample
Defined in: sdk/src/water/waterPlugin.ts:98
What Waters.sample answers.
Properties
Section titled “Properties”bodyId
Section titled “bodyId”bodyId:
string
Defined in: sdk/src/water/waterPlugin.ts:101
depth:
number
Defined in: sdk/src/water/waterPlugin.ts:103
How far the point is above the surface (negative under it), in world units.
entity
Section titled “entity”entity:
number
Defined in: sdk/src/water/waterPlugin.ts:100
The entity of the body that holds the most of the water there, and what the game calls it (its bodyId).
flow: [
number,number,number]
Defined in: sdk/src/water/waterPlugin.ts:107
How the water moves there, in world units a second (a river’s current; still water is zero).
inside
Section titled “inside”inside:
boolean
Defined in: sdk/src/water/waterPlugin.ts:111
Whether the point is over water: always, for an answer that is not null.
normal
Section titled “normal”normal: [
number,number,number]
Defined in: sdk/src/water/waterPlugin.ts:105
The surface’s normal at the point, in world space.
surface
Section titled “surface”surface: [
number,number,number]
Defined in: sdk/src/water/waterPlugin.ts:109
The world position of the surface above or below the point.