UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Projects::Private Namespace Reference

Functions

bool TryGetBoolField (Json::FConstObject Object, const TCHAR *FieldName, bool &Out)
 
template<typename T >
bool TryConvertFromDouble (double Double, T &OutNumber)
 
template<>
bool TryConvertFromDouble< uint64 > (double Double, uint64 &OutNumber)
 
template<>
bool TryConvertFromDouble< int64 > (double Double, int64 &OutNumber)
 
bool TryGetNumberField (Json::FConstObject Object, const TCHAR *FieldName, int32 &Out)
 
bool TryGetNumberField (Json::FConstObject Object, const TCHAR *FieldName, uint32 &Out)
 
bool TryGetStringField (Json::FConstObject Object, const TCHAR *FieldName, FString &Out)
 
bool TryGetStringArrayField (Json::FConstObject Object, const TCHAR *FieldName, TArray< FString > &Out)
 
bool TryGetStringArrayField (Json::FConstObject Object, const TCHAR *FieldName, TArray< FName > &Out)
 
bool TryGetStringArrayFieldWithDeprecatedFallback (Json::FConstObject Object, const TCHAR *FieldName, const TCHAR *DeprecatedFieldName, TArray< FString > &OutArray)
 
FText GetArrayObjectTypeError (const TCHAR *FieldName, int32 Index)
 
FText GetArrayObjectChildParseError (const TCHAR *FieldName, int32 Index, const FText &PropagateError)
 
bool TryGetStringField (Json::FConstObject Object, const TCHAR *FieldName, FStringView &Out)
 
template<typename TEnum >
bool TryGetEnumArrayField (Json::FConstObject Object, const TCHAR *FieldName, TArray< TEnum > &OutArray)
 
template<typename TEnum >
bool TryGetEnumArrayFieldWithDeprecatedFallback (Json::FConstObject Object, const TCHAR *FieldName, const TCHAR *DeprecatedFieldName, TArray< TEnum > &OutArray)
 
TOptional< FTextRead (Json::FConstObject Object, FPluginManifest &Out)
 
TOptional< FTextRead (Json::FConstObject Object, FPluginDescriptor &Out)
 
TOptional< FTextRead (Json::FConstObject Object, FModuleDescriptor &Out)
 
TOptional< FTextRead (Json::FConstObject Object, FLocalizationTargetDescriptor &Out)
 
TOptional< FTextRead (Json::FConstObject Object, FPluginReferenceDescriptor &Out)
 
TOptional< FTextRead (Json::FConstObject Object, FPluginDisallowedDescriptor &Out)
 
FCustomBuildSteps ReadCustomBuildSteps (Json::FConstObject Object, const TCHAR *FieldName)
 
template<typename FUNCTOR >
bool ReadFromDefaultJsonHelper (const FJsonObject &Object, FUNCTOR &&Functor)
 
template<typename TYPE >
bool ReadFromDefaultJson (const FJsonObject &Object, TYPE &Out, FText *OutFailReason)
 
template<typename TYPE >
TOptional< FTextReadArray (Json::FConstObject Object, const TCHAR *FieldName, TArray< TYPE > &OutArray)
 
template<typename TYPE >
bool ReadArrayFromDefaultJson (const FJsonObject &Object, const TCHAR *Name, TArray< TYPE > &OutArray, FText *OutFailReason)
 

Function Documentation

◆ GetArrayObjectChildParseError()

FText UE::Projects::Private::GetArrayObjectChildParseError ( const TCHAR FieldName,
int32  Index,
const FText PropagateError 
)

◆ GetArrayObjectTypeError()

FText UE::Projects::Private::GetArrayObjectTypeError ( const TCHAR FieldName,
int32  Index 
)

◆ Read() [1/6]

TOptional< FText > UE::Projects::Private::Read ( Json::FConstObject  Object,
FLocalizationTargetDescriptor Out 
)

◆ Read() [2/6]

TOptional< FText > UE::Projects::Private::Read ( Json::FConstObject  Object,
FModuleDescriptor Out 
)

◆ Read() [3/6]

TOptional< FText > UE::Projects::Private::Read ( Json::FConstObject  Object,
FPluginDescriptor Out 
)

◆ Read() [4/6]

TOptional< FText > UE::Projects::Private::Read ( Json::FConstObject  Object,
FPluginDisallowedDescriptor Out 
)

◆ Read() [5/6]

TOptional< FText > UE::Projects::Private::Read ( Json::FConstObject  Object,
FPluginManifest Out 
)

◆ Read() [6/6]

TOptional< FText > UE::Projects::Private::Read ( Json::FConstObject  Object,
FPluginReferenceDescriptor Out 
)

◆ ReadArray()

template<typename TYPE >
TOptional< FText > UE::Projects::Private::ReadArray ( Json::FConstObject  Object,
const TCHAR FieldName,
TArray< TYPE > &  OutArray 
)

◆ ReadArrayFromDefaultJson()

template<typename TYPE >
bool UE::Projects::Private::ReadArrayFromDefaultJson ( const FJsonObject Object,
const TCHAR Name,
TArray< TYPE > &  OutArray,
FText OutFailReason 
)

◆ ReadCustomBuildSteps()

FCustomBuildSteps UE::Projects::Private::ReadCustomBuildSteps ( Json::FConstObject  Object,
const TCHAR FieldName 
)

◆ ReadFromDefaultJson()

template<typename TYPE >
bool UE::Projects::Private::ReadFromDefaultJson ( const FJsonObject Object,
TYPE Out,
FText OutFailReason 
)

◆ ReadFromDefaultJsonHelper()

template<typename FUNCTOR >
bool UE::Projects::Private::ReadFromDefaultJsonHelper ( const FJsonObject Object,
FUNCTOR &&  Functor 
)

◆ TryConvertFromDouble()

template<typename T >
bool UE::Projects::Private::TryConvertFromDouble ( double  Double,
T &  OutNumber 
)

◆ TryConvertFromDouble< int64 >()

template<>
bool UE::Projects::Private::TryConvertFromDouble< int64 > ( double  Double,
int64 OutNumber 
)

◆ TryConvertFromDouble< uint64 >()

template<>
bool UE::Projects::Private::TryConvertFromDouble< uint64 > ( double  Double,
uint64 OutNumber 
)

◆ TryGetBoolField()

bool UE::Projects::Private::TryGetBoolField ( Json::FConstObject  Object,
const TCHAR FieldName,
bool Out 
)

These are utility functions to be as close to the default Json parser as possible, only really necessary because we have public APIs that take FJsonObjects directly

◆ TryGetEnumArrayField()

template<typename TEnum >
bool UE::Projects::Private::TryGetEnumArrayField ( Json::FConstObject  Object,
const TCHAR FieldName,
TArray< TEnum > &  OutArray 
)
inline

Get the field named FieldName as an array of strings. Returns false if it doesn't exist or any member cannot be converted.

◆ TryGetEnumArrayFieldWithDeprecatedFallback()

template<typename TEnum >
bool UE::Projects::Private::TryGetEnumArrayFieldWithDeprecatedFallback ( Json::FConstObject  Object,
const TCHAR FieldName,
const TCHAR DeprecatedFieldName,
TArray< TEnum > &  OutArray 
)
inline

◆ TryGetNumberField() [1/2]

bool UE::Projects::Private::TryGetNumberField ( Json::FConstObject  Object,
const TCHAR FieldName,
int32 Out 
)

◆ TryGetNumberField() [2/2]

bool UE::Projects::Private::TryGetNumberField ( Json::FConstObject  Object,
const TCHAR FieldName,
uint32 Out 
)

◆ TryGetStringArrayField() [1/2]

bool UE::Projects::Private::TryGetStringArrayField ( Json::FConstObject  Object,
const TCHAR FieldName,
TArray< FName > &  Out 
)

◆ TryGetStringArrayField() [2/2]

bool UE::Projects::Private::TryGetStringArrayField ( Json::FConstObject  Object,
const TCHAR FieldName,
TArray< FString > &  Out 
)

◆ TryGetStringArrayFieldWithDeprecatedFallback()

bool UE::Projects::Private::TryGetStringArrayFieldWithDeprecatedFallback ( Json::FConstObject  Object,
const TCHAR FieldName,
const TCHAR DeprecatedFieldName,
TArray< FString > &  OutArray 
)

◆ TryGetStringField() [1/2]

bool UE::Projects::Private::TryGetStringField ( Json::FConstObject  Object,
const TCHAR FieldName,
FString &  Out 
)

◆ TryGetStringField() [2/2]

bool UE::Projects::Private::TryGetStringField ( Json::FConstObject  Object,
const TCHAR FieldName,
FStringView Out 
)