Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Json > Dom > FJsonObject

Light Theme

Dark Theme

FJsonObject

A Json Object is a structure holding an unordered set of name/value pairs.

References

Module	Json
Header	/Engine/Source/Runtime/Json/Public/Dom/JsonObject.h
Include	#include "Dom/JsonObject.h"

Syntax

class FJsonObject

Remarks

A Json Object is a structure holding an unordered set of name/value pairs. In a Json file, it is represented by everything between curly braces {}.

Variables

		Name	Description
	TMap< FString, ...	Values

Functions

	Name	Description
void	Duplicate ( const TSharedPtr< const FJsonObject..., const TSharedPtr< FJsonObject >& D... )
void	Duplicate ( const TSharedPtr< FJsonObject >& S..., TSharedPtr< FJsonObject >& Dest )
const TArray...	GetArrayField ( const FString& FieldName )	Get the field named FieldName as an array.
bool	GetBoolField ( const FString& FieldName )	Gets the field with the specified name as a boolean.
TSharedPtr< ...	GetField ( const FString& FieldName )
int32	GetIntegerField ( const FString& FieldName )	Gets a numeric field and casts to an int32
double	GetNumberField ( const FString& FieldName )	Gets the field with the specified name as a number.
const TShare...	GetObjectField ( const FString& FieldName )	Gets the field with the specified name as a Json object.
FString	GetStringField ( const FString& FieldName )	Get the field named FieldName as a string.
bool	HasField ( const FString& FieldName )	Checks whether a field with the specified name exists in the object.
bool	HasTypedField ( const FString& FieldName )	Checks whether a field with the specified name and type exists in the object.
void	RemoveField ( const FString& FieldName )	Removes the field with the specified name.
void	SetArrayField ( const FString& FieldName, const TArray< TSharedPtr< FJsonValu... )	Set an array field named FieldName and value of Array
void	SetBoolField ( const FString& FieldName, bool InValue )	Set a boolean field named FieldName and value of InValue
void	SetField ( const FString& FieldName, const TSharedPtr< FJsonValue >& Va... )	Sets the value of the field with the specified name.
void	SetNumberField ( const FString& FieldName, double Number )	Add a field named FieldName with Number as value
void	SetObjectField ( const FString& FieldName, const TSharedPtr< FJsonObject >& J... )	Set an ObjectField named FieldName and value of JsonObject
void	SetStringField ( const FString& FieldName, const FString& StringValue )	Add a field named FieldName with value of StringValue
bool	TryGetArrayField ( const FString& FieldName, const TArray< TSharedPtr< FJsonValu... )	Try to get the field named FieldName as an array, or return false if it's another type
bool	TryGetBoolField ( const FString& FieldName, bool& OutBool )	Get the field named FieldName as a string.
bool	TryGetEnumArrayField ( const FString& FieldName, TArray< TEnum >& OutArray )	Get the field named FieldName as an array of enums.
TSharedPtr< ...	TryGetField ( const FString& FieldName )	Attempts to get the field with the specified name.
bool	TryGetNumberField ( const FString& FieldName, uint32& OutNumber )	Get the field named FieldName as a number, and makes sure it's within uint32 range.
bool	TryGetNumberField ( const FString& FieldName, float& OutNumber )	Get the field named FieldName as a number.
bool	TryGetNumberField ( const FString& FieldName, double& OutNumber )	Get the field named FieldName as a number.
bool	TryGetNumberField ( const FString& FieldName, int8& OutNumber )	Get the field named FieldName as a number, and makes sure it's within int8 range.
bool	TryGetNumberField ( const FString& FieldName, int16& OutNumber )	Get the field named FieldName as a number, and makes sure it's within int16 range.
bool	TryGetNumberField ( const FString& FieldName, int32& OutNumber )	Get the field named FieldName as a number, and makes sure it's within int32 range.
bool	TryGetNumberField ( const FString& FieldName, int64& OutNumber )	Get the field named FieldName as a number.
bool	TryGetNumberField ( const FString& FieldName, uint8& OutNumber )	Get the field named FieldName as a number, and makes sure it's within uint8 range.
bool	TryGetNumberField ( const FString& FieldName, uint16& OutNumber )	Get the field named FieldName as a number, and makes sure it's within uint16 range.
bool	TryGetNumberField ( const FString& FieldName, uint64& OutNumber )	Get the field named FieldName as a number, and makes sure it's within uint64 range.
bool	TryGetObjectField ( const FString& FieldName, const TSharedPtr< FJsonObject >... )	Try to get the field named FieldName as an object, or return false if it's another type
bool	TryGetStringArrayField ( const FString& FieldName, TArray< FString >& OutArray )	Get the field named FieldName as an array of strings.
bool	TryGetStringField ( const FString& FieldName, FString& OutString )	Get the field named FieldName as a string.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel