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

FBaseAttenuationSettings

Base class for attenuation settings.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FBaseAttenuationSettings

	FForceFeedbackAttenuationSettings
	FSoundAttenuationSettings

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/Attenuation.h
Include	#include "Engine/Attenuation.h"

Syntax

struct FBaseAttenuationSettings

Remarks

Base class for attenuation settings.

Variables

	Name	Description
TEnumAsByte< en...	AttenuationShape	The shape of the non-custom attenuation method.
FVector	AttenuationShapeExtents	The dimensions to use for the attenuation shape.
float	ConeOffset	The distance back from the sound's origin to begin the cone when using the cone attenuation shape.
float	ConeSphereFalloffDistance	The distance over which volume attenuation occurs for the optional sphere shape.
float	ConeSphereRadius	An optional attenuation radius (sphere) that extends from the cone origin.
FRuntimeFloatCu...	CustomAttenuationCurve	The custom volume attenuation curve to use.
float	dBAttenuationAtMax	The attenuation volume at the falloff distance in decibels (Only for 'Natural Sound' Distance Algorithm).
EAttenuationDis...	DistanceAlgorithm	The type of attenuation as a function of distance to use.
float	FalloffDistance	The distance over which volume attenuation occurs.
*ENaturalSo...	FalloffMode	Whether to continue attenuating, go silent, or hold last volume value when beyond falloff bounds and 'Attenuation At Max (dB)' is set to a value greater than -60dB.

Constructors

	Name	Description
	FBaseAttenuationSettings()

Destructors

	Name	Description
	~FBaseAttenuationSettings()

Functions

		Name	Description
	float	AttenuationEval ( float Distance, float Falloff, float DistanceScale )
	float	AttenuationEvalBox ( const FTransform& Origin, FVector Location, float DistanceScale )
	float	AttenuationEvalCapsule ( const FTransform& Origin, FVector Location, float DistanceScale )
	float	AttenuationEvalCone ( const FTransform& Origin, FVector Location, float DistanceScale )
	void	CollectAttenuationShapesForVisualization ( TMultiMap< EAttenuationShape::Type,... )
	float	Evaluate ( const FTransform& Origin, FVector Location, float DistanceScale )
	float	GetMaxDimension()
	float	GetMaxFalloffDistance()

Classes

	Name	Description
	AttenuationShapeDetails