UWaterBodyOceanComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Water

Header

/Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyOceanComponent.h

Include

#include "WaterBodyOceanComponent.h"

Syntax

UCLASS(Blueprintable)
class UWaterBodyOceanComponent : public UWaterBodyComponent

Variables

Name Description

Protected variable UProperty nonpieduplicatetransient

TArray< UOceanB...

 

CollisionBoxes

Protected variable UProperty Category, EditAnywhere BlueprintReadOnly

FVector

 

CollisionExtents

Protected variable UProperty nonpieduplicatetransient

TArray< UOceanC...

 

CollisionHullSets

Protected variable

float

 

HeightOffset

Constructors

Name Description

Public function

UWaterBodyOceanComponent

(
    const FObjectInitializer& ObjectIn...
)

Overridden from UWaterBodyComponent

Name Description

Protected function Virtual

void

 

BeginUpdateWaterBody()

Called every time UpdateAll is called on WaterBody (prior to UpdateWaterBody)

Public function Virtual Const

TArray< UPri...

 

GetCollisionComponents()

Returns body's collision components

Public function Virtual Const

FVector

 

GetCollisionExtents()

Returns collision extents (For internal use. Please use AWaterBodyOcean instead.)

Public function Virtual Const

float

 

GetHeightOffset()

Returns the additional water height added to the body (For internal use. Please use AWaterBodyOcean instead.)

Public function Virtual Const

EWaterBodyTy...

 

GetWaterBodyType()

UWaterBodyComponent Interface

Protected function Virtual Const

bool

 

IsBodyDynamic()

UWaterBodyComponent Interface

Protected function Virtual

void

 

OnPostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...,
    bool& bShapeOrPositionChanged,
    bool& bWeightmapSettingsChanged
)

Called by UWaterBodyComponent::PostEditChangeProperty.

Protected function Virtual

void

 

OnUpdateBody

(
    bool bWithExclusionVolumes
)

Protected function Virtual

void

 

Reset()

Public function Virtual

void

 

SetHeightOffset

(
    float InHeightOffset
)

Sets an additional water height (For internal use. Please use AWaterBodyOcean instead.)