UWaterBodyComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UWaterBodyComponent

	UWaterBodyCustomComponent
	UWaterBodyLakeComponent
	UWaterBodyOceanComponent
	UWaterBodyRiverComponent

References

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

Syntax

UCLASS(Abstract,
HideCategories=(Tags, Activation, Cooking, Replication, Input, AssetUserData, Mesh))
class UWaterBodyComponent : public UPrimitiveComponent

Variables

	Name	Description
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
bool	bCanAffectNavigation
bool	bFillCollisionUnderWaterBodiesForNavmesh	Prevent navmesh generation under the water geometry
bool	bGenerateCollisions	If true, one or more collision components associated with this water will be generated.
bool	bOverrideWaterMesh	TODO [jonathan.bard] : make sure override water mesh works for all types.
float	CollisionHeightOffset	The distance above the surface of the water where collision checks should still occur.
FName	CollisionProfileName
FPostProcessSet...	CurrentPostProcessSettings
FWaterCurveSett...	CurveSettings
TArray< TLazyOb...	ExclusionVolumes
TArray< TLazyOb...	Islands	Islands in this water body
TWeakObjectPtr<...	Landscape
TMap< FName, FW...	LayerWeightmapSettings
float	MaxWaveHeightOffset	Offset added to the automatically calculated max wave height bounds.
int32	OverlapMaterialPriority	Higher number is higher priority.
UPhysicalMateri...	PhysicalMaterial
float	ShapeDilation
float	TargetWaveMaskDepth	Water depth at which waves start being attenuated.
UMaterialInterf...	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).
UMaterialInstan...	UnderwaterPostProcessMID
FUnderwaterPost...	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).
int32	WaterBodyIndex	Unique Id for accessing (wave, ... ) data in GPU buffers
FWaterBodyHeigh...	WaterHeightmapSettings
UMaterialInterf...	WaterMaterial
UStaticMesh ...	WaterMeshOverride
UMaterialInstan...	WaterMID
TSubclassOf< UN...	WaterNavAreaClass	The navigation area class that will be generated on nav mesh.
UWaterSplineMet...	WaterSplineMetadata

Constructors

	Name	Description
	UWaterBodyComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddExclusionVolume ( AWaterBodyExclusionVolume* InE... )	Adds WaterBody exclusion volume
void	AddIsland ( AWaterBodyIsland* Island )
bool	AffectsLandscape()
bool	AffectsWaterMesh()
void	ApplyNavigationSettings()
void	BeginUpdateWaterBody()	Called every time UpdateAll is called on WaterBody (prior to UpdateWaterBody)
bool	CanAffectNavigation()	Returns whether the body affects navigation
bool	CanAffectWaterMesh()
EWaterBodyQu...	CheckAndAjustQueryFlags ( EWaterBodyQueryFlags InQueryFlags )
TArray< TSha...	CheckWaterBodyStatus()
bool	ContainsExclusionVolume ( TLazyObjectPtr< AWaterBodyExclusion... )
bool	ContainsIsland ( TLazyObjectPtr< AWaterBodyIsland > ... )
void	CreateOrUpdateUnderwaterPostProcessMID()
void	CreateOrUpdateWaterMID()
float	FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation )	Spline query helper.
ALandscapePr...	FindLandscape()
float	GetAudioIntensityAtSplineInputKey ( float InKey )
TArray< UPri...	GetBrushRenderableComponents()
void	GetBrushRenderDependencies ( TSet< UObject* >& OutDependen... )
ETextureRend...	GetBrushRenderTargetFormat()
float	GetChannelDepth()	Returns channel depth
FBox	GetCollisionComponentBounds()	Returns the body's collision component bounds
TArray< UPri...	GetCollisionComponents()	Returns body's collision components
FVector	GetCollisionExtents()	Returns collision extents (For internal use. Please use AWaterBodyOcean instead.)
FName	GetCollisionProfileName()	Returns collision profile name
float	GetConstantDepth()	Returns what can be considered the single water depth of the water surface.
float	GetConstantSurfaceZ()	Returns what can be considered the single base Z of the water surface.
FVector	GetConstantVelocity()	Returns what can be considered the single water velocity of the water surface.
TArray< AWat...	GetExclusionVolumes()	Gets the exclusion volume that influence this water body
float	GetHeightOffset()	Returns the additional water height added to the body (For internal use. Please use AWaterBodyOcean instead.)
TArray< AWat...	GetIslands()	Gets the islands that influence this water body
const TMap< ...	GetLayerWeightmapSettings()
float	GetMaxWaveHeight()	Returns the max height that this water body's waves can hit.
TSubclassOf<...	GetNavAreaClass()	Returns navigation area class
int32	GetOverlapMaterialPriority()	Returns overlap material priority
FPostProcess...	GetPostProcessProperties()	Returns post process properties
UMaterialIns...	GetRiverToLakeTransitionMaterialInstance()	Returns River to lake transition material instance (For internal use. Please use AWaterBodyRiver instead.)
UMaterialIns...	GetRiverToOceanTransitionMaterialInstance()	Returns River to ocean transition material instance (For internal use. Please use AWaterBodyRiver instead.)
float	GetSimpleWaveHeightAtPosition ( const FVector& InPosition, float InWaterDepth, float InTime )	Computes the raw wave perturbation of the water height only (simple version : faster computation)
TArray< UPri...	GetStandardRenderableComponents()	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)
void	GetSurfaceMinMaxZ ( float& OutMinZ, float& OutMaxZ )	Returns the minimum and maximum Z of the water surface, including waves
EObjectFlags	GetTransientMIDFlags()
UMaterialIns...	GetUnderwaterPostProcessMaterialInstance()	Returns under water post process MID
AWaterBody &...	GetWaterBodyActor()	Returns the WaterBodyActor who owns this component
int32	GetWaterBodyIndex()	Returns the unique id of this water body for accessing data in GPU buffers
EWaterBodyTy...	GetWaterBodyType()	Returns the type of body
const FWater...	GetWaterCurveSettings()
const FWater...	GetWaterHeightmapSettings()
UMaterialInt...	GetWaterMaterial()	Returns water material
UMaterialIns...	GetWaterMaterialInstance()	Returns water MID
UStaticMesh ...	GetWaterMeshOverride()	Returns water mesh override
FVector	GetWaterNavCollisionOffset()	Returns nav collision offset
UWaterSpline...	GetWaterSpline()	Returns water spline component
UWaterSpline...	GetWaterSplineMetadata()	Returns water spline metadata
const UWater...	GetWaterSplineMetadata()	Returns water spline metadata
void	GetWaterSurfaceInfoAtLocation ( const FVector& InLocation, FVector& OutWaterSurfaceLocation, FVector& OutWaterSurfaceNormal, FVector& OutWaterVelocity, float& OutWaterDepth, bool bIncludeDepth )
float	GetWaterVelocityAtSplineInputKey ( float InKey )	Spline queries specific to metadata type
FVector	GetWaterVelocityVectorAtSplineInputKey ( float InKey )
UWaterWavesB...	GetWaterWaves()
float	GetWaveAttenuationFactor ( const FVector& InPosition, float InWaterDepth )	Computes the attenuation factor to apply to the raw wave perturbation.
float	GetWaveHeightAtPosition ( const FVector& InPosition, float InWaterDepth, float InTime, FVector& OutNormal )	Computes the raw wave perturbation of the water height/normal
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.
float	GetWaveReferenceTime()	Returns the time basis to use in waves computation (must be unique for all water bodies currently, to ensure proper transitions between water tiles)
bool	HasWaves()	Returns true if there are valid water waves
bool	IsBodyDynamic()	Returns whether the body is baked (false) at save-time or needs to be dynamically regenerated at runtime (true) and is therefore transient.
bool	IsFlatSurface()	Returns whether the body has a flat surface or not
bool	IsHeightOffsetSupported()	Returns whether the body support a height offset
bool	IsWaterSplineClosedLoop()	Returns whether the body's spline is closed
bool	IsWaveSupported()	Returns whether the body supports waves
bool	IsWorldLocationInExclusionVolume ( const FVector& InWorldLocation )	Returns true if the location is within one of this water body's exclusion volumes
void	OnPostEditChangeProperty ( FPropertyChangedEvent& PropertyCha..., bool& bShapeOrPositionChanged, bool& bWeightmapSettingsChanged )	Called by UWaterBodyComponent::PostEditChangeProperty.
void	OnSplineDataChanged()
void	OnUpdateBody ( bool bWithExclusionVolumes )
void	OnWaterBodyChanged ( bool bShapeOrPositionChanged, bool bWeightmapSettingsChanged )
void	OnWaterSplineMetadataChanged ( UWaterSplineMetadata* InWaterS..., FPropertyChangedEvent& PropertyCha... )
void	OnWavesDataUpdated ( UWaterWavesBase* InWaterWaves, EPropertyChangeType::Type InChangeT... )
void	PrepareCurrentPostProcessSettings()
FWaterBodyQu...	QueryWaterInfoClosestToWorldLocation ( const FVector& InWorldLocation, EWaterBodyQueryFlags InQueryFlags, const TOptional< float >& InSpline... )	Returns the requested water info closest to this world location
void	RegisterOnChangeWaterSplineMetadata ( UWaterSplineMetadata* InWaterS..., bool bRegister )
void	RegisterOnUpdateWavesData ( UWaterWavesBase* InWaterWaves, bool bRegister )
void	RemoveExclusionVolume ( AWaterBodyExclusionVolume* InE... )	Removes WaterBody exclusion volume
void	RemoveIsland ( AWaterBodyIsland* Island )
void	RequestGPUWaveDataUpdate()
void	Reset()
bool	SetDynamicParametersOnMID ( UMaterialInstanceDynamic* InMI... )	Sets the dynamic parameters needed by the material instance for rendering.
bool	SetDynamicParametersOnUnderwaterPostProcessMID ( UMaterialInstanceDynamic* InMI... )	Sets the dynamic parameters needed by the underwater post process material instance for rendering.
void	SetHeightOffset ( float InHeightOffset )	Sets an additional water height (For internal use. Please use AWaterBodyOcean instead.)
void	SetUnderwaterPostProcessMaterial ( UMaterialInterface* InMaterial )	Sets under water post process material
void	SetWaterMaterial ( UMaterialInterface* InMaterial )	Sets water material
void	SetWaterMeshOverride ( UStaticMesh* InMesh )	Sets the water mesh (when bOverrideWaterMesh is true of the for custom water body actors)
bool	ShouldGenerateWaterMeshTile()	Is this water body rendered with the WaterMeshComponent, with the quadtree-based water renderer?
void	UpdateAll ( bool bShapeOrPositionChanged )
void	UpdateComponentVisibility ( bool bAllowWaterMeshRebuild )	Updates the bVisible/bHiddenInGame flags on the component and eventually the child renderable components (e.g. custom water body)
void	UpdateExclusionVolumes()
void	UpdateIslands()
void	UpdateMaterialInstances()	Creates/Destroys/Updates necessary MIDS
void	UpdateSplineComponent()
void	UpdateWaterBody ( bool bWithExclusionVolumes )	Updates WaterBody (called 1st with bWithExclusionVolumes = false, then with true
bool	UpdateWaterHeight()

Overridden from USceneComponent

	Name	Description
bool	MoveComponentImpl ( const FVector& Delta, const FQuat& NewRotation, bool bSweep, FHitResult* Hit, EMoveComponentFlags MoveFlags, ETeleportType Teleport )	Override this method for custom behavior for MoveComponent
void	OnHiddenInGameChanged()	Overridable internal function to respond to changes in the hidden in game value of the component.
void	OnVisibilityChanged()	Overridable internal function to respond to changes in the visibility of the component.

Overridden from UActorComponent

	Name	Description
void	CheckForErrors()	Validates this component's data
void	OnComponentDestroyed ( bool bDestroyingHierarchy )	Called when a component is destroyed
void	OnRegister()	Component interface

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditImport()	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
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditUndo()	Called before applying a transaction to the object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

	Name	Description
FBox	GetNavigationBounds()	Get bounds for navigation octree
void	GetNavigationData ( FNavigationRelevantData& Data )	INavRelevantInterface start.
bool	IsNavigationRelevant()	Are modifiers active?

Constants

Name	Description
FixedVelocityName
FixedWaterDepthName
FixedZHeightName
GlobalOceanHeightName
WaterAreaParamName
WaterBodyIndexParamName	Public static constants :
WaterVelocityAndHeightName