set_water_body_gerstner_waves
Apply a Gerstner wave set to a Lake or Ocean water body and return wave count, height, and steepness, rejecting rivers and flagging fold risk when total steepness exceeds 1.
Instructions
Build a Gerstner wave set (UGerstnerWaterWaves + simple parametric generator) and apply it to a wave-supporting water body (Lake/Ocean; rivers are rejected). The generator ramps per-wave Steepness from large_wave_steepness to small_wave_steepness; the no-self-intersection (no fold, no black-crest) criterion is total_steepness (returned) <= 1 — lower the two steepness params and/or num_waves if it exceeds 1.
Returns: { water_body_label: string, wave_supported: bool, has_waves: bool, num_waves: int, max_wave_height: number, total_steepness: number, applied: bool }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| num_waves | No | Optional wave count for the generator (>= 1; default 16) | |
| wind_angle | No | Optional dominant wind angle in degrees | |
| max_amplitude | No | Optional maximum wave amplitude in uu | |
| min_amplitude | No | Optional minimum wave amplitude in uu | |
| max_wavelength | No | Optional maximum wavelength in uu | |
| min_wavelength | No | Optional minimum wavelength in uu | |
| water_body_label | Yes | Label of the AWaterBody actor (must support waves: Lake or Ocean) | |
| steepness_falloff | No | Optional exponent shaping the small->large steepness ramp (generator default 1.0) | |
| large_wave_steepness | No | Optional steepness of the largest wave (generator default 0.2) | |
| small_wave_steepness | No | Optional steepness of the smallest wave (generator default 0.4) |