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

#include <PropertyPathName.h>

Public Member Functions

int32 GetSegmentCount () const
 
FPropertyPathNameSegment GetSegment (int32 Index) const
 
void SetSegment (int32 Index, const FPropertyPathNameSegment &Segment)
 
void Push (const FPropertyPathNameSegment &Segment)
 
void Pop ()
 
void SetIndex (int32 Index)
 
bool IsEmpty () const
 
void Empty ()
 
void Reset ()
 
UE_API bool operator== (const FPropertyPathName &Path) const
 
UE_API bool operator< (const FPropertyPathName &Path) const
 
bool operator!= (const FPropertyPathName &Path) const
 
bool operator<= (const FPropertyPathName &Path) const
 
bool operator>= (const FPropertyPathName &Path) const
 
bool operator> (const FPropertyPathName &Path) const
 
UE_API void ToString (FStringBuilderBase &Out, FStringView Separator=TEXTVIEW(" -> ")) const
 
UE_API TSharedRef< FJsonValueToJsonValue () const
 

Static Public Member Functions

static UE_API bool FromJsonValue (const TSharedPtr< FJsonValue > &JsonValue, FPropertyPathName &OutPath)
 

Friends

FStringBuilderBaseoperator<< (FStringBuilderBase &Builder, const FPropertyPathName &Path)
 
UE_API friend uint32 GetTypeHash (const FPropertyPathName &Path)
 

Detailed Description

Represents the path to a property, by name, including the property type and the container index.

Sequenced containers use the index directly and associative containers (Sets and Maps) use virtual indices that skip gaps instead of logical indices.

Member Function Documentation

◆ Empty()

void UE::FPropertyPathName::Empty ( )
inline

◆ FromJsonValue()

bool UE::FPropertyPathName::FromJsonValue ( const TSharedPtr< FJsonValue > &  JsonValue,
FPropertyPathName OutPath 
)
static

◆ GetSegment()

FPropertyPathNameSegment UE::FPropertyPathName::GetSegment ( int32  Index) const
inline

Returns the segment at a valid index.

◆ GetSegmentCount()

int32 UE::FPropertyPathName::GetSegmentCount ( ) const
inline

Returns the number of segments in the path.

◆ IsEmpty()

bool UE::FPropertyPathName::IsEmpty ( ) const
inline

◆ operator!=()

bool UE::FPropertyPathName::operator!= ( const FPropertyPathName Path) const
inline

◆ operator<()

bool UE::FPropertyPathName::operator< ( const FPropertyPathName Path) const

◆ operator<=()

bool UE::FPropertyPathName::operator<= ( const FPropertyPathName Path) const
inline

◆ operator==()

bool UE::FPropertyPathName::operator== ( const FPropertyPathName Path) const

◆ operator>()

bool UE::FPropertyPathName::operator> ( const FPropertyPathName Path) const
inline

◆ operator>=()

bool UE::FPropertyPathName::operator>= ( const FPropertyPathName Path) const
inline

◆ Pop()

void UE::FPropertyPathName::Pop ( )
inline

Pops the last segment off the end of the path.

◆ Push()

void UE::FPropertyPathName::Push ( const FPropertyPathNameSegment Segment)
inline

Pushes a new segment on the end of the path.

◆ Reset()

void UE::FPropertyPathName::Reset ( )
inline

◆ SetIndex()

void UE::FPropertyPathName::SetIndex ( int32  Index)
inline

Sets the index of the last segment of the path. Ignored if the path is empty.

◆ SetSegment()

void UE::FPropertyPathName::SetSegment ( int32  Index,
const FPropertyPathNameSegment Segment 
)
inline

Sets the segment at a valid index.

◆ ToJsonValue()

TSharedRef< FJsonValue > UE::FPropertyPathName::ToJsonValue ( ) const

◆ ToString()

void UE::FPropertyPathName::ToString ( FStringBuilderBase Out,
FStringView  Separator = TEXTVIEW(" -> ") 
) const

Friends And Related Symbol Documentation

◆ GetTypeHash

UE_API friend uint32 GetTypeHash ( const FPropertyPathName Path)
friend

◆ operator<<

FStringBuilderBase & operator<< ( FStringBuilderBase Builder,
const FPropertyPathName Path 
)
friend

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