UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
PropertyVisitorHelpers Namespace Reference

Namespaces

namespace  Private
 

Functions

template<typename Type >
voidResolveVisitedPath (const Type *RootObject, void *RootData, const FPropertyVisitorPath &Path)
 
template<typename Type >
voidResolveVisitedPathInfo_Generic (Type *This, FPropertyVisitorPath &Path, void *Data, const FPropertyVisitorInfo &Info)
 
template<typename Type >
voidResolveVisitedPathInfo_Generic (Type *This, void *Data, const FPropertyVisitorInfo &Info)
 
COREUOBJECT_API EPropertyVisitorControlFlow VisitProperty (const UStruct *PropertyOwner, const FProperty *Property, FPropertyVisitorPath &Path, const FPropertyVisitorData &InData, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorPath &, const FPropertyVisitorData &)> InFunc)
 
COREUOBJECT_API EPropertyVisitorControlFlow VisitProperty (const UStruct *PropertyOwner, const FProperty *Property, FPropertyVisitorContext &Context, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorContext &)> InFunc)
 
COREUOBJECT_API FString PathToString (TArrayView< const FPropertyVisitorInfo > Path, const TCHAR *Separator=TEXT("."))
 
COREUOBJECT_API void PathToString (TArrayView< const FPropertyVisitorInfo > Path, FStringBuilderBase &Out, const TCHAR *Separator=TEXT("."))
 
COREUOBJECT_API void PathAppendString (TArrayView< const FPropertyVisitorInfo > Path, FStringBuilderBase &Out, const TCHAR *Separator=TEXT("."))
 
COREUOBJECT_API bool PathIsContainedWithin (TArrayView< const FPropertyVisitorInfo > Path, TArrayView< const FPropertyVisitorInfo > OtherPath, bool *bIsEqual=nullptr)
 
COREUOBJECT_API FArchiveSerializedPropertyChain PathToSerializedPropertyChain (TArrayView< const FPropertyVisitorInfo > Path)
 

Function Documentation

◆ PathAppendString()

void PropertyVisitorHelpers::PathAppendString ( TArrayView< const FPropertyVisitorInfo Path,
FStringBuilderBase Out,
const TCHAR Separator = TEXT(".") 
)

◆ PathIsContainedWithin()

bool PropertyVisitorHelpers::PathIsContainedWithin ( TArrayView< const FPropertyVisitorInfo Path,
TArrayView< const FPropertyVisitorInfo OtherPath,
bool bIsEqual = nullptr 
)

Is this property path contained in the specified one

Parameters
OtherPathproperty path to check if it is contained in
bIsEqualoptional parameter to know if it fully match
Returns
true if it is contained in the specified path

◆ PathToSerializedPropertyChain()

FArchiveSerializedPropertyChain PropertyVisitorHelpers::PathToSerializedPropertyChain ( TArrayView< const FPropertyVisitorInfo Path)

Convert the given path to a serialized property chain

◆ PathToString() [1/2]

FString PropertyVisitorHelpers::PathToString ( TArrayView< const FPropertyVisitorInfo Path,
const TCHAR Separator = TEXT(".") 
)

Convert the given path to a string

◆ PathToString() [2/2]

void PropertyVisitorHelpers::PathToString ( TArrayView< const FPropertyVisitorInfo Path,
FStringBuilderBase Out,
const TCHAR Separator = TEXT(".") 
)

◆ ResolveVisitedPath()

template<typename Type >
void * PropertyVisitorHelpers::ResolveVisitedPath ( const Type *  RootObject,
void RootData,
const FPropertyVisitorPath Path 
)

Given a FPropertyVisitorPath, attempt to resolve that to a valid data pointer. RootObject is required to implement ResolveVisitedPathInfo to provide the resolver logic.

◆ ResolveVisitedPathInfo_Generic() [1/2]

template<typename Type >
void * PropertyVisitorHelpers::ResolveVisitedPathInfo_Generic ( Type *  This,
FPropertyVisitorPath Path,
void Data,
const FPropertyVisitorInfo Info 
)

A generic implementation of ResolveVisitedPathInfo that uses Visit to find the property data pointer. This may be used as the ResolveVisitedPathInfo implementation for your type if it doesn't have a more optimized version.

◆ ResolveVisitedPathInfo_Generic() [2/2]

template<typename Type >
void * PropertyVisitorHelpers::ResolveVisitedPathInfo_Generic ( Type *  This,
void Data,
const FPropertyVisitorInfo Info 
)

◆ VisitProperty() [1/2]

PRAGMA_ENABLE_DEPRECATION_WARNINGS EPropertyVisitorControlFlow PropertyVisitorHelpers::VisitProperty ( const UStruct PropertyOwner,
const FProperty Property,
FPropertyVisitorContext Context,
const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorContext &)>  InFunc 
)

Visit the property from an instance.

◆ VisitProperty() [2/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS EPropertyVisitorControlFlow PropertyVisitorHelpers::VisitProperty ( const UStruct PropertyOwner,
const FProperty Property,
FPropertyVisitorPath Path,
const FPropertyVisitorData InData,
const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorPath &, const FPropertyVisitorData &)>  InFunc 
)