Navigation
API > API/Runtime > API/Runtime/Engine
Base class for attenuation settings.
| Name | FBaseAttenuationSettings |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/Attenuation.h |
| Include Path | #include "Engine/Attenuation.h" |
Syntax
USTRUCT (BlueprintType )
struct FBaseAttenuationSettings
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBaseAttenuationSettings() |
Engine/Attenuation.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FBaseAttenuationSettings() |
Engine/Attenuation.h |
Structs
| Name | Remarks |
|---|---|
| AttenuationShapeDetails |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AttenuationShape | TEnumAsByte< enum EAttenuationShape::Type > | The shape of the non-custom attenuation method. | Engine/Attenuation.h |
|
| AttenuationShapeExtents | FVector | The dimensions to use for the attenuation shape. | Engine/Attenuation.h |
|
| ConeOffset | float | The distance back from the sound's origin to begin the cone when using the cone attenuation shape. | Engine/Attenuation.h |
|
| ConeSphereFalloffDistance | float | The distance over which volume attenuation occurs for the optional sphere shape. | Engine/Attenuation.h |
|
| ConeSphereRadius | float | An optional attenuation radius (sphere) that extends from the cone origin. | Engine/Attenuation.h |
|
| CustomAttenuationCurve | FRuntimeFloatCurve | The custom volume attenuation curve to use. Value clamped at 1.0. | Engine/Attenuation.h |
|
| dBAttenuationAtMax | float | The attenuation volume at the falloff distance in decibels (Only for 'Natural Sound' Distance Algorithm). | Engine/Attenuation.h |
|
| DistanceAlgorithm | EAttenuationDistanceModel | The type of attenuation as a function of distance to use. | Engine/Attenuation.h |
|
| FalloffDistance | float | The distance over which volume attenuation occurs. | Engine/Attenuation.h |
|
| FalloffMode | ENaturalSoundFalloffMode | 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. | Engine/Attenuation.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float AttenuationEval
(
float Distance, |
Engine/Attenuation.h | ||
float AttenuationEvalBox
(
const FTransform& Origin, |
Engine/Attenuation.h | ||
float AttenuationEvalCapsule
(
const FTransform& Origin, |
Engine/Attenuation.h | ||
float AttenuationEvalCone
(
const FTransform& Origin, |
Engine/Attenuation.h | ||
virtual void CollectAttenuationShapesForVisualization
(
TMultiMap< EAttenuationShape::Type, AttenuationShapeDetails >& ShapeDetailsMap |
Engine/Attenuation.h | ||
float Evaluate
(
const FTransform& Origin, |
Engine/Attenuation.h | ||
float GetMaxDimension() |
Engine/Attenuation.h | ||
float GetMaxFalloffDistance() |
Engine/Attenuation.h |