1. Epic GamesDeveloper
  3. Water

Water

Unreal Engine C++ API Reference > Plugins

Classes

  Type Name Description
Public class UClass ABuoyancyManager    
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 HideCategories AWaterZone    
Public struct FBuoyancyAuxData    
Public struct FBuoyancyComponentAsyncAux Auxiliary, persistent data which the update can use.  
Public struct FBuoyancyComponentAsyncInput    
Public struct FBuoyancyComponentAsyncOutput    
Public struct FBuoyancyComponentBaseAsyncAux    
Public struct FBuoyancyComponentBaseAsyncInput    
Public struct FBuoyancyComponentBaseAsyncOutput    
Public class FBuoyancyComponentSim    
Public struct UStruct blueprintable FBuoyancyData    
Public class FBuoyancyManagerAsyncCallback    
Public struct FBuoyancyManagerAsyncInput    
Public struct FBuoyancyManagerAsyncOutput    
Public struct FBuoyancyPhysicsState Frequently accessed runtime physical values.  
Public struct FBuoyancySimOutput    
Public class FGerstnerWaterWaveViewExtension    
Public struct FGerstnerWave Raw wave parameters for one gerstner wave  
Public struct FGerstnerWaveOctave    
Public class FOnCameraUnderwaterStateChanged    
Public class FOnPontoonEnteredWater    
Public class FOnPontoonExitedWater    
Public struct FOnWaterBodyChangedParams    
Public struct FOnWaterBodyIslandChangedParams    
Public class FOnWaterScalabilityChanged    
Public struct FOnWaterSplineDataChangedParams    
Public struct FOnWaterSplineMetadataChangedParams    
Public struct FSolverSafeWaterBodyData    
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 FWaterBodyStaticMeshSettings    
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 struct FWaterIconHelper    
Public class FWaterMeshIndexBuffer    
Public class FWaterMeshSceneProxy Water mesh scene proxy  
Public class FWaterMeshVertexBuffer    
Public struct FWaterQuadTree    
Public struct UStruct FWaterSplineCurveDefaults    
Public struct FWaterSplineDataPhysics    
Public struct FWaterSplineMetadataPhysics    
Public struct FWaterUtils    
Public class FWaterVertexFactoryParameters    
Public class FWaterVertexFactoryRaytracingParameters    
Public class FWaterViewExtension    
Public struct FWaveGPUResources    
Public struct FWaveInfo Struct holding wave computation result :  
Public class IWaterBrushActorInterface Interface implemented by actors which can affect the water brush  
Public class IWaterEditorServices    
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 UDEPRECATED_CustomMeshGenerator    
Public class UClass MinimalAPI UDEPRECATED_LakeGenerator    
Public class UClass MinimalAPI UDEPRECATED_OceanGenerator    
Public class UClass MinimalAPI UDEPRECATED_RiverGenerator    
Public class UClass Abstract deprecated, within UDEPRECATED_WaterBodyGenerator For internal use.  
Public class UClass UEnvQueryTest_InsideWaterBody    
Public class UGerstnerWaterWaveGeneratorBase Base class for the gerstner water wave generation.  
Public class UGerstnerWaterWaveGeneratorSimple Default implementation of a gerstner wave generator using a simple custom range based set of parameters to generate waves.  
Public class UGerstnerWaterWaveGeneratorSpectrum Default implementation of a gerstner wave generator using known wave spectra from oceanology.  
Public class 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 Meta category, editinlinenew UNiagaraDataInterfaceWater    
Public class UClass UNiagaraWaterFunctionLibrary    
Public class UClass UOceanBoxCollisionComponent    
Public class UClass ClassGroup UOceanCollisionComponent    
Public class UClass Abstract HideCategories UWaterBodyComponent    
Public class UClass Blueprintable UWaterBodyCustomComponent    
Public class UClass hidedropdown UWaterBodyHLODBuilder    
Public class UClass Blueprintable UWaterBodyLakeComponent    
Public class UClass MinimalAPI UWaterBodyMeshComponent Base class for meshes used to render water bodies without relying on the water zone/water mesh.  
Public class UClass Blueprintable UWaterBodyOceanComponent    
Public class UClass Blueprintable UWaterBodyRiverComponent    
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
FOnWaterSplineDataChanged  
FWaterVertexFactoryBufferRef  
FWaterVertexFactoryRaytracingParametersRef  

Enums

  Type Name Description
Public enum EAsyncBuoyancyComponentDataType    
Public enum UEnum EBuoyancyEvent    
Public enum EWaterBodyQueryFlags    
Public enum EWaterBodyStatus    
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 EWaterZoneRebuildFlags    
Public enum EWaveSpectrumType    

Functions

  Type Name Description
Public function const FShaderParametersMetadata *  
Public function const FShaderParametersMetadata *  
Public function const FVertexFactoryType *

GetWaterVertexFactoryType ( bool bWithWaterSelectionSupport
)

  
Public function bool

IsWaterEnabled ( bool bIsRenderThread
)

  
Public function constexpr bool  
Public function constexpr bool  
Public function constexpr EWaterBodyQueryFlags  
Public function constexpr EWaterZoneRebuildFlags  
Public function EWaterZoneRebuildFlags &  
Public function EWaterBodyQueryFlags &  
Public function constexpr EWaterBodyQueryFlags  
Public function constexpr EWaterZoneRebuildFlags  
Public function EWaterBodyQueryFlags &  
Public function EWaterZoneRebuildFlags &  
Public function constexpr EWaterBodyQueryFlags  
Public function constexpr EWaterZoneRebuildFlags  
Public function EWaterBodyQueryFlags &  
Public function EWaterZoneRebuildFlags &  
Public function constexpr EWaterBodyQueryFlags  
Public function constexpr EWaterZoneRebuildFlags  

Variables

  Type Name Description
Public variable TAutoConsoleVariable< int32 > CVarWaterBuoyancyDebugPoints  
Public variable TAutoConsoleVariable< int32 > CVarWaterBuoyancyDebugSize  
Public variable TAutoConsoleVariable< int32 > CVarWaterDebugBuoyancy  
Public variable TAutoConsoleVariable< float > CVarWaterOceanFallbackDepth  
Public variable   STATCAT_Advanced  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page