UGameplayStatics::GetClosestListenerLocation

Finds and returns the position of the closest listener to the specified location

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 bool GetClosestListenerLocation
(
    const UObject * WorldContextObject,
    const FVector & Location,
    float MaximumRange,
    const bool bAllowAttenuationOverride,
    FVector & ListenerPosition
)

Remarks

Finds and returns the position of the closest listener to the specified location

This will always return false if there is no audio device, or the audio device is disabled.

Returns

true if we've successfully found a listener within MaximumRange of Location, otherwise false.

Parameters

Parameter

Description

Location

The location from which we'd like to find the closest listener, in world space.

MaximumRange

The maximum distance away from Location that a listener can be.

bAllowAttenuationOverride

True for the adjusted listener position (if attenuation override is set), false for the raw listener position (for panning)

ListenerPosition

[Out] The position of the closest listener in world space, if found.

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