1. Epic GamesDeveloper
  3. UWaterBodyComponent

UWaterBodyComponent

API > API/Plugins > API/Plugins/Water

Inheritance Hierarchy

References

   
Module Water
Header /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyComponent.h
Include #include "WaterBodyComponent.h"

Syntax

UCLASS&40;Abstract,  
       HideCategories&61;&40;Tags, Activation, Cooking, Physics, Replication, Input, AssetUserData, Mesh&41;&41;  
class UWaterBodyComponent : public UPrimitiveComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAffectsLandscape If enabled, landscape will be deformed based on this water body placed on top of it and landscape height will be considered when determining water depth at runtime
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool bAlwaysGenerateWaterMeshTiles When this is set to true, the water mesh will always generate tiles for this water body.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite float CollisionHeightOffset The distance above the surface of the water where collision checks should still occur.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly FPostProcessSettings CurrentPostProcessSettings  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite FWaterCurveSettings CurveSettings  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay double FixedWaterDepth If the Water Material assigned to this component has Fixed Depth enabled, this is the depth that is passed.
Protected variable UProperty Category, AdvancedDisplay visibleanywhere TWeakObjectPtr< ALandscapeProxy > Landscape  
Public variable TMap< FName, FWaterBodyWeightmapSettings > LayerWeightmapSettings  
Public variable UProperty Category, EditAnywhere float MaxWaveHeightOffset Offset added to the automatically calculated max wave height bounds.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 OverlapMaterialPriority Higher number is higher priority.
Protected variable UProperty Transient TSoftObjectPtr< AWaterZone > OwningWaterZone  
Public variable TObjectPtr< UPhysicalMaterial > PhysicalMaterial  
Public variable float ShapeDilation  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FWaterBodyStaticMeshSettings StaticMeshSettings  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname float TargetWaveMaskDepth Water depth at which waves start being attenuated.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UMaterialInterface > UnderwaterPostProcessMaterial Post process material to apply when the camera goes underwater (only available when bGenerateCollisions is true because collisions are needed to detect if it's under water).
Protected variable UProperty Category, Meta Transient nonpieduplicatetransient, textexporttransient, visibleinstanceonly TObjectPtr< UMaterialInstanceDynamic > UnderwaterPostProcessMID  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite FUnderwaterPostProcessSettings UnderwaterPostProcessSettings Post process settings to apply when the camera goes underwater (only available when bGenerateCollisions is true because collisions are needed to detect if it's under water).
Protected variable UProperty Category, AdvancedDisplay visibleanywhere TArray< TSoftObjectPtr< AWaterBodyExclusionVolume > > WaterBodyExclusionVolumes  
Protected variable UProperty Category BlueprintReadOnly Transient duplicatetransient, nontransactional, visibleanywhere int32 WaterBodyIndex Unique Id for accessing (wave, ... ) data in GPU buffers
Protected variable UProperty Category, AdvancedDisplay visibleanywhere TArray< TSoftObjectPtr< AWaterBodyIsland > > WaterBodyIslands Islands in this water body
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FWaterBodyHeightmapSettings WaterHeightmapSettings  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMaterialInterface > WaterHLODMaterial  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UMaterialInterface > WaterInfoMaterial  
Protected variable UProperty Category, Meta Transient nonpieduplicatetransient, textexporttransient, visibleinstanceonly TObjectPtr< UMaterialInstanceDynamic > WaterInfoMID  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TObjectPtr< UMaterialInterface > WaterMaterial  
Protected variable UProperty Category BlueprintReadOnly Transient duplicatetransient, nontransactional, visibleanywhere TObjectPtr< UStaticMesh > WaterMeshOverride  
Protected variable UProperty Transient TObjectPtr< UMaterialInstanceDynamic > WaterMID  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TSubclassOf< UNavAreaBase > WaterNavAreaClass The navigation area class that will be generated on nav mesh.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UWaterSplineMetadata > WaterSplineMetadata  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UMaterialInterface > WaterStaticMeshMaterial  
Protected variable UProperty Category, Meta Transient nonpieduplicatetransient, textexporttransient, visibleinstanceonly TObjectPtr< UMaterialInstanceDynamic > WaterStaticMeshMID  
Protected variable UProperty Category, AdvancedDisplay textexporttransient, visibleinstanceonly TSoftObjectPtr< AWaterZone > WaterZoneOverride  

Constructors

  Type Name Description
Public function  

UWaterBodyComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Adds WaterBody exclusion volume
Public function void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function void  
Protected function void  
Protected function Virtual void Called every time UpdateAll is called on WaterBody (prior to UpdateWaterBody)
Public function Virtual Const bool  
Protected function Const EWaterBodyQueryFlags  
Protected function Virtual TArray< TSharedRef< FTokenizedMessage > >  
Public function Const bool  
Public function Const bool  
Protected function void Copies the relevant collision settings from the water body component to the component passed in parameter (useful when using external components for collision)
Protected function void Copies the relevant navigation settings from the water body component to the component passed in parameter (useful when using external components for navigation)
Protected function void  
Protected function void  
Protected function Virtual void  
Protected function void  
Protected function void  
Protected function void  
Public function Const float

FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation
)

 Spline query helper.
Public function Virtual Const ALandscapeProxy *  
Public function Virtual Const bool Generates the mesh representation of the water body
Public function Virtual Const float  
Public function Virtual Const TArray< UPrimitiveComponent * >  
Public function Virtual Const void

GetBrushRenderDependencies ( TSet< UObject* >& OutDependencies
)

  
Public function Virtual Const ETextureRenderTargetFormat  
Public function Const float Returns channel depth
Public function Virtual Const FBox Returns the body's collision component bounds
Public function Virtual Const UFunction BlueprintCallable, Category TArray< UPrimitiveComponent * >

GetCollisionComponents ( bool bInOnlyEnabledComponents
)

 Returns body's collision components
Public function Virtual Const FVector Returns collision half-extents
Public function Virtual Const float Returns what can be considered the single water depth of the water surface.
Public function Virtual Const float Returns what can be considered the single base Z of the water surface.
Public function Virtual Const FVector Returns what can be considered the single water velocity of the water surface.
Public function Const UWaterBodyInfoMeshComponent *  
Public function Const UFunction BlueprintCallable, Category TArray< AWaterBodyExclusionVolume * > Gets the exclusion volume that influence this water body
Public function Virtual Const float Returns the additional water height added to the body (For internal use. Please use AWaterBodyOcean instead.)
Public function Virtual Const UMaterialInterface *  
Public function Virtual Const FMeshDescription  
Public function Const UFunction BlueprintCallable, Category TArray< AWaterBodyIsland * > Gets the islands that influence this water body
Public function Const const TMap< FName, FWaterBodyWeightmapSettings > &  
Public function Const UFunction BlueprintCallable, Category float Returns the max height that this water body's waves can hit.
Protected function Const TSubclassOf< UNavAreaBase > Returns navigation area class
Public function Const int32 Returns overlap material priority
Public function Const FPostProcessVolumeProperties Returns post process properties
Public function Virtual UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Returns River to lake transition material instance (For internal use. Please use AWaterBodyRiver instead.)
Public function Virtual UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Returns River to ocean transition material instance (For internal use. Please use AWaterBodyRiver instead.)
Protected function Virtual Const float

GetSimpleWaveHeightAtPosition ( const FVector& InPosition,
float InWaterDepth,
float InTime
)

 Computes the raw wave perturbation of the water height only (simple version : faster computation)
Public function Virtual Const UFunction BlueprintCallable, Category TArray< UPrimitiveComponent * > Retrieves the list of primitive components that this water body uses when not being rendered by the water mesh (e.g. the static mesh component used when WaterMeshOverride is specified)
Public function Virtual Const void

GetSurfaceMinMaxZ ( float& OutMinZ,
float& OutMaxZ
)

 Returns the minimum and maximum Z of the water surface, including waves
Protected function Const EObjectFlags  
Public function UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Returns under water post process MID
Public function Const UFunction BlueprintCallable, Category AWaterBody * Returns the WaterBodyActor who owns this component
Public function Const int32 Returns the unique id of this water body for accessing data in GPU buffers
Public function Const const FWaterBodyStaticMeshSettings &  
Public function Virtual Const EWaterBodyType Returns the type of body
Public function Const const FWaterCurveSettings &  
Public function Const const FWaterBodyHeightmapSettings &  
Public function UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Returns water info MID
Public function Const UWaterBodyInfoMeshComponent *  
Public function Const UFunction BlueprintCallable, Category UMaterialInterface * Returns water material
Public function UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Returns water MID
Public function Const UStaticMesh * Returns water mesh override
Public function Const FVector Returns nav collision offset
Public function Const UFunction BlueprintCallable, Category UWaterSplineComponent * Returns water spline component
Public function Const const UWaterSplineMetadata * Returns water spline metadata
Public function UWaterSplineMetadata * Returns water spline metadata
Protected function Virtual Const FVector  
Protected function Virtual Const const TCHAR *  
Public function Const UMaterialInterface * Returns material used to render the water as a static mesh
Public function UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Returns water static mesh MID
Public function Const UFunction BlueprintCallable, Category void

GetWaterSurfaceInfoAtLocation ( const FVector& InLocation,
FVector& OutWaterSurfaceLocation,
FVector& OutWaterSurfaceNormal,
FVector& OutWaterVelocity,
float& OutWaterDepth,
bool bIncludeDepth
)

  
Public function Virtual Const UFunction BlueprintCallable, Category float Spline queries specific to metadata type
Public function Virtual Const FVector  
Public function Const UFunction BlueprintCallable, Category UWaterWavesBase *  
Public function Const AWaterZone * Gets the water zone to which this component belongs
Protected function Virtual Const float

GetWaveAttenuationFactor ( const FVector& InPosition,
float InWaterDepth
)

 Computes the attenuation factor to apply to the raw wave perturbation.
Protected function Virtual Const float

GetWaveHeightAtPosition ( const FVector& InPosition,
float InWaterDepth,
float InTime,
FVector& OutNormal
)

 Computes the raw wave perturbation of the water height/normal
Public function Const bool

GetWaveInfoAtPosition ( const FVector& InPosition,
float InWaterDepth,
bool bInSimpleWaves,
FWaveInfo& InOutWaveInfo
)

 Fills wave-related information at the given world position and for this water depth.
Public function Virtual Const float Returns the time basis to use in waves computation (must be unique for all water bodies currently, to ensure proper transitions between water tiles)
Public function Const bool Returns true if there are valid water waves
Public function Virtual Const bool Returns whether the body is baked (false) at save-time or needs to be dynamically regenerated at runtime (true) and is therefore transient.
Protected function Virtual Const bool Returns whether the body has a flat surface or not
Protected function Virtual Const bool Returns whether the body support a height offset
Protected function Virtual Const bool  
Protected function Virtual Const bool Returns whether the body's spline is closed
Public function Virtual Const bool Returns whether the body supports waves
Public function Const bool

IsWorldLocationInExclusionVolume ( const FVector& InWorldLocation
)

 Returns true if the location is within one of this water body's exclusion volumes
Protected function Virtual void

OnPostEditChangeProperty ( FOnWaterBodyChangedParams& InOutOnWaterBodyChangedParams
)

  
Protected function Virtual void Called when the WaterBodyActor has had all its components registered.
Protected function Virtual void

OnUpdateBody ( bool bWithExclusionVolumes
)

  
Public function void  
Protected function Virtual void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Public function Virtual Const FWaterBodyQueryResult

QueryWaterInfoClosestToWorldLocation ( const FVector& InWorldLocation,
EWaterBodyQueryFlags InQueryFlags,
const TOptional< float >& InSplineInputKey
)

 Returns the requested water info closest to this world location
Protected function void

RegisterOnChangeWaterSplineData ( bool bRegister
)

  
Protected function void

RegisterOnUpdateWavesData ( UWaterWavesBase* InWaterWaves,
bool bRegister
)

  
Public function void Removes WaterBody exclusion volume
Public function void  
Protected function void  
Public function Virtual void

Reset ()

  
Public function Virtual bool Sets the dynamic parameters needed by the material instance for rendering.
Public function Virtual bool Sets the dynamic parameters needed by the underwater post process material instance for rendering.
Public function Virtual bool Sets the dynamic parameters needed by the material instance for rendering the water info texture.
Public function Virtual void

SetHeightOffset ( float InHeightOffset
)

 Sets an additional water height (For internal use. Please use AWaterBodyOcean instead.)
Public function Virtual void  
Public function void

SetNavAreaClass ( TSubclassOf< UNavAreaBase > NewWaterNavAreaClass
)

 Set the navigation area class
Public function void Sets under water post process material
Public function UFunction BlueprintCallable, Category void

SetWaterAndUnderWaterPostProcessMaterial ( UMaterialInterface* InWaterMaterial,
UMaterialInterface* InUnderWaterPostProcessMaterial
)

  
Public function void

SetWaterBodyStaticMeshEnabled ( bool bEnabled
)

  
Public function void Sets water material
Public function void Sets a static mesh to use as a replacement for the water mesh (for water bodies that are being rendered by the water mesh)
Public function void Sets water static mesh material
Public function UFunction BlueprintCallable, Category void

SetWaterZoneOverride ( const TSoftObjectPtr< AWaterZone >& InWaterZoneOverride
)

 Override the default behavior of water bodies finding their water zone based on bounds and set a specific water zone to which this water body should register.
Public function Const bool Is this water body rendered with the WaterMeshComponent, with the quadtree-based water renderer?
Public function void

UpdateAll ( const FOnWaterBodyChangedParams& InParams
)

  
Public function Virtual void

UpdateComponentVisibility ( bool bAllowWaterZoneRebuild
)

 Updates the bVisible/bHiddenInGame flags on the component and eventually the child renderable components (e.g. custom water body)
Protected function void  
Public function void  
Public function Virtual void Creates/Destroys/Updates necessary MIDS
Protected function void  
Protected function Virtual void

UpdateWaterBody ( bool bWithExclusionVolumes
)

 Updates WaterBody (called 1st with bWithExclusionVolumes = false, then with true
Public function void  
Protected function void  
Protected function bool  
Protected function void  
Public function Virtual void  
Public function void

UpdateWaterZones ( bool bAllowChangesDuringCook
)

 Registers or this water body with corresponding overlapping water zones and unregisters it from any old zones if they are no longer overlapping.

Overridden from UPrimitiveComponent

  Type Name Description
Protected function Virtual void

OnComponentCollisionSettingsChanged ( bool bUpdateOverlaps
)

 Called when the BodyInstance ResponseToChannels, CollisionEnabled or bNotifyRigidBodyCollision changes, in case subclasses want to use that information.
Protected function Virtual void Called when bGenerateOverlapEvents changes, in case subclasses want to use that information.

Overridden from USceneComponent

  Type Name Description
Protected function Virtual bool

MoveComponentImpl ( const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FHitResult* Hit,
EMoveComponentFlags MoveFlags,
ETeleportType Teleport
)

 Override this method for custom behavior for MoveComponent
Protected function Virtual void Overridable internal function to respond to changes in the hidden in game value of the component.
Protected function Virtual void Overridable internal function to respond to changes in the visibility of the component.

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Validates this component's data
Protected function Virtual Const TSubclassOf< class UHLODBuilder > Return the custom HLODBuilder class that should be used to generate HLODs for components of this type.
Protected function Virtual Const bool Override to specify that a component is relevant to the HLOD generation.
Protected function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Component interface
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Protected function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Protected function Virtual void Called after applying a transaction to the object.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void Called before applying a transaction to the object.
Protected function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

  Type Name Description
Public function Virtual Const FBox Get bounds for navigation octree
Public function Virtual Const void INavRelevantInterface start.
Public function Virtual Const bool Are modifiers active?

Constants

Name Description
FixedVelocityName  
FixedWaterDepthName  
FixedZHeightName  
GlobalOceanHeightName  
GroundZMinParamName  
MaxFlowVelocityParamName  
WaterAreaParamName  
WaterBodyIndexParamName Public static constants :
WaterBodyZOffsetParamName  
WaterVelocityAndHeightName  
WaterZMaxParamName  
WaterZMinParamName  

Deprecated Variables

  Type Name Description
Protected variable UProperty bool bCanAffectNavigation_DEPRECATED  
Protected variable UProperty bool bFillCollisionUnderWaterBodiesForNavmesh_DEPRECATED  
Protected variable UProperty bool bGenerateCollisions_DEPRECATED  
Protected variable UProperty bool bOverrideWaterMesh_DEPRECATED  
Protected variable UProperty FName CollisionProfileName_DEPRECATED  
Protected variable UProperty TArray< TLazyObjectPtr< AWaterBodyExclusionVolume > > ExclusionVolumes_DEPRECATED  
Protected variable TArray< TLazyObjectPtr< AWaterBodyIsland > > Islands_DEPRECATED  
Protected variable UProperty TObjectPtr< UMaterialInterface > WaterLODMaterial_DEPRECATED  

Deprecated Functions

  Type Name Description
Protected function Virtual Const bool Please use CanEverAffectNavigation() instead.
Public function Virtual Const bool Renamed to CanEverAffectWaterMesh
Protected function Const AWaterZone * This function is no longer called. Instead uses UWaterSubsystem::FindWaterZone to determine the right water zone when no override is provided.
Public function Const UMaterialInterface * Renamed to GetWaterStaticMeshMaterial
Public function UFunction BlueprintCallable, Category, Meta UMaterialInstanceDynamic * GetWaterLODMaterialInstance has been renamed to GetWaterStaticMeshMaterialInstance.
Protected function Virtual void

OnPostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent,
bool& bShapeOrPositionChanged,
bool& bWeightmapSettingsChanged
)

 Use the version of the function taking FOnWaterBodyChangedParams
Protected function void Use OnWaterSplineDataChanged
Public function UFunction BlueprintCallable, Category, Meta void

OnWaterBodyChanged ( bool bShapeOrPositionChanged,
bool bWeightmapSettingsChanged
)

 Use version which takes FOnWaterBodyChangedParams
Public function void Renamed to SetWaterStaticMeshMaterial
Public function void

UpdateAll ( bool bShapeOrPositionChanged
)

 Use the version of this function taking FOnWaterBodyChangedParams in parameter

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page