1. Epic GamesDeveloper
  3. UWaterSubsystem

UWaterSubsystem

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

Unreal Engine C++ API Reference > Plugins > Water

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Transient&41;  
class UWaterSubsystem : public UTickableWorldSubsystem

Remarks

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

Variables

  Type Name Description
Public variable UProperty Transient TObjectPtr< ABuoyancyManager > BuoyancyManager  
Public variable UProperty TObjectPtr< UStaticMesh > DefaultLakeMesh  
Public variable UProperty TObjectPtr< UStaticMesh > DefaultRiverMesh  
Public variable UProperty Category BlueprintAssignable FOnCameraUnderwaterStateChanged OnCameraUnderwaterStateChanged  
Public variable UProperty Category BlueprintAssignable FOnWaterScalabilityChanged OnWaterScalabilityChanged  
Public variable UWaterSubsystem::FOnWaterSubsystemInitialized OnWaterSubsystemInitialized  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const TSoftObjectPtr< AWaterZone >

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

 Returns the water with the highest priority within the bounds provided.
Public function 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.
Public function Static bool  
Public function Const ABuoyancyManager *  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category float  
Public function Const UMaterialParameterCollection *  
Public function Const UFunction BlueprintCallable, Category float Returns the base height of the ocean. This should correspond to its world Z position
Public function TWeakObjectPtr< UWaterBodyComponent >  
Public function Const UFunction BlueprintCallable, Category float Returns the relative flood height
Public function Const UFunction BlueprintCallable, Category float Returns the total height of the ocean.
Public function Const float  
Public function Static UFunction BlueprintCallable, Category int32  
Public function Static UFunction BlueprintCallable, Category int32  
Public function Static UFunction BlueprintCallable, Category int32  
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category float  
Public function 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
Public function 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
Public function Const UFunction BlueprintCallable, Category float  
Public function Static TWeakPtr< FWaterViewExtension, ESPMode::ThreadSafe >

GetWaterViewExtension ( const UWorld* InWorld
)

 Static helper function to get a weak ptr to the water scene view extension for a given world.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool  
Public function void  
Public function void

MarkWaterZonesInRegionForRebuild ( const FBox2D& InUpdateRegion,
EWaterZoneRebuildFlags InRebuildFlags
)

  
Public function UFunction BlueprintCallable, Category void

PrintToWaterLog ( const FString& Message,
bool bWarning
)

  
Public function Static void  
Public function void  
Public function UFunction BlueprintCallable, Category void

SetOceanFloodHeight ( float InFloodHeight
)

  
Public function void  
Public function void  
Public function void

SetShouldPauseWaveTime ( bool bInPauseWaveTime
)

  
Public function void

SetSmoothedWorldTimeSeconds ( float InTime
)

  

Overridden from UWorldSubsystem

  Type Name Description
Public function Virtual Const bool UWorldSubsystem implementation Begin.
Public function Virtual void Called once all UWorldSubsystems have been initialized

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void USubsystem implementation Begin.

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const bool FTickableGameObject implementation Begin.
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Classes

  Type Name Description
Public class FOnWaterSubsystemInitialized    
Public struct 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 :

Deprecated Variables

  Type Name Description
Public variable FWaterBodyManager WaterBodyManager This will become a private member. Prefer calling GetWaterBodyManager instead

Deprecated Functions

  Type Name Description
Public function Static void

ForEachWaterBodyComponent ( const UWorld* World,
TFunctionRef< bool(UWaterBodyComponent*)> Predicate
)

 Please use FWaterBodyManager::ForEachWaterBodyComponent instead.
Public function Const AWaterZone *

GetWaterZoneActor ( ULevel* InPreferredOuterLevel
)

 There may be multiple water zones per level. Prefer calling the GetWaterZone on a per-water body basis or iterating over all zones.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page