UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FPropertyLocalizationDataGatherer Class Reference

#include <PropertyLocalizationDataGathering.h>

Classes

struct  FGatherableFieldsForType
 

Public Types

typedef TFunction< void(const UObject *, FPropertyLocalizationDataGatherer &, const EPropertyLocalizationGathererTextFlags)> FLocalizationDataObjectGatheringCallback
 
typedef TMap< const UClass *, FLocalizationDataObjectGatheringCallbackFLocalizationDataObjectGatheringCallbackMap
 
typedef TFunction< void(const FString &, const UScriptStruct *, const void *, const void *, FPropertyLocalizationDataGatherer &, const EPropertyLocalizationGathererTextFlags)> FLocalizationDataStructGatheringCallback
 
typedef TMap< const UScriptStruct *, FLocalizationDataStructGatheringCallbackFLocalizationDataStructGatheringCallbackMap
 

Public Member Functions

COREUOBJECT_API FPropertyLocalizationDataGatherer (TArray< FGatherableTextData > &InOutGatherableTextDataArray, const UPackage *const InPackage, EPropertyLocalizationGathererResultFlags &OutResultFlags)
 
 FPropertyLocalizationDataGatherer (const FPropertyLocalizationDataGatherer &)=delete
 
FPropertyLocalizationDataGathereroperator= (const FPropertyLocalizationDataGatherer &)=delete
 
