FBaseAttenuationSettings

Base class for attenuation settings.

Windows
MacOS
Linux

Inheritance Hierarchy

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

Public variable

TEnumAsByte< en...

 

AttenuationShape

The shape of the non-custom attenuation method.

Public variable

FVector

 

AttenuationShapeExtents

The dimensions to use for the attenuation shape.

Public variable

float

 

ConeOffset

The distance back from the sound's origin to begin the cone when using the cone attenuation shape.

Public variable

FRuntimeFloatCu...

 

CustomAttenuationCurve

The custom volume attenuation curve to use.

Public variable

float

 

dBAttenuationAtMax

The attenuation volume at the falloff distance in decibels (Only for 'Natural Sound' Distance Algorithm).

Public variable

EAttenuationDis...

 

DistanceAlgorithm

The type of attenuation as a function of distance to use.

Public variable

float

 

FalloffDistance

The distance over which volume attenuation occurs.

Public variable

*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

Public function

FBaseAttenuationSettings()

Destructors

Name Description

Public function Virtual

~FBaseAttenuationSettings()

Functions

Name Description

Public function Const

float

 

AttenuationEval

(
    float Distance,
    float Falloff,
    float DistanceScale
)

Public function Const

float

 

AttenuationEvalBox

(
    const FTransform& Origin,
    FVector Location,
    float DistanceScale
)

Public function Const

float

 

AttenuationEvalCapsule

(
    const FTransform& Origin,
    FVector Location,
    float DistanceScale
)

Public function Const

float

 

AttenuationEvalCone

(
    const FTransform& Origin,
    FVector Location,
    float DistanceScale
)

Public function Virtual Const

void

 

CollectAttenuationShapesForVisualization

Public function Const

float

 

Evaluate

(
    const FTransform& Origin,
    FVector Location,
    float DistanceScale
)

Public function Const

float

 

GetMaxDimension()

Public function Const

float

 

GetMaxFalloffDistance()

Classes

Name

Description

Public struct

AttenuationShapeDetails

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss