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