Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Water > AWaterBody

Light Theme

Dark Theme

AWaterBody

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AWaterBody

	AWaterBodyCustom
	AWaterBodyLake
	AWaterBodyOcean
	AWaterBodyRiver

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Abstract,
       HideCategories=(Tags, Activation, Cooking, Replication, Input, Actor, AssetUserData))
class AWaterBody :
    public AActor,
    public INavRelevantInterface,
    public IWaterBrushActorInterface

Variables

	Name	Description
UBillboardCompo...	ActorIcon
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 and remove the bool (WaterMeshOverride is already a pointer.
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
UWaterSplineCom...	SplineComp	The spline data attached to this water type.
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
EWaterBodyType	WaterBodyType	: Remove and always use GetWaterBodyType()
FWaterBodyHeigh...	WaterHeightmapSettings
UMaterialInterf...	WaterMaterial
UStaticMesh ...	WaterMeshOverride
UMaterialInstan...	WaterMID
TSubclassOf< UN...	WaterNavAreaClass	The navigation area class that will be generated on nav mesh.
UWaterSplineMet...	WaterSplineMetadata
UWaterWavesBase...	WaterWaves

Constructors

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

Functions

	Name	Description
void	AddExclusionVolume ( AWaterBodyExclusionVolume* InE... )	Adds WaterBody exclusion volume
void	AddIsland ( AWaterBodyIsland* Island )
void	ApplyNavigationSettings()
void	BeginUpdateWaterBody()	Called every time UpdateAll is called on WaterBody (prior to UpdateWaterBody)
bool	CanAffectNavigation()	Returns whether the body affects navigation
EWaterBodyQu...	CheckAndAjustQueryFlags ( EWaterBodyQueryFlags InQueryFlags )
EWaterBodySt...	CheckWaterBodyStatus()
bool	ContainsExclusionVolume ( TLazyObjectPtr< AWaterBodyExclusion... )
bool	ContainsIsland ( TLazyObjectPtr< AWaterBodyIsland > ... )
void	CreateOrUpdateUnderwaterPostProcessMID()
void	CreateOrUpdateWaterMID()
float	FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation )	Spline query helper.
ALandscapePr...	FindLandscape()
void	FixupOnPostRegisterAllComponents()	For internal use.
float	GetAudioIntensityAtSplineInputKey ( float InKey )
float	GetChannelDepth()	Returns channel depth
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.
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
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)
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
EWaterBodyTy...	GetWaterBodyType()	Returns the type of body
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
float	GetWaterVelocityAtSplineInputKey ( float InKey )	Spline queries specific to metadata type
FVector	GetWaterVelocityVectorAtSplineInputKey ( float InKey )
const UWater...	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
void	InitializeBody()	Initializes the water body
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	IsBodyInitialized()	Returns whether the body was initialized
bool	IsFlatSurface()	Returns whether the body has a flat surface or not
bool	IsHeightOffsetSupported()	Returns whether the body support a height offset
bool	IsIconVisible()	Returns whether icon billboard is visible.
bool	IsWaterBodyTypeReadOnly()	For internal use.
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 AWaterBodyActor::PostEditChangeProperty.
void	OnSplineDataChanged()
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	SetDynamicParametersOnMID ( UMaterialInstanceDynamic* InMI... )	Sets the dynamic parameters needed by the material instance for rendering
void	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	SetOceanOnWaterSubsystem()
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)
void	SetWaterWaves ( UWaterWavesBase* InWaterWaves )
void	SetWaterWavesInternal ( UWaterWavesBase* InWaterWaves, bool bTriggerWaterBodyChanged )
bool	ShouldGenerateWaterMeshTile()	Is this water body rendered with the WaterMeshComponent, with the quadtree-based water renderer?
void	UpdateActorIcon()
void	UpdateAll ( bool bShapeOrPositionChanged )
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
void	UpdateWaterComponentVisibility()
bool	UpdateWaterHeight()

Overridden from AActor

	Name	Description
void	BeginPlay()	Overridable native event for when play begins for this actor.
void	CheckForErrors()	Validates this actor's data
void	Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
void	NotifyActorBeginOverlap ( AActor* OtherActor )	Actor Interface
void	NotifyActorEndOverlap ( AActor* OtherActor )	Event when an actor no longer overlaps another actor, and they have separated.
void	OnConstruction ( const FTransform& Transform )	AActor interface
void	PostEditMove ( bool bFinished )	Called after an actor has been moved in the editor
void	PostRegisterAllComponents()	Called after all the components in the Components array are registered, called both in editor and during gameplay
void	PostUnregisterAllComponents()	Called after all currently registered components are cleared
void	PreInitializeComponents()	Called right before components are initialized, only called during gameplay

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	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
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?

Overridden from IWaterBrushActorInterface

	Name	Description
bool	AffectsLandscape()	Returns true if this water actor is currently setup to modify the landscape :
bool	AffectsWaterMesh()	Returns true if this water actor is currently affecting (i.e. being rendered by) a AWaterMeshActor :
bool	CanAffectWaterMesh()	Returns true if this water actor could potentially be affecting (i.e. being rendered by) a AWaterMeshActor :
void	GetBrushRenderDependencies ( TSet< UObject* >& OutDependen... )	Returns the list of objects this actor depends on to render its brush (textures, materials...)
ETextureRend...	GetBrushRenderTargetFormat()	Returns the format of the render target used to render this actor in the water brush
const TMap< ...	GetLayerWeightmapSettings()	Returns the landscape weightmap settings, per layer, for this water actor
const FWater...	GetWaterCurveSettings()	Returns the curve settings for this water actor
const FWater...	GetWaterHeightmapSettings()	Returns the landscape heightmap settings for this water actor

Enums

	Name	Description
	EWaterBodyStatus

Constants

Name	Description
FixedZHeightName
GlobalOceanHeightName
OverriddenWaterDepthName
WaterBodyIndexParamName	Public static constants :
WaterVelocityAndHeightName

Deprecated Variables

		Name	Description
	FLandmassTerrai...	TerrainCarvingSettings_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss