Navigation
API > API/Runtime > API/Runtime/JsonUtilities > API/Runtime/JsonUtilities/FJsonSchemaGenerator
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FString UStructToJsonSchemaString
(
const FJsonSchemaPropertyFilter& PropertyFilter, |
Templated variant of UStructToJsonSchemaString() (see above.). | JsonSchema/JsonSchemaGenerator.h | |
static FString UStructToJsonSchemaString
(
TNotNull< const UStruct* > Struct, |
String output variant of UStructToJsonSchemaObject() (see above.) | JsonSchema/JsonSchemaGenerator.h |
UStructToJsonSchemaString(const FJsonSchemaPropertyFilter &, const FJsonSchemaEditorMetadata *, const int32, const bool)
Description
Templated variant of UStructToJsonSchemaString() (see above.).
Works according to struct/class type instead of an taking actual UStruct/UClass reference - i.e. UStructToJsonSchema
| Name | UStructToJsonSchemaString |
| Type | function |
| Header File | /Engine/Source/Runtime/JsonUtilities/Public/JsonSchema/JsonSchemaGenerator.h |
| Include Path | #include "JsonSchema/JsonSchemaGenerator.h" |
template<typename InStructType>
static FString UStructToJsonSchemaString
(
const FJsonSchemaPropertyFilter & PropertyFilter,
const FJsonSchemaEditorMetadata * CachedEditorMetadata,
const int32 Indent,
const bool bPrettyPrint
)
Schema for the UStruct, as a JSON string.
Parameters
| Name | Remarks |
|---|---|
| PropertyFilter | Determines how to filter collected struct and property data. |
| CachedEditorMetadata | If valid, use this metadata instead of collecting it. Otherwise, it will be automatically collected (if running in Editor context.) This is optional, and used for workflows that have cached metadata from an earlier process. |
| Indent | How many additional tabs to add to the json serializer output. |
| bPrettyPrint | Option to use pretty print (e.g., adds line endings), otherwise condensed print. |
UStructToJsonSchemaString(TNotNull< const UStruct >, const FJsonSchemaPropertyFilter &, const FJsonSchemaEditorMetadata , const int32, const bool)
Description
String output variant of UStructToJsonSchemaObject() (see above.)
Provides JSON string instead of JSON object.
| Name | UStructToJsonSchemaString |
| Type | function |
| Header File | /Engine/Source/Runtime/JsonUtilities/Public/JsonSchema/JsonSchemaGenerator.h |
| Include Path | #include "JsonSchema/JsonSchemaGenerator.h" |
| Source | /Engine/Source/Runtime/JsonUtilities/Private/JsonSchema/JsonSchemaGenerator.cpp |
static FString UStructToJsonSchemaString
(
TNotNull< const UStruct * > Struct,
const FJsonSchemaPropertyFilter & PropertyFilter,
const FJsonSchemaEditorMetadata * CachedEditorMetadata,
const int32 Indent,
const bool bPrettyPrint
)
Schema for the UStruct, as a JSON string.
Parameters
| Name | Remarks |
|---|---|
| Struct | The type to build a schema for. Can be either UScriptStruct, UClass or UFunction. |
| PropertyFilter | Determines how to filter collected struct and property data. |
| CachedEditorMetadata | If valid, use this metadata instead of collecting it. Otherwise, it will be automatically collected (if running in Editor context.) This is optional, and used for workflows that have cached metadata from an earlier process. |
| Indent | How many additional tabs to add to the json serializer output. |
| bPrettyPrint | Option to use pretty print (e.g., adds line endings), otherwise condensed print. |