Navigation
API > API/Plugins > API/Plugins/Water
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDeveloperSettings
- UWaterRuntimeSettings
References
| Module | Water |
| Header | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterRuntimeSettings.h |
| Include | #include "WaterRuntimeSettings.h" |
Syntax
UCLASS&40;Config&61;Engine, defaultconfig, Meta&61;&40;DisplayName&61;"Water"&41;&41;
class UWaterRuntimeSettings : public UDeveloperSettings
Remarks
Implements the runtime settings for the Water plugin.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TEnumAsByte< ECollisionChannel > | CollisionChannelForWaterTraces | Collision channel to use for tracing and blocking water bodies | |
| TSoftObjectPtr< UMaterialParameterCollection > | MaterialParameterCollection | Material Parameter Collection for everything water-related | |
| float | WaterBodyIconWorldZOffset | Offset in Z for the water body icon in world-space. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FName | |||
| UMaterialInterface * | |||
| TSubclassOf< UWaterBodyCustomComponent > | |||
| TSubclassOf< UWaterBodyLakeComponent > | |||
| TSubclassOf< UWaterBodyOceanComponent > | |||
| TSubclassOf< UWaterBodyRiverComponent > | |||
| void | SetShouldWarnOnMismatchOceanExtent
(
bool bEnable |
||
| bool |
Overridden from UDeveloperSettings
| Type | Name | Description | |
|---|---|---|---|
| FName | Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
UObject interface | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
Typedefs
| Name | Description |
|---|---|
| FOnUpdateSettings | Delegate called whenever the curve data is updated. |
Constants
| Name | Description |
|---|---|
| OnSettingsChange |