UGameplayStatics::PlaySound2D

Plays a sound directly with no attenuation, perfect for UI sounds.

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 PlaySound2D
(
    const UObject * WorldContextObject,
    USoundBase * Sound,
    float VolumeMultiplier,
    float PitchMultiplier,
    float StartTime,
    USoundConcurrency * ConcurrencySettings,
    AActor * OwningActor,
    bool bIsUISound
)

Remarks

Plays a sound directly with no attenuation, perfect for UI sounds.

Fire and Forget. Not Replicated.

Parameters

Parameter

Description

Sound

Sound to play.

VolumeMultiplier

A linear scalar multiplied with the volume, in order to make the sound louder or softer.

PitchMultiplier

A linear scalar multiplied with the pitch.

StartTime

How far in to the sound to begin playback at

ConcurrencySettings

Override concurrency settings package to play sound with

OwningActor

The actor to use as the "owner" for concurrency settings purposes. Allows PlaySound calls to do a concurrency limit per owner.

bIsUISound

True if sound is UI related, else false

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