1. Epic GamesDeveloper
  3. FField

FField

Base class of reflection data objects.

API > API/Runtime > API/Runtime/CoreUObject

Base class of reflection data objects.

   
Name FField
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/Field.h
Include Path #include "UObject/Field.h"

Syntax

class FField

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FField ( FFieldVariant InOwner,
const FName& InName,
EObjectFlags InObjectFlags
)

   UObject/Field.h  

FField ( EInternal InInernal,
FFieldClass* InClass
)

 Constructors. UObject/Field.h  

FField ( UField* InField
)

   UObject/Field.h  

FField ( FField&&
)

   UObject/Field.h  

FField ( const FField&
)

   UObject/Field.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FField()

   UObject/Field.h  

Typedefs

Name Type Remarks Include Path
BaseFieldClass FField   UObject/Field.h
FieldTypeClass FFieldClass   UObject/Field.h
FLinkedListBuilder TLinkedListBuilder< FField >   UObject/Field.h
FOnConvertCustomUFieldToFField TMulticastDelegate_ThreeParams< void, FFieldClass *, UField *, FField *& >   UObject/Field.h
Super FField   UObject/Field.h
ThisClass FField   UObject/Field.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FlagsPrivate EObjectFlags Object flags UObject/Field.h  
NamePrivate FName Name of this field UObject/Field.h  
Next FField * Next Field in the linked list UObject/Field.h  
Owner FFieldVariant Owner of this field UObject/Field.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ClassPrivate FFieldClass * Pointer to the class object representing the type of this FField UObject/Field.h  
MetaDataMap TMap< FName, FString > * Editor-only meta data map UObject/Field.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddCppProperty ( FProperty* Property
)

   UObject/Field.h  

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   UObject/Field.h  

void AppendMetaData ( const TMap< FName, FString >& MetaDataMapToAppend
)

 Append the given metadata to this field UObject/Field.h  

void AppendName ( FString& ResultString
) const

   UObject/Field.h  

virtual void BeginDestroy()

   UObject/Field.h  

virtual void Bind()

   UObject/Field.h  

void ClearFlags ( EObjectFlags NewFlags
)

   UObject/Field.h  

const FString * FindMetaData ( const FName& Key
) const

   UObject/Field.h  

const FString * FindMetaData ( const TCHAR* Key
) const

 Find the metadata value associated with the key UObject/Field.h  

FString GetAuthoredName ()

 Returns a human readable string that was assigned to this field at creation. UObject/Field.h  

bool GetBoolMetaData ( const FName& Key
) const

   UObject/Field.h  

bool GetBoolMetaData ( const TCHAR* Key
) const

 Find the metadata value associated with the key and return bool UObject/Field.h  

uint64 GetCastFlags()

   UObject/Field.h  

FFieldClass * GetClass()

   UObject/Field.h  

UClass * GetClassMetaData ( const FName& Key
) const

   UObject/Field.h  

UClass * GetClassMetaData ( const TCHAR* Key
) const

 Find the metadata value associated with the key and return Class UObject/Field.h  

FText GetDisplayNameText()

 Finds the localized display name or native display name as a fallback. UObject/Field.h  

double GetDoubleMetaData ( const FName& Key
) const

   UObject/Field.h  

double GetDoubleMetaData ( const TCHAR* Key
) const

 Find the metadata value associated with the key and return double UObject/Field.h  

virtual SIZE_T GetFieldSize()

   UObject/Field.h  

EObjectFlags GetFlags()

 Retrieve the object flags directly UObject/Field.h  

float GetFloatMetaData ( const TCHAR* Key
) const

 Find the metadata value associated with the key and return float UObject/Field.h  

float GetFloatMetaData ( const FName& Key
) const

   UObject/Field.h  

FName GetFName()

   UObject/Field.h  

FString GetFullGroupName ( bool bStartWithOuter
) const

 Walks up the chain of packages until it reaches the top level, which it ignores. UObject/Field.h  

FString GetFullName()

   UObject/Field.h  

virtual FField * GetInnerFieldByName ( const FName& InName
)

 Returns an inner field by name if the field has any UObject/Field.h  

virtual void GetInnerFields ( TArray< FField* >& OutFields
)

 Fills the provided array with all inner fields this field owns (recursively) UObject/Field.h  

int32 GetIntMetaData ( const FName& Key
) const

   UObject/Field.h  

int32 GetIntMetaData ( const TCHAR* Key
) const

 Find the metadata value associated with the key and return int32 UObject/Field.h  

FLinkerLoad * GetLinker()

   UObject/Field.h  

const FString & GetMetaData ( const TCHAR* Key
) const

 Find the metadata value associated with the key UObject/Field.h  

const FString & GetMetaData ( const FName& Key
) const

   UObject/Field.h  

const TMap< FName, FString > * GetMetaDataMap()

 Gets all metadata associated with this field UObject/Field.h  

const FText GetMetaDataText ( const FName& MetaDataKey,
const FTextKey LocalizationNamespace,
const FTextKey LocalizationKey
) const

   UObject/Field.h  

const FText GetMetaDataText ( const TCHAR* MetaDataKey,
const FTextKey LocalizationNamespace,
const FTextKey LocalizationKey
) const

 Find the metadata value associated with the key and localization namespace and key UObject/Field.h  

void GetName ( FString& OutName
) const

   UObject/Field.h  

FString GetName ()

   UObject/Field.h  

UPackage * GetOutermost()

 Goes up the outer chain to look for the outermost package UObject/Field.h  

