WaterSystem
18 tools in this family (folder Editor/Tools/WaterSystem/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.
| Tool | Effect | Description |
|---|---|---|
water_add_buoyancy_body | writes | Register a Rigidbody for Archimedean buoyancy. F_buoy = ρ·V·g per sample point, scaled by submerged |
water_add_river_flow | writes | Add a directional river-flow zone. Any BuoyancyBody whose sample point enters the AABB receives a |
water_add_wave_layer | writes | Append a single Gerstner wave layer to a surface's wave stack. Use this for fine-grained tuning |
water_apply_profile | writes | Apply a built-in profile preset to an existing surface. Replaces the surface's wave stack and ALL |
water_configure_caustics | writes | Configure underwater caustics — the dancing light patterns on submerged surfaces. Two layers pan |
water_configure_color | writes | Set the surface's shallow-water color, deep-water color, and the Beer-Lambert depth falloff (m). |
water_configure_foam | writes | Configure foam appearance (color, intensity, texture, scale, speed, shoreline width). Shoreline foam… |
water_configure_reflections | writes | Configure reflection mode for a water surface: None | PlanarMirror | ReflectionProbe | ScreenSpac… |
water_configure_refraction | writes | Set how the surface distorts the scene below it. Strength 0..1 controls offset magnitude. |
water_configure_underwater | writes | Set underwater rendering parameters: fog color, exponential fog density, fresnel power (for surface |
water_configure_waves | writes | Replace a surface's wave stack with a generated stack of N layers, optionally seeded. Use the |
water_configure_wet_surfaces | writes | Set the global wet-surface config. Surfaces near water (within distance metres) appear wet with |
water_create_surface | writes | Create a new water surface (Ocean / Lake / River / Pool). The surface is registered with the water |
water_export_profile | read-only | Export a surface's WaterProfile to JSON. Optionally writes the JSON to disk (project-relative path) |
water_hook_weather | writes | When weather changes, blend the wave stack of one (or all) water surface(s) to the matching preset. |
water_sample_height | read-only | Query the water surface Y-coordinate and normal at a world XYZ position. Returns the composite wave |
water_trigger_splash | writes | Post a splash event at a world position. Subscribers (VFX manager, audio manager) drain the queue |
water_validate_setup | read-only | Validate that a water surface is properly configured: profile assigned, mesh generated, bounds valid… |