Navigation
API > API/Plugins > API/Plugins/Water
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&40;Blueprintable&41;
class AWaterBodyIsland :
public AActor,
public IWaterBrushActorInterface
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
TObjectPtr< UBillboardComponent > | ActorIcon | |
     |
TObjectPtr< UWaterSplineComponent > | SplineComp | The spline data attached to this water type. |
    |
FWaterCurveSettings | WaterCurveSettings | |
    |
FWaterBodyHeightmapSettings | WaterHeightmapSettings | |
    |
TMap< FName, FWaterBodyWeightmapSettings > | WaterWeightmapSettings |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
AWaterBodyIsland
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
    |
UWaterSplineComponent * | ||
 |
void | OnWaterBodyIslandChanged
(
const FOnWaterBodyIslandChangedParams& InParams |
|
 |
void | OnWaterSplineDataChanged
(
const FOnWaterSplineDataChangedParams& InParams |
|
 |
void | ||
 |
void | UpdateAll
(
const FOnWaterBodyIslandChangedParams& InParams |
|
 |
void | UpdateHeight () |
|
 |
void |
Overridden from AActor
| Type | 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 | GetActorDescProperties
(
FPropertyPairsMap& PropertyPairsMap |
Add properties to the actor desc. |
  |
void | PostEditMove
(
bool bFinished |
Called after an actor has been moved in the editor |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | 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 | Handles reading, writing, and reference collecting using FArchive. |
Overridden from IWaterBrushActorInterface
| Type | Name | Description | |
|---|---|---|---|
   |
bool | Returns true if this water actor is currently setup to modify the landscape : | |
   |
bool | Returns true if this water actor is currently affecting (i.e. being rendered by) a AWaterZoneActor : | |
   |
bool | Returns true if this water actor could potentially be affecting (i.e. being rendered by) a AWaterZoneActor : | |
   |
void | GetBrushRenderDependencies
(
TSet< UObject* >& OutDependencies |
Returns the list of objects this actor depends on to render its brush (textures, materials...) |
   |
ETextureRenderTargetFormat | Returns the format of the render target used to render this actor in the water brush | |
   |
const TMap< FName, FWaterBodyWeightmapSettings > & | Returns the landscape weightmap settings, per layer, for this water actor | |
   |
const FWaterCurveSettings & | Returns the curve settings for this water actor | |
   |
const FWaterBodyHeightmapSettings & | Returns the landscape heightmap settings for this water actor |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Use OnWaterSplineDataChanged | |
 |
void | OnWaterBodyIslandChanged
(
bool bShapeOrPositionChanged, |
Use the version of this function taking a FOnWaterBodyIslandChangedParams in parameter |
 |
void | UpdateAll () |
Use the version of this function taking FOnWaterBodyIslandChangedParams in parameter |