struct
FWaterSurfaceSample
- Module
- SceneTypes
- Header
#include "Water/WaterQuery.h"- Namespace
Mowo
Properties
| Type | Name | Description |
|---|---|---|
bool | valid | Default false. |
float | height | Default 0.0f. |
Vec3 | normal | Default Vec3(0.0f, 1.0f, 0.0f). |
Vec3 | flow | Horizontal flow (m/s) of the sampled surface — non-zero only for rivers, pointing downstream along the spline tangent. Buoyancy and character water use it to push bodies along the current. Default Vec3(0.0f, 0.0f, 0.0f). |
float | depth | Water column depth below the surface, in metres. Authored per spline point (rivers), averaged over the polygon (lakes) or taken from Ocean Depth. 0 means the body never said. Default 0.0f. |
float | shoreDistance | Distance to the nearest shoreline, metres. Large for an unbounded plane. Default 0.0f. |
EWaterBodyType | bodyType | Default EWaterBodyType::Ocean. |
uint32_t | bodyId | Which body dominates here — the ECS entity id of the WaterBodyComponent that won the transition, or 0 for the global WaterComponent plane. Audio and gameplay key ambiences off it: a swimmer crossing from a river into a lake is a different sound, and "which surface am I in" has no answer in the height alone. Default 0. |
float | bodyWeight | How much of the dominant body the answer actually is, 0..1. Below 1 the point sits in a transition band and the height, flow and depth above are already the blend — this says so, so a caller crossfading an ambience crossfades over the same band the surface does. Default 1.0f. |
float | waveHeight | Wave excursion of the dominant surface at this point: the height minus the body's still-water level. Positive on a crest, negative in a trough. Default 0.0f. |
Generated from Water/WaterQuery.h via scenetypes.json · Nov 4, 2026Version 1.0.0