FJsonSchemaGeneratorEditor::UStructToJsonSchemaMetadata

Navigation

API > API/Editor > API/Editor/JsonUtilitiesEditor > API/Editor/JsonUtilitiesEditor/FJsonSchemaGeneratorEditor

Description

Usually not called by a developer directly. Used by the Runtime module via the Module Feature.

Recursively walks Struct's property hierarchy, collecting editor-only meta-data like tooltips and other Meta values, returning them in the cookable metadata.

e.g: // Details for a person USTRUCT() struct FPerson {

// Full name

FString Name;

// How old they are

int32 Age; }

// A family of people USTRUCT() struct FFamily { // Members of this family

TArray Members; }

-> metadata: description -> "A family of people" PropertyMetadata -> Members = "Members of this family" Members.Name = "Full name" Members.Age = "How old they are" (ClampMin = 1)

Note: When Struct is a UFunction, function parameter descriptions will be harvested from doxygen markup in the function comment e.g: // Returns the best friend of the given person // Person: The person to find the best friend of

FPerson GetBestFriend(const FPerson& Person)

-> metadata: description -> "Returns the best friend of the given person" PropertyMetadata -> Person -> "The person to find the best friend of"

static FJsonSchemaEditorMetadata UStructToJsonSchemaMetadata  
(  
    TNotNull< const UStruct * > Struct,  
    const FJsonSchemaPropertyFilter & PropertyFilter,  
    const void * InstanceMemory  
)  
Copy full snippet

static FJsonSchemaEditorMetadata UStructToJsonSchemaMetadata (     TNotNull< const UStruct * > Struct,     const FJsonSchemaPropertyFilter & PropertyFilter,     const void * InstanceMemory )

The collected property metadata.

Parameters