Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
| Name | FMetasoundFrontendClassMetadata |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendDocument.h |
| Include Path | #include "MetasoundFrontendDocument.h" |
Syntax
USTRUCT ()
struct FMetasoundFrontendClassMetadata
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMetasoundFrontendClassMetadata() |
MetasoundFrontendDocument.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Author | FString | MetasoundFrontendDocument.h |
|
|
| bAutoUpdateManagesInterface | bool | If true, auto-update will manage (add and remove) inputs/outputs associated with internally connected nodes when the interface of the given node is auto-updated. | MetasoundFrontendDocument.h |
|
| bIsDeprecated | bool | If true, this node is deprecated and should not be used in new MetaSounds. | MetasoundFrontendDocument.h |
|
| bSerializeText | bool | Whether or not the given metadata text should be serialized or is procedurally maintained via auto-update & the referenced registry class (to avoid localization text desync). | MetasoundFrontendDocument.h | |
| CategoryHierarchy | TArray< FText > | MetasoundFrontendDocument.h |
|
|
| CategoryHierarchyTransient | TArray< FText > | MetasoundFrontendDocument.h |
|
|
| ChangeID | FGuid | ID used to identify if any of the above have been modified, to determine if the parent class should be auto-updated. | MetasoundFrontendDocument.h |
|
| ClassName | FMetasoundFrontendClassName | MetasoundFrontendDocument.h |
|
|
| Description | FText | MetasoundFrontendDocument.h |
|
|
| DescriptionTransient | FText | MetasoundFrontendDocument.h |
|
|
| DisplayName | FText | MetasoundFrontendDocument.h |
|
|
| DisplayNameTransient | FText | MetasoundFrontendDocument.h |
|
|
| Keywords | TArray< FText > | MetasoundFrontendDocument.h |
|
|
| KeywordsTransient | TArray< FText > | MetasoundFrontendDocument.h |
|
|
| PromptIfMissingTransient | FText | TODO: Move to using a non-localized hint path. | MetasoundFrontendDocument.h |
|
| Type | EMetasoundFrontendClassType | MetasoundFrontendDocument.h |
|
|
| Version | FMetasoundFrontendVersionNumber | MetasoundFrontendDocument.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetAndClearAutoUpdateManagesInterface_Deprecated() |
Deprecated field in favor of GraphClass PresetOptions. | MetasoundFrontendDocument.h | |
const FString & GetAuthor() |
MetasoundFrontendDocument.h | ||
| MetasoundFrontendDocument.h | |||
const FGuid & GetChangeID() |
MetasoundFrontendDocument.h | ||
const FMetasoundFrontendClassName & GetClassName() |
MetasoundFrontendDocument.h | ||
const FText & GetDescription() |
MetasoundFrontendDocument.h | ||
const FText & GetDisplayName() |
MetasoundFrontendDocument.h | ||
bool GetIsDeprecated() |
MetasoundFrontendDocument.h | ||
| MetasoundFrontendDocument.h | |||
const FText & GetPromptIfMissing() |
MetasoundFrontendDocument.h | ||
EMetasoundFrontendClassType GetType() |
MetasoundFrontendDocument.h | ||
const FMetasoundFrontendVersionNumber & GetVersion() |
MetasoundFrontendDocument.h | ||
void SetAuthor
(
const FString& InAuthor |
MetasoundFrontendDocument.h | ||
| MetasoundFrontendDocument.h | |||
void SetClassName
(
const FMetasoundFrontendClassName& InClassName |
MetasoundFrontendDocument.h | ||
void SetDescription
(
const FText& InDescription |
MetasoundFrontendDocument.h | ||
void SetDisplayName
(
const FText& InDisplayName |
MetasoundFrontendDocument.h | ||
void SetIsDeprecated
(
bool bInIsDeprecated |
MetasoundFrontendDocument.h | ||
| MetasoundFrontendDocument.h | |||
void SetPromptIfMissing
(
const FText& InPromptIfMissing |
MetasoundFrontendDocument.h | ||
void SetSerializeText
(
bool bInSerializeText |
MetasoundFrontendDocument.h | ||
void SetType
(
const EMetasoundFrontendClassType InType |
MetasoundFrontendDocument.h | ||
void SetVersion
(
const FMetasoundFrontendVersionNumber& InVersion |
MetasoundFrontendDocument.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FMetasoundFrontendClassMetadata GenerateClassMetadata
(
const Metasound::FNodeClassMetadata& InNodeClassMetadata, |
Generates class metadata intended to be used as a registry descriptor from FNodeClassMetadata. Does not initialize a change ID as it is not considered to be transactional. | MetasoundFrontendDocument.h | |
static FName GetAuthorPropertyName() |
MetasoundFrontendDocument.h | ||
static FName GetCategoryHierarchyPropertyName() |
MetasoundFrontendDocument.h | ||
static FName GetClassNamePropertyName() |
MetasoundFrontendDocument.h | ||
static FName GetDescriptionPropertyName() |
MetasoundFrontendDocument.h | ||
static FName GetDisplayNamePropertyName() |
MetasoundFrontendDocument.h | ||
static FName GetIsDeprecatedPropertyName() |
MetasoundFrontendDocument.h | ||
static FName GetKeywordsPropertyName() |
MetasoundFrontendDocument.h | ||
static FName GetVersionPropertyName() |
MetasoundFrontendDocument.h |