Umi WaterOverviewGetting startedSamplesComponentsScriptingFAQLimitsCore vs ProChangelog

Umi Water — 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. Inspector title and menu: Add Component > Umi Water > <Water …>; the Script field shows the class name. The add-ons' components are in their own packages' documentation: Umi Water Pro, Umi Boat Physics.

WaterSurface

Core. Add Component > Umi Water > Water Surface, or GameObject > Umi Water. The water body: a grid mesh, the wave profile, and the one place physics asks for the water height. Add-ons (ocean, ripples, shore …) are extensions on the same object.

FieldWhat it does
MaterialThe water material (Water for Core). Pro extensions switch it to Water Pro.
Look PresetApply… sets the material to a ready look (sea, lake, tropical …).
SizeWater area in local X / Z (default 200 × 200).
ResolutionGrid cells per side (1–512). Cell size = Size / Resolution; keep it ≤ 1/6 of the shortest wave (the inspector warns, Set fixes it). Ignored by WaterInfinite.
ProfileThe Gerstner WaveProfile. Empty = flat water (or only the waves of extensions).
Profile Blend TimeSeconds to cross-fade when the profile changes at runtime (0–300).
Sample IterationsNewton iterations that find the height under a point, because waves also move water sideways (0–8; 4 is enough). A query runs at most this many plus 4, and stops once it is within 0.5 mm, so 0 still searches.
DensityFluid density for buoyancy: fresh water 1000, sea water 1025.
Underwater FogAbsorption fog when the camera is below the surface.
Depth WriteWrites the water's depth into the camera depth texture (for depth of field …): Auto / On / Off.
ExtensionsThe add-ons on this object, what each adds, Add Extension (lists only what is installed; modules are marked).
Water QualityRead-only: the level in effect (from Quality Settings). Preview overrides it in the editor.

Physics does not read the mesh: it calls WaterSurface.TrySampleAny (height, normal, velocity).

Your own script can be an extension too: derive from WaterSurfaceExtension and override SetShaderData (extra data for the water material, per surface or per camera), OnBeforeRender or OnRendered (e.g. a screen pass after the water). It does not change the surface physics sees — waves come from the profile and the Umi extensions.

Buoyancy

Core. Add Component > Umi Water > Buoyancy. Floats a Rigidbody: Archimedes force from a voxel approximation of its collider, quadratic water drag, and optional ripples, foam and splash. Needs a collider; floats on any WaterSurface.

FieldWhat it does
ResolutionVoxels along the collider's longest axis (default 4). More = smoother torque, more cost. Read when the component is enabled: a change in Play mode applies after you disable and enable it.
DensityObject density, kg/m³. Water is 1000: lower floats, higher sinks (500 = half submerged).
Mass From DensitySets the Rigidbody's mass to Density × collider volume. Off: you set the mass; Density still sets the buoyant force.
Drag CoefficientCd of the quadratic drag: ~1 blunt shapes, ~0.1 streamlined. The area is the collider's across the direction of motion (a raft falling flat meets more water than edge-on).
Water Linear DampingRigidbody drag while in water (blended by the submerged share; disabling Buoyancy gives the Rigidbody its own back).
Water Angular DampingRigidbody angular drag while in water (the same way).
Radiation DampingDamping of bobbing and rocking by the waves the object sends out, from its waterline area (default 0.2; 0 = none). A dropped cube settles in a few bobs, a flat raft almost at once. With HullHydrodynamics on the same body you would damp twice: use one of the two.
Wave PushHow much the wave slope pushes the object sideways (default 1): it rides the waves' orbits with the water and drifts slowly down-wave; ripples from other sources push it too. 0 = it only rises and falls.
Ripple AmountScales the waves the object makes (0 = none). Needs Umi Water Pro (WaterRipples); greyed out without it.
Splash AmountScales spray and foam where the object hits the water faster than 2 m/s (0 = none). Needs a WaterParticles in the scene.

Read-only in play mode: Volume (m³), Voxels, Submerged (0 = out of water, 1 = fully under).

WaterInteractor

Core. Add Component > Umi Water > Water Interactor. For a character, paddle or kinematic object that should disturb the water but not float: foam and spray at the waterline, a splash on entry, ripples with Pro. No Rigidbody needed.

FieldWhat it does
Use ColliderTakes radius, height and centre from this object's collider every step.
Radius / Height / OffsetThe water-pushing column, m (hand or blade: small; standing character: height 1.8). Offset is in local space.
Ripple AmountScales the volume pushed aside (0 = none). Needs Umi Water Pro; greyed out without it.
Surface DepthOnly this much of the column below the surface pushes water into waves when it moves sideways.
Foam AmountScales the foam at the waterline (needs WaterParticles).
Spray AmountScales spray where it pushes into the water or enters faster than 2 m/s (needs WaterParticles).

WaterParticles

Core. Add Component > Umi Water > Water Particles. Not a source: it draws the foam and spray that Buoyancy, WaterInteractor and boats throw. One per scene. Foam goes into a texture around the main camera that the water shader turns into lace; spray is a particle system.

FieldWhat it does
Foam Material / Spray MaterialWhat draws the foam patches / spray droplets.
Max Foam / Max SprayMost patches / droplets alive at once. Read when the component is enabled (a change in Play mode applies after disabling and enabling it).
Foam Resolution / Foam Texel SizeFoam texture: texels per side, texel size (m). Foam beyond Resolution × Texel Size / 2 from the camera is not drawn (512 × 0.25 → 64 m).
Foam Fade TimeSeconds for left-behind foam to fade to a third; it drifts with the current meanwhile. 0 = only live patches.
Wake Min SpeedSpeed relative to the water (m/s) below which a hull leaves no foam.
Wake RateFoam per second per meter of waterline per m/s above the minimum.
Leeward FoamExtra foam where the waterline faces away from the motion (stern).
Foam Lifetime (Min / Max)Life of a foam patch, s.
Foam DragHow fast foam loses its own speed and drifts with the water (1/s).
Spray Min Speed / Spray RateSpeed at which a hull pushes spray off its waterline (m/s); droplets per second per meter per m/s above it.
Sheet Min Speed / Sheet RateSpeed above which a planing bottom throws a spray sheet; its density.
Slam Impulse Per ParticleImpulse (N·s) per spray particle when something slams into the water.
Spray Lifetime (Min / Max)Life of a droplet, s; it leaves a small foam patch where it falls.

WaterInfinite

Core. Extension: Water Surface > Add Extension > Water Infinite. Draws the surface to the horizon: rings of patches around the camera, finer near it. The surface's Size and Resolution are then not used (greyed out). Physics is unchanged.

FieldWhat it does
Cell SizeCell of the finest ring, next to the camera, m (0.05–2; default 0.25). Keep it ≤ 1/6 of the shortest wave.
LevelsRings; each doubles the cell and the distance (4–16; 12 rings of 0.25 m reach ≥ 16 km).

WaterMask

Core. Add Component > Umi Water > Water Mask. Hides the water inside a closed mesh, e.g. a boat's hull up to the deck, so the cockpit stays dry. Drawn only: physics does not see it.

FieldWhat it does
MeshClosed mesh in this object's local space. Convex shapes are exact. Needs no renderer. With Read/Write either winding works; without it the triangles must face outwards (a mesh that renders correctly does).

WaveProfile

Core asset. Create > Umi Water > Wave Profile. The Gerstner waves of a WaterSurface (Calm, Moderate, Storm … ship with the package). Physics and the shader use the same waves.

FieldWhat it does
Steepness ScaleMultiplies every wave's steepness, and so its height (0–2).
Direction OffsetRotates every wave, degrees.
WavesPer wave: Direction (degrees, 0 = +X, 90 = +Z), Wavelength (crest to crest, m), Steepness (0 flat – 1 sharp; keep the sum of all below 1 or the surface folds), Phase (radians).