UGameplayStatics::CreateSound2D

Creates a sound 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 UAudioComponent * CreateSound2D
(
    const UObject * WorldContextObject,
    USoundBase * Sound,
    float VolumeMultiplier,
    float PitchMultiplier,
    float StartTime,
    USoundConcurrency * ConcurrencySettings,
    bool bPersistAcrossLevelTransition,
    bool bAutoDestroy
)

Remarks

Creates a sound with no attenuation, perfect for UI sounds. This does NOT play the sound

Not Replicated.

Returns

An audio component to manipulate the created sound

Parameters

Parameter

Description

Sound

Sound to create.

VolumeMultiplier

Multiplied with the volume to make the sound louder or softer.

PitchMultiplier

Multiplies the pitch.

StartTime

How far in to the sound to begin playback at

ConcurrencySettings

Override concurrency settings package to play sound with

PersistAcrossLevelTransition

Whether the sound should continue to play when the map it was played in is unloaded

bAutoDestroy

Whether the returned audio component will be automatically cleaned up when the sound finishes (by completing or stopping) or whether it can be reactivated

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