FPropertyBindingPath | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/PropertyBindingUtils

References


Module	PropertyBindingUtils
Header	/Engine/Plugins/Runtime/PropertyBindingUtils/Source/PropertyBindingUtils/Public/PropertyBindingPath.h
Include	#include "PropertyBindingPath.h"

Syntax

USTRUCT ()  
struct FPropertyBindingPath

Remarks

Representation of a property path that can be used for property access and binding.

The engine supports many types of property paths, this implementation has these specific properties:

Allow to resolve all the indirections from a base value (object or struct) up to the leaf property
handle redirects from Core Redirect, BP classes, User Defines Structs and Property Bags

You may also take a look at: FCachedPropertyPath, TFieldPath<>, FPropertyPath.

Constructors

	Type	Name	Description
		FPropertyBindingPath ()
		FPropertyBindingPath ( const FGuid InStructID )
		FPropertyBindingPath ( const FGuid InStructID, const FName PropertyName )
		FPropertyBindingPath ( const FGuid InStructID, TConstArrayView< FPropertyBindingPathSegment > InSegments )

Functions

Type	Name	Description
void	AddPathSegment ( const FName InName, const int32 InArrayIndex, const UStruct* InInstanceType )	Adds a path segment to the path.
void	AddPathSegment ( const FPropertyBindingPathSegment& PathSegment )	Adds a path segment to the path.
bool	FromString ( const FString& InPath )	Parses path from string. The path should be in format: Foo.Bar[1].Baz
TArrayView< FPropertyBindingPathSegment >	GetMutableSegments ()
const FPropertyBindingPathSegment &	GetSegment ( const int32 Index )
TConstArrayView< FPropertyBindingPathSegment >	GetSegments ()
const FGuid &	GetStructID ()
bool	HasAnyInstancedIndirection ()
bool	IsPathEmpty ()
int32	NumSegments ()
void	Reset ()	Reset the path to empty.
bool	ResolveIndirections ( const UStruct* BaseStruct, TArray< FPropertyBindingPathIndirection >& OutIndirections, FString* OutError, bool bHandleRedirects )	Resolves the property path against base struct type.
bool	ResolveIndirectionsWithValue ( const FPropertyBindingDataView BaseValueView, TArray< FPropertyBindingPathIndirection >& OutIndirections, FString* OutError, bool bHandleRedirects )	Resolves the property path against base value.
void	SetStructID ( const FGuid NewStructID )
FString	ToString ( const int32 HighlightedSegment, const TCHAR* HighlightPrefix, const TCHAR* HighlightPostfix, const bool bOutputInstances )	Returns the property path as a one string. Highlight allows to decorate a specific segment.
bool	UpdateSegments ( const UStruct* BaseStruct, FString* OutError )	Updates property segments from base struct type.
bool	UpdateSegmentsFromValue ( const FPropertyBindingDataView BaseValueView, FString* OutError )	Updates property segments from base value.

Operators

	Type	Name	Description
	bool	operator== ( const FPropertyBindingPath& RHS )	Test if paths are equal.