USoundEffectPreset

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectPreset.h

Include

#include "Sound/SoundEffectPreset.h"

Syntax

class USoundEffectPreset : public UObject

Variables

Name Description

Protected variable

bool

 

bInitialized

Protected variable

TArray< TSoundE...

 

Instances

Array of instances which are using this preset.

Protected variable

FCriticalSectio...

 

InstancesMutationCriticalSection

Constructors

Name Description

Public function

USoundEffectPreset

(
    const FObjectInitializer& ObjectIn...
)

Destructors

Name Description

Public function Virtual

~USoundEffectPreset()

Functions

Name Description

Public function

void

 

AddEffectInstance

(
    TSoundEffectPtr& InEffectPtr
)

Public function

void

 

AddReferencedEffects

(
    FReferenceCollector& InCollector
)

Public function Virtual Const

bool

 

CanFilter()

Public function Static

TSharedPtr< ...

 

CreateInstance

(
    USoundEffectPreset& InOutPreset
)

Creates a sound effect instance but does not initialize it.

Public function Static

TSharedPtr< ...

 

CreateInstance

(
    const TInitData& InInitData,
    USoundEffectPreset& InOutPreset
)

Creates a sound effect instance and initializes it.

Public function Virtual Const

FSoundEffect...

 

CreateNewEffect()

Public function Virtual Const

USoundEffect...

 

CreateNewPreset

(
    UObject* InParent,
    FName Name,
    EObjectFlags Flags
)

Protected function

void

 

EffectCommand

(
    TFunction< void> InForEachEffe...
)

Defers execution of command on each active effect instance on the audio render thread

Public function Virtual Const

FText

 

GetAssetActionName()

Public function Virtual Const

FColor

 

GetPresetColor()

Public function Virtual Const

UClass *

 

GetSupportedClass()

Public function Virtual Const

bool

 

HasAssetActions()

Public function Virtual

void

 

Init()

Protected function

void

 

IterateEffects

(
    TFunction< void> InForEachEffe...
)

Immediately executes command for each active effect instance on the active thread

Public function Virtual

void

 

OnInit()

Public function Static

void

 

RegisterInstance

(
    USoundEffectPreset& InPreset,
    TSoundEffectPtr InEffectPtr
)

Public function

void

 

RemoveEffectInstance

(
    TSoundEffectPtr& InEffectPtr
)

Public function Static

void

 

UnregisterInstance

(
    TSoundEffectPtr InEffectPtr
)

Public function

void

 

Update()

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Typedefs

Name

Description

TSoundEffectWeakPtr