T * GetOwner()

   UObject/Field.h  

T * GetOwnerChecked()

   UObject/Field.h  

UClass * GetOwnerClass()

 Goes up the outer chain to look for a UClass UObject/Field.h  

UStruct * GetOwnerStruct()

 Goes up the outer chain to look for a UStruct UObject/Field.h  

UField * GetOwnerUField()

 Goes up the outer chain to look for a UField UObject/Field.h  
Goes up the outer chain to look for a UObject. UObject/Field.h  

FFieldVariant GetOwnerVariant()

 Gets the owner container for this field UObject/Field.h  

void GetPathName ( const UObject* StopOuter,
FStringBuilderBase& ResultString
) const

   UObject/Field.h  

FString GetPathName ( const UObject* StopOuter
) const

   UObject/Field.h  

virtual void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   UObject/Field.h  

FText GetToolTipText ( bool bShortTooltip
) const

 Finds the localized tooltip or native tooltip as a fallback. UObject/Field.h  

T * GetTypedOwner ()

   UObject/Field.h  

UObject * GetTypedOwner ( UClass* Target
) const

 Goes up the outer chain to look for the outer of the specified type UObject/Field.h  

FField * GetTypedOwner ( FFieldClass* Target
) const

 Goes up the outer chain to look for the outer of the specified type UObject/Field.h  

bool HasAllCastFlags ( const uint64 InCastFlags
) const

   UObject/Field.h  

bool HasAllFlags ( EObjectFlags FlagsToCheck
) const

 Used to safely check whether all of the passed in flags are set. UObject/Field.h  

bool HasAnyCastFlags ( const uint64 InCastFlags
) const

   UObject/Field.h  

bool HasAnyFlags ( EObjectFlags FlagsToCheck
) const

 Used to safely check whether any of the passed in flags are set. UObject/Field.h  

bool HasMetaData ( const FName& Key
) const

   UObject/Field.h  

bool HasMetaData ( const TCHAR* Key
) const

 Determines if the property has any metadata associated with the key UObject/Field.h  
Internal function for quickly getting the owner of this object as UObject. UObject/Field.h  

bool IsA ( const FFieldClass* FieldType
) const

   UObject/Field.h  

bool IsA ()

   UObject/Field.h  

bool IsIn ( const FField* InOwner
) const

   UObject/Field.h  

bool IsIn ( const UObject* InOwner
) const

   UObject/Field.h  

bool IsNative()

   UObject/Field.h  

bool IsRooted()

   UObject/Field.h  

bool IsValidLowLevel()

   UObject/Field.h  

virtual void PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field UObject/Field.h  

virtual void PostLoad()

   UObject/Field.h  

void RemoveMetaData ( const TCHAR* Key
)

 Clear any metadata associated with the key UObject/Field.h  

void RemoveMetaData ( const FName& Key
)

   UObject/Field.h  

void Rename ( const FName& NewName
)

   UObject/Field.h  

virtual void Serialize ( FArchive& Ar
)

 Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties. UObject/Field.h  

void SetFlags ( EObjectFlags NewFlags
)

   UObject/Field.h  

void SetMetaData ( const TCHAR* Key,
FString&& InValue
)

   UObject/Field.h  

void SetMetaData ( const TCHAR* Key,
const TCHAR* InValue
)

 Sets the metadata value associated with the key UObject/Field.h  

void SetMetaData ( const FName& Key,
const TCHAR* InValue
)

   UObject/Field.h  

void SetMetaData ( const FName& Key,
FString&& InValue
)

   UObject/Field.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SetFlagsTo ( EObjectFlags NewFlags
)

 Set the object flags directly UObject/Field.h  

Static

Name Remarks Include Path Unreal Specifiers

static FField * Construct ( const FName& FieldTypeName,
const FFieldVariant& InOwner,
const FName& InName,
EObjectFlags InFlags
)

 Constructs a new field given the name of its class UObject/Field.h  

static FField * Construct ( const FFieldVariant& InOwner,
const FName& InName,
EObjectFlags InFlags
)

 Constructs a new field given its class UObject/Field.h  

static void CopyMetaData ( const FField* InSourceField,
FField* InDestField
)

 Copies all metadata from Source Field to Dest Field UObject/Field.h  

static FField * CreateFromUField ( UField* InField
)

 Creates a new FField from existing UField UObject/Field.h  

static FField * Duplicate ( const FField* InField,
FFieldVariant DestOwner,
const FName DestName,
EObjectFlags FlagMask,
EInternalObjectFlags InternalFlagsMask
)

 Duplicates an FField UObject/Field.h  

static FName GenerateFFieldName ( FFieldVariant InOwner,
FFieldClass* InClass
)

 Generates a name for a Field of a given type. Each generated name is unique in the current runtime UObject/Field.h  

static FOnConvertCustomUFieldToFField & GetConvertCustomUFieldToFFieldDelegate()

 Gets a delegate to convert custom UField types to FFields UObject/Field.h  

static FFieldClass * StaticClass()

   UObject/Field.h  

static uint64 StaticClassCastFlags()

   UObject/Field.h  

static uint64 StaticClassCastFlagsPrivate()

   UObject/Field.h  

static FField * TryConstruct ( const FName& FieldTypeName,
const FFieldVariant& InOwner,
const FName& InName,
EObjectFlags InFlags
)

 Tries to construct a new field given the name of its class. UObject/Field.h  

Operators

Name Remarks Include Path Unreal Specifiers

FField & operator= ( const FField&
)

   UObject/Field.h  
  UObject/Field.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page