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

> Unreal Engine API Reference > Plugins > Water > UBuoyancyComponent

Light Theme

Dark Theme

UBuoyancyComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UBuoyancyComponent

References

Module	Water
Header	/Engine/Plugins/Experimental/Water/Source/Runtime/Public/BuoyancyComponent.h
Include	#include "BuoyancyComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Config=Game, Meta=(BlueprintSpawnableComponent))
class UBuoyancyComponent : public UActorComponent

Variables

	Name	Description
int8: 1	bCanBeActive
int8: 1	bIsInWaterBody
int8: 1	bIsOverlappingWaterBody
FBuoyancyData	BuoyancyData
uint8: 1	bUseAsyncPath
TMap< uint32, T...	ConfiguredPontoonCoefficients
FBuoyancyCompon...	CurAsyncInput
FBuoyancyCompon...	CurAsyncOutput
EAsyncBuoyancyC...	CurAsyncType
TArray< AWaterB...	CurrentWaterBodies
FBuoyancyCompon...	NextAsyncOutput
FOnPontoonEnter...	OnEnteredWaterDelegate
FOnPontoonExite...	OnExitedWaterDelegate
float	OutputInterpAlpha
TArray< FAsyncO...	OutputsWaitingOn
uint32	PontoonConfiguration
UPrimitiveCompo...	SimulatingComponent	Primitive component that will be used for physics simulation.
int32	VelocityPontoonIndex

Constructors

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

Functions

		Name	Description
	void	AddCustomPontoon ( float Radius, FName CenterSocketName )
	void	AddCustomPontoon ( float Radius, const FVector& RelativeLocation )
	void	ApplyBuoyancy ( UPrimitiveComponent* Primitive... )
	void	ApplyForces ( float DeltaTime, FVector LinearVelocity, float ForwardSpeed, float ForwardSpeedKmh, UPrimitiveComponent* Primitive... )
	FVector	ComputeAngularDragTorque ( const FVector& AngularVelocity )
	void	ComputeBuoyancy ( FSphericalPontoon& Pontoon, float ForwardSpeedKmh )
	FVector	ComputeLinearDragForce ( const FVector& PhyiscsVelocity )
	void	ComputePontoonCoefficients()
	FVector	ComputeWaterForce ( const float DeltaTime, const FVector LinearVelocity )
	TUniquePtr< ...	CreateAsyncAux()
	void	EnteredWaterBody ( AWaterBody* WaterBody )
	void	ExitedWaterBody ( AWaterBody* WaterBody )
	void	FinalizeAuxData()
	void	FinalizeSimCallbackData ( FBuoyancyManagerAsyncInput& Input )
	void	GameThread_ProcessIntermediateAsyncOutput ( const FBuoyancyComponentAsyncOutput... )
	void	GameThread_ProcessIntermediateAsyncOutput ( const FBuoyancyManagerAsyncOutput&... )
	TArray< AWat...	GetCurrentWaterBodies()
	const TArray...	GetCurrentWaterBodies()
	void	GetLastWaterSurfaceInfo ( FVector& OutWaterPlaneLocation, FVector& OutWaterPlaneNormal, FVector& OutWaterSurfacePosition, float& OutWaterDepth, int32& OutWaterBodyIdx, FVector& OutWaterVelocity )
	UPrimitiveCo...	GetSimulatingComponent()
	float	GetWaterHeight ( FVector Position, const TMap< const AWaterBody,..., float DefaultHeight, AWaterBody& OutWaterBody, float& OutWaterDepth, FVector& OutWaterPlaneLocation, FVector& OutWaterPlaneNormal, FVector& OutWaterSurfacePosition, FVector& OutWaterVelocity, int32& OutWaterBodyIdx, bool bShouldIncludeWaves )
	float	GetWaterHeight ( FVector Position, const TMap< const AWaterBody*,..., float DefaultHeight, bool bShouldIncludeWaves )
	void	GetWaterSplineKey ( FVector Location, TMap< const AWaterBody, float..., TMap< const AWaterBody, float... )
	bool	HasPontoons()
	bool	IsActive()
	bool	IsInWaterBody()
	bool	IsOverlappingWaterBody()
	bool	IsUsingAsyncPath()
	void	OnPontoonEnteredWater ( const FSphericalPontoon& Pontoon )
	void	OnPontoonExitedWater ( const FSphericalPontoon& Pontoon )
	void	SetCanBeActive ( bool bInCanBeActive )
	TUniquePtr< ...	SetCurrentAsyncInputOutput ( int32 InputIdx, FBuoyancyManagerAsyncOutput* C..., FBuoyancyManagerAsyncOutput* N..., float Alpha, int32 BuoyancyManagerTimestamp )
	void	SetCurrentAsyncInputOutputInternal ( FBuoyancyComponentAsyncInput* ..., int32 InputIdx, FBuoyancyManagerAsyncOutput* C..., FBuoyancyManagerAsyncOutput* N..., float Alpha, int32 BuoyancyManagerTimestamp )
	void	SetupWaterBodyOverlaps()
	void	Update ( float DeltaTime )
	void	UpdatePontoonCoefficients()
	int32	UpdatePontoons ( float DeltaTime, float ForwardSpeed, float ForwardSpeedKmh, UPrimitiveComponent* Primitive... )

Overridden from UActorComponent

	Name	Description
void	BeginPlay()	Begins Play for the component.
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Ends gameplay for this component.
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FAsyncOutputWrapper

Deprecated Variables

		Name	Description
	TArray< FSpheri...	Pontoons_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