UWaterBodyRiverComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Water

Header

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

Include

#include "WaterBodyRiverComponent.h"

Syntax

UCLASS(Blueprintable)
class UWaterBodyRiverComponent : public UWaterBodyComponent

Variables

Name Description

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

UMaterialInterf...

 

LakeTransitionMaterial

Material used when a river is overlapping a lake.

Protected variable UProperty Category, Meta Transient nonpieduplicatetransient, textexporttransient, visibleinstanceonly

UMaterialInstan...

 

LakeTransitionMID

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

UMaterialInterf...

 

OceanTransitionMaterial

This is the material used when a river is overlapping the ocean.

Protected variable

UMaterialInstan...

 

OceanTransitionMID

Protected variable UProperty nonpieduplicatetransient

TArray< USpline...

 

SplineMeshComponents

Constructors

Name Description

Public function

UWaterBodyRiverComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Overridden from UWaterBodyComponent

Name Description

Public function Virtual Const

TArray< UPri...

 

GetBrushRenderableComponents()

Public function Virtual Const

TArray< UPri...

 

GetCollisionComponents()

Returns body's collision components

Public function Virtual

UMaterialIns...

 

GetRiverToLakeTransitionMaterialInstance()

Returns River to lake transition material instance (For internal use. Please use AWaterBodyRiver instead.)

Public function Virtual

UMaterialIns...

 

GetRiverToOceanTransitionMaterialInstance()

Returns River to ocean transition material instance (For internal use. Please use AWaterBodyRiver instead.)

Public function Virtual Const

TArray< UPri...

 

GetStandardRenderableComponents()

Retrieves the list of primitive components that this water body uses when not being rendered by the water mesh (e.g. the static mesh component used when WaterMeshOverride is specified)

Public function Virtual Const

EWaterBodyTy...

 

GetWaterBodyType()

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

UWaterBodyComponent Interface

Protected function Virtual

void

 

UpdateMaterialInstances()

Creates/Destroys/Updates necessary MIDS