UGameplayStatics::SetGlobalListenerFocusParameters

Sets the global listener focus parameters which will scale focus behavior of sounds based on their focus azimuth settings in their attenuation settings.

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 SetGlobalListenerFocusParameters
(
    const UObject * WorldContextObject,
    float FocusAzimuthScale,
    float NonFocusAzimuthScale,
    float FocusDistanceScale,
    float NonFocusDistanceScale,
    float FocusVolumeScale,
    float NonFocusVolumeScale,
    float FocusPriorityScale,
    float NonFocusPriorityScale
)

Remarks

Sets the global listener focus parameters which will scale focus behavior of sounds based on their focus azimuth settings in their attenuation settings.

Fire and Forget. Not Replicated.

Parameters

Parameter

Description

FocusAzimuthScale

An angle scale value used to scale the azimuth angle that defines where sounds are in-focus.

NonFocusAzimuthScale-

An angle scale value used to scale the azimuth angle that defines where sounds are out-of-focus.

FocusDistanceScale

A distance scale value to use for sounds which are in-focus. Values < 1.0 will reduce perceived distance to sounds, values > 1.0 will increase perceived distance to in-focus sounds.

NonFocusDistanceScale

A distance scale value to use for sounds which are out-of-focus. Values < 1.0 will reduce perceived distance to sounds, values > 1.0 will increase perceived distance to in-focus sounds.

FocusVolumeScale-

A volume attenuation value to use for sounds which are in-focus.

NonFocusVolumeScale-

A volume attenuation value to use for sounds which are out-of-focus.

FocusPriorityScale

A priority scale value (> 0.0) to use for sounds which are in-focus. Values < 1.0 will reduce the priority of in-focus sounds, values > 1.0 will increase the priority of in-focus sounds.

NonFocusPriorityScale

A priority scale value (> 0.0) to use for sounds which are out-of-focus. Values < 1.0 will reduce the priority of sounds out-of-focus sounds, values > 1.0 will increase the priority of out-of-focus sounds.

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