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
Public variable bool bWeightmapSettingsChanged  
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 void

GetActorDescProperties ( FPropertyPairsMap& PropertyPairsMap
)

  
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 Const UFunction BlueprintCallable, Category UWaterSplineComponent * Returns water spline component
Public function Const const UWaterSplineMetadata *  
Public function UWaterSplineMetadata *  
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

IsComponentRelevantForNavigation ( UActorComponent* Component
)

  
Public function Virtual Const bool  
Public function Virtual void

NotifyActorBeginOverlap ( AActor* OtherActor
)

 Actor Interface
Public function Virtual void

NotifyActorEndOverlap ( AActor* OtherActor
)

  
Public function Virtual void

PopulatePIEDuplicationSeed ( AActor::FDuplicationSeedInterface& DuplicationSeed
)

  
Public function Virtual void  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void

PostEditMove ( bool bFinished
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

SetActorHiddenInGame ( bool bNewHidden
)

  
Public function Virtual bool

SetIsHiddenEdLayer ( bool bIsHiddenEdLayer
)

  
Public function Virtual void

SetIsTemporarilyHiddenInEditor ( bool bIsHidden
)

  
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 void

SetWaterWaves ( UWaterWavesBase* InWaterWaves
)

  
Protected function void  
Public function Virtual void

UnregisterAllComponents ( bool bForReregister
)

  

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

Deprecated Functions

  Type Name Description
Public function Const  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function Const  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function Const  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function Const  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

 Deprecated
Public function Const  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  
Public function  

UE_DEPRECATED ( all,
"Moved to WaterBodyComponent"
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page