1. Epic GamesDeveloper
  3. AWaterBody

AWaterBody

Base class for all water body actors.

API > API/Plugins > API/Plugins/Water

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, Config=Engine, Abstract,  
       HideCategories=(Tags, Activation, Cooking, Replication, Input, Actor, AssetUserData))  
class AWaterBody :  
    public AActor ,  
    public IWaterBrushActorInterface

Remarks

Base class for all water body actors.

WaterBodyActors provide a spline-based workflow to create lakes, rivers, and oceans which automatically create meshes, carve landscapes, and support physics interactions.

To create a new water body this class must be derived (native or blueprint) and have the `WaterBodyType_ property changed to the specific water type. The new class will automatically have a corresponding UWaterBodyComponent specific to that water body type. The component class for each water body type can be defined in the Editor Settings.

Variables

  Type Name Description
Protected variable UProperty nonpieduplicatetransient, textexporttransient TObjectPtr< UWaterBodyInfoMeshComponent > DilatedWaterInfoMeshComponent  
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere TObjectPtr< UWaterSplineComponent > SplineComp The spline data attached to this water type.
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere TObjectPtr< UWaterBodyComponent > WaterBodyComponent  
Protected variable UProperty Category, EditDefaultsOnly, Meta Config TSubclassOf< UWaterBodyCustomComponent > WaterBodyCustomComponentClass  
Protected variable UProperty Category, Meta BlueprintReadOnly Transient duplicatetransient, nontransactional int32 WaterBodyIndex Unique Id for accessing (wave, ... ) data in GPU buffers
Protected variable UProperty Category, EditDefaultsOnly, Meta Config TSubclassOf< UWaterBodyLakeComponent > WaterBodyLakeComponentClass  
Protected variable UProperty Category, EditDefaultsOnly, Meta Config TSubclassOf< UWaterBodyOceanComponent > WaterBodyOceanComponentClass  
Protected variable UProperty Category, EditDefaultsOnly, Meta Config TSubclassOf< UWaterBodyRiverComponent > WaterBodyRiverComponentClass  
Protected variable UProperty nonpieduplicatetransient, textexporttransient TArray< TObjectPtr< UWaterBodyStaticMeshComponent > > WaterBodyStaticMeshComponents  
Protected variable UProperty Category, EditDefaultsOnly, Meta EWaterBodyType WaterBodyType  
Protected variable UProperty nonpieduplicatetransient, textexporttransient TObjectPtr< UWaterBodyInfoMeshComponent > WaterInfoMeshComponent  
Protected variable UProperty instanced TObjectPtr< UWaterSplineMetadata > WaterSplineMetadata  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly displayname, instanced TObjectPtr< UWaterWavesBase > WaterWaves #todo_water: This should be moved to the component when component subobjects are supported

Constructors

  Type Name Description
Public function  

AWaterBody ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void Removes all invalid references in the WaterBodyStaticMeshComponents list.
Protected function Virtual void  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta float  
Public function Const UFunction BlueprintCallable, Category, Meta TArray< AWaterBodyExclusionVolume * >  
Public function Const UFunction BlueprintCallable, Category, Meta TArray< AWaterBodyIsland * >  
Public function Virtual UFunction BlueprintCallable, Category, Meta UMaterialInstanceDynamic * Deprecated
Public function Virtual UFunction BlueprintCallable, Category, Meta UMaterialInstanceDynamic *  
Public function Const UFunction BlueprintCallable, Category UWaterBodyComponent * Returns the water body component
Protected function Const const TArray< TObjectPtr< UWaterBodyStaticMeshComponent > > &  
Public function Virtual Const UFunction BlueprintCallable, Category EWaterBodyType Returns the type of body
Public function UFunction BlueprintCallable, Category, Meta UMaterialInstanceDynamic *  
Public function Const UFunction BlueprintCallable, Category UWaterSplineComponent * Returns water spline component
Public function UWaterSplineMetadata *  
Public function Const const UWaterSplineMetadata *  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta float  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta FVector  
Public function Const UFunction BlueprintCallable, Category UWaterWavesBase *  
Protected function Virtual void Initializes the water body by creating the respective component for this water body type.
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category, Meta void

OnWaterBodyChanged ( bool bShapeOrPositionChanged,
bool bWeightmapSettingsChanged
)

  
Protected function void

SetWaterBodyStaticMeshComponents ( TArrayView< TObjectPtr< UWaterBodyStaticMeshComponent > > NewComponentList,
TConstArrayView< TObjectPtr< UWaterBodyStaticMeshComponent > > ComponentsToUnregister
)

 Sets up a new list of water body static mesh components.
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category void

SetWaterWaves ( UWaterWavesBase* InWaterWaves
)

  
Protected function void  

Overridden from AActor

  Type Name Description
Public function Virtual Const void Add properties to the actor desc.
Public function Virtual Const bool Indicates whether this actor contributes to the HLOD generation.
Public function Virtual void Actor Interface
Public function Virtual void

NotifyActorEndOverlap ( AActor* OtherActor
)

 Event when an actor no longer overlaps another actor, and they have separated.
Public function Virtual void Populate the duplication seed when duplicating the actor for PIE.
Public function Virtual void Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.
Public function Virtual void

PostEditMove ( bool bFinished
)

 Called after an actor has been moved in the editor
Public function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.
Public function Virtual void Called right before components are initialized, only called during gameplay
Public function Virtual void Called before all the components in the Components array are registered, called both in editor and during gameplay
Public function Virtual void

SetActorHiddenInGame ( bool bNewHidden
)

 Sets the actor to be hidden in the game
Public function Virtual bool

SetIsHiddenEdLayer ( bool bIsHiddenEdLayer
)

 Changes bHiddenEdLayer flag and returns true if flag changed.
Public function Virtual void

SetIsTemporarilyHiddenInEditor ( bool bIsHidden
)

 Explicitly sets whether or not this actor is hidden in the editor for the duration of the current editor session
Public function Virtual void

UnregisterAllComponents ( bool bForReregister
)

 Unregister all currently registered components

Overridden from UObject

  Type Name Description
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IWaterBrushActorInterface

  Type Name Description
Public function Virtual Const bool Returns true if this water actor is currently setup to modify the landscape :
Public function Virtual Const bool Returns true if this water actor is currently affecting (i.e. being rendered by) a AWaterZoneActor :
Public function Virtual Const bool Returns true if this water actor could potentially be affecting (i.e. being rendered by) a AWaterZoneActor :
Public function Virtual Const TArray< UPrimitiveComponent * > Returns an ordered list of components to render in the actor brush render pass (e.g. USplineMeshComponents for rivers)
Public function Virtual Const void

GetBrushRenderDependencies ( TSet< UObject* >& OutDependencies
)

 Returns the list of objects this actor depends on to render its brush (textures, materials...)
Public function Virtual Const ETextureRenderTargetFormat Returns the format of the render target used to render this actor in the water brush
Public function Virtual Const const TMap< FName, FWaterBodyWeightmapSettings > & Returns the landscape weightmap settings, per layer, for this water actor
Public function Virtual Const const FWaterCurveSettings & Returns the curve settings for this water actor
Public function Virtual Const const FWaterBodyHeightmapSettings & Returns the landscape heightmap settings for this water actor

Deprecated Variables

  Type Name Description
Protected variable UProperty bool bAffectsLandscape_DEPRECATED  
Protected variable UProperty bool bCanAffectNavigation_DEPRECATED  
Protected variable UProperty bool bFillCollisionUnderWaterBodiesForNavmesh_DEPRECATED  
Protected variable UProperty bool bGenerateCollisions_DEPRECATED  
Protected variable UProperty bool bOverrideWaterMesh_DEPRECATED  
Protected variable UProperty FName CollisionProfileName_DEPRECATED  
Protected variable UProperty FWaterCurveSettings CurveSettings_DEPRECATED  
Protected variable UProperty TArray< TLazyObjectPtr< AWaterBodyExclusionVolume > > ExclusionVolumes_DEPRECATED  
Protected variable UProperty TArray< TLazyObjectPtr< AWaterBodyIsland > > Islands_DEPRECATED  
Protected variable UProperty TMap< FName, FWaterBodyWeightmapSettings > LayerWeightmapSettings_DEPRECATED  
Protected variable UProperty float MaxWaveHeightOffset_DEPRECATED  
Protected variable UProperty int32 OverlapMaterialPriority_DEPRECATED  
Protected variable UProperty TObjectPtr< UPhysicalMaterial > PhysicalMaterial_DEPRECATED  
Protected variable UProperty float ShapeDilation_DEPRECATED  
Protected variable UProperty float TargetWaveMaskDepth_DEPRECATED  
Protected variable UProperty FLandmassTerrainCarvingSettings TerrainCarvingSettings_DEPRECATED  
Protected variable UProperty TObjectPtr< UMaterialInterface > UnderwaterPostProcessMaterial_DEPRECATED  
Protected variable UProperty TObjectPtr< UMaterialInstanceDynamic > UnderwaterPostProcessMID_DEPRECATED  
Protected variable UProperty FUnderwaterPostProcessSettings UnderwaterPostProcessSettings_DEPRECATED  
Protected variable UProperty FWaterBodyHeightmapSettings WaterHeightmapSettings_DEPRECATED  
Protected variable UProperty TObjectPtr< UMaterialInterface > WaterMaterial_DEPRECATED  
Protected variable UProperty TObjectPtr< UStaticMesh > WaterMeshOverride_DEPRECATED  
Protected variable UProperty TObjectPtr< UMaterialInstanceDynamic > WaterMID_DEPRECATED  
Protected variable UProperty TSubclassOf< UNavAreaBase > WaterNavAreaClass_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page