create_ocean_water_body
Spawn an Ocean AWaterBody actor, optionally link it to a WaterZone, and read back its wave height to verify ocean waves.
Instructions
Spawn an Ocean AWaterBody actor, optionally link to a WaterZone, and read back its wave height (on an ocean the factory's waves are CORRECT -- ~508 uu -- so no warning is emitted here).
Returns: { actor_label: string, actor_name: string, body_type: string, water_zone_label: string, linked_to_zone: bool, affects_landscape: bool, max_wave_height: number (RE-READ), max_wave_height_on_spawn: number (RE-READ), has_waves: bool, waves_disabled: bool, requested: { actor_label, location, water_zone_label, affects_landscape, disable_waves } }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| location | No | Optional [X, Y, Z] world location (defaults to origin) | |
| actor_label | Yes | Label to assign to the new water body actor | |
| disable_waves | No | OPT-IN, default FALSE. Sets water_waves = None right after the spawn and RE-READS GetMaxWaveHeight(). On an ocean you almost certainly do NOT want this. | |
| water_zone_label | No | Optional label of an existing AWaterZone to auto-link the body to. If given and the zone is not found, `success` is FALSE (the body is still spawned; `linked_to_zone` says so). | |
| affects_landscape | No | When true the body carves the existing landscape via the water landscape brush; defaults to FALSE (non-destructive) |