AWaterBodyExclusionVolume | Unreal Engine 5.6 Documentation

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

Name	Remarks	Include Path	Unreal Specifiers
AWaterBodyExclusionVolume ( const FObjectInitializer& ObjectInitializer )		WaterBodyExclusionVolume.h

Name	Type	Remarks	Include Path	Unreal Specifiers
ActorIcon	TObjectPtr< class UBillboardComponent >		WaterBodyExclusionVolume.h	Transient
ExclusionMode	EWaterExclusionMode	Determines the behavior of the WaterBodies list.	WaterBodyExclusionVolume.h	EditAnywhere Category=Water
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	EditInstanceOnly BlueprintReadOnly Category=Water Meta=(DisplayAfter=ExclusionMode)

Name	Remarks	Include Path	Unreal Specifiers
void UpdateActorIcon()		WaterBodyExclusionVolume.h
void UpdateOverlappingWaterBodies ( const FWaterExclusionVolumeChangedParams& Params )		WaterBodyExclusionVolume.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostRegisterAllComponents()		WaterBodyExclusionVolume.h

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

Name	Remarks	Include Path	Unreal Specifiers
virtual void Destroyed()		WaterBodyExclusionVolume.h
virtual FName GetCustomIconName()		WaterBodyExclusionVolume.h
virtual void PostEditMove ( bool bFinished )		WaterBodyExclusionVolume.h

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

Name	Type	Include Path	Unreal Specifiers
bExcludeAllOverlappingWaterBodies_DEPRECATED	bool	WaterBodyExclusionVolume.h	Meta=(DeprecationMessage="Property changed from boolean to EWaterExclusionMode enum. a value of AddWaterBodiesListToExclusion is equivalent to a value of false.")
bIgnoreAllOverlappingWaterBodies_DEPRECATED	bool	WaterBodyExclusionVolume.h	Meta=(DeprecationMessage="Property renamed to bExcludeAllOverlapping")
WaterBodiesToExclude_DEPRECATED	TArray< TObjectPtr< AWaterBody > >	WaterBodyExclusionVolume.h	Meta=(DeprecationMessage="Property renamed to WaterBodies")
WaterBodiesToIgnore_DEPRECATED	TArray< TObjectPtr< AWaterBody > >	WaterBodyExclusionVolume.h	Meta=(DeprecationMessage="Property renamed to WaterBodiesToExclude")
WaterBodyToIgnore_DEPRECATED	TObjectPtr< AWaterBody >	WaterBodyExclusionVolume.h	Meta=(DeprecatedProperty)