UGameplayStatics::SetSoundClassDistanceScale

Sets attenuation distance scale value on the sound class over the given amount of time from it's current attenuation distance override value (1.0f it not overridden).

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

Sets attenuation distance scale value on the sound class over the given amount of time from it's current attenuation distance override value (1.0f it not overridden). Attenuation scale allows scaling the attenuation distance used for computing distance attenuation.

Fire and Forget. Not Replicated.

Parameters

Parameter

Description

SoundClass

Sound class to to use to set the attenuation distance scale on.

DistanceAttenuationScale

A distance attenuation scale value.

TimeSec

A time value to linearly interpolate from the current distance attenuation scale value to the new value.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback