FJsonSchemaGenerator

Used for generating a JSON schema from any [UStruct](API\Runtime\CoreUObject\UStruct) or [FProperty](API\Runtime\CoreUObject\FProperty).

API > API/Runtime > API/Runtime/JsonUtilities

Used for generating a JSON schema from any UStruct or FProperty.

   
Name FJsonSchemaGenerator
Type class
Header File /Engine/Source/Runtime/JsonUtilities/Public/JsonSchema/JsonSchemaGenerator.h
Include Path #include "JsonSchema/JsonSchemaGenerator.h"

Syntax

class FJsonSchemaGenerator

Functions

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FJsonObject > FPropertyToJsonSchemaObject ( TNotNull< const FProperty* > Property,
const FJsonSchemaPropertyFilter& PropertyFilter,
const FJsonSchemaEditorMetadata* CachedEditorMetadata,
const void* InstanceMemory
)

 Derives a JSON Schema definition for Property's type. JsonSchema/JsonSchemaGenerator.h  

static FString FPropertyToJsonSchemaString ( TNotNull< const FProperty* > Property,
const FJsonSchemaPropertyFilter& PropertyFilter,
const FJsonSchemaEditorMetadata* CachedEditorMetadata,
const int32 Indent,
const bool bPrettyPrint
)

 String output variant of FPropertyToJsonSchemaObject() (see above.) JsonSchema/JsonSchemaGenerator.h  

static TSharedPtr< FJsonObject > UStructToJsonSchemaObject ( const FJsonSchemaPropertyFilter& PropertyFilter,
FJsonSchemaEditorMetadata* CachedEditorMetadata
)

 Templated variant of UStructToJsonSchemaObject() (see above.). JsonSchema/JsonSchemaGenerator.h  

static TSharedPtr< FJsonObject > UStructToJsonSchemaObject ( TNotNull< const UStruct* > Struct,
const FJsonSchemaPropertyFilter& PropertyFilter,
const FJsonSchemaEditorMetadata* CachedEditorMetadata,
const void* InstanceMemory
)

 Recursively walks Struct's property hierarchy to derive a JSON Schema definition for this type. JsonSchema/JsonSchemaGenerator.h  

static FString UStructToJsonSchemaString ( const FJsonSchemaPropertyFilter& PropertyFilter,
const FJsonSchemaEditorMetadata* CachedEditorMetadata,
const int32 Indent,
const bool bPrettyPrint
)

 Templated variant of UStructToJsonSchemaString() (see above.). JsonSchema/JsonSchemaGenerator.h  

static FString UStructToJsonSchemaString ( TNotNull< const UStruct* > Struct,
const FJsonSchemaPropertyFilter& PropertyFilter,
const FJsonSchemaEditorMetadata* CachedEditorMetadata,
const int32 Indent,
const bool bPrettyPrint
)

 String output variant of UStructToJsonSchemaObject() (see above.) JsonSchema/JsonSchemaGenerator.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page