UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | Friends | List of all members
FPropertyTag Struct Reference

#include <PropertyTag.h>

Public Member Functions

 UE_DEPRECATED (5.4, "Prop has been deprecated. Use GetProperty()/SetProperty().") FProperty *Prop
 
 UE_DEPRECATED (5.4, "StructName has been deprecated and replaced by GetType(). Use GetType().IsStruct(StructName) to test, otherwise if Type is StructProperty then StructName is GetType().GetParameterName(0).") FName StructName
 
 UE_DEPRECATED (5.4, "EnumName has been deprecated and replaced by GetType(). Use GetType().IsEnum(EnumName) to test, otherwise if Type is EnumProperty or ByteProperty then EnumName is GetType().GetParameterName(0).") FName EnumName
 
 UE_DEPRECATED (5.4, "InnerName has been deprecated and replaced by GetType(). If Type is ArrayProperty/SetProperty/MapProperty/OptionalProperty then InnerType is GetType().GetParameterName(0).") FName InnerType
 
 UE_DEPRECATED (5.4, "ValueName has been deprecated and replaced by GetType(). If Type is MapProperty then ValueType is GetType().GetParameterName(1).") FName ValueType
 
 UE_DEPRECATED (5.4, "StructGuid has been deprecated and replaced by GetType(). If Type is StructProperty then StructGuid is GetType().GetParameterName(1).") FGuid StructGuid
 
 FPropertyTag ()
 
UE_INTERNAL COREUOBJECT_API FPropertyTag (FProperty *Property, int32 InIndex, uint8 *Value)
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS FPropertyTag (FPropertyTag &&)=default
 
 FPropertyTag (const FPropertyTag &)=default
 
FPropertyTag & operator= (FPropertyTag &&)=default
 
FPropertyTag & operator= (const FPropertyTag &)=default
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS FProperty * GetProperty () const
 
void SetProperty (FProperty *Property)
 
void SetPropertyGuid (const FGuid &InPropertyGuid)
 
UE::FPropertyTypeName GetType () const
 
void SetType (UE::FPropertyTypeName TypeName)
 
void SerializeTaggedProperty (FArchive &Ar, FProperty *Property, uint8 *Value, const uint8 *Defaults) const
 
UE_INTERNAL COREUOBJECT_API void SerializeTaggedProperty (FStructuredArchive::FSlot Slot, FProperty *Property, uint8 *Value, const uint8 *Defaults) const
 

Public Attributes

FName Type
 
FName Name
 
int32 Size = 0
 
int32 ArrayIndex = INDEX_NONE
 
int64 SizeOffset = INDEX_NONE
 
FGuid PropertyGuid
 
uint8 HasPropertyGuid = 0
 
uint8 BoolVal = 0
 
EPropertyTagSerializeType SerializeType = EPropertyTagSerializeType::Unknown
 
EOverriddenPropertyOperation OverrideOperation
 
bool bExperimentalOverridableLogic = false
 

Friends

FArchive & operator<< (FArchive &Ar, FPropertyTag &Tag)
 
void operator<< (FStructuredArchive::FSlot Slot, FPropertyTag &Tag)
 
void LoadPropertyTagNoFullType (FStructuredArchive::FSlot Slot, FPropertyTag &Tag)
 
void SerializePropertyTagAsText (FStructuredArchive::FSlot Slot, FPropertyTag &Tag)
 

Detailed Description

A tag describing a class property, to aid in serialization.

Constructor & Destructor Documentation

◆ FPropertyTag() [1/4]

FPropertyTag::FPropertyTag ( )

◆ FPropertyTag() [2/4]

FPropertyTag::FPropertyTag ( FProperty *  Property,
int32  InIndex,
uint8 *  Value 
)

◆ FPropertyTag() [3/4]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FPropertyTag::FPropertyTag ( FPropertyTag &&  )
default

◆ FPropertyTag() [4/4]

FPropertyTag::FPropertyTag ( const FPropertyTag &  )
default

Member Function Documentation

◆ GetProperty()

PRAGMA_ENABLE_DEPRECATION_WARNINGS FProperty * FPropertyTag::GetProperty ( ) const
inline

◆ GetType()

UE::FPropertyTypeName FPropertyTag::GetType ( ) const
inline

◆ operator=() [1/2]

FPropertyTag & FPropertyTag::operator= ( const FPropertyTag &  )
default

◆ operator=() [2/2]

FPropertyTag & FPropertyTag::operator= ( FPropertyTag &&  )
default

◆ SerializeTaggedProperty() [1/2]

void FPropertyTag::SerializeTaggedProperty ( FArchive &  Ar,
FProperty *  Property,
uint8 *  Value,
const uint8 *  Defaults 
) const

◆ SerializeTaggedProperty() [2/2]

void FPropertyTag::SerializeTaggedProperty ( FStructuredArchive::FSlot  Slot,
FProperty *  Property,
uint8 *  Value,
const uint8 *  Defaults 
) const

◆ SetProperty()

void FPropertyTag::SetProperty ( FProperty *  Property)

◆ SetPropertyGuid()

void FPropertyTag::SetPropertyGuid ( const FGuid &  InPropertyGuid)

◆ SetType()

void FPropertyTag::SetType ( UE::FPropertyTypeName  TypeName)

◆ UE_DEPRECATED() [1/6]

FPropertyTag::UE_DEPRECATED ( 5.  4,
"EnumName has been deprecated and replaced by GetType(). Use GetType().IsEnum(EnumName) to  test,
otherwise if Type is EnumProperty or ByteProperty then EnumName is GetType().GetParameterName(0)."   
)

◆ UE_DEPRECATED() [2/6]

FPropertyTag::UE_DEPRECATED ( 5.  4,
"InnerName has been deprecated and replaced by GetType(). If Type is ArrayProperty/SetProperty/MapProperty/OptionalProperty then InnerType is GetType().GetParameterName(0)."   
)

◆ UE_DEPRECATED() [3/6]

FPropertyTag::UE_DEPRECATED ( 5.  4,
"Prop has been deprecated. Use GetProperty()/SetProperty()."   
)

◆ UE_DEPRECATED() [4/6]

FPropertyTag::UE_DEPRECATED ( 5.  4,
"StructGuid has been deprecated and replaced by GetType(). If Type is StructProperty then StructGuid is GetType().GetParameterName(1)."   
)

◆ UE_DEPRECATED() [5/6]

FPropertyTag::UE_DEPRECATED ( 5.  4,
"StructName has been deprecated and replaced by GetType(). Use GetType().IsStruct(StructName) to  test,
otherwise if Type is StructProperty then StructName is GetType().GetParameterName(0)."   
)

◆ UE_DEPRECATED() [6/6]

FPropertyTag::UE_DEPRECATED ( 5.  4,
"ValueName has been deprecated and replaced by GetType(). If Type is MapProperty then ValueType is GetType().GetParameterName(1)."   
)

Friends And Related Symbol Documentation

◆ LoadPropertyTagNoFullType

void LoadPropertyTagNoFullType ( FStructuredArchive::FSlot  Slot,
FPropertyTag &  Tag 
)
friend

◆ operator<< [1/2]

FArchive & operator<< ( FArchive &  Ar,
FPropertyTag &  Tag 
)
friend

◆ operator<< [2/2]

void operator<< ( FStructuredArchive::FSlot  Slot,
FPropertyTag &  Tag 
)
friend

◆ SerializePropertyTagAsText

void SerializePropertyTagAsText ( FStructuredArchive::FSlot  Slot,
FPropertyTag &  Tag 
)
friend

Member Data Documentation

◆ ArrayIndex

int32 FPropertyTag::ArrayIndex = INDEX_NONE

◆ bExperimentalOverridableLogic

bool FPropertyTag::bExperimentalOverridableLogic = false

◆ BoolVal

uint8 FPropertyTag::BoolVal = 0

◆ HasPropertyGuid

uint8 FPropertyTag::HasPropertyGuid = 0

◆ Name

FName FPropertyTag::Name

◆ OverrideOperation

EOverriddenPropertyOperation FPropertyTag::OverrideOperation

◆ PropertyGuid

FGuid FPropertyTag::PropertyGuid

◆ SerializeType

EPropertyTagSerializeType FPropertyTag::SerializeType = EPropertyTagSerializeType::Unknown

◆ Size

int32 FPropertyTag::Size = 0

◆ SizeOffset

int64 FPropertyTag::SizeOffset = INDEX_NONE

◆ Type

FName FPropertyTag::Type
The documentation for this struct was generated from the following files: