Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

AWaterBodyRiver

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AWaterBody

AWaterBodyRiver

References

Module	Water
Header	/Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyRiverActor.h
Include	#include "WaterBodyRiverActor.h"

Syntax

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

Variables

	Name	Description
UMaterialInterf...	LakeTransitionMaterial	Material used when a river is overlapping a lake.
UMaterialInstan...	LakeTransitionMID
UMaterialInterf...	OceanTransitionMaterial	This is the material used when a river is overlapping the ocean.
UMaterialInstan...	OceanTransitionMID
URiverGenerator...	RiverGenerator

Constructors

	Name	Description
	AWaterBodyRiver ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	void	CreateOrUpdateLakeTransitionMID()
	void	CreateOrUpdateOceanTransitionMID()
	void	SetLakeTransitionMaterial ( UMaterialInterface* InMat )
	void	SetOceanTransitionMaterial ( UMaterialInterface* InMat )

Overridden from AWaterBody

	Name	Description
TArray< UPri...	GetCollisionComponents()	Returns body's collision components
UMaterialIns...	GetRiverToLakeTransitionMaterialInstance()	Returns River to lake transition material instance (For internal use. Please use AWaterBodyRiver instead.)
UMaterialIns...	GetRiverToOceanTransitionMaterialInstance()	Returns River to ocean transition material instance (For internal use. Please use AWaterBodyRiver instead.)
EWaterBodyTy...	GetWaterBodyType()	AWaterBody Interface
void	InitializeBody()	AWaterBody Interface
bool	IsBodyInitialized()	Returns whether the body was initialized
void	OnPostEditChangeProperty ( FPropertyChangedEvent& PropertyCha..., bool& bShapeOrPositionChanged, bool& bWeightmapSettingsChanged )	Called by AWaterBodyActor::PostEditChangeProperty.
void	UpdateMaterialInstances()	Creates/Destroys/Updates necessary MIDS
void	UpdateWaterBody ( bool bWithExclusionVolumes )	Updates WaterBody (called 1st with bWithExclusionVolumes = false, then with true

Overridden from IWaterBrushActorInterface

		Name	Description
	TArray< UPri...	GetBrushRenderableComponents()	IWaterBrushActorInterface Interface

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss