Vixen
c7401864
csharp
public enum WaterBodyKind

What kind of water a body is.

Read the guide page for this →

Remarks

Unreal's five actors as one enum ([35 § D6](../../docs/plan/35-water.md#d6-a-water-body-is-a-spline-and-a-profile-and-there-is-no-new-spline)). They differ in three things — whether the spline closes, whether the surface has one height or many, and whether the body adds water or removes it — and none of those is worth a type.

⚠ Island is the same mechanism with the sign flipped, which is Unreal's Invert Shape property promoted to the thing it actually is. An island is not a second kind of actor; it is a body whose coverage subtracts.

Fields and properties (5)

  • Ocean

    A closed spline marking a shoreline, with water extending past it to the horizon.

  • Lake

    A closed spline, one height for every point.

  • River

    An open spline. The height varies along it, and it has a direction.

  • Custom

    A closed spline standing for a mesh — a pool, an aqueduct, a ship's hold.

  • Island

    A closed spline that removes water and raises the ground.

Used by (24)

  • BuoyancyTestsVixen.Water.Tests
  • LakeVixen.Water.Physics.Tests
  • TypeRegistrationVixen.Rendering.Water
  • UnderwaterShapeTestsVixen.Rendering.Water.Tests
  • Vixen_Rendering_Water_WaterBodyComponentSerializerVixen.Rendering.Water
  • WaterBodyVixen.Water
  • WaterBodyComponentVixen.Rendering.Water
  • WaterCarveTestsVixen.Water.Tests
  • WaterDebugDrawVixen.Rendering.Water
  • WaterDebugDrawTestsVixen.Rendering.Water.Tests
  • WaterEvaluatorTestsVixen.Water.Tests
  • WaterFieldTestsVixen.Water.Tests
  • WaterHorizonImageTestsVixen.Graphics.Golden.Tests
  • WaterSurfaceMeshTestsVixen.Water.Tests
  • WaterZoneSystemVixen.Rendering.Water
  • WaterZoneTestsVixen.Water.Tests
  • Describes_Vixen_Editor_Water_WaterBodySettingsVixen.Editor.Water
  • SceneWaterComponentTestsVixen.Editor.Assets.Tests
  • WaterBodySettingsVixen.Editor.Water
  • WaterEditVixen.Editor.Water
  • WaterEditTestsVixen.Editor.Water.Tests
  • WaterModeVixen.Editor.Water
  • WaterModeTestsVixen.Editor.Water.Tests
  • WaterModuleVixen.Editor.Water