Navigation
API > API/Plugins > API/Plugins/Water
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- AActor
- ABrush
- AVolume
- APhysicsVolume
- AWaterBodyExclusionVolume
References
| Module | Water |
| Header | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyExclusionVolume.h |
| Include | #include "WaterBodyExclusionVolume.h" |
Syntax
UCLASS&40;&41;
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 | |
   |
bool | bExcludeAllOverlappingWaterBodies | If checked, all water bodies overlapping with this exclusion volumes will be affected. |
    |
TArray< TObjectPtr< AWaterBody > > | WaterBodiesToExclude | List of water bodies that will be affected by this exclusion volume |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
AWaterBodyExclusionVolume
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ||
 |
void |
Overridden from AActor
| Type | Name | Description | |
|---|---|---|---|
  |
void | Destroyed () |
Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending |
   |
FName | Returns a custom brush icon name to use in place of the automatic class icon where actors are represented via 2d icons in the editor (e.g scene outliner and menus) | |
  |
void | PostEditMove
(
bool bFinished |
Called after an actor has been moved in the editor |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization | |
  |
void | PostEditUndo () |
Called after applying a transaction to the object. |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
   |
bool | bIgnoreAllOverlappingWaterBodies_DEPRECATED | |
   |
TArray< TObjectPtr< AWaterBody > > | WaterBodiesToIgnore_DEPRECATED | |
   |
TObjectPtr< AWaterBody > | WaterBodyToIgnore_DEPRECATED |