Navigation
API > API/Plugins > API/Plugins/Water
| Name | AWaterBodyIsland |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyIslandActor.h |
| Include Path | #include "WaterBodyIslandActor.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable)
class AWaterBodyIsland :
public AActor ,
public IWaterBrushActorInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AWaterBodyIsland
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AWaterBodyIsland
(
const FObjectInitializer& ObjectInitializer |
WaterBodyIslandActor.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActorIcon | TObjectPtr< UBillboardComponent > | WaterBodyIslandActor.h |
|
|
| WaterCurveSettings | FWaterCurveSettings | WaterBodyIslandActor.h |
|
|
| WaterHeightmapSettings | FWaterBodyHeightmapSettings | WaterBodyIslandActor.h |
|
|
| WaterWeightmapSettings | TMap< FName, FWaterBodyWeightmapSettings > | WaterBodyIslandActor.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWaterSplineComponent * GetWaterSpline() |
WaterBodyIslandActor.h |
|
|
void UpdateActorIcon() |
WaterBodyIslandActor.h | ||
void UpdateHeight() |
WaterBodyIslandActor.h | ||
void UpdateOverlappingWaterBodyComponents() |
WaterBodyIslandActor.h |
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetActorDescProperties
(
FPropertyPairsMap& PropertyPairsMap |
WaterBodyIslandActor.h | ||
virtual void PostEditMove
(
bool bFinished |
WaterBodyIslandActor.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
WaterBodyIslandActor.h | ||
virtual void PostEditImport() |
WaterBodyIslandActor.h | ||
virtual void PostEditUndo() |
WaterBodyIslandActor.h | ||
virtual void PostLoad() |
WaterBodyIslandActor.h | ||
virtual void Serialize
(
FArchive& Ar |
WaterBodyIslandActor.h |
Overridden from IWaterBrushActorInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AffectsLandscape() |
Returns true if this water actor is currently setup to modify the landscape : | WaterBodyIslandActor.h | |
virtual bool AffectsWaterMesh() |
Returns true if this water actor is currently affecting (i.e. being rendered by) a AWaterZone actor : | WaterBodyIslandActor.h | |
virtual bool CanEverAffectWaterInfo() |
Returns true if this water actor could potentially be affecting the water info texture of an AWaterZone actor: | WaterBodyIslandActor.h | |
virtual bool CanEverAffectWaterMesh() |
Returns true if this water actor could potentially be affecting (i.e. being rendered by) a AWaterZone actor : | WaterBodyIslandActor.h | |
virtual void GetBrushRenderDependencies
(
TSet< UObject* >& OutDependencies |
Returns the list of objects this actor depends on to render its brush (textures, materials...) | WaterBodyIslandActor.h | |
virtual ETextureRenderTargetFormat GetBrushRenderTargetFormat() |
Returns the format of the render target used to render this actor in the water brush | WaterBodyIslandActor.h | |
virtual const TMap< FName, FWaterBodyWeightmapSettings > & GetLayerWeightmapSettings() |
Returns the landscape weightmap settings, per layer, for this water actor | WaterBodyIslandActor.h | |
virtual const FWaterCurveSettings & GetWaterCurveSettings() |
Returns the curve settings for this water actor | WaterBodyIslandActor.h | |
virtual const FWaterBodyHeightmapSettings & GetWaterHeightmapSettings() |
Returns the landscape heightmap settings for this water actor | WaterBodyIslandActor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnWaterBodyIslandChanged
(
const FOnWaterBodyIslandChangedParams& InParams |
WaterBodyIslandActor.h | ||
void OnWaterSplineDataChanged
(
const FOnWaterSplineDataChangedParams& InParams |
WaterBodyIslandActor.h | ||
void UpdateAll
(
const FOnWaterBodyIslandChangedParams& InParams |
WaterBodyIslandActor.h |
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Destroyed() |
WaterBodyIslandActor.h |