Water

Windows
MacOS
Linux

Classes

Name

Description

Public class UClass Abstract Blueprintable HideCategories

AWaterBody

Public class UClass Blueprintable

AWaterBodyCustom

Public class UClass

AWaterBodyExclusionVolume

WaterBodyExclusionVolume allows players not enter surface swimming when touching a water volume

Public class UClass Blueprintable

AWaterBodyIsland

Public class UClass Blueprintable

AWaterBodyLake

Public class UClass Blueprintable

AWaterBodyOcean

Public class UClass Blueprintable

AWaterBodyRiver

Public class UClass Blueprintable

AWaterMeshActor

Public struct UStruct blueprintable

FBuoyancyData

Public class

FGerstnerWaterWaveViewExtension

Public struct UStruct BlueprintType

FGerstnerWave

Raw wave parameters for one gerstner wave

Public struct UStruct BlueprintType

FGerstnerWaveOctave

Public class

FOnCameraUnderwaterStateChanged

Public class

FOnPontoonEnteredWater

Public class

FOnPontoonExitedWater

Public class

FOnWaterScalabilityChanged

Public struct UStruct blueprintable

FSphericalPontoon

Public struct UStruct BlueprintType

FUnderwaterPostProcessSettings

Public struct

FUnderwaterPostProcessVolume

Public struct UStruct BlueprintType

FWaterBodyHeightmapSettings

Public class

FWaterBodyManager

Public struct

FWaterBodyQueryResult

Struct holding the result from water queries :

Public struct

FWaterBodyRenderData

Render data per water body

Public struct UStruct BlueprintType

FWaterBodyWeightmapSettings

Public struct UStruct BlueprintType

FWaterBrushEffectBlurring

Public struct UStruct BlueprintType

FWaterBrushEffectCurlNoise

Public struct UStruct BlueprintType

FWaterBrushEffectCurves

Public struct UStruct BlueprintType

FWaterBrushEffectDisplacement

Public struct UStruct BlueprintType

FWaterBrushEffects

Public struct UStruct BlueprintType

FWaterBrushEffectSmoothBlending

Public struct UStruct BlueprintType

FWaterBrushEffectTerracing

Public struct UStruct BlueprintType

FWaterCurveSettings

Public struct

FWaterCustomVersion

Custom serialization version for Water plugin.

Public struct UStruct BlueprintType

FWaterFalloffSettings

Public class

FWaterMeshIndexBuffer

Public class

FWaterMeshSceneProxy

Water mesh scene proxy

Public class

FWaterMeshVertexBuffer

Public struct

FWaterQuadTree

Public struct UStruct

FWaterSplineCurveDefaults

Public struct

FWaterTileInstanceData

Instance data to feed the GPU, each array is bound as an instanced vertex stream

Public struct

FWaterUtils

Public class

FWaterVertexFactoryParameters

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FWaveInfo

Struct holding wave computation result :

Public class

IWaterBrushActorInterface

Interface implemented by actors which can affect the water brush

Public class

IWaterModuleInterface

Public class

TWaterInstanceDataBuffers

Public struct

TWaterMeshUserData

Water user data provided to FMeshBatchElement(s)

Public struct

TWaterMeshUserDataBuffers

List of per-"water render group" user data buffers :

Public class

TWaterVertexFactory

Public class UClass Blueprintable Meta Config

UBuoyancyComponent

Public class UClass MinimalAPI

UConvertWaterBodyActorsCommandlet

Public class UClass MinimalAPI

UCustomMeshGenerator

Public class UClass

UEnvQueryTest_InsideWaterBody

Public class UClass Abstract, MinimalAPI Blueprintable, BlueprintType editinlinenew

UGerstnerWaterWaveGeneratorBase

Base class for the gerstner water wave generation.

Public class UClass MinimalAPI BlueprintType editinlinenew, notblueprintable

UGerstnerWaterWaveGeneratorSimple

Default implementation of a gerstner wave generator using a simple custom range based set of parameters to generate waves.

Public class UClass MinimalAPI BlueprintType editinlinenew, notblueprintable

UGerstnerWaterWaveGeneratorSpectrum

Default implementation of a gerstner wave generator using known wave spectra from oceanology.

Public class UClass MinimalAPI BlueprintType editinlinenew

UGerstnerWaterWaves

Public class UClass

UGerstnerWaterWaveSubsystem

UGerstnerWaterWaveSubsystem manages all UGerstnerWaterWaves objects, regardless of which world they belong to (it's a UEngineSubsystem )

Public class UClass ClassGroup

ULakeCollisionComponent

Public class UClass MinimalAPI

ULakeGenerator

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceWater

Public class UClass

UNiagaraWaterFunctionLibrary

Public class UClass

UOceanBoxCollisionComponent

Public class UClass ClassGroup

UOceanCollisionComponent

Public class UClass MinimalAPI

UOceanGenerator

Public class UClass MinimalAPI

URiverGenerator

Public class UClass Abstract within

UWaterBodyGenerator

For internal use.

Public class

UWaterBrushActorInterface

Dummy class needed to support Cast(Object).

Public class UClass ClassGroup, HideCategories editinlinenew

UWaterMeshComponent

Water Mesh Component responsible for generating and rendering a continuous water mesh on top of all the existing water body actors in the world The component contains a quadtree which defines where there are water tiles.

Public class UClass Meta Config defaultconfig

UWaterRuntimeSettings

Implements the runtime settings for the Water plugin.

Public class UClass ClassGroup, Meta

UWaterSplineComponent

Public class UClass

UWaterSplineMetadata

Public class UClass BlueprintType Transient

UWaterSubsystem

This is the API used to get information about water at runtime

Public class UClass Abstract BlueprintType editinlinenew, notblueprintable

UWaterWaves

Public class UClass BlueprintType AutoExpandCategories notblueprintable

UWaterWavesAsset

Public class UClass BlueprintType AutoExpandCategories notblueprintable

UWaterWavesAssetReference

Public class UClass Abstract BlueprintType editinlinenew, notblueprintable

UWaterWavesBase

Typedefs

Name

Description

FWaterVertexFactoryBufferRef

Enums

Name

Description

Public enum

EWaterBodyQueryFlags

Public enum UEnum BlueprintType

EWaterBodyType

Public enum UEnum BlueprintType

EWaterBrushBlendType

The blend mode changes how the brush material is applied to the terrain.

Public enum UEnum BlueprintType

EWaterBrushFalloffMode

Public enum

EWaterMeshRenderGroupType

Public enum UEnum

EWaveSpectrumType

Functions

Name Description

Public function

bool

 

IsWaterEnabled

(
    bool bIsRenderThread
)

Public function

bool

 

IsWaterMeshEnabled

(
    bool bIsRenderThread
)

Public function

constexpr bo ...

 

operator!

(
    EWaterBodyQueryFlags E
)

Public function

constexpr EW ...

 

operator&

(
    EWaterBodyQueryFlags Lhs,
    EWaterBodyQueryFlags Rhs
)

Public function

EWaterBodyQu ...

 

operator&=

(
    EWaterBodyQueryFlags & Lhs,
    EWaterBodyQueryFlags Rhs
)

Public function

constexpr EW ...

 

operator^

(
    EWaterBodyQueryFlags Lhs,
    EWaterBodyQueryFlags Rhs
)

Public function

EWaterBodyQu ...

 

operator^=

(
    EWaterBodyQueryFlags & Lhs,
    EWaterBodyQueryFlags Rhs
)

Public function

constexpr EW ...

 

operator|

(
    EWaterBodyQueryFlags Lhs,
    EWaterBodyQueryFlags Rhs
)

Public function

EWaterBodyQu ...

 

operator|=

(
    EWaterBodyQueryFlags & Lhs,
    EWaterBodyQueryFlags Rhs
)

Public function

constexpr EW ...

 

operator~

(
    EWaterBodyQueryFlags E
)

Variables

Name Description

Public variable

 

STATCAT_Advanced

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback