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 > UWaterWavesAssetReference

Light Theme

Dark Theme

UWaterWavesAssetReference

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UWaterWavesBase

UWaterWavesAssetReference

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, NotBlueprintable, AutoExpandCategories="Water Waves Asset")
class UWaterWavesAssetReference : public UWaterWavesBase

Functions

		Name	Description
	const UWater...	GetWaterWavesAsset ( UWaterWaves* InWaterWavesAsset )
	void	SetWaterWavesAsset ( UWaterWavesAsset* InWaterWaves... )

Overridden from UWaterWavesBase

	Name	Description
float	GetMaxWaveHeight()	Returns the maximum wave height that can be reached by those waves
float	GetSimpleWaveHeightAtPosition ( const FVector& InPosition, float InWaterDepth, float InTime )	Computes the raw wave perturbation of the water height only (simple version : faster computation)
const UWater...	GetWaterWaves()	Return the underlying Water class type.
UWaterWaves ...	GetWaterWaves()
float	GetWaveAttenuationFactor ( const FVector& InPosition, float InWaterDepth, float InTargetWaveMaskDepth )	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

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostDuplicate ( EDuplicateMode::Type DuplicateMode )
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
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.

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

Take our survey

Dismiss