FCachedPropertyPath

Base class for cached property paths

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FCachedPropertyPath

FDynamicPropertyPath

References

Module

PropertyPath

Header

/Engine/Source/Runtime/PropertyPath/Public/PropertyPathHelpers.h

Include

#include "PropertyPathHelpers.h"

Syntax

struct FCachedPropertyPath

Remarks

Base class for cached property paths

Constructors

Name Description

Public function

FCachedPropertyPath()

UStruct boilerplate constructor - do not use

Public function

FCachedPropertyPath

(
    const FString& Path
)

Public function

FCachedPropertyPath

(
    const FPropertyPathSegment& Segmen...
)

Public function

FCachedPropertyPath

(
    const TArray< FString >& PathSegme...
)

Functions

Name Description

Public function Const

bool

 

Equals

(
    const FString& Other
)

Compares this property path to a string

Public function Const

void *

 

GetCachedAddress()

Get the cached address for this property path, if any

Public function Const

void *

 

GetCachedContainer()

Get the cached container for this property path, for checking purposes

Public function Const

UFunction &#...

 

GetCachedFunction()

Get the cached function for this property path, if any

Public function Const

FProperty &#...

 

GetFProperty()

Returns FProperty if valid.

Public function Const

const FPrope...

 

GetLastSegment()

Get the path segment at the end of the path

Public function Const

int32

 

GetNumSegments()

Public function Const

const FPrope...

 

GetSegment

(
    int32 InSegmentIndex
)

Get the path segment at the specified index

Public function Const

bool

 

IsFullyResolved()

Check whether a path is fully resolved.

Public function Const

bool

 

IsResolved()

Check whether a path is resolved.

Public function Const

bool

 

IsValid()

Check whether this property path is non-empty

Public function

void

 

MakeFromString

(
    const FString& InPropertyPath
)

Make a new property path from a string

Public function Static

FCachedPrope...

 

MakeUnresolvedCopy

(
    const FCachedPropertyPath& ToCopy
)

Make a copy which is unresolved

Public function

void

 

RemoveFromEnd

(
    int32 InNumSegments
)

Trims this property path at the end

Public function

void

 

RemoveFromStart

(
    int32 InNumSegments
)

Trims this property path at the start

Public function Const

bool

 

Resolve

(
    UObject* InContainer
)

Resolve this property path against the specified object.

Public function Const

void

 

ResolveLeaf

(
    void* InAddress
)

Cache a resolved address for faster subsequent access

Public function Const

void

 

ResolveLeaf

(
    UFunction* InFunction
)

Cache a resolved function for faster subsequent access

Public function Const

void

 

SetCachedContainer

(
    void* InContainer
)

Set the cached container for this property path, for checking purposes

Public function Const

void

 

SetCanSafelyUsedCachedAddress

(
    bool bInCanSafelyUsedCachedAddress
)

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

Public function Const

void

 

ToEditPropertyChain

(
    FEditPropertyChain& OutPropertyCha...
)

Convert this property path to a FEditPropertyChain.

Public function Const

FPropertyCha...

 

ToPropertyChangedEvent

(
    EPropertyChangeType::Type InChangeT...
)

Convert this property path to a FPropertyChangedEvent.

Public function Const

FString

 

ToString()

Make a string representation of this property path

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FString& Other
)

Compares this property path to a string