FField

Base class of reflection data objects.

Windows
MacOS
Linux

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

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

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

Name Description

Public function Virtual

~FField()

Functions

Name Description

Public function Virtual

void

 

AddCppProperty

(
    FProperty * Property
)

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector & Collector
)

Public function Const

void

 

AppendName

(
    FString & ResultString
)

Public function Virtual

void

 

BeginDestroy()

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 InternalFlagsM...
)

Duplicates an FField

Public function Const

const FStrin ...

 

FindMetaData

(
    const FName & Key
)

Find the metadata value associated with the key

Public function Const

const FStrin ...

 

FindMetaData

(
    const TCHAR * Key
)

Find the metadata value associated with the key

Public function 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

Public function Const

FString

 

GetAuthoredName()

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

 

GetCastFlags()

Public function Const

FFieldClass ...

 

GetClass()

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

FOnConvertCu ...

 

GetConvertCustomUFieldToFFieldDelegate()

Gets a delegate to convert custom UField types to FFields

Public function Const

FText

 

GetDisplayNameText()

Finds the localized display name or native display name as a fallback.

Public function Const

EObjectFlags

 

GetFlags()

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

 

GetFName()

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

 

GetFullName()

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 TCHAR * Key
)

Find the metadata value associated with the key and return int32

Public function Const

int32

 

GetIntMetaData

(
    const FName & Key
)

Public function Const

FLinkerLoad ...

 

GetLinker()

Public function Const

const FStrin ...

 

GetMetaData

(
    const TCHAR * Key
)

Find the metadata value associated with the key

Public function Const

const FStrin ...

 

GetMetaData

(
    const FName & Key
)

Find the metadata value associated with the key

Public function Const

const TMap < ...

 

GetMetaDataMap()

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 ...

 

GetOutermost()

Goes up the outer chain to look for the outermost package

Public function Const

T *

 

GetOwner()

Public function Const

T *

 

GetOwnerChecked()

Public function Const

UClass *

 

GetOwnerClass()

Goes up the outer chain to look for a UClass

Public function Const

UStruct *...

 

GetOwnerStruct()

Goes up the outer chain to look for a UStruct

Public function Const

UField *

 

GetOwnerUField()

Goes up the outer chain to look for a UField

Public function Const

UObject *...

 

GetOwnerUObject()

Goes up the outer chain to look for a UObject .

Public function Const

FFieldVarian ...

 

GetOwnerVariant()

Gets the owner container for this field

Public function Const

void

 

GetPathName

(
    const UObject * StopOuter,
    FStringBuilderBase & ResultString
)

Public function Const

FString

 

GetPathName

(
    const UObject * StopOuter
)

Public function Virtual

void

 

GetPreloadDependencies

(
    TArray < UObject * >& OutDeps
)

Public function Const

FText

 

GetToolTipText

(
    bool bShortTooltip
)

Finds the localized tooltip or native tooltip as a fallback.

Public function Const

T *

 

GetTypedOwner()

Public function Const

UObject *...

 

GetTypedOwner

(
    UClass * Target
)

Goes up the outer chain to look for the outer of the specified type

Public function Const

FField *

 

GetTypedOwner

(
    FFieldClass * Target
)

Goes up the outer chain to look for the outer of the specified type

Public function Const

bool

 

HasAllCastFlags

(
    const uint64 InCastFlags
)

Public function Const

bool

 

HasAllFlags

(
    EObjectFlags FlagsToCheck
)

Used to safely check whether all of the passed in flags are set.

Public function Const

bool

 

HasAnyCastFlags

(
    const uint64 InCastFlags
)

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 *...

 

InternalGetOwnerAsUObjectUnsafe()

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

 

IsNative()

Public function Const

bool

 

IsRooted()

Public function Const

bool

 

IsValidLowLevel()

Public function Virtual

void

 

PostDuplicate

(
    const FField & InField
)

Fixups after duplicating a Field

Public function Virtual

void

 

PostLoad()

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

 

Serialize

(
    FArchive & Ar
)

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 ...

 

StaticClass()

Public function Static

uint64

 

StaticClassCastFlags()

Public function Static

uint64

 

StaticClassCastFlagsPrivate()

Typedefs

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback