Navigation
API > API/Plugins > API/Plugins/Water
WaterBodyExclusionVolume allows players not enter surface swimming when touching a water volume
| Name | AWaterBodyExclusionVolume |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyExclusionVolume.h |
| Include Path | #include "WaterBodyExclusionVolume.h" |
Syntax
UCLASS (MinimalAPI)
class AWaterBodyExclusionVolume : public APhysicsVolume
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ABrush → AVolume → APhysicsVolume → AWaterBodyExclusionVolume
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AWaterBodyExclusionVolume
(
const FObjectInitializer& ObjectInitializer |
WaterBodyExclusionVolume.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActorIcon | TObjectPtr< class UBillboardComponent > | WaterBodyExclusionVolume.h |
|
|
| ExclusionMode | EWaterExclusionMode | Determines the behavior of the WaterBodies list. | WaterBodyExclusionVolume.h |
|
| WaterBodies | TArray< TSoftObjectPtr< AWaterBody > > | List of water bodies that will be added or removed from the exclusion volume based on the ExclusionMode parameter. | WaterBodyExclusionVolume.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateActorIcon() |
WaterBodyExclusionVolume.h | ||
void UpdateOverlappingWaterBodies
(
const FWaterExclusionVolumeChangedParams& Params |
WaterBodyExclusionVolume.h |
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostRegisterAllComponents() |
WaterBodyExclusionVolume.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateAffectedWaterBodyCollisions
(
const FWaterExclusionVolumeChangedParams& Params |
Updates all water bodies affected by this exclusion volume to rebuild due to a change in this exclusion volume. | WaterBodyExclusionVolume.h |
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Destroyed() |
WaterBodyExclusionVolume.h | ||
virtual FName GetCustomIconName() |
WaterBodyExclusionVolume.h | ||
virtual void PostEditMove
(
bool bFinished |
WaterBodyExclusionVolume.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
WaterBodyExclusionVolume.h | ||
virtual void PostEditImport() |
WaterBodyExclusionVolume.h | ||
virtual void PostEditUndo() |
WaterBodyExclusionVolume.h | ||
virtual void PostLoad() |
WaterBodyExclusionVolume.h | ||
virtual void Serialize
(
FArchive& Ar |
WaterBodyExclusionVolume.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExcludeAllOverlappingWaterBodies_DEPRECATED | bool | WaterBodyExclusionVolume.h |
|
|
| bIgnoreAllOverlappingWaterBodies_DEPRECATED | bool | WaterBodyExclusionVolume.h |
|
|
| WaterBodiesToExclude_DEPRECATED | TArray< TObjectPtr< AWaterBody > > | WaterBodyExclusionVolume.h |
|
|
| WaterBodiesToIgnore_DEPRECATED | TArray< TObjectPtr< AWaterBody > > | WaterBodyExclusionVolume.h |
|
|
| WaterBodyToIgnore_DEPRECATED | TObjectPtr< AWaterBody > | WaterBodyExclusionVolume.h |
|