COREUOBJECT_API void GatherLocalizationDataFromObjectWithCallbacks (const UObject *Object, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API void GatherLocalizationDataFromObject (const UObject *Object, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API void GatherLocalizationDataFromObjectFields (const FString &PathToParent, const UObject *Object, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API void GatherLocalizationDataFromStructWithCallbacks (const FString &PathToParent, const UScriptStruct *Struct, const void *StructData, const void *DefaultStructData, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API void GatherLocalizationDataFromStruct (const FString &PathToParent, const UScriptStruct *Struct, const void *StructData, const void *DefaultStructData, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API void GatherLocalizationDataFromStructFields (const FString &PathToParent, const UStruct *Struct, const void *StructData, const void *DefaultStructData, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API void GatherLocalizationDataFromChildTextProperties (const FString &PathToParent, const FProperty *const Property, const void *const ValueAddress, const void *const DefaultValueAddress, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API void GatherTextInstance (const FText &Text, const FString &Description, const bool bIsEditorOnly)
 
COREUOBJECT_API void GatherScriptBytecode (const FString &PathToScript, const TArray< uint8 > &ScriptData, const bool bIsEditorOnly)
 
COREUOBJECT_API bool IsDefaultTextInstance (const FText &Text) const
 
COREUOBJECT_API void MarkDefaultTextInstance (const FText &Text)
 
COREUOBJECT_API bool ShouldProcessObject (const UObject *Object, const EPropertyLocalizationGathererTextFlags GatherTextFlags) const
 
COREUOBJECT_API void MarkObjectProcessed (const UObject *Object, const EPropertyLocalizationGathererTextFlags GatherTextFlags)
 
COREUOBJECT_API const FGatherableFieldsForTypeGetGatherableFieldsForType (const UStruct *InType)
 
UE_FORCEINLINE_HINT TArray< FGatherableTextData > & GetGatherableTextDataArray () const
 
UE_FORCEINLINE_HINT bool IsObjectValidForGather (const UObject *Object) const
 

Static Public Member Functions

static COREUOBJECT_API bool IsEditorOnlyProperty (const FProperty *Property)
 
static COREUOBJECT_API bool ExtractTextIdentity (const FText &Text, FString &OutNamespace, FString &OutKey, const bool bCleanNamespace)
 
static COREUOBJECT_API FLocalizationDataObjectGatheringCallbackMapGetTypeSpecificLocalizationDataObjectGatheringCallbacks ()
 
static COREUOBJECT_API FLocalizationDataStructGatheringCallbackMapGetTypeSpecificLocalizationDataStructGatheringCallbacks ()
 

Member Typedef Documentation

◆ FLocalizationDataObjectGatheringCallback

◆ FLocalizationDataObjectGatheringCallbackMap

◆ FLocalizationDataStructGatheringCallback

◆ FLocalizationDataStructGatheringCallbackMap

Constructor & Destructor Documentation

◆ FPropertyLocalizationDataGatherer() [1/2]

FPropertyLocalizationDataGatherer::FPropertyLocalizationDataGatherer ( TArray< FGatherableTextData > &  InOutGatherableTextDataArray,
const UPackage *const  InPackage,
EPropertyLocalizationGathererResultFlags OutResultFlags 
)

◆ FPropertyLocalizationDataGatherer() [2/2]

FPropertyLocalizationDataGatherer::FPropertyLocalizationDataGatherer ( const FPropertyLocalizationDataGatherer )
delete

Member Function Documentation

◆ ExtractTextIdentity()

bool FPropertyLocalizationDataGatherer::ExtractTextIdentity ( const FText Text,
FString &  OutNamespace,
FString &  OutKey,
const bool  bCleanNamespace 
)
static

◆ GatherLocalizationDataFromChildTextProperties()

void FPropertyLocalizationDataGatherer::GatherLocalizationDataFromChildTextProperties ( const FString &  PathToParent,
const FProperty *const  Property,
const void *const  ValueAddress,
const void *const  DefaultValueAddress,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ GatherLocalizationDataFromObject()

void FPropertyLocalizationDataGatherer::GatherLocalizationDataFromObject ( const UObject Object,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ GatherLocalizationDataFromObjectFields()

void FPropertyLocalizationDataGatherer::GatherLocalizationDataFromObjectFields ( const FString &  PathToParent,
const UObject Object,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ GatherLocalizationDataFromObjectWithCallbacks()

void FPropertyLocalizationDataGatherer::GatherLocalizationDataFromObjectWithCallbacks ( const UObject Object,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ GatherLocalizationDataFromStruct()

void FPropertyLocalizationDataGatherer::GatherLocalizationDataFromStruct ( const FString &  PathToParent,
const UScriptStruct Struct,
const void StructData,
const void DefaultStructData,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ GatherLocalizationDataFromStructFields()

void FPropertyLocalizationDataGatherer::GatherLocalizationDataFromStructFields ( const FString &  PathToParent,
const UStruct Struct,
const void StructData,
const void DefaultStructData,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ GatherLocalizationDataFromStructWithCallbacks()

void FPropertyLocalizationDataGatherer::GatherLocalizationDataFromStructWithCallbacks ( const FString &  PathToParent,
const UScriptStruct Struct,
const void StructData,
const void DefaultStructData,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ GatherScriptBytecode()

void FPropertyLocalizationDataGatherer::GatherScriptBytecode ( const FString &  PathToScript,
const TArray< uint8 > &  ScriptData,
const bool  bIsEditorOnly 
)

◆ GatherTextInstance()

void FPropertyLocalizationDataGatherer::GatherTextInstance ( const FText Text,
const FString &  Description,
const bool  bIsEditorOnly 
)

◆ GetGatherableFieldsForType()

const FPropertyLocalizationDataGatherer::FGatherableFieldsForType & FPropertyLocalizationDataGatherer::GetGatherableFieldsForType ( const UStruct InType)

◆ GetGatherableTextDataArray()

UE_FORCEINLINE_HINT TArray< FGatherableTextData > & FPropertyLocalizationDataGatherer::GetGatherableTextDataArray ( ) const
inline

◆ GetTypeSpecificLocalizationDataObjectGatheringCallbacks()

FPropertyLocalizationDataGatherer::FLocalizationDataObjectGatheringCallbackMap & FPropertyLocalizationDataGatherer::GetTypeSpecificLocalizationDataObjectGatheringCallbacks ( )
static

◆ GetTypeSpecificLocalizationDataStructGatheringCallbacks()

FPropertyLocalizationDataGatherer::FLocalizationDataStructGatheringCallbackMap & FPropertyLocalizationDataGatherer::GetTypeSpecificLocalizationDataStructGatheringCallbacks ( )
static

◆ IsDefaultTextInstance()

bool FPropertyLocalizationDataGatherer::IsDefaultTextInstance ( const FText Text) const

◆ IsEditorOnlyProperty()

bool FPropertyLocalizationDataGatherer::IsEditorOnlyProperty ( const FProperty Property)
static

◆ IsObjectValidForGather()

UE_FORCEINLINE_HINT bool FPropertyLocalizationDataGatherer::IsObjectValidForGather ( const UObject Object) const
inline

◆ MarkDefaultTextInstance()

void FPropertyLocalizationDataGatherer::MarkDefaultTextInstance ( const FText Text)

◆ MarkObjectProcessed()

void FPropertyLocalizationDataGatherer::MarkObjectProcessed ( const UObject Object,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
)

◆ operator=()

FPropertyLocalizationDataGatherer & FPropertyLocalizationDataGatherer::operator= ( const FPropertyLocalizationDataGatherer )
delete

◆ ShouldProcessObject()

bool FPropertyLocalizationDataGatherer::ShouldProcessObject ( const UObject Object,
const EPropertyLocalizationGathererTextFlags  GatherTextFlags 
) const

The documentation for this class was generated from the following files: