Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Plugins > Water > UWaterSubsystem

Light Theme

Dark Theme

UWaterSubsystem

This is the API used to get information about water at runtime

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UWorldSubsystem

UTickableWorldSubsystem

UWaterSubsystem

References

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

Syntax

UCLASS(BlueprintType, Transient)
class UWaterSubsystem : public UTickableWorldSubsystem

Remarks

This is the API used to get information about water at runtime

Variables

		Name	Description
	ABuoyancyManage...	BuoyancyManager
	UStaticMesh ...	DefaultLakeMesh
	UStaticMesh ...	DefaultRiverMesh
	FOnCameraUnderw...	OnCameraUnderwaterStateChanged
	FOnWaterScalabi...	OnWaterScalabilityChanged
	UWaterSubsystem...	OnWaterSubsystemInitialized
	FWaterBodyManag...	WaterBodyManager

Constructors

	Name	Description
	UWaterSubsystem()

Functions

	Name	Description
void	ForEachWaterBodyComponent ( const UWorld* World, TFunctionRef< bool... )	Execute a predicate function on each valid water body.
bool	GetAllowWaterSubsystemOnPreviewWorld()
ABuoyancyMan...	GetBuoyancyManager()
float	GetCameraUnderwaterDepth()
UMaterialPar...	GetMaterialParameterCollection()
float	GetOceanBaseHeight()	Returns the base height of the ocean. This should correspond to its world Z position
TWeakObjectP...	GetOceanBodyComponent()
float	GetOceanFloodHeight()	Returns the relative flood height
float	GetOceanTotalHeight()	Returns the total height of the ocean.
float	GetOverrideSmoothedWorldTimeSeconds()
int32	GetShallowWaterMaxDynamicForces()
int32	GetShallowWaterMaxImpulseForces()
int32	GetShallowWaterSimulationRenderTargetSize()
bool	GetShouldOverrideSmoothedWorldTimeSeconds()
float	GetSmoothedWorldTimeSeconds()
FWaterBodyMa...	GetWaterBodyManager ( UWorld* InWorld )	Static helper function to get a waterbody manager from a world, returns nullptr if world or manager don't exist
UWaterSubsys...	GetWaterSubsystem ( const UWorld* InWorld )	Static helper function to get a water subsystem from a world, returns nullptr if world or subsystem don't exist
float	GetWaterTimeSeconds()
AWaterZone &...	GetWaterZoneActor()
bool	IsShallowWaterSimulationEnabled()
bool	IsUnderwaterPostProcessEnabled()
bool	IsWaterRenderingEnabled()
void	MarkAllWaterMeshesForRebuild()
void	PrintToWaterLog ( const FString& Message, bool bWarning )
void	SetAllowWaterSubsystemOnPreviewWorld ( bool bInValue )
void	SetOceanBodyComponent ( TWeakObjectPtr< UWaterBodyComponent... )
void	SetOceanFloodHeight ( float InFloodHeight )
void	SetOverrideSmoothedWorldTimeSeconds ( float InTime )
void	SetShouldOverrideSmoothedWorldTimeSeconds ( bool bOverride )
void	SetShouldPauseWaveTime ( bool bInPauseWaveTime )
void	SetSmoothedWorldTimeSeconds ( float InTime )

Overridden from UWorldSubsystem

		Name	Description
	bool	DoesSupportWorldType ( EWorldType::Type WorldType )	UWorldSubsystem implementation Begin.

Overridden from USubsystem

		Name	Description
	void	Deinitialize()	Implement this for deinitialization of instances of the system
	void	Initialize ( FSubsystemCollectionBase& Collecti... )	USubsystem implementation Begin.

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
bool	IsTickable()	FTickableGameObject implementation Begin.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Classes

	Name	Description
	FOnWaterSubsystemInitialized
	FScopedAllowWaterSubsystemOnPreviewWorld	Little scope object to temporarily change the value of bAllowWaterSubsystemOnPreviewWorld

Constants

Name	Description
bAllowWaterSubsystemOnPreviewWorld	By default, there is no water subsystem allowed on preview worlds except when explicitly requested :