Navigation
API > API/Plugins > API/Plugins/Water
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- USceneComponent
- UPrimitiveComponent
- UWaterBodyComponent
- UWaterBodyOceanComponent
References
| Module | Water |
| Header | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyOceanComponent.h |
| Include | #include "WaterBodyOceanComponent.h" |
Syntax
UCLASS&40;Blueprintable&41;
class UWaterBodyOceanComponent : public UWaterBodyComponent
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< TObjectPtr< UOceanBoxCollisionComponent > > | CollisionBoxes | |
    |
FVector | CollisionExtents | |
   |
TArray< TObjectPtr< UOceanCollisionComponent > > | CollisionHullSets | |
   |
float | HeightOffset | |
    |
FVector2D | OceanExtents | The extent of the ocean, centered around water zone to which the ocean belongs. |
  |
FVector2D | SavedZoneLocation | Saved water zone location so that the ocean mesh can be regenerated relative to it and match it perfectly without being loaded. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UWaterBodyOceanComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
    |
void | Rebuilds the ocean mesh to completely fill the zone to which it belongs. | |
 |
void | SetCollisionExtents
(
const FVector& NewExtents |
|
 |
void | SetOceanExtent
(
const FVector2D& NewExtents |
Overridden from UWaterBodyComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | Called every time UpdateAll is called on WaterBody (prior to UpdateWaterBody) | |
  |
TArray< TSharedRef< FTokenizedMessage > > | ||
   |
bool | GenerateWaterBodyMesh
(
UE::Geometry::FDynamicMesh3& OutMesh, |
Generates the mesh representation of the water body |
   |
TArray< UPrimitiveComponent * > | GetCollisionComponents
(
bool bInOnlyEnabledComponents |
Returns body's collision components |
   |
FVector | Returns collision half-extents | |
   |
float | Returns the additional water height added to the body (For internal use. Please use AWaterBodyOcean instead.) | |
   |
EWaterBodyType | UWaterBodyComponent Interface | |
   |
const TCHAR * | ||
   |
bool | UWaterBodyComponent Interface | |
  |
void | OnPostEditChangeProperty
(
FOnWaterBodyChangedParams& InOutOnWaterBodyChangedParams |
|
  |
void | Called when the WaterBodyActor has had all its components registered. | |
  |
void | OnUpdateBody
(
bool bWithExclusionVolumes |
|
  |
void | ||
  |
void | Reset () |
|
  |
void | SetHeightOffset
(
float InHeightOffset |
Sets an additional water height (For internal use. Please use AWaterBodyOcean instead.) |
Overridden from USceneComponent
| Type | Name | Description | |
|---|---|---|---|
   |
FBoxSphereBounds | CalcBounds
(
const FTransform& LocalToWorld |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
  |
FVector2D | VisualExtents_DEPRECATED |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FVector2D | Oceans no longer rely on the visual extent parameter making this obsolete. Instead they will be guaranteed to fill the entire water zone to which they belong. | |
 |
void | SetVisualExtents
(
FVector2D |
Oceans no longer rely on the visual extent parameter making this obsolete. Instead they will be guaranteed to fill the entire water zone to which they belong. |