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

Light Theme

Dark Theme

AWaterBodyIsland

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AWaterBodyIsland

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable)
class AWaterBodyIsland :
public AActor,
public IWaterBrushActorInterface

Variables

	Name	Description
UBillboardCompo...	ActorIcon
UWaterSplineCom...	SplineComp	The spline data attached to this water type.
FWaterCurveSett...	WaterCurveSettings
FWaterBodyHeigh...	WaterHeightmapSettings
TMap< FName, FW...	WaterWeightmapSettings

Constructors

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

Functions

		Name	Description
	UWaterSpline...	GetWaterSpline()
	void	OnSplineDataChanged()
	void	OnWaterBodyIslandChanged ( bool bShapeOrPositionChanged, bool bWeightmapSettingsChanged )
	void	UpdateActorIcon()
	void	UpdateAll()
	void	UpdateHeight()
	void	UpdateOverlappingWaterBodies()

Overridden from AActor

		Name	Description
	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	PostEditMove ( bool bFinished )	Called after an actor has been moved in the editor

Overridden from UObject

	Name	Description
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	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 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

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

Take our survey

Dismiss