WaterBodySettings

Remarks

§ "The body inspector": kind, spline, material, wave asset, then the profile, then the terrain group, the underwater group and the physics group. What is here is the first two groups; the underwater group is a PostProcessVolume block verbatim, which doc 32's own inspector already draws, and the material is an asset reference the project's picker supplies.

Fields and properties (13)

• public WaterBodyKind Kind

  What kind of water it is.

• public float SurfaceHeight

  Where a closed body's surface sits, in world units.

• public int Priority

  Which body wins where two overlap. Higher is on top.

• public float HalfWidth

  How far the channel reaches either side of the curve, in metres.

• public float Depth

  How far below the surface the bed sits, in metres.

• public float Velocity

  How fast the water moves downstream, in metres a second.

• public float AudioIntensity

  How loud it is.

• public float ShoreFalloff

  How wide the band is over which coverage falls to zero at the boundary, in metres.

• public float BedRamp

  How far inside the boundary the bed reaches its full depth, in metres.

• public float CarveStrength

  How much of its bed the terrain takes, 0…1.

• public int BedLayer

  Which paint layer the bed is, or −1 for none.

• public WaterProfilePoint Profile

  The per-control-point profile this describes.

• public WaterCarveProfile Carve

  How much of the bed the ground takes, and what it paints along it.

Methods (2)

• public WaterBodyComponent ComponentFor(string spline)

  What a scene entity carries, built from these and a spline's name.

• public string? Validate()

  Why this body cannot be made, or if it can.

Used by (4)

• Describes_Vixen_Editor_Water_WaterBodySettingsVixen.Editor.Water
• WaterEditTestsVixen.Editor.Water.Tests
• WaterModeVixen.Editor.Water
• WaterModuleVixen.Editor.Water