AWaterBodyExclusionVolume

WaterBodyExclusionVolume allows players not enter surface swimming when touching a water volume

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

Name Description

Public variable UProperty Transient

UBillboardCompo...

 

ActorIcon

Public variable UProperty Category, EditAnywhere

bool

 

bIgnoreAllOverlappingWaterBodies

If checked, all water bodies overlapping with this exclusion volumes will be affected.

Public variable UProperty Category, Meta editinstanceonly

TArray< AWaterB...

 

WaterBodiesToIgnore

List of water bodies that will be affected by this exclusion volume

Constructors

Name Description

Public function

AWaterBodyExclusionVolume

(
    const FObjectInitializer& ObjectIn...
)

Functions

Overridden from AActor

Name Description

Protected function Virtual

void

 

Destroyed()

Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending

Protected function Virtual Const

FName

 

GetCustomIconName()

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)

Protected function Virtual

void

 

PostEditMove

(
    bool bFinished
)

Called after an actor has been moved in the editor

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostEditImport()

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

Protected function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Protected function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

Name Description

Public variable UProperty Meta

AWaterBody *...

 

WaterBodyToIgnore_DEPRECATED