1. Epic GamesDeveloper
  3. FField

FField

Base class of reflection data objects.

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/Field.h
Include #include "UObject/Field.h"

Syntax

class FField

Remarks

Base class of reflection data objects.

Variables

  Type Name Description
Public variable EObjectFlags FlagsPrivate Object flags
Public variable FName NamePrivate Name of this field
Public variable FField * Next Next Field in the linked list
Public variable FFieldVariant Owner Owner of this field

Constructors

  Type Name Description
Public function  

FField ( UField* InField
)

  
Public function  

FField ( EInternal InInernal,
FFieldClass* InClass
)

 Constructors.
Public function  

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

  

Destructors

  Type Name Description
Public function Virtual  

~FField ()

  

Functions

  Type Name Description
Public function Virtual void

AddCppProperty ( FProperty* Property
)

  
Public function Virtual void  
Public function void

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

 Append the given metadata to this field
Public function Const void

AppendName ( FString& ResultString
)

  
Public function Virtual void  
Public function Virtual void

Bind ()

  
Public function void

ClearFlags ( EObjectFlags NewFlags
)

  
Public function Static FField *

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

 Constructs a new field given the name of its class
Public function Static FField *

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

 Constructs a new field given its class
Public function Static void

CopyMetaData ( const FField* InSourceField,
FField* InDestField
)

 Copies all metadata from Source Field to Dest Field
Public function Static FField *

CreateFromUField ( UField* InField
)

 Creates a new FField from existing UField
Public function Static FField *

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

 Duplicates an FField
Public function Const const FString *

FindMetaData ( const TCHAR* Key
)

 Find the metadata value associated with the key
Public function Const const FString *

FindMetaData ( const FName& Key
)

 Find the metadata value associated with the key
Public function Static FName Generates a name for a Field of a given type. Each generated name is unique in the current runtime
Public function Const FString Returns a human readable string that was assigned to this field at creation.
Public function Const bool

GetBoolMetaData ( const FName& Key
)

  
Public function Const bool

GetBoolMetaData ( const TCHAR* Key
)

 Find the metadata value associated with the key and return bool
Public function Const uint64  
Public function Const FFieldClass *  
Public function Const UClass *

GetClassMetaData ( const FName& Key
)

 Find the metadata value associated with the key and return Class
Public function Const UClass *

GetClassMetaData ( const TCHAR* Key
)

 Find the metadata value associated with the key and return Class
Public function Static FOnConvertCustomUFieldToFField & Gets a delegate to convert custom UField types to FFields
Public function Const FText Finds the localized display name or native display name as a fallback.
Public function Const double

GetDoubleMetaData ( const FName& Key
)

  
Public function Const double

GetDoubleMetaData ( const TCHAR* Key
)

 Find the metadata value associated with the key and return double
Public function Const EObjectFlags Retrieve the object flags directly
Public function Const float

GetFloatMetaData ( const TCHAR* Key
)

 Find the metadata value associated with the key and return float
Public function Const float

GetFloatMetaData ( const FName& Key
)

  
Public function Const FName  
Public function Const FString

GetFullGroupName ( bool bStartWithOuter
)

 Walks up the chain of packages until it reaches the top level, which it ignores.
Public function Const FString  
Public function Virtual FField *

GetInnerFieldByName ( const FName& InName
)

 Returns an inner field by name if the field has any
Public function Virtual void

GetInnerFields ( TArray< FField* >& OutFields
)

 Fills the provided array with all inner fields this field owns (recursively)
Public function Const int32

GetIntMetaData ( const FName& Key
)

  
Public function Const int32

GetIntMetaData ( const TCHAR* Key
)

 Find the metadata value associated with the key and return int32
Public function Const FLinkerLoad *  
Public function Const const FString &

GetMetaData ( const TCHAR* Key
)

 Find the metadata value associated with the key
Public function Const const FString &

GetMetaData ( const FName& Key
)

 Find the metadata value associated with the key
Public function Const const TMap< FName, FString > * Gets all metadata associated with this field
Public function Const const FText

GetMetaDataText ( const FName& MetaDataKey,
const FString LocalizationNamespace,
const FString LocalizationKey
)

 A dynamically sizeable string.
Public function Const const FText

GetMetaDataText ( const TCHAR* MetaDataKey,
const FString LocalizationNamespace,
const FString LocalizationKey
)

 Find the metadata value associated with the key and localization namespace and key
Public function Const void

GetName ( FString& OutName
)

  
Public function Const FString

GetName ()

  
Public function Const UPackage * Goes up the outer chain to look for the outermost package
Public function Const T *  
Public function Const T *  
Public function Const UClass * Goes up the outer chain to look for a UClass
Public function Const UStruct * Goes up the outer chain to look for a UStruct
Public function Const UField * Goes up the outer chain to look for a UField
Public function Const UObject * Goes up the outer chain to look for a UObject.
Public function Const FFieldVariant Gets the owner container for this field
Public function Const FString

GetPathName ( const UObject* StopOuter
)

  
Public function Const void

GetPathName ( const UObject* StopOuter,
FStringBuilderBase& ResultString
)

  
Public function Virtual void  
Public function Const FText

GetToolTipText ( bool bShortTooltip
)

 Finds the localized tooltip or native tooltip as a fallback.
Public function Const T *  
Public function Const FField * Goes up the outer chain to look for the outer of the specified type
Public function Const UObject *

GetTypedOwner ( UClass* Target
)

 Goes up the outer chain to look for the outer of the specified type
Public function Const bool

HasAllFlags ( EObjectFlags FlagsToCheck
)

 Used to safely check whether all of the passed in flags are set.
Public function Const bool

HasAnyFlags ( EObjectFlags FlagsToCheck
)

 Used to safely check whether any of the passed in flags are set.
Public function Const bool

HasMetaData ( const TCHAR* Key
)

 Determines if the property has any metadata associated with the key
Public function Const bool

HasMetaData ( const FName& Key
)

  
Public function Const UObject * Internal function for quickly getting the owner of this object as UObject.
Public function Const bool

IsA ()

  
Public function Const bool

IsA ( const FFieldClass* FieldType
)

  
Public function Const bool

IsIn ( const UObject* InOwner
)

  
Public function Const bool

IsIn ( const FField* InOwner
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual void

PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field
Public function Virtual void  
Public function void

RemoveMetaData ( const TCHAR* Key
)

 Clear any metadata associated with the key
Public function void

RemoveMetaData ( const FName& Key
)

 Clear any metadata associated with the key
Public function void

Rename ( const FName& NewName
)

  
Public function Virtual void Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties.
Public function void

SetFlags ( EObjectFlags NewFlags
)

  
Protected function void

SetFlagsTo ( EObjectFlags NewFlags
)

 Set the object flags directly
Public function void

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

  
Public function void

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

 Sets the metadata value associated with the key
Public function void

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

 Sets the metadata value associated with the key
Public function void

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

 Sets the metadata value associated with the key
Public function Static FFieldClass *  
Public function Static constexpr uint64  
Public function Static constexpr uint64  

Typedefs

Name Description
BaseFieldClass  
FieldTypeClass  
FOnConvertCustomUFieldToFField  
Super  
ThisClass  

Deprecated Functions

  Type Name Description
Public function Const bool

HasAllCastFlags ( const uint64 InCastFlags
)

 HasAllCastFlags is deprecated. Not all FField has CastFlag. Use IsA instead.
Public function Const bool

HasAnyCastFlags ( const uint64 InCastFlags
)

 HasAnyCastFlags is deprecated. Not all FField has CastFlag. Use IsA instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page