UE::FPropertyTypeName Class Reference

#include <PropertyTypeName.h>

Public Member Functions
	FPropertyTypeName ()=default
UE_API	FPropertyTypeName (const FProperty *Property)
bool	IsEmpty () const
UE_API FName	GetName () const
UE_API int32	GetParameterCount () const
UE_API FPropertyTypeName	GetParameter (int32 ParamIndex) const
FName	GetParameterName (int32 ParamIndex) const
void	Reset ()
UE_API bool	IsStruct (FName StructName) const
UE_API bool	IsEnum (FName EnumName) const

Friends
UE_API friend uint32	GetTypeHash (const FPropertyTypeName &TypeName)
UE_API friend void	AppendHash (FBlake3 &Builder, const FPropertyTypeName &TypeName)
UE_API friend bool	operator== (const FPropertyTypeName &Lhs, const FPropertyTypeName &Rhs)
UE_API friend bool	operator< (const FPropertyTypeName &Lhs, const FPropertyTypeName &Rhs)
UE_API friend FArchive &	operator<< (FArchive &Ar, FPropertyTypeName &TypeName)
UE_API friend void	operator<< (FStructuredArchiveSlot Slot, FPropertyTypeName &TypeName)
UE_API friend FStringBuilderBase &	operator<< (FStringBuilderBase &Builder, const FPropertyTypeName &TypeName)

Detailed Description

Represents the type name of a property, including any containers and underlying types.

The path name for a type is represented as the object name with the outer chain as type parameters.

• /Script/CoreUObject.Outer0:Outer1.Outer2.StructName -> StructName(/Script/CoreUObject,Outer0,Outer1,Outer2)

Examples:

• int32 -> IntProperty
• TArray<int32> -> ArrayProperty(IntProperty)
• TArray<FStructType> -> ArrayProperty(StructProperty(StructType(/Script/Module),e21f566f-7153-433a-959d-bfb3abed17e2))
• TMap<FKeyStruct, EByteEnum> -> MapProperty(StructProperty(KeyStruct(/Script/Module)),EnumProperty(ByteEnum(/Script/Module),ByteProperty))

Incomplete property types created from sources with incomplete type information. Consumers must support this.

• ArrayProperty(StructProperty)
• MapProperty(EnumProperty,StructProperty)

Constructor & Destructor Documentation

FPropertyTypeName() [1/2]

UE::FPropertyTypeName::FPropertyTypeName ( )

default

FPropertyTypeName() [2/2]

UE::FPropertyTypeName::FPropertyTypeName ( const FProperty *  Property )

explicit

Member Function Documentation

GetName()

FName UE::FPropertyTypeName::GetName

(

)

const

Returns the type at the root of this property type name.

Example: MapProperty(StructProperty(KeyStruct),EnumProperty(ByteEnum,ByteProperty))

• GetName() -> MapProperty

GetParameter()

FPropertyTypeName UE::FPropertyTypeName::GetParameter

(

int32

ParamIndex

)

const

Returns the indexed parameter under the root of this property type name.

An out-of-bounds index will return an empty type name.

Example: MapProperty(StructProperty(KeyStruct),EnumProperty(ByteEnum,ByteProperty))

• GetParameter(0) -> StructProperty(KeyStruct)
• GetParameter(1) -> EnumProperty(ByteEnum,ByteProperty)

GetParameterCount()

int32 UE::FPropertyTypeName::GetParameterCount

(

)

const

Returns the number of type parameters under the root of this property type name.

Example: MapProperty(StructProperty(KeyStruct),EnumProperty(ByteEnum,ByteProperty))

• GetParameterCount() -> 2

GetParameterName()

FName UE::FPropertyTypeName::GetParameterName ( int32  ParamIndex ) const

inline

Returns the indexed parameter type name under the root of this property type name.

An out-of-bounds index will return a name of None.

Example: MapProperty(StructProperty(KeyStruct),EnumProperty(ByteEnum,ByteProperty))

• GetParameterName(0) -> StructProperty
• GetParameterName(1) -> EnumProperty

IsEmpty()

bool UE::FPropertyTypeName::IsEmpty ( ) const

inline

IsEnum()

bool UE::FPropertyTypeName::IsEnum

(

FName

EnumName

)

const

Returns true if this is EnumProperty or ByteProperty with a first parameter of EnumName.

IsStruct()

bool UE::FPropertyTypeName::IsStruct

(

FName

StructName

)

const

Returns true if this is StructProperty with a first parameter of StructName.

Reset()

void UE::FPropertyTypeName::Reset ( )

inline

Resets this to an empty type name.

Friends And Related Symbol Documentation

AppendHash

UE_API friend void AppendHash ( FBlake3 &  Builder, const FPropertyTypeName &  TypeName  )

friend

GetTypeHash

UE_API friend uint32 GetTypeHash ( const FPropertyTypeName &  TypeName )

friend

operator<

UE_API friend bool operator< ( const FPropertyTypeName &  Lhs, const FPropertyTypeName &  Rhs  )

friend

operator<< [1/3]

UE_API friend FArchive & operator<< ( FArchive &  Ar, FPropertyTypeName &  TypeName  )

friend

operator<< [2/3]

UE_API friend FStringBuilderBase & operator<< ( FStringBuilderBase &  Builder, const FPropertyTypeName &  TypeName  )

friend

operator<< [3/3]

UE_API friend void operator<< ( FStructuredArchiveSlot  Slot, FPropertyTypeName &  TypeName  )

friend

operator==

UE_API friend bool operator== ( const FPropertyTypeName &  Lhs, const FPropertyTypeName &  Rhs  )

friend

---

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

• Engine/Source/Runtime/CoreUObject/Public/UObject/PropertyTypeName.h
• Engine/Source/Runtime/CoreUObject/Private/UObject/PropertyTypeName.cpp