AWaterBody

Choose your operating system:

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(Blueprintable, Abstract,
       HideCategories=(Tags, Activation, Cooking, Replication, Input, Actor, AssetUserData))
class AWaterBody :
    public AActor,
    public IWaterBrushActorInterface

Variables

	Name	Description
UBillboardCompo...	ActorIcon
UWaterSplineCom...	SplineComp	The spline data attached to this water type.
UWaterBodyCompo...	WaterBodyComponent
int32	WaterBodyIndex	Unique Id for accessing (wave, ... ) data in GPU buffers
EWaterBodyType	WaterBodyType
UWaterSplineMet...	WaterSplineMetadata
UWaterWavesBase...	WaterWaves	#todo_water: This should be moved to the component when component subobjects are supported

Constructors

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

Functions

	Name	Description
void	DeprecateData()
float	GetAudioIntensityAtSplineInputKey ( float InKey )
TArray< AWat...	GetExclusionVolumes()
TArray< AWat...	GetIslands()
UMaterialIns...	GetRiverToLakeTransitionMaterialInstance()
UMaterialIns...	GetRiverToOceanTransitionMaterialInstance()
UWaterBodyCo...	GetWaterBodyComponent()	Returns the water body component
EWaterBodyTy...	GetWaterBodyType()	Returns the type of body
UMaterialIns...	GetWaterMaterialInstance()
UWaterSpline...	GetWaterSpline()	Returns water spline component
UWaterSpline...	GetWaterSplineMetadata()
const UWater...	GetWaterSplineMetadata()
float	GetWaterVelocityAtSplineInputKey ( float InKey )
FVector	GetWaterVelocityVectorAtSplineInputKey ( float InKey )
UWaterWavesB...	GetWaterWaves()
void	InitializeBody()	Initializes the water body by creating the respective component for this water body type.
bool	IsIconVisible()	Returns whether icon billboard is visible.
void	OnWaterBodyChanged ( bool bShapeOrPositionChanged, bool bWeightmapSettingsChanged )
void	SetWaterMaterial ( UMaterialInterface* InMaterial )
void	SetWaterWaves ( UWaterWavesBase* InWaterWaves )
void	SetWaterWavesInternal ( UWaterWavesBase* InWaterWaves )
void	UpdateActorIcon()	#todo_water: all icon stuff can be moved to the component

Overridden from AActor

	Name	Description
void	NotifyActorBeginOverlap ( AActor* OtherActor )	Actor Interface
void	NotifyActorEndOverlap ( AActor* OtherActor )	Event when an actor no longer overlaps another actor, and they have separated.
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	PreInitializeComponents()	Called right before components are initialized, only called during gameplay
void	PreRegisterAllComponents()	Called before all the components in the Components array are registered, called both in editor and during gameplay
void	SetActorHiddenInGame ( bool bNewHidden )	Sets the actor to be hidden in the game
bool	SetIsHiddenEdLayer ( bool bIsHiddenEdLayer )	Changes bHiddenEdLayer flag and returns true if flag changed.
void	SetIsTemporarilyHiddenInEditor ( bool bIsHidden )	Explicitly sets whether or not this actor is hidden in the editor for the duration of the current editor session
void	UnregisterAllComponents ( bool bForReregister )	Unregister all currently registered components

Overridden from UObject

	Name	Description
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	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
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	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

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 AWaterZoneActor :
bool	CanAffectWaterMesh()	Returns true if this water actor could potentially be affecting (i.e. being rendered by) a AWaterZoneActor :
TArray< UPri...	GetBrushRenderableComponents()	Returns an ordered list of components to render in the actor brush render pass (e.g. USplineMeshComponents for rivers)
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

Deprecated Variables

		Name	Description
	bool	bAffectsLandscape_DEPRECATED
	bool	bCanAffectNavigation_DEPRECATED
	bool	bFillCollisionUnderWaterBodiesForNavmesh_DEPRECATED
	bool	bGenerateCollisions_DEPRECATED
	bool	bOverrideWaterMesh_DEPRECATED
	FName	CollisionProfileName_DEPRECATED
	FWaterCurveSett...	CurveSettings_DEPRECATED
	TArray< TLazyOb...	ExclusionVolumes_DEPRECATED
	TArray< TLazyOb...	Islands_DEPRECATED
	TMap< FName, FW...	LayerWeightmapSettings_DEPRECATED
	float	MaxWaveHeightOffset_DEPRECATED
	int32	OverlapMaterialPriority_DEPRECATED
	UPhysicalMateri...	PhysicalMaterial_DEPRECATED
	float	ShapeDilation_DEPRECATED
	float	TargetWaveMaskDepth_DEPRECATED
	FLandmassTerrai...	TerrainCarvingSettings_DEPRECATED
	UMaterialInterf...	UnderwaterPostProcessMaterial_DEPRECATED
	UMaterialInstan...	UnderwaterPostProcessMID_DEPRECATED
	FUnderwaterPost...	UnderwaterPostProcessSettings_DEPRECATED
	FWaterBodyHeigh...	WaterHeightmapSettings_DEPRECATED
	UMaterialInterf...	WaterMaterial_DEPRECATED
	UStaticMesh ...	WaterMeshOverride_DEPRECATED
	UMaterialInstan...	WaterMID_DEPRECATED
	TSubclassOf< UN...	WaterNavAreaClass_DEPRECATED

Deprecated Functions

	Name	Description
void	AddExclusionVolume ( AWaterBodyExclusionVolume* InE... )	Moved to WaterBodyComponent
void	BeginUpdateWaterBody()	Moved to WaterBodyComponent
bool	CanAffectNavigation()	Moved to WaterBodyComponent
bool	ContainsExclusionVolume ( TLazyObjectPtr< AWaterBodyExclusion... )	Moved to WaterBodyComponent
bool	ContainsIsland ( TLazyObjectPtr< AWaterBodyIsland > ... )	Moved to WaterBodyComponent
float	FindInputKeyClosestToWorldLocation ( const FVector& WorldLocation )	Moved to WaterBodyComponent
ALandscapePr...	FindLandscape()	Moved to WaterBodyComponent
float	GetChannelDepth()	Moved to WaterBodyComponent
TArray< UPri...	GetCollisionComponents()	Moved to WaterBodyComponent
FVector	GetCollisionExtents()	Moved to WaterBodyComponent
float	GetConstantDepth()	Moved to WaterBodyComponent
float	GetConstantSurfaceZ()	Moved to WaterBodyComponent
float	GetHeightOffset()	Moved to WaterBodyComponent
int32	GetOverlapMaterialPriority()	Moved to WaterBodyComponent
FPostProcess...	GetPostProcessProperties()	Moved to WaterBodyComponent
float	GetSimpleWaveHeightAtPosition ( const FVector& InPosition, float InWaterDepth, float InTime )	Moved to WaterBodyComponent
void	GetSurfaceMinMaxZ ( float& OutMinZ, float& OutMaxZ )	Moved to WaterBodyComponent
FVector	GetWaterNavCollisionOffset()	Moved to WaterBodyComponent
float	GetWaveAttenuationFactor ( const FVector& InPosition, float InWaterDepth )	Moved to WaterBodyComponent
float	GetWaveHeightAtPosition ( const FVector& InPosition, float InWaterDepth, float InTime, FVector& OutNormal )	Moved to WaterBodyComponent
bool	GetWaveInfoAtPosition ( const FVector& InPosition, float InWaterDepth, bool bInSimpleWaves, FWaveInfo& InOutWaveInfo )	Moved to WaterBodyComponent
float	GetWaveReferenceTime()	Moved to WaterBodyComponent
bool	HasWaves()	Moved to WaterBodyComponent
bool	IsBodyDynamic()	Moved to WaterBodyComponent
bool	IsFlatSurface()	Moved to WaterBodyComponent
bool	IsHeightOffsetSupported()	Moved to WaterBodyComponent
bool	IsWaterSplineClosedLoop()	Moved to WaterBodyComponent
bool	IsWaveSupported()	Moved to WaterBodyComponent
bool	IsWorldLocationInExclusionVolume ( const FVector& InWorldLocation )	Moved to WaterBodyComponent
FWaterBodyQu...	QueryWaterInfoClosestToWorldLocation ( const FVector& InWorldLocation, EWaterBodyQueryFlags InQueryFlags, const TOptional< float >& InSpline... )	Moved to WaterBodyComponent
void	RemoveExclusionVolume ( AWaterBodyExclusionVolume* InE... )	Moved to WaterBodyComponent
void	SetDynamicParametersOnMID ( UMaterialInstanceDynamic* InMI... )	Moved to WaterBodyComponent
void	SetHeightOffset ( float InHeightOffset )	Moved to WaterBodyComponent
void	SetUnderwaterPostProcessMaterial ( UMaterialInterface* InMaterial )	Moved to WaterBodyComponent
void	SetWaterMeshOverride ( UStaticMesh* InMesh )	Moved to WaterBodyComponent
bool	ShouldGenerateWaterMeshTile()	Moved to WaterBodyComponent
void	UpdateMaterialInstances()	Moved to WaterBodyComponent
void	UpdateWaterBody ( bool bWithExclusionVolumes )	Moved to WaterBodyComponent