Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Kismet/GameplayStatics.h |
Include |
#include "Kismet/GameplayStatics.h" |
Source |
/Engine/Source/Runtime/Engine/Private/GameplayStatics.cpp |
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
)
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.
An audio component to manipulate the spawned sound
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 |