1. Epic GamesDeveloper
  3. FCachedPropertyPath

FCachedPropertyPath

Base class for cached property paths

API > API/Runtime > API/Runtime/PropertyPath

Base class for cached property paths

   
Name FCachedPropertyPath
Type struct
Header File /Engine/Source/Runtime/PropertyPath/Public/PropertyPathHelpers.h
Include Path #include "PropertyPathHelpers.h"

Syntax

USTRUCT ()  
struct FCachedPropertyPath

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  PropertyPathHelpers.h  

FCachedPropertyPath ( const TArray< FString >& PathSegments
)

   PropertyPathHelpers.h  

FCachedPropertyPath ( const FPropertyChangedChainEvent& PropertyChangedChainEvent
)

 Allows constructing a cached property path from the standard events of a PostEditChange Notify or Callback PropertyPathHelpers.h  

FCachedPropertyPath ( const FPropertyChangedEvent& PropertyChangedEvent,
const FEditPropertyChain& PropertyChain
)

   PropertyPathHelpers.h  

FCachedPropertyPath ( const FString& Path
)

   PropertyPathHelpers.h  
UStruct boilerplate constructor - do not use PropertyPathHelpers.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FCachedPropertyPath()

   PropertyPathHelpers.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCanSafelyUsedCachedAddress bool Whether this path resolves over object or dynamic array boundaries, making it unsafe for general direct cached access PropertyPathHelpers.h  
CachedAddress void * Cached read/write address for property-terminated paths PropertyPathHelpers.h  
CachedContainer void * Cached container PropertyPathHelpers.h  
CachedFunction TObjectPtr< UFunction > Cached function for function-terminated paths PropertyPathHelpers.h  
CachedLastContainerInPath void * Cached last container PropertyPathHelpers.h  
CachedLastContainerInPathIndex int32 Index of last container property in path, INDEX_NONE if last container is not in path PropertyPathHelpers.h  
Segments TArray< FPropertyPathSegment > Path segments for this path PropertyPathHelpers.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Equals ( const FString& Other
) const

 Compares this property path to a string PropertyPathHelpers.h  

void * GetCachedAddress()

 Get the cached address for this property path, if any PropertyPathHelpers.h  

void * GetCachedContainer()

 Get the cached container for this property path, for checking purposes PropertyPathHelpers.h  

UFunction * GetCachedFunction()

 Get the cached function for this property path, if any PropertyPathHelpers.h  

void * GetCachedLastContainerInPath()

 Get cached last container property in path PropertyPathHelpers.h  

int32 GetCachedLastContainerInPathIndex()

 Get cached index of last container property in path, INDEX_NONE if last container is not in path PropertyPathHelpers.h  

FProperty * GetFProperty()

 Returns FProperty if valid. This can be UFunction PropertyPathHelpers.h  

const FPropertyPathSegment & GetLastSegment()

 Get the path segment at the end of the path PropertyPathHelpers.h  

int32 GetNumSegments()

   PropertyPathHelpers.h  

const FPropertyPathSegment & GetSegment ( int32 InSegmentIndex
) const

 Get the path segment at the specified index PropertyPathHelpers.h  

bool IsFullyResolved ()

 Check whether a path is fully resolved. PropertyPathHelpers.h  

bool IsResolved ()

 Check whether a path is resolved. PropertyPathHelpers.h  

bool IsValid()

 Check whether this property path is non-empty PropertyPathHelpers.h  

void MakeFromChangeEvent ( const FPropertyChangedChainEvent& PropertyChangedChainEvent
)

 Make a new property path from the chain of properties that come standard in PostEditPropertyChain events PropertyPathHelpers.h  

void MakeFromChangeEvent ( const FPropertyChangedEvent& PropertyChangedEvent,
const FEditPropertyChain& PropertyChain
)

   PropertyPathHelpers.h  

void MakeFromString ( const FString& InPropertyPath
)

 Make a new property path from a string PropertyPathHelpers.h  

FCachedPropertyPath MakeParentPath()

 Make a copy without the last segment, if the path is resolved, the new path is also resolved. PropertyPathHelpers.h  

void RemoveFromEnd ( int32 InNumSegments
)

 Trims this property path at the end PropertyPathHelpers.h  

void RemoveFromStart ( int32 InNumSegments
)

 Trims this property path at the start PropertyPathHelpers.h  

bool Resolve ( UObject* InContainer
) const

 Resolve this property path against the specified object. PropertyPathHelpers.h  

void ResolveLeaf ( void* InAddress
) const

 Cache a resolved address for faster subsequent access PropertyPathHelpers.h  

void ResolveLeaf ( UFunction* InFunction
) const

 Cache a resolved function for faster subsequent access PropertyPathHelpers.h  

void SetCachedContainer ( void* InContainer
) const

 Set the cached container for this property path, for checking purposes PropertyPathHelpers.h  

void SetCachedLastContainer ( void* InContainer,
int32 InIndex
) const

 Update cached last container property in path & correspondng index, invalidates 'bCanSafelyUsedCachedAddress' PropertyPathHelpers.h  

void SetCanSafelyUsedCachedAddress ( bool bInCanSafelyUsedCachedAddress
) const

 Set whether this path resolves over object or dynamic array boundaries, making it unsafe for general direct cached access PropertyPathHelpers.h  

void ToEditPropertyChain ( FEditPropertyChain& OutPropertyChain
) const

 Convert this property path to a FEditPropertyChain. Note that the path must be resolved. PropertyPathHelpers.h  

FPropertyChangedEvent ToPropertyChangedEvent ( EPropertyChangeType::Type InChangeType
) const

 Convert this property path to a FPropertyChangedEvent. Note that the path must be resolved. PropertyPathHelpers.h  

FString ToString()

 Make a string representation of this property path PropertyPathHelpers.h  

Static

Name Remarks Include Path Unreal Specifiers

static FCachedPropertyPath MakeUnresolvedCopy ( const FCachedPropertyPath& ToCopy
)

 Make a copy which is unresolved PropertyPathHelpers.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FString& Other
) const

 Compares this property path to a string PropertyPathHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page