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

Light Theme

Dark Theme

FProperty

An UnrealScript variable.

Inheritance Hierarchy

FField

FProperty

	FBoolProperty
	FEnumProperty
	FMulticastDelegateProperty
	FNetPropertyHook
	FNumericProperty
	FObjectPropertyBase
	FStructProperty

References

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

Syntax

class FProperty : public FField

Remarks

An UnrealScript variable.

Variables

	Name	Description
int32	ArrayDim	Persistent variables.
FProperty *	DestructorLinkNext	In memory only: Linked list of properties requiring destruction.
int32	ElementSize
FProperty *	NextRef	In memory only: Linked list of object reference properties from most-derived to base
FProperty *	PostConstructLinkNext	In memory only: Linked list of properties requiring post constructor initialization.
EPropertyFlags	PropertyFlags
FProperty *	PropertyLinkNext	In memory only: Linked list of properties from most-derived to base
uint16	RepIndex
FName	RepNotifyFunc

Constructors

	Name	Description
	FProperty ( UField* InField )
	FProperty ( EInternal InInernal, FFieldClass* InClass )
	FProperty ( FFieldVariant InOwner, const FName& InName, EObjectFlags InObjectFlags )	Constructors.
	FProperty ( FFieldVariant InOwner, const UECodeGen_Private::FPropertyP..., EPropertyFlags AdditionalPropertyFl... )	Constructor used for constructing compiled-in properties
	FProperty ( FFieldVariant InOwner, const UECodeGen_Private::FPropertyP..., EPropertyFlags AdditionalPropertyFl... )	Constructor used for constructing compiled-in properties
	FProperty ( FFieldVariant InOwner, const FName& InName, EObjectFlags InObjectFlags, int32 InOffset, EPropertyFlags InFlags )	Compiled-in property constructor is deprecated, use other constructors instead.

Functions

	Name	Description
void *	AllocateAndInitializeValue()	Allocates and initializes memory to hold a value this property represents
void	AppendSchemaHash ( FBlake3& Builder, bool bSkipEditorOnly )	Updates the given HashBuilder with name and type information of this Property.
void	CallGetter ( const void* Container, void* OutValue )	Calls the native getter function for this property
void	CallSetter ( void* Container, const void* InValue )	Calls the native setter function for this property
void	ClearPropertyFlags ( EPropertyFlags NewFlags )
void	ClearValue ( void* Data )	Zeros the value for this property.
void	ClearValue_InContainer ( void* Data, int32 ArrayIndex )	Zeros the value for this property.
void	ClearValueInternal ( void* Data )
FField *	Construct ( const FFieldVariant& InOwner, const FName& InName, EObjectFlags InObjectFlags )
ValueType co...	ContainerPtrToValuePtr ( UObject const* ContainerPtr, int32 ArrayIndex )
ValueType co...	ContainerPtrToValuePtr ( void const* ContainerPtr, int32 ArrayIndex )
ValueType &#...	ContainerPtrToValuePtr ( void* ContainerPtr, int32 ArrayIndex )
ValueType &#...	ContainerPtrToValuePtr ( UObject* ContainerPtr, int32 ArrayIndex )	Get the pointer to property value in a supplied 'container'.
ValueType &#...	ContainerPtrToValuePtrForDefaults ( UStruct* ContainerClass, UObject* ContainerPtr, int32 ArrayIndex )	Default variants, these accept and return NULL, and also check the property against the size of the container.
ValueType &#...	ContainerPtrToValuePtrForDefaults ( UStruct* ContainerClass, void* ContainerPtr, int32 ArrayIndex )
ValueType co...	ContainerPtrToValuePtrForDefaults ( UStruct* ContainerClass, UObject const* ContainerPtr, int32 ArrayIndex )
ValueType co...	ContainerPtrToValuePtrForDefaults ( UStruct* ContainerClass, void const* ContainerPtr, int32 ArrayIndex )
bool	ContainsInstancedObjectProperty()	Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a UObject reference that is marked CPF_NeedCtorLink (i.e. instanced keyword).
bool	ContainsObjectReference ( TArray< const FStructProperty*..., EPropertyObjectReferenceType InRefe... )	Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a UObject reference.
bool	ContainsWeakObjectReference()	Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a weak UObject reference.
EConvertFrom...	ConvertFromType ( const FPropertyTag& Tag, FStructuredArchive::FSlot Slot, uint8* Data, UStruct* DefaultsStruct )	Allows a property to implement backwards compatibility handling for tagged properties
void	CopyCompleteValue ( void* Dest, void const* Src )	Copy the value for all elements of this property.
void	CopyCompleteValue_InContainer ( void* Dest, void const* Src )
void	CopyCompleteValueFromScriptVM ( void* Dest, void const* Src )	Copy the value for all elements of this property. From the script VM.
void	CopyCompleteValueFromScriptVM_InContainer ( void* OutContainer, void const* InValue )
void	CopyCompleteValueToScriptVM ( void* Dest, void const* Src )	Copy the value for all elements of this property. To the script VM.
void	CopyCompleteValueToScriptVM_InContainer ( void* OutValue, void const* InContainer )	Equivalent to the above functions, but using the container and aware of getters/setters when the container has them.
void	CopySingleValue ( void* Dest, void const* Src )	Copy the value for a single element of this property.
void	CopySingleValueFromScriptVM ( void* Dest, void const* Src )	Copy the value for a single element of this property. From the script VM.
void	CopySingleValueToScriptVM ( void* Dest, void const* Src )	Copy the value for a single element of this property. To the script VM.
void	CopyValuesInternal ( void* Dest, void const* Src, int32 Count )
void	DestroyAndFreeValue ( void* InMemory )	Destroys and frees memory with a value this property represents
void	DestroyValue ( void* Dest )	Destroys the value for this property.
void	DestroyValue_InContainer ( void* Dest )	Destroys the value for this property.
void	DestroyValueInternal ( void* Dest )
void	EmitReferenceInfo ( UE::GC::FTokenStreamBuilder& Token..., int32 BaseOffset, TArray< const FStructProperty*..., FGCStackSizeHelper& StackSizeHelpe... )	Emits tokens used by realtime garbage collection code to passed in ReferenceTokenStream.
void	ExportCppDeclaration ( FOutputDevice& Out, EExportedDeclaration::Type Declarat..., const TCHAR* ArrayDimOverride, uint32 AdditionalExportCPPFlags, bool bSkipParameterName, const FString* ActualCppType, const FString* ActualExtendedT..., const FString* ActualParameter... )
bool	ExportText_Direct ( FString& ValueStr, const void* Data, const void* Delta, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )
bool	ExportText_InContainer ( int32 Index, FString& ValueStr, const void* Data, const void* Delta, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )
void	ExportText_Internal ( FString& ValueStr, const void* PropertyValueOrCon..., EPropertyPointerType PointerType, const void* DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )
void	ExportTextItem_Direct ( FString& ValueStr, const void* PropertyValue, const void* DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )
void	ExportTextItem_InContainer ( FString& ValueStr, const void* Container, const void* DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )
FName	FindRedirectedPropertyName ( UStruct* ObjectStruct, FName OldName )	Gets a redirected property name, will return NAME_None if no redirection was found
ELifetimeCon...	GetBlueprintReplicationCondition()
FString	GetCPPMacroType ( FString& ExtendedTypeText )
FString	GetCPPType ( FString* ExtendedTypeText, uint32 CPPExportFlags )	Returns the text to use for exporting this property to header file.
FString	GetCPPTypeForwardDeclaration()
FName	GetID()
int32	GetMinAlignment()
FString	GetNameCPP()	Returns the C++ name of the property, including the _DEPRECATED suffix if the property is deprecated.
int32	GetOffset_ForDebug()	Return offset of property from container base.
int32	GetOffset_ForGC()	Return offset of property from container base.
int32	GetOffset_ForInternal()	Return offset of property from container base.
int32	GetOffset_ForUFunction()	Return offset of property from container base.
int32	GetOffset_ReplaceWith_ContainerPtrToValuePtr()	Return offset of property from container base.
const FPrope...	GetOwnerProperty()
FProperty &#...	GetOwnerProperty()	Returns the first FProperty in this property's Outer chain that does not have a FProperty for an Outer
EPropertyFla...	GetPropertyFlags()	Returns this property's propertyflags
FProperty &#...	GetRepOwner()	Returns the replication owner, which is the property itself, or NULL if this isn't important for replication.
void	GetSingleValue_InContainer ( const void* InContainer, void* OutValue, int32 ArrayIndex )	Copies a single value to OutValue even if the property represents a static array of values
int32	GetSize()
UPropertyWra...	GetUPropertyWrapper()	Gets the wrapper object for this property or creates one if it doesn't exist yet
void	GetValue_InContainer ( void const* InContainer, void* OutValue )
void *	GetValueAddressAtIndex_Direct ( const FProperty* Inner, void* InValueAddress, int32 Index )	Gets value address at given index inside of a static array or container
uint32	GetValueTypeHash ( const void* Src )	Returns the hash value for an element of this property.
uint32	GetValueTypeHashInternal ( const void* Src )
bool	HasAllPropertyFlags ( uint64 FlagsToCheck )	Used to safely check whether all of the passed in flags are set.
bool	HasAnyPropertyFlags ( uint64 FlagsToCheck )	Used to safely check whether any of the passed in flags are set.
bool	HasGetter()	Checks if this property as a native getter function
bool	HasSetter()	Checks if this property as a native setter function
bool	HasSetterOrGetter()	Checks if this property as a native setter or getter function
bool	Identical ( const void* A, const void* B, uint32 PortFlags )	Determines whether the property values are identical.
bool	Identical_InContainer ( const void* A, const void* B, int32 ArrayIndex, uint32 PortFlags )	Determines whether the property values are identical.
const TCHAR ...	ImportSingleProperty ( const TCHAR* Str, void* DestData, UStruct* ObjectStruct, UObject* SubobjectOuter, int32 PortFlags, FOutputDevice* Warn, TArray< struct FDefinedProperty >&... )	Parses and imports a text definition of a single property's value (if array, may be an individual element) also includes parsing of special operations for array properties (Add/Remove/RemoveIndex/Empty)
const TCHAR ...	ImportText_Direct ( const TCHAR* Buffer, void* PropertyPtr, UObject* OwnerObject, int32 PortFlags, FOutputDevice* ErrorText )	Import a text value
const TCHAR ...	ImportText_InContainer ( const TCHAR* Buffer, void* Container, UObject* OwnerObject, int32 PortFlags, FOutputDevice* ErrorText )	Import a text value
const TCHAR ...	ImportText_Internal ( const TCHAR* Buffer, void* ContainerOrPropertyPtr, EPropertyPointerType PointerType, UObject* OwnerObject, int32 PortFlags, FOutputDevice* ErrorText )
void	Init()	Initializes internal state.
void	InitializeValue ( void* Dest )	Zeros, copies from the default, or calls the constructor for on the value for this property.
void	InitializeValue_InContainer ( void* Dest )	Zeros, copies from the default, or calls the constructor for on the value for this property.
void	InitializeValueInternal ( void* Dest )
void	InstanceSubobjects ( void* Data, void const* DefaultData, UObject* Owner, FObjectInstancingGraph* Instan... )	Creates new copies of components
bool	IsEditorOnlyProperty()	Editor-only properties are those that only are used with the editor is present or cannot be removed from serialisation.
bool	IsInContainer ( int32 ContainerSize )	See if the offset of this property is below the supplied container size
bool	IsInContainer ( UStruct* ContainerClass )	See if the offset of this property is below the supplied container size
int32	Link ( FArchive& Ar )
void	LinkInternal ( FArchive& Ar )
void	LinkWithoutChangingOffset ( FArchive& Ar )
bool	NetSerializeItem ( FArchive& Ar, UPackageMap* Map, void* Data, TArray< uint8 >* MetaData )
bool	PassCPPArgsByRef()
void	PerformOperationWithGetter ( void* OutContainer, const void* DirectPropertyAddr..., TFunctionRef< void(const void*... )	Helper function for getting container / struct property value and performing operation directly on the value memory
void	PerformOperationWithSetter ( void* OutContainer, void* DirectPropertyAddress, TFunctionRef< void(void*)> Dir... )	Helper function for setting container / struct property value and performing operation directly on the value memory
void *	PointerToValuePtr ( void const* ContainerOrPropert..., EPropertyPointerType PropertyPointe..., int32 ArrayIndex )
bool	SameType ( const FProperty* Other )	Returns true, if Other is property of exactly the same type
void	SerializeBinProperty ( FStructuredArchive::FSlot Slot, void* Data, int32 ArrayIdx )	Serializes the property with the struct's data residing in Data.
void	SerializeItem ( FStructuredArchive::FSlot Slot, void* Value, void const* Defaults )
void	SerializeNonMatchingBinProperty ( FStructuredArchive::FSlot Slot, void* Data, void const* DefaultData, UStruct* DefaultStruct )	Serializes the property with the struct's data residing in Data, unless it matches the default
void	SetBlueprintReplicationCondition ( ELifetimeCondition InBlueprintRepli... )
void	SetOffset_Internal ( int32 NewOffset )	Set the alignment offset for this property - added for FMapProperty
void	SetPropertyFlags ( EPropertyFlags NewFlags )
void	SetSingleValue_InContainer ( void* OutContainer, const void* InValue, int32 ArrayIndex )	Copies a single value to the property even if the property represents a static array of values
void	SetValue_InContainer ( void* OutContainer, const void* InValue )
bool	ShouldDuplicateValue()	Determines whether this property value is eligible for copying when duplicating an object
bool	ShouldPort ( uint32 PortFlags )
bool	ShouldSerializeValue ( FArchive& Ar )
FFieldClass ...	StaticClass()
constexpr ui...	StaticClassCastFlags()
constexpr ui...	StaticClassCastFlagsPrivate()
bool	SupportsNetSharedSerialization()
bool	ValidateImportFlags ( uint32 PortFlags, FOutputDevice* ErrorText )	Verify that modifying this property's value via ImportText is allowed.

Overridden from FField

		Name	Description
	void	PostDuplicate ( const FField& InField )	Fixups after duplicating a Field
	void	Serialize ( FArchive& Ar )	Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties.

Operators

		Name	Description
	void	operator delete ( void* InMem )
	void *	operator new ( const size_t InSize )
	void *	operator new ( const size_t InSize, void* InMem )

Typedefs

Name	Description
Super
ThisClass

Deprecated Functions

	Name	Description
void	ExportTextItem ( FString& ValueStr, const void* PropertyValue, const void* DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )	Please use ExportTextItem_InContainer or ExportTextItem_Direct instead.
	FProperty ( FFieldVariant InOwner, const FName& InName, EObjectFlags InObjectFlags, int32 InOffset, EPropertyFlags InFlags )	Compiled-in property constructor is deprecated, use other constructors instead.
const TCHAR ...	ImportText ( const TCHAR* Buffer, void* Data, int32 PortFlags, UObject* OwnerObject, FOutputDevice* ErrorText )	ImportText that takes a direct property pointer is deprecated. Please use ImportText_Direct or ImportText_InContainer instead.

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

Take our survey

Cancel