UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FBaseAttenuationSettings Struct Reference

#include <Attenuation.h>

+ Inheritance diagram for FBaseAttenuationSettings:

Classes

struct  AttenuationShapeDetails
 

Public Member Functions

virtual ENGINE_API ~FBaseAttenuationSettings ()
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=AttenuationDistance, meta=(DisplayName="Attenuation At Max (dB)", ClampMin="-60", ClampMax="0")) float dBAttenuationAtMax
 
ENGINE_API FBaseAttenuationSettings ()
 
virtual ENGINE_API void CollectAttenuationShapesForVisualization (TMultiMap< EAttenuationShape::Type, AttenuationShapeDetails > &ShapeDetailsMap) const
 
ENGINE_API float GetMaxDimension () const
 
ENGINE_API float GetMaxFalloffDistance () const
 
ENGINE_API float Evaluate (const FTransform &Origin, FVector Location, float DistanceScale=1.f) const
 
ENGINE_API float AttenuationEval (float Distance, float Falloff, float DistanceScale=1.f) const
 
ENGINE_API float AttenuationEvalBox (const FTransform &Origin, FVector Location, float DistanceScale=1.f) const
 
ENGINE_API float AttenuationEvalCapsule (const FTransform &Origin, FVector Location, float DistanceScale=1.f) const
 
ENGINE_API float AttenuationEvalCone (const FTransform &Origin, FVector Location, float DistanceScale=1.f) const
 

Public Attributes

EAttenuationDistanceModel DistanceAlgorithm
 
TEnumAsByte< enum EAttenuationShape::TypeAttenuationShape
 
ENaturalSoundFalloffMode FalloffMode
 
FVector AttenuationShapeExtents
 
float ConeOffset
 
float FalloffDistance
 
float ConeSphereRadius
 
float ConeSphereFalloffDistance
 
FRuntimeFloatCurve CustomAttenuationCurve
 

Constructor & Destructor Documentation

◆ ~FBaseAttenuationSettings()

FBaseAttenuationSettings::~FBaseAttenuationSettings ( )
virtualdefault

◆ FBaseAttenuationSettings()

FBaseAttenuationSettings::FBaseAttenuationSettings ( )

Member Function Documentation

◆ AttenuationEval()

float FBaseAttenuationSettings::AttenuationEval ( float  Distance,
float  Falloff,
float  DistanceScale = 1.f 
) const

◆ AttenuationEvalBox()

float FBaseAttenuationSettings::AttenuationEvalBox ( const FTransform Origin,
FVector  Location,
float  DistanceScale = 1.f 
) const

◆ AttenuationEvalCapsule()

float FBaseAttenuationSettings::AttenuationEvalCapsule ( const FTransform Origin,
FVector  Location,
float  DistanceScale = 1.f 
) const

◆ AttenuationEvalCone()

float FBaseAttenuationSettings::AttenuationEvalCone ( const FTransform Origin,
FVector  Location,
float  DistanceScale = 1.f 
) const

◆ CollectAttenuationShapesForVisualization()

void FBaseAttenuationSettings::CollectAttenuationShapesForVisualization ( TMultiMap< EAttenuationShape::Type, AttenuationShapeDetails > &  ShapeDetailsMap) const
virtual

Reimplemented in FSoundAttenuationSettings.

◆ Evaluate()

float FBaseAttenuationSettings::Evaluate ( const FTransform Origin,
FVector  Location,
float  DistanceScale = 1.f 
) const

◆ GetMaxDimension()

float FBaseAttenuationSettings::GetMaxDimension ( ) const

◆ GetMaxFalloffDistance()

float FBaseAttenuationSettings::GetMaxFalloffDistance ( ) const

◆ UPROPERTY()

FBaseAttenuationSettings::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
Category  = AttenuationDistance,
meta  = (DisplayName="Attenuation At Max (dB)", ClampMin="-60", ClampMax="0") 
)

Member Data Documentation

◆ AttenuationShape

TEnumAsByte<enum EAttenuationShape::Type> FBaseAttenuationSettings::AttenuationShape

◆ AttenuationShapeExtents

FVector FBaseAttenuationSettings::AttenuationShapeExtents

◆ ConeOffset

float FBaseAttenuationSettings::ConeOffset

◆ ConeSphereFalloffDistance

float FBaseAttenuationSettings::ConeSphereFalloffDistance

◆ ConeSphereRadius

float FBaseAttenuationSettings::ConeSphereRadius

◆ CustomAttenuationCurve

FRuntimeFloatCurve FBaseAttenuationSettings::CustomAttenuationCurve

◆ DistanceAlgorithm

EAttenuationDistanceModel FBaseAttenuationSettings::DistanceAlgorithm

◆ FalloffDistance

float FBaseAttenuationSettings::FalloffDistance

◆ FalloffMode

ENaturalSoundFalloffMode FBaseAttenuationSettings::FalloffMode

The documentation for this struct was generated from the following files: