Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Metadata associated with a vertex.
| Name | FMetasoundFrontendVertexMetadata |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendDocument.h |
| Include Path | #include "MetasoundFrontendDocument.h" |
Syntax
USTRUCT ()
struct FMetasoundFrontendVertexMetadata
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsAdvancedDisplay | bool | If true, vertex is shown for advanced display. | MetasoundFrontendDocument.h | |
| SortOrderIndex | int32 | Order index of vertex member when shown as a node. | MetasoundFrontendDocument.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| 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 | |
| Description | FText | Description of the vertex. | MetasoundFrontendDocument.h |
|
| DescriptionTransient | FText | Description of the vertex if vertex is natively defined (must be transient to avoid localization desync on load) | MetasoundFrontendDocument.h |
|
| DisplayName | FText | Display name for a vertex. | MetasoundFrontendDocument.h |
|
| DisplayNameTransient | FText | Display name for a vertex if vertex is natively defined (must be transient to avoid localization desync on load) | MetasoundFrontendDocument.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FText & GetDescription () |
MetasoundFrontendDocument.h | ||
const FText & GetDisplayName () |
MetasoundFrontendDocument.h | ||
bool GetSerializeText() |
MetasoundFrontendDocument.h | ||
void SetDescription
(
const FText& InText |
MetasoundFrontendDocument.h | ||
void SetDisplayName
(
const FText& InText |
MetasoundFrontendDocument.h | ||
void SetIsAdvancedDisplay
(
const bool InIsAdvancedDisplay |
MetasoundFrontendDocument.h | ||
void SetSerializeText
(
bool bInSerializeText |
MetasoundFrontendDocument.h |