FToolsetJsonConverter

Base class for custom conversion between FProperty and JSON.

API > API/Plugins > API/Plugins/ToolsetRegistry

Base class for custom conversion between FProperty and JSON.

   
Name FToolsetJsonConverter
Type class
Header File /Engine/Plugins/Experimental/ToolsetRegistry/Source/ToolsetRegistry/Public/ToolsetRegistry/ToolsetJsonConverter.h
Include Path #include "ToolsetRegistry/ToolsetJsonConverter.h"

Syntax

class FToolsetJsonConverter

Constructors

Name Remarks Include Path Unreal Specifiers

FToolsetJsonConverter()

   ToolsetRegistry/ToolsetJsonConverter.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FToolsetJsonConverter()

   ToolsetRegistry/ToolsetJsonConverter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanConvertProperty ( TNotNull< const FProperty* > Property
)

 Determines whether a given property type can be handled by this converter. ToolsetRegistry/ToolsetJsonConverter.h  

FString GetName()

 Returns the name of the converter. ToolsetRegistry/ToolsetJsonConverter.h  

bool JsonDataToProperty ( const TSharedPtr< FJsonValue >& JsonValue,
TNotNull< FProperty* > Property,
void* OutValue,
UObject* Outer
)

 Set an FProperty on an instance from JSON data. ToolsetRegistry/ToolsetJsonConverter.h  

TSharedPtr< FJsonValue > PropertyToDefault ( TNotNull< const FProperty* > Property,
const FString& DefaultString
)

 Generates a default object from the FProperty. ToolsetRegistry/ToolsetJsonConverter.h  

TSharedPtr< FJsonValue > PropertyToJsonData ( TNotNull< FProperty* > Property,
const void* Value
)

 Gets an FProperty on an instance to JSON data. ToolsetRegistry/ToolsetJsonConverter.h  

TSharedPtr< FJsonObject > PropertyToJsonSchema ( TNotNull< const FProperty* > Property
)

 Converts an FProperty to JSON schema. ToolsetRegistry/ToolsetJsonConverter.h  

Public Virtual

Static

Name Remarks Include Path Unreal Specifiers

static bool ToolsetJsonDataToProperty ( const TSharedPtr< FJsonValue >& JsonValue,
TNotNull< FProperty* > Property,
TNotNull< void* > OutValue
)

 Sets a property on an instance from JSON data via the full ToolsetJson pipeline. ToolsetRegistry/ToolsetJsonConverter.h  

static bool ToolsetJsonDataToStruct ( const TSharedRef< FJsonObject >& JsonObject,
TNotNull< const UStruct* > StructDefinition,
TNotNull< void* > OutStruct
)

 Updates a UStruct instance from JSON data via the full ToolsetJson pipeline. ToolsetRegistry/ToolsetJsonConverter.h  

static TSharedPtr< FJsonValue > ToolsetPropertyToJsonData ( TNotNull< FProperty* > Property,
TNotNull< const void* > Value
)

 Converts a property value to JSON data via the full ToolsetJson pipeline. ToolsetRegistry/ToolsetJsonConverter.h  

static TSharedPtr< FJsonObject > ToolsetPropertyToJsonSchema ( TNotNull< const FProperty* > Property
)

 Converts a property to JSON schema via the full ToolsetJson pipeline. ToolsetRegistry/ToolsetJsonConverter.h  

static TSharedPtr< FJsonObject > ToolsetStructToJsonData ( TNotNull< const UStruct* > StructDefinition,
TNotNull< const void* > Struct,
bool UserVisiblePropertiesOnly
)

 Converts a UStruct instance to JSON data via the full ToolsetJson pipeline. ToolsetRegistry/ToolsetJsonConverter.h  

static TSharedPtr< FJsonObject > ToolsetStructToJsonSchema ( TNotNull< const UStruct* > StructDefinition,
bool UserVisiblePropertiesOnly
)

 Converts a UStruct to JSON schema via the full ToolsetJson pipeline. ToolsetRegistry/ToolsetJsonConverter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page