1. Epic GamesDeveloper
  3. USoundEffectPreset

USoundEffectPreset

Unreal Engine C++ API Reference > Runtime > Engine > Sound

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

  Type Name Description
Protected variable bool bInitialized  
Protected variable TArray< TSoundEffectWeakPtr > Instances Array of instances which are using this preset.
Protected variable FCriticalSection InstancesMutationCriticalSection  

Constructors

  Type Name Description
Public function  

USoundEffectPreset ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddEffectInstance ( TSoundEffectPtr& InEffectPtr
)

  
Public function void  
Public function Virtual Const bool  
Public function Static TSharedPtr< TSoundEffectType, ESPMode::ThreadSafe > Creates a sound effect instance but does not initialize it.
Public function Static TSharedPtr< TSoundEffectType, ESPMode::ThreadSafe >

CreateInstance ( const TInitData& InInitData,
USoundEffectPreset& InOutPreset
)

 Creates a sound effect instance and initializes it.
Public function Virtual Const FSoundEffectBase *  
Public function Virtual Const USoundEffectPreset *

CreateNewPreset ( UObject* InParent,
FName Name,
EObjectFlags Flags
)

  
Protected function void

EffectCommand ( TFunction< void(T&)> InForEachEffect
)

 Defers execution of command on each active effect instance on the audio render thread
Public function Virtual Const FText  
Public function Virtual Const FColor  
Public function Virtual Const UClass *  
Public function Virtual Const bool  
Public function Virtual void

Init ()

  
Protected function void

IterateEffects ( TFunction< void(T&)> InForEachEffect
)

 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

  Type Name Description
Public function Virtual void Called before destroying the object.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Typedefs

Name Description
TSoundEffectWeakPtr  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page