1. Epic GamesDeveloper
  3. UJsonBlueprintFunctionLibrary

UJsonBlueprintFunctionLibrary

API > API/Plugins > API/Plugins/JsonBlueprintUtilities

   
Name UJsonBlueprintFunctionLibrary
Type class
Header File /Engine/Plugins/JsonBlueprintUtilities/Source/JsonBlueprintUtilities/Public/JsonBlueprintFunctionLibrary.h
Include Path #include "JsonBlueprintFunctionLibrary.h"

Syntax

UCLASS (BlueprintType)  
class UJsonBlueprintFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static bool FromFile ( const FFilePath& File,
FJsonObjectWrapper& OutJsonObject
)

 Creates a JsonObject from the provided Json file. JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Json"
  • Meta=(DisplayName="Load Json from File")

static bool FromString ( const FString& JsonString,
FJsonObjectWrapper& OutJsonObject
)

 Creates a JsonObject from the provided Json string. JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Json"
  • Meta=(DisplayName="Load Json from String")

static bool GetField ( const FJsonObjectWrapper& JsonObject,
const FString& FieldName,
int32& OutValue
)

 Gets the value of the specified field. JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • CustomThunk
  • BlueprintInternalUseOnly
  • Category="Json"
  • Meta=(CustomStructureParam="OutValue", AutoCreateRefTerm="OutValue")

static bool GetFieldNames ( const FJsonObjectWrapper& JsonObject,
TArray< FString >& FieldNames
)

 Gets all field names on the JsonObject JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Json"

static bool HasField ( const FJsonObjectWrapper& JsonObject,
const FString& FieldName
)

 Checks if the field exists on the object. JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Json"

static bool JsonFieldToProperty ( const FString& FieldName,
const FJsonObjectWrapper& SourceObject,
FProperty* TargetProperty,
void* TargetValuePtr
)

 FieldName only used for logging, SrcValue should be the resolved field. JsonBlueprintFunctionLibrary.h  

static bool PropertyToJsonField ( const FString& FieldName,
FProperty* SourceProperty,
const void* SourceValuePtr,
FJsonObjectWrapper& TargetObject
)

 If FieldName empty, Object created as root, or created with name "Value" otherwise. JsonBlueprintFunctionLibrary.h  

static bool SetField ( const FJsonObjectWrapper& JsonObject,
const FString& FieldName,
const int32& Value
)

 Adds (new) or sets (existing) the value of the specified field. JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • CustomThunk
  • BlueprintInternalUseOnly
  • Category="Json"
  • Meta=(CustomStructureParam="Value", AutoCreateRefTerm="Value")

static bool StructToJsonString ( const int32& Struct,
FString& OutJsonString
)

   JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • CustomThunk
  • BlueprintInternalUseOnly
  • Category="Json"
  • Meta=(DisplayName="Convert Struct To Json String", CustomStructureParam="Struct", AutoCreateRefTerm="Struct")

static bool ToFile ( const FJsonObjectWrapper& JsonObject,
const FFilePath& File
)

 Creates a file from the provided JsonObject. JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Json"
  • Meta=(DisplayName="Save Json to File")

static bool ToString ( const FJsonObjectWrapper& JsonObject,
FString& OutJsonString
)

 Creates a Json string from the provided JsonObject. JsonBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="Json"
  • Meta=(DisplayName="Get Json String")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page