1. Epic GamesDeveloper
  3. UWaterSubsystem

UWaterSubsystem

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

API > API/Plugins > API/Plugins/Water

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

   
Name UWaterSubsystem
Type class
Header File /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterSubsystem.h
Include Path #include "WaterSubsystem.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Transient)  
class UWaterSubsystem : public UTickableWorldSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWaterSubsystem()

   WaterSubsystem.h  

Classes

Name Remarks
FOnWaterSubsystemInitialized  

Structs

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

Constants

Name Type Remarks Include Path
bAllowWaterSubsystemOnPreviewWorld bool By default, there is no water subsystem allowed on preview worlds except when explicitly requested : WaterSubsystem.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BuoyancyManager TObjectPtr< ABuoyancyManager >   WaterSubsystem.h
  • Transient
DefaultLakeMesh TObjectPtr< UStaticMesh >   WaterSubsystem.h  
DefaultRiverMesh TObjectPtr< UStaticMesh >   WaterSubsystem.h  
OnCameraUnderwaterStateChanged FOnCameraUnderwaterStateChanged   WaterSubsystem.h
  • BlueprintAssignable
  • Category=Water
OnWaterScalabilityChanged FOnWaterScalabilityChanged   WaterSubsystem.h
  • BlueprintAssignable
  • Category=Water
OnWaterSubsystemInitialized UWaterSubsystem::FOnWaterSubsystemInitialized   WaterSubsystem.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bPauseWaveTime bool   WaterSubsystem.h  
bUnderWaterForAudio bool   WaterSubsystem.h  
bUsingOverrideWorldTimeSeconds bool   WaterSubsystem.h  
bUsingSmoothedTime bool   WaterSubsystem.h  
CachedDepthUnderwater float   WaterSubsystem.h  
FloodHeight float   WaterSubsystem.h  
MaterialParameterCollection TObjectPtr< UMaterialParameterCollection > The parameter collection asset that holds the global parameters that are updated by this actor WaterSubsystem.h  
NonSmoothedWorldTimeSeconds float   WaterSubsystem.h  
OceanBodyComponent TWeakObjectPtr< UWaterBodyComponent >   WaterSubsystem.h  
OverrideWorldTimeSeconds float   WaterSubsystem.h  
PrevWorldTimeSeconds float   WaterSubsystem.h  
SmoothedWorldTimeSeconds float   WaterSubsystem.h  
UnderwaterPostProcessVolume FUnderwaterPostProcessVolume   WaterSubsystem.h  
UnderwaterTraceChannel ECollisionChannel   WaterSubsystem.h  
WaterBodyManager FWaterBodyManager   WaterSubsystem.h  
WaterTerrainActors TMultiMap< const AActor *, TWeakObjectPtr< UWaterTerrainComponent > > Keeps track of all actors that have WaterTerrainComponents so we can avoid extra work iterating every actors components to find one when global events are triggered. WaterSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSoftObjectPtr< AWaterZone > FindWaterZone ( const FBox2D& Bounds,
const TSoftObjectPtr< const ULevel > PreferredLevel
) const

   WaterSubsystem.h  

ABuoyancyManager * GetBuoyancyManager()

   WaterSubsystem.h  

float GetCameraUnderwaterDepth()

   WaterSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=Water

UMaterialParameterCollection * GetMaterialParameterCollection()

   WaterSubsystem.h  

float GetOceanBaseHeight()

 Returns the base height of the ocean. This should correspond to its world Z position WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

TWeakObjectPtr< UWaterBodyComponent > GetOceanBodyComponent()

   WaterSubsystem.h  

float GetOceanFloodHeight()

 Returns the relative flood height WaterSubsystem.h
  • BlueprintCallable
  • Category=Water
Returns the total height of the ocean. WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

float GetOverrideSmoothedWorldTimeSeconds()

   WaterSubsystem.h  

bool GetShouldOverrideSmoothedWorldTimeSeconds()

   WaterSubsystem.h  

float GetSmoothedWorldTimeSeconds()

   WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

void GetWaterTerrainComponents ( TArray< UWaterTerrainComponent* >& OutWaterTerrainComponents
) const

 Returns a list of all water terrain components registered to the water subsystem. WaterSubsystem.h  

float GetWaterTimeSeconds()

   WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

bool IsShallowWaterSimulationEnabled()

   WaterSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=Water

bool IsUnderwaterPostProcessEnabled()

   WaterSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=Water

bool IsWaterRenderingEnabled()

   WaterSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category=Water

void MarkAllWaterZonesForRebuild ( EWaterZoneRebuildFlags RebuildFlags,
const UObject* DebugRequestingObject
)

   WaterSubsystem.h  

void MarkWaterZonesInRegionForRebuild ( const FBox2D& InUpdateRegion,
EWaterZoneRebuildFlags InRebuildFlags,
const UObject* DebugRequestingObject
)

   WaterSubsystem.h  

void OnActorMoved ( AActor* MovedActor
)

   WaterSubsystem.h  

void PrintToWaterLog ( const FString& Message,
bool bWarning
)

   WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

void RegisterWaterTerrainComponent ( UWaterTerrainComponent* WaterTerrainComponent
)

   WaterSubsystem.h  

void SetOceanBodyComponent ( TWeakObjectPtr< UWaterBodyComponent > InOceanBodyComponent
)

   WaterSubsystem.h  

void SetOceanFloodHeight ( float InFloodHeight
)

   WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

void SetOverrideSmoothedWorldTimeSeconds ( float InTime
)

   WaterSubsystem.h  

void SetShouldOverrideSmoothedWorldTimeSeconds ( bool bOverride
)

   WaterSubsystem.h  

void SetShouldPauseWaveTime ( bool bInPauseWaveTime
)

   WaterSubsystem.h  

void SetSmoothedWorldTimeSeconds ( float InTime
)

   WaterSubsystem.h  

void UnregisterWaterTerrainComponent ( UWaterTerrainComponent* WaterTerrainComponent
)

   WaterSubsystem.h  

Overridden from UWorldSubsystem

Name Remarks Include Path Unreal Specifiers

virtual bool DoesSupportWorldType ( EWorldType::Type WorldType
) const

 UWorldSubsystem implementation Begin. WaterSubsystem.h  

virtual void PostInitialize()

   WaterSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   WaterSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 USubsystem implementation Begin. WaterSubsystem.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsTickableInEditor()

   WaterSubsystem.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   WaterSubsystem.h  

virtual bool IsTickable()

 FTickableGameObject implementation Begin. WaterSubsystem.h  

virtual void Tick ( float DeltaTime
)

   WaterSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSoftObjectPtr< AWaterZone > FindWaterZone ( const UWorld* World,
const FBox2D& Bounds,
const TSoftObjectPtr< const ULevel > PreferredLevel
)

 Returns the water with the highest priority within the bounds provided. WaterSubsystem.h  

static bool GetAllowWaterSubsystemOnPreviewWorld()

   WaterSubsystem.h  

static int32 GetShallowWaterMaxDynamicForces()

   WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

static int32 GetShallowWaterMaxImpulseForces()

   WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

static int32 GetShallowWaterSimulationRenderTargetSize()

   WaterSubsystem.h
  • BlueprintCallable
  • Category=Water

static FWaterBodyManager * GetWaterBodyManager ( const UWorld* InWorld
)

 Static helper function to get a waterbody manager from a world, returns nullptr if world or manager don't exist WaterSubsystem.h  

static UWaterSubsystem * GetWaterSubsystem ( const UWorld* InWorld
)

 Static helper function to get a water subsystem from a world, returns nullptr if world or subsystem don't exist WaterSubsystem.h  

static FWaterViewExtension * GetWaterViewExtension ( const UWorld* InWorld
)

 Static helper function to get a weak ptr to the water scene view extension for a given world. WaterSubsystem.h  

static TWeakPtr< FWaterViewExtension, ESPMode::ThreadSafe > GetWaterViewExtensionWeakPtr ( const UWorld* InWorld
)

 Static helper function to get a TWeakPtr to the water scene view extension for a given world. WaterSubsystem.h  

static void SetAllowWaterSubsystemOnPreviewWorld ( bool bInValue
)

   WaterSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page