UGameplayStatics::SpawnSoundAttached

Plays a sound attached to and following the specified component.

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 * SpawnSoundAttached
(
    USoundBase * Sound,
    USceneComponent * AttachToComponent,
    FName AttachPointName,
    FVector Location,
    FRotator Rotation,
    EAttachLocation::Type LocationType,
    bool bStopWhenAttachedToDestroyed,
    float VolumeMultiplier,
    float PitchMultiplier,
    float StartTime,
    USoundAttenuation * AttenuationSettings,
    USoundConcurrency * ConcurrencySettings,
    bool bAutoDestroy
)

Remarks

Plays a sound attached to and following the specified component. This is a fire and forget sound. Replication is also not handled at this point.

Returns

An audio component to manipulate the spawned sound

Parameters

Parameter

Description

Sound

sound to play

AttachComponent

Component to attach to.

AttachPointName

Optional named point within the AttachComponent to play the sound at

Location

Depending on the value of Location Type this is either a relative offset from the attach component/point or an absolute world position that will be translated to a relative offset

Rotation

Depending on the value of Location Type this is either a relative offset from the attach component/point or an absolute world rotation that will be translated to a relative offset

LocationType

Specifies whether Location is a relative offset or an absolute world position

bStopWhenAttachedToDestroyed

Specifies whether the sound should stop playing when the owner of the attach to component is destroyed.

VolumeMultiplier

Volume multiplier

PitchMultiplier

PitchMultiplier

StartTime

How far in to the sound to begin playback at

AttenuationSettings

Override attenuation settings package to play sound with

ConcurrencySettings

Override concurrency settings package to play sound with

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