Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > UObject > UField

Light Theme

Dark Theme

UField

Base class of reflection data objects.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UField

FProperty

FArrayProperty

FBoolProperty

FDelegateProperty

FEnumProperty

FInterfaceProperty

FMapProperty

FMulticastDelegateProperty

	FMulticastInlineDelegateProperty
	FMulticastSparseDelegateProperty

FMulticastDelegateProperty

	FMulticastInlineDelegateProperty
	FMulticastSparseDelegateProperty

FNameProperty

FNetPropertyHook

FNumericProperty

	FByteProperty
	FDoubleProperty
	FFloatProperty
	FInt16Property
	FInt64Property
	FInt8Property
	FIntProperty
	FUInt16Property
	FUInt32Property
	FUInt64Property

FNumericProperty

	FByteProperty
	FDoubleProperty
	FFloatProperty
	FInt16Property
	FInt64Property
	FInt8Property
	FIntProperty
	FUInt16Property
	FUInt32Property
	FUInt64Property

FObjectPropertyBase

FLazyObjectProperty

FObjectProperty

	FClassProperty
	FClassProperty

FSoftObjectProperty

	FSoftClassProperty
	FSoftClassProperty

FWeakObjectProperty

FObjectPropertyBase

FLazyObjectProperty

FObjectProperty

	FClassProperty
	FClassProperty

FSoftObjectProperty

	FSoftClassProperty
	FSoftClassProperty

FWeakObjectProperty

FSetProperty

FStrProperty

FStructProperty

FTextProperty

UEnum

UUserDefinedEnum

UStruct

References

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

Syntax

class UField : public UObject

Remarks

Base class of reflection data objects.

Variables

		Name	Description
	UField *	Next	Next Field in the linked list

Constructors

	Name	Description
	UField ( const FObjectInitializer& ObjectIn... )
	UField ( FVTableHelper& Helper )	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
	UField ( EStaticConstructor, EObjectFlags InFlags )	Constructors.

Functions

	Name	Description
void	__DefaultConstructor ( const FObjectInitializer& X )
UObject *...	__VTableCtorCaller ( FVTableHelper& Helper )
void	AddCppProperty ( FProperty* Property )
void	Bind()
const FStrin...	FindMetaData ( const TCHAR* Key )	Find the metadata value associated with the key
const FStrin...	FindMetaData ( const FName& Key )	Find the metadata value associated with the key
void	FormatNativeToolTip ( FString& ToolTipString, bool bRemoveExtraSections )	Formats a source comment into the form we want to show in the editor, is used by GetToolTipText and anything else that will get a native tooltip
FField *	GetAssociatedFField()	Gets the FField object associated with this Field
FString	GetAuthoredName()	Returns a human readable string that was assigned to this field at creation.
bool	GetBoolMetaData ( const FName& Key )
bool	GetBoolMetaData ( const TCHAR* Key )	Find the metadata value associated with the key and return bool
UClass *	GetClassMetaData ( const FName& Key )	Find the metadata value associated with the key and return Class
UClass *	GetClassMetaData ( const TCHAR* Key )	Find the metadata value associated with the key and return Class
FText	GetDisplayNameText()	Finds the localized display name or native display name as a fallback.
float	GetFloatMetaData ( const FName& Key )
float	GetFloatMetaData ( const TCHAR* Key )	Find the metadata value associated with the key and return float
int32	GetIntMetaData ( const FName& Key )
int32	GetIntMetaData ( const TCHAR* Key )	Find the metadata value associated with the key and return int32
const FStrin...	GetMetaData ( const FName& Key )	Find the metadata value associated with the key
const FStrin...	GetMetaData ( const TCHAR* Key )	Find the metadata value associated with the key
FText	GetMetaDataText ( const FName& MetaDataKey, const FString LocalizationNamespace, const FString LocalizationKey )	A dynamically sizeable string.
FText	GetMetaDataText ( const TCHAR* MetaDataKey, const FString LocalizationNamespace, const FString LocalizationKey )	Find the metadata value associated with the key and localization namespace and key
UClass *	GetOwnerClass()	Goes up the outer chain to look for a UClass
UStruct *...	GetOwnerStruct()	Goes up the outer chain to look for a UStruct
FText	GetToolTipText ( bool bShortTooltip )	Finds the localized tooltip or native tooltip as a fallback.
bool	HasAllCastFlags ( const uint64 InCastFlags )
bool	HasAnyCastFlags ( const uint64 InCastFlags )
bool	HasMetaData ( const FName& Key )
bool	HasMetaData ( const TCHAR* Key )	Determines if the property has any metadata associated with the key
void	RemoveMetaData ( const TCHAR* Key )	Clear any metadata associated with the key
void	RemoveMetaData ( const FName& Key )	Clear any metadata associated with the key
void	SetAssociatedFField ( FField* InField )	Sets the FField object associated with this Field
void	SetMetaData ( const FName& Key, const TCHAR* InValue )	Sets the metadata value associated with the key
void	SetMetaData ( const TCHAR* Key, const TCHAR* InValue )	Sets the metadata value associated with the key
UClass *	StaticClass()	Returns a UClass object representing this class at runtime
EClassCastFl...	StaticClassCastFlags()	Returns the static cast flags for this class
const TCHAR ...	StaticPackage()	Returns the package this class belongs in
void	StaticRegisterNativesUField()

Overridden from UObject

	Name	Description
bool	NeedsLoadForClient()	Called during saving to determine the load flags to save with the object.
bool	NeedsLoadForServer()	Called during saving to determine the load flags to save with the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Operators

		Name	Description
	void *	operator new ( const size_t InSize, EInternal* InMem )	For internal use only; use StaticConstructObject() to create new objects.
	void *	operator new ( const size_t InSize, EInternal InInternalOnly, UObject* InOuter, FName InName, EObjectFlags InSetFlags )	For internal use only; use StaticConstructObject() to create new objects.

Typedefs

Name	Description
BaseFieldClass
FieldTypeClass
Super	Typedef for the base class (UObject)
ThisClass	Typedef for UField.

Constants

Name	Description
StaticClassFlags	Bitwise union of EClassFlags pertaining to this class.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss