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::GetClosestListenerLocation

Light Theme

Dark Theme

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

Returns

true if we've successfully found a listener within MaximumRange of Location, otherwise false. @note This will always return false if there is no audio device, or the audio device is disabled.

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.

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

Take our survey

Dismiss