AWaterBodyOcean

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Water

Header

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

Include

#include "WaterBodyOceanActor.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable)
class AWaterBodyOcean : public AWaterBody

Variables

Name Description

Protected variable UProperty Category, EditAnywhere BlueprintReadOnly

FVector

 

CollisionExtents

Protected variable

float

 

HeightOffset

Protected variable UProperty nonpieduplicatetransient

UOceanGenerator...

 

OceanGenerator

Constructors

Name Description

Public function

AWaterBodyOcean

(
    const FObjectInitializer& ObjectIn...
)

Overridden from AWaterBody

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()

AWaterBody Interface

Protected function Virtual

void

 

InitializeBody()

AWaterBody Interface

Protected function Virtual Const

bool

 

IsBodyDynamic()

Returns whether the body is baked (false) at save-time or needs to be dynamically regenerated at runtime (true) and is therefore transient.

Protected function Virtual Const

bool

 

IsBodyInitialized()

Returns whether the body was initialized

Protected function Virtual

void

 

OnPostEditChangeProperty

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

Called by AWaterBodyActor::PostEditChangeProperty.

Public function Virtual

void

 

SetHeightOffset

(
    float InHeightOffset
)

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

Protected function Virtual

void

 

UpdateWaterBody

(
    bool bWithExclusionVolumes
)

Updates WaterBody (called 1st with bWithExclusionVolumes = false, then with true
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss