Quick reference for Water. Narrative workflows live in the other handbook chapters.
Components
| Display name | Runtime type | Role |
|---|
| Water Body River | WaterBodyRiverComponent | Stream / River / GreatRiver spline strip |
| Water Body Lake | WaterBodyLakeComponent | Closed-spline or polygon lake |
| Water Body Ocean | WaterBodyOceanComponent | Infinite or finite ocean |
| Water Buoyancy | WaterBuoyancyComponent | Rigid-body buoyancy |
| Water Dry Volume | WaterDryVolumeComponent | Query exclusion box |
| Water Surface Attachment | WaterSurfaceAttachmentComponent | Kinematic wave follow |
| Water River Network | WaterRiverNetworkComponent | Tributary confluence graph |
| Water Particle Bridge | WaterParticleBridgeComponent | Optional OpenParticleSystem mapping |
System / bridge components (auto-mounted when the Gem is enabled): WaterSystemComponent, Atom bridge, SurfaceData bridge, Navigation bridge, debug overlay, river mesh builder.
Category in the Editor: Water. Create Entity submenu: Water ?River / Lake / Ocean.
| Bus | Address | Key methods |
|---|
WaterSurfaceRequestBus | Single | GetWaterSurfaceSample, height, underwater, flow, GetDisplacedSurfacePosition, batch samples (C++) |
WaterSystemRequestBus | Single | water time, time source (C++), global tide, GetWaterInfoRaster (C++) |
WaterBodyRequestBus | Body EntityId | water level offset, waves enabled |
WaterSurfaceAttachmentRequestBus | Attachment EntityId | rest anchor, enabled |
WaterNotificationBus | Floater EntityId | enter / exit / submersion |
WaterSystemNotificationBus | Broadcast | camera + body enter/exit/submersion |
Script category: water. C++-only exclusions: SetTimeSource, GetWaterInfoRaster, batch samples, NotifyGlobalTideChanged.
Assets
| Kind | Path |
|---|
| Prefabs | Gems/Water/Assets/Prefabs/Water/River_Default, Lake_Default, Ocean_Default |
| Waves | Gems/Water/Assets/Waves/*.waterwaves |
| Materials | Gems/Water/Assets/Materials/Water/WaterSurface_*.material |
| Material type | Gems/Water/Assets/Materials/Types/WaterSurface.materialtype |
| Passes | Gems/Water/Assets/Passes/WaterParent.pass, MultiView variant, ripple / InfoMap / FFT passes |
| Registry | Gems/Water/Registry/water.setreg |
| Flow bakes | Assets/WaterBakes/FlowMap_*_lutrgba8.png (project) |
Sample content
| Content | Path |
|---|
| Levels | AutomatedTesting/Levels/WaterSamples/{Stream,Lake,Ocean,Estuary,RiverNetwork,ConcaveLake,RiverProfiles,TransparentSorting} |
| Prefabs | AutomatedTesting/Prefabs/Water/{BuoyantCrate,Driftwood,SimpleBoat} |
| Python smoke / golden | AutomatedTesting/Gem/PythonTests/WaterSamples/ |
Default query priorities
| Body | Priority |
|---|
| River family | 160 |
| Lake | 128 |
| Ocean | 64 |