Navigation
API > API/Plugins > API/Plugins/Water
Implements the runtime settings for the Water plugin.
| Name | UWaterRuntimeSettings |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterRuntimeSettings.h |
| Include Path | #include "WaterRuntimeSettings.h" |
Syntax
UCLASS (MinimalAPI, Config=Engine, defaultconfig, Meta=(DisplayName="Water"))
class UWaterRuntimeSettings : public UDeveloperSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → UWaterRuntimeSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWaterRuntimeSettings() |
WaterRuntimeSettings.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnUpdateSettings | TMulticastDelegate_TwoParams< void, const UWaterRuntimeSettings *, EPropertyChangeType::Type > | Delegate called whenever the curve data is updated. | WaterRuntimeSettings.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnSettingsChange | FOnUpdateSettings | WaterRuntimeSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CollisionChannelForWaterTraces | TEnumAsByte< ECollisionChannel > | Collision channel to use for tracing and blocking water bodies | WaterRuntimeSettings.h |
|
| MaterialParameterCollection | TSoftObjectPtr< UMaterialParameterCollection > | Material Parameter Collection for everything water-related | WaterRuntimeSettings.h |
|
| WaterBodyIconWorldZOffset | float | Offset in Z for the water body icon in world-space. | WaterRuntimeSettings.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bWarnOnMismatchOceanExtent | bool | #todo_water: move this | WaterRuntimeSettings.h |
|
| DefaultWaterCollisionProfileName | FName | Default collision profile name of water bodies | WaterRuntimeSettings.h |
|
| DefaultWaterInfoMaterial | TSoftObjectPtr< UMaterialInterface > | WaterRuntimeSettings.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GetDefaultWaterCollisionProfileName() |
WaterRuntimeSettings.h | ||
UMaterialInterface * GetDefaultWaterInfoMaterial() |
WaterRuntimeSettings.h | ||
TSubclassOf< UWaterBodyCustomComponent > GetWaterBodyCustomComponentClass() |
WaterRuntimeSettings.h | ||
TSubclassOf< UWaterBodyLakeComponent > GetWaterBodyLakeComponentClass() |
WaterRuntimeSettings.h | ||
TSubclassOf< UWaterBodyOceanComponent > GetWaterBodyOceanComponentClass() |
WaterRuntimeSettings.h | ||
TSubclassOf< UWaterBodyRiverComponent > GetWaterBodyRiverComponentClass() |
WaterRuntimeSettings.h | ||
virtual void PostInitProperties() |
WaterRuntimeSettings.h | ||
void SetShouldWarnOnMismatchOceanExtent
(
bool bEnable |
WaterRuntimeSettings.h | ||
bool ShouldWarnOnMismatchOceanExtent() |
WaterRuntimeSettings.h |
Overridden from UDeveloperSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetCategoryName() |
WaterRuntimeSettings.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
WaterRuntimeSettings.h |