Umi Water ProOverviewComponentsLimitsChangelog

Umi Water Pro — components

Every component has a section here, named after its class (the Documentation link in an inspector opens its section). Fields are listed in the inspector's order. Units: meters, seconds, kg/m³ unless noted. Umi Water Pro needs Umi Water (free): add it to My Assets first.

WaterOcean

Pro. Extension: Add Extension > Water Ocean. Wind sea from an FFT on the GPU, added to the surface's Gerstner waves. Physics reads it on the CPU. Adding it switches the material to Water Pro and adds WaterEffects (Ctrl+Z takes both back).

FieldWhat it does
SpectrumAn OceanSpectrum asset. Empty = no FFT ocean. The line under it shows the sea state's significant wave height and peak wavelength.
CascadesTile sizes of the three FFT layers, m, largest first (default 800 / 120 / 20). The first two move mesh and physics, the third adds normals and foam. The first should be at least 4 × the peak wavelength (a warning and Fix say so; strong wind with a long fetch needs a bigger one).
Blend TimeCross-fade when the spectrum changes at runtime, s.
ComputeThe FFT compute shader (set automatically).
Allow On MobileOff: on Android / iOS the FFT ocean is off and the surface keeps its own waves (it costs 30–100+ ms on phones).

OceanSpectrum

Pro asset. Create > Umi Water > Ocean Spectrum. The sea state of a WaterOcean.

FieldWhat it does
TypeJONSWAP (fetch-limited wind sea; γ = 1 is Pierson-Moskowitz) or Phillips.
Wind Speed10 m above the sea, m/s (0.5–40).
Wind DirectionWhere the wind blows to, degrees (0 = +X, 90 = +Z).
FetchJONSWAP: distance the wind has blown over water, km. Longer = longer, higher waves.
Peak EnhancementJONSWAP γ: 3.3 typical, 1 = Pierson-Moskowitz.
DirectionalityAbove 1 long-crested waves, below 1 confused sea.
Short Waves FadeWaves shorter than about this are faded out, m.
Energy ScaleMultiplies the energy (heights scale with its square root).
ChoppinessHorizontal displacement: sharp crests, flat troughs; above ~1 crests fold.
Foam Threshold / Foam DecayWhitecaps where the surface is squeezed (Jacobian below this); seconds to fade to 37 %.

WaterRipples

Pro. Extension: Add Extension > Water Ripples. Interactive waves in a window around the camera (or a focus): Buoyancy, WaterInteractor, hulls and fluid push water aside and make ripples. Physics feels them.

FieldWhat it does
Compute / Splat ShaderSet automatically.
Resolution / Texel SizeSimulated window: texels per side, texel size (m). Window = resolution × texel size (512 × 0.125 = 64 m).
FocusWindow centre. Empty = ahead of the main camera.
DecayHow fast ripples die out, 1/s.
ViscosityExtra damping of short ripples, m²/s.
Max HeightRipple height limit, ± m.
StrengthScales what bodies push aside (1 = their real volume).
Affects PhysicsRipples are part of the surface physics sees. Off = visual only.
Allow On MobileOff: no ripples on Android / iOS.

WaterShore

Pro. Extension: Add Extension > Water Shore. Bakes a water map from the ground below (depth) and from WaterRiver / WaterColorZone children: waves fade in shallow water, optional shore waves break and run up the beach.

FieldWhat it does
Shore AdaptationBake depth from colliders without a Rigidbody and fade waves in shallow water. Off: only rivers are baked.
Shore DepthDepth at which waves reach full height, m.
Ground LayersColliders that count as ground (leave out bridges, overhangs).
Map Texel SizeTexel of the baked map, m (0.25–8).
Baked MapThe WaterMapAsset saved by Bake: loaded instead of baking at scene load. Bake again after moving the ground.
AreaSurface: the map covers the water. Zone: a box around the coast (works with WaterInfinite).
Zone Center / Zone Size / Zone BlendThe zone box (local X / Z, m) and its fade width (≥ ~20 m in strong waves). Put its edges in deep water or on land.
Shore WavesA train of waves runs onto every coast: rises, breaks, runs up. Physics feels it.
Shore Wave Height / Period / DepthDeep-water height (m), time between waves (s), depth where they start to rise (m).
Shore Wave Steepness / GroupinessCrest sharpness near the shore; 0 = every wave alike, 1 = sets of large waves.
Shore Wave Direction / LeeSwell direction (degrees); height on coasts facing away, share of full.
Breaking FoamWhite water where waves break and in the swash (drawn only).

Moving water: the map is baked from the ground, so moving, rotating or resizing the water (or changing a river / colour zone) bakes it again — about 0.15 s in the Shoreline sample, every frame while the water keeps moving. Play mode warns once when that happens (3 bakes in 60 frames) and the inspector shows how often. Keep the water still, or disable WaterShore on water that moves all the time (tides, locks); a single jump is fine.

WaterRiver

Pro. Add Component > Umi Water > Pro > Water River, as a child of a surface with WaterShore. A river from the SplineContainer on the same object: each spline is a channel with its own height, current and colour. Steep drops are waterfalls, steep stretches rapids. Physics feels the current.

FieldWhat it does
Default Width / Default SpeedChannel width (m) and centre current (m/s) where a spline has no Width / Speed data.
Wave ScaleMultiplies the surface's waves inside the channels.
Bank MarginHow far the water extends under the banks, m.
Blend DistanceWhere the river enters other water, it blends over this distance, m.
Junction BlendWhere channels meet, they blend over this distance, m.
SpacingSpline sampling step, m.
WhitewaterHow white waterfalls, pools and rapids run (drawn only).
Rapids SlopeDrop per metre above which the river runs white; twice as steep = fully white.
MistMist, spray and foam at the foot of waterfalls (Play mode; needs WaterParticles).
Water Color / TurbidityColour of murky water; how murky, 1/m (0 = clear, 1 ≈ see 2 m deep).
Color SpreadHow far the colour spreads into the water it enters, m.

WaterRiverAudio

Pro. Add Component > Umi Water > Pro > Water River Audio, on a WaterRiver. Two 3D loops: flow at the river point nearest to the listener, and the nearest waterfall. Clips are yours (the sample uses the showcase's).

FieldWhat it does
Flow Clip / Flow VolumeLoop of flowing water; volume at a calm current. None = no flow sound.
Fast SpeedCurrent (m/s) at which the flow is full volume.
Flow RangeSilent beyond this distance from the river's edge, m.
Fall Clip / Fall VolumeLoop of falling water; volume for a 5 m × 8 m fall (bigger is louder, up to twice).
Fall RangeSilent beyond this distance from the waterfall, m.

WaterColorZone

Pro. Add Component > Umi Water > Pro > Water Color Zone, as a child of a surface with WaterShore. Tints the water in a box (a muddy bay, an algae pond). Baked into the water map; drawn only.

FieldWhat it does
SizeBox along this transform's X / Z, m.
BlendFade inside the box's edge, m.
Water Color / TurbidityColour of murky water; how murky, 1/m.

WaterEffects

Pro. Extension: Add Extension > Water Effects (added with any Pro extension). Below-surface effects of Water Pro.

FieldWhat it does
Caustics / Caustics Max DepthCaustics on geometry under water (needs the material's caustics texture); deepest point, m.
Underwater FogAbsorption and scattering fog when the camera is below the surface.
Light Shafts / Light Shaft DistanceSun shafts under water, cut by floating objects' shadows (not at Low); how far, m.
Particles / Count / Range / SizeDust and plankton around an underwater camera.
Lens Drops / Lens Drop TimeDrops on a game camera's lens after it comes out of the water; how long, s.

WaterPlanarReflection

Pro. Extension: Add Extension > Water Planar Reflection. Opt-in exact mirror reflection (a second camera render); screen-space reflection stays on top. Not at Low quality. Costs a camera render: see the limits.

FieldWhat it does
Resolution ScaleReflection image size relative to the camera (0.5 costs about a quarter of 1).
Culling MaskLayers the reflection shows.
ShadowsShadows in the reflection (the costliest part).
Max DistanceHow far it reaches, m (0 = camera far plane).
Wave DistortionHow much waves bend it, m.
Clip OffsetClip plane above the rest level, m: raise it if things just under the water show up.

WaterMapAsset

Pro. Asset: created by Bake in the WaterShore inspector, next to the scene. The water map baked in the editor: rest height, current, wave scale, depth, shore waves and water colour. A WaterShore with an up-to-date asset loads it instead of baking when the scene starts (no raycasts, no freeze; ground that loads later does not matter). The ground is part of the asset: bake again after moving it.

FieldWhat it shows
Texels / SizeResolution of the map and the box it covers along the water's local X / Z, m.
Shore waves / ColorWhether it holds shore waves, and a colour (murky rivers, colour zones).

It has no settings. It remembers what it was baked from (the shore's settings, the water's position, rivers, colour zones); when any of that changes the shore bakes at load again and the Setup Check says so.