1. Epic GamesDeveloper
  3. UMetaSoundSettings

UMetaSoundSettings

API > API/Plugins > API/Plugins/MetasoundEngine

Inheritance Hierarchy

References

   
Module MetasoundEngine
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundSettings.h
Include #include "MetasoundSettings.h"

Syntax

UCLASS (Config=MetaSound, defaultconfig, Meta=(DisplayName="MetaSounds"))  
class UMetaSoundSettings : public UDeveloperSettings

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta Config TArray< FDefaultMetaSoundAssetAutoUpdateSettings > AutoUpdateAssetDenylist List of MetaSound assets whose node references should not be AutoUpdated.
Public variable UProperty Category, EditAnywhere, Meta Config TArray< FMetasoundFrontendClassName > AutoUpdateDenylist List of native MetaSound classes whose node references should not be AutoUpdated.
Public variable UProperty Category, EditAnywhere Config bool bAutoUpdateEnabled If true, AutoUpdate is enabled, increasing load times.
Public variable UProperty Category, EditAnywhere, Meta Config bool bAutoUpdateLogWarningOnDroppedConnection If true, warnings will be logged if updating a node results in existing connections being discarded.
Public variable UProperty Transient int32 DenyListCacheChangeID  
Public variable UProperty Category, EditAnywhere, Meta Config TArray< FDirectoryPath > DirectoriesToRegister Directories to scan & automatically register MetaSound post initial asset scan on engine start-up.

Functions

  Type Name Description
Public function Const const FMetaSoundPageSettings *

FindPageSettings ( const FGuid& InPageID
)

 Returns the page settings with the unique ID given.
Public function Const const FMetaSoundPageSettings * Returns the page settings with the provided name.
Public function Const const FMetaSoundQualitySettings *

FindQualitySettings ( const FGuid& InQualityID
)

 Returns the quality settings with the unique ID given.
Public function Const const FMetaSoundQualitySettings * Returns the quality settings with the provided name.
Public function Const TArray< FName > Returns superset of page platforms (and groups) that define page target(s).
Public function Const TArray< FGuid >

GetCookedTargetPageIDs ( FName PlatformName
)

 Returns PageIDs to be cooked to the given platform/platform group.
Public function Const const FMetaSoundPageSettings &  
Public function Metasound::Engine::FOnSettingsDefaultConformed &  
Public function Metasound::Engine::FOnPageSettingsUpdated &  
Public function Static UFunction TArray< FName > Returns an array of page names.
Public function Static FName  
Public function Const const TArray< FMetaSoundPageSettings > & Returns the project-specific page settings (does not include the required default settings).
Public function Static UFunction TArray< FName > Returns an array of quality setting names.
Public function Static FName  
Public function Const const TArray< FMetaSoundQualitySettings > &  
Public function Const const FMetaSoundPageSettings & Returns the currently targeted page settings.
Public function Const void

IterateCookedTargetPageIDs ( FName PlatformName,
TFunctionRef< void(const FGuid&)> Iter
)

 Iterates PageIDs cooked to the given platform/platform group.
Public function Const void

IteratePageSettings ( TFunctionRef< void(const FMetaSoundPageSettings&)> Iter,
bool bReverse
)

 Iterates possible page settings in order (including the default page settings, which is always last).
Public function bool

SetTargetPage ( FName PageName
)

 Sets the target page to the given name.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page