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 > Runtime > Engine > Kismet > UGameplayStatics > UGameplayStatics::SetSoundClassDistanceScale

Light Theme

Dark Theme

UGameplayStatics::SetSoundClassDistanceScale

Linearly interpolates the attenuation distance scale value from it's current attenuation distance override value (1.0f it not overridden) to its new attenuation distance override, over the given amount of time

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Kismet/GameplayStatics.h
Include	#include "Kismet/GameplayStatics.h"
Source	/Engine/Source/Runtime/Engine/Private/GameplayStatics.cpp

Syntax

static void SetSoundClassDistanceScale
(
    const UObject * WorldContextObject,
    USoundClass * SoundClass,
    float DistanceAttenuationScale,
    float TimeSec
)

Remarks

Linearly interpolates the attenuation distance scale value from it's current attenuation distance override value (1.0f it not overridden) to its new attenuation distance override, over the given amount of time

Fire and Forget. Not Replicated.

Parameters

Parameter	Description
SoundClass	Sound class to to use to set the attenuation distance scale on.
DistanceAttenuationScale	A scalar for the attenuation distance used for computing distance attenuation.
TimeSec	A time value to linearly interpolate from the current distance attenuation scale value to the new value.

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

Take our survey

Dismiss