1. Epic GamesDeveloper
  3. FWaterBodyManager

FWaterBodyManager

API > API/Plugins > API/Plugins/Water

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

Syntax

class FWaterBodyManager

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnWaterBodyAdded FWaterBodyEvent   WaterBodyManager.h  
OnWaterBodyRemoved FWaterBodyEvent   WaterBodyManager.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
GlobalMaxWaveHeight float   WaterBodyManager.h  
WaterBodyComponents TSparseArray< TWeakObjectPtr< UWaterBodyComponent > > List of components registered to this manager. WaterBodyManager.h  
WaterViewExtension TSharedPtr< FWaterViewExtension, ESPMode::ThreadSafe >   WaterBodyManager.h  
WaterZones TSparseArray< TWeakObjectPtr< AWaterZone > > List of Water zones registered to this manager. WaterBodyManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddWaterBodyComponent ( UWaterBodyComponent* InWaterBodyComponent
)

 Register any water body component upon addition to the world WaterBodyManager.h  

int32 AddWaterZone ( AWaterZone* InWaterZone
)

   WaterBodyManager.h  

void Deinitialize()

   WaterBodyManager.h  
Execute a predicate function on each valid water body. WaterBodyManager.h  

void ForEachWaterZone ( TFunctionRef< bool(AWaterZone*)> Pred
) const

   WaterBodyManager.h  

float GetGlobalMaxWaveHeight()

 Returns the maximum of all MaxWaveHeight : WaterBodyManager.h  

FWaterViewExtension * GetWaterViewExtension()

   WaterBodyManager.h  

TWeakPtr< FWaterViewExtension, ESPMode::ThreadSafe > GetWaterViewExtensionWeakPtr()

   WaterBodyManager.h  

bool HasAnyWaterBodies()

   WaterBodyManager.h  

void Initialize ( UWorld* World
)

   WaterBodyManager.h  

int32 MaxWaterBodyIndex()

   WaterBodyManager.h  

int32 NumWaterBodies()

   WaterBodyManager.h  

int32 NumWaterZones()

   WaterBodyManager.h  

void RemoveWaterBodyComponent ( UWaterBodyComponent* InWaterBodyComponent
)

 Unregister any water body upon removal to the world WaterBodyManager.h  

void RemoveWaterZone ( AWaterZone* InWaterZone
)

   WaterBodyManager.h  

void RequestGPUDataRebuild()

 Recomputes water gpu data whenever it changes on one of the managed water types. WaterBodyManager.h  

void RequestWaveDataRebuild()

 Recomputes wave-related data whenever it changes on one of water bodies. WaterBodyManager.h  

void Shrink ()

 Shrinks the sparse array storage for water body components and water zones. WaterBodyManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ForEachWaterBodyComponent ( const UWorld* World,
TFunctionRef< bool(UWaterBodyComponent*)> Pred
)

 Execute a predicate function on each valid water body. WaterBodyManager.h  

static void ForEachWaterZone ( const UWorld* World,
TFunctionRef< bool(AWaterZone*)> Pred
)

   WaterBodyManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page