UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TFieldPath< PropertyType > Struct Template Reference

#include <FieldPath.h>

+ Inheritance diagram for TFieldPath< PropertyType >:

Public Member Functions

 TFieldPath ()
 
 TFieldPath (const TFieldPath &Other)
 
TFieldPathoperator= (const TFieldPath &Other)
 
UE_FORCEINLINE_HINT TFieldPath (TYPE_OF_NULLPTR)
 
 TFieldPath (const TCHAR *InPath)
 
template<typename OtherPropertyType >
 TFieldPath (OtherPropertyType *InProperty, EDummy1=Dummy1)
 
template<typename OtherPropertyType >
 TFieldPath (const TFieldPath< OtherPropertyType > &Other)
 
template<typename OtherPropertyType >
void operator= (OtherPropertyType *InProperty)
 
template<typename OtherPropertyType >
void operator= (const TFieldPath< OtherPropertyType > &Other)
 
UE_FORCEINLINE_HINT PropertyType * Get (UStruct *InCurrentStruct=nullptr) const
 
PropertyType * ResolveWithRenamedStructPackage (UStruct *InCurrentStruct)
 
UE_FORCEINLINE_HINT PropertyType * operator* () const
 
UE_FORCEINLINE_HINT PropertyType * operator-> () const
 
- Public Member Functions inherited from FFieldPath
 FFieldPath ()=default
 
 FFieldPath (FField *InField)
 
COREUOBJECT_API void Generate (FField *InField)
 
COREUOBJECT_API void Generate (const TCHAR *InFieldPathString)
 
COREUOBJECT_API FFieldTryToResolvePath (UStruct *InCurrentStruct, EPathResolveType InResolveType=FFieldPath::UseStructIfOuterNotFound) const
 
void ResolveField (FFieldClass *ExpectedClass=FField::StaticClass(), UStruct *InCurrentStruct=nullptr, EPathResolveType InResolveType=FFieldPath::UseStructIfOuterNotFound) const
 
FFieldGetTyped (FFieldClass *ExpectedType, UStruct *InCurrentStruct=nullptr) const
 
bool IsPathToFieldEmpty () const
 
bool IsStale () const
 
void Reset ()
 
UE_FORCEINLINE_HINT bool operator== (const FFieldPath &InOther) const
 
UE_FORCEINLINE_HINT bool operator!= (const FFieldPath &InOther) const
 
COREUOBJECT_API FString ToString () const
 

Additional Inherited Members

- Protected Types inherited from FFieldPath
enum  EPathResolveType { UseStructIfOuterNotFound = 0 , UseStructAlways = 1 }
 
- Protected Member Functions inherited from FFieldPath
bool NeedsResolving () const
 
void ClearCachedField () const
 
- Protected Attributes inherited from FFieldPath
FFieldResolvedField = nullptr
 
TWeakObjectPtr< UStructResolvedOwner
 
TArray< FNamePath
 

Constructor & Destructor Documentation

◆ TFieldPath() [1/6]

template<class PropertyType >
TFieldPath< PropertyType >::TFieldPath ( )
inline

◆ TFieldPath() [2/6]

template<class PropertyType >
TFieldPath< PropertyType >::TFieldPath ( const TFieldPath< PropertyType > &  Other)
inline

◆ TFieldPath() [3/6]

template<class PropertyType >
UE_FORCEINLINE_HINT TFieldPath< PropertyType >::TFieldPath ( TYPE_OF_NULLPTR  )
inline

Construct from a null pointer

◆ TFieldPath() [4/6]

template<class PropertyType >
TFieldPath< PropertyType >::TFieldPath ( const TCHAR InPath)
inline

Construct from a string

◆ TFieldPath() [5/6]

template<class PropertyType >
TFieldPath< PropertyType >::TFieldPath ( OtherPropertyType InProperty,
EDummy1  = Dummy1 
)
inline

Construct from an object pointer

Parameters
Objectobject to create a weak pointer to

◆ TFieldPath() [6/6]

template<class PropertyType >
TFieldPath< PropertyType >::TFieldPath ( const TFieldPath< OtherPropertyType > &  Other)
inline

Construct from another weak pointer of another type, intended for derived-to-base conversions

Parameters
Otherweak pointer to copy from

Member Function Documentation

◆ Get()

template<class PropertyType >
UE_FORCEINLINE_HINT PropertyType * TFieldPath< PropertyType >::Get ( UStruct InCurrentStruct = nullptr) const
inline

Gets the field represented by this TFieldPath

Parameters
InCurrentStructStruct that's trying to resolve this field path
Returns
Field represented by this FFieldPath or null if it couldn't be resolved

◆ operator*()

template<class PropertyType >
UE_FORCEINLINE_HINT PropertyType * TFieldPath< PropertyType >::operator* ( ) const
inline

Dereference the weak pointer

◆ operator->()

template<class PropertyType >
UE_FORCEINLINE_HINT PropertyType * TFieldPath< PropertyType >::operator-> ( ) const
inline

Dereference the weak pointer

◆ operator=() [1/3]

template<class PropertyType >
TFieldPath & TFieldPath< PropertyType >::operator= ( const TFieldPath< PropertyType > &  Other)
inline

◆ operator=() [2/3]

template<class PropertyType >
void TFieldPath< PropertyType >::operator= ( const TFieldPath< OtherPropertyType > &  Other)
inline

Assign from another weak pointer, intended for derived-to-base conversions

Parameters
Otherweak pointer to copy from

◆ operator=() [3/3]

template<class PropertyType >
void TFieldPath< PropertyType >::operator= ( OtherPropertyType InProperty)
inline

Copy from an object pointer

Parameters
Objectobject to create a weak pointer to

◆ ResolveWithRenamedStructPackage()

template<class PropertyType >
PropertyType * TFieldPath< PropertyType >::ResolveWithRenamedStructPackage ( UStruct InCurrentStruct)
inline

The documentation for this struct was generated from the following file: