1. Epic GamesDeveloper
  3. UWaterBodyRiverComponent

UWaterBodyRiverComponent

Unreal Engine C++ API Reference > Plugins > Water

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

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UMaterialInterface > LakeTransitionMaterial Material used when a river is overlapping a lake.
Protected variable UProperty Category, Meta Transient nonpieduplicatetransient, textexporttransient, visibleinstanceonly TObjectPtr< UMaterialInstanceDynamic > LakeTransitionMID  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UMaterialInterface > OceanTransitionMaterial This is the material used when a river is overlapping the ocean.
Protected variable UProperty Category, Meta Transient nonpieduplicatetransient, textexporttransient, visibleinstanceonly TObjectPtr< UMaterialInstanceDynamic > OceanTransitionMID  
Protected variable UProperty nonpieduplicatetransient TArray< TObjectPtr< USplineMeshComponent > > SplineMeshComponents  

Constructors

  Type Name Description
Public function  

UWaterBodyRiverComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Protected function void

UpdateSplineMesh ( USplineMeshComponent* MeshComp,
int32 SplinePointIndex
)

  

Overridden from UWaterBodyComponent

  Type Name Description
Protected function Virtual Const bool Generates the mesh representation of the water body
Public function Virtual Const TArray< UPrimitiveComponent * >  
Public function Virtual Const TArray< UPrimitiveComponent * >

GetCollisionComponents ( bool bInOnlyEnabledComponents
)

 Returns body's collision components
Public function Virtual Const UMaterialInterface * Returns river to lake transition water material
Public function Virtual UMaterialInstanceDynamic * Returns River to lake transition material instance (For internal use. Please use AWaterBodyRiver instead.)
Public function Virtual Const UMaterialInterface * Returns river to ocean transition water material
Public function Virtual UMaterialInstanceDynamic * Returns River to ocean transition material instance (For internal use. Please use AWaterBodyRiver instead.)
Public function Virtual Const TArray< UPrimitiveComponent * > 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 EWaterBodyType UWaterBodyComponent Interface
Protected function Virtual Const const TCHAR *  
Protected function Virtual void

OnPostEditChangeProperty ( FOnWaterBodyChangedParams& InOutOnWaterBodyChangedParams
)

  
Protected function Virtual void

OnUpdateBody ( bool bWithExclusionVolumes
)

  
Protected function Virtual void

Reset ()

 UWaterBodyComponent Interface
Protected function Virtual void Creates/Destroys/Updates necessary MIDS

Overridden from USceneComponent

  Type Name Description
Protected function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page