Interface WaterSample

Water at a point, from waterAt or hydrologyWaterAt.

interface WaterSample {
    depth: number;
    flowX: number;
    flowZ: number;
    kind: "none" | "sea" | "lake" | "river";
    level: number;
}

Properties

depth: number

Water depth (surface minus ground), metres; 0 where dry.

flowX: number

Surface flow velocity along x, m/s.

flowZ: number

Surface flow velocity along z, m/s.

kind: "none" | "sea" | "lake" | "river"

What kind of water is here.

level: number

Water surface height (frame-local y), or NaN where dry.