Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

AWaterBodyExclusionVolume

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

Windows

MacOS

Linux

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](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class AWaterBodyExclusionVolume : public APhysicsVolume

Remarks

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

Variables

	Name	Description
UBillboardCompo...	ActorIcon
bool	bIgnoreAllOverlappingWaterBodies	If checked, all water bodies overlapping with this exclusion volumes will be affected.
TArray< AWaterB...	WaterBodiesToIgnore	List of water bodies that will be affected by this exclusion volume

Constructors

	Name	Description
	AWaterBodyExclusionVolume ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	void	UpdateActorIcon()
	void	UpdateOverlappingWaterBodies()

Overridden from AActor

	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	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)
void	PostEditMove ( bool bFinished )	Called after an actor has been moved in the editor

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
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
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

		Name	Description
	AWaterBody *...	WaterBodyToIgnore_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss