#include <UnrealType.h>

Inheritance diagram for FProperty:

Public Member Functions
COREUOBJECT_API	FProperty (FFieldVariant InOwner, const FName &InName, EObjectFlags InObjectFlags)

COREUOBJECT_API	FProperty (FFieldVariant InOwner, const UECodeGen_Private::FPropertyParamsBaseWithOffset &Prop, EPropertyFlags AdditionalPropertyFlags=CPF_None)

COREUOBJECT_API	FProperty (FFieldVariant InOwner, const UECodeGen_Private::FPropertyParamsBaseWithoutOffset &Prop, EPropertyFlags AdditionalPropertyFlags=CPF_None)

COREUOBJECT_API void	SetElementSize (int32 NewSize)

int32	GetElementSize () const

virtual COREUOBJECT_API void	Serialize (FArchive &Ar) override

virtual COREUOBJECT_API void	PostDuplicate (const FField &InField) override

COREUOBJECT_API FString	GetNameCPP () const

virtual COREUOBJECT_API FString	GetCPPMacroType (FString &ExtendedTypeText) const

virtual bool	HasSetter () const

virtual bool	HasGetter () const

virtual bool	HasSetterOrGetter () const

virtual void	CallSetter (void Container, const void InValue) const

virtual void	CallGetter (const void Container, void OutValue) const

COREUOBJECT_API EPropertyVisitorControlFlow	Visit (const FPropertyVisitorData &Data, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorPath &, const FPropertyVisitorData &)> InFunc) const

COREUOBJECT_API EPropertyVisitorControlFlow	Visit (const FPropertyVisitorData &Data, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorContext &)> InFunc) const

virtual COREUOBJECT_API EPropertyVisitorControlFlow	Visit (FPropertyVisitorContext &Context, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorContext &)> InFunc) const

virtual COREUOBJECT_API void *	ResolveVisitedPathInfo (void *Data, const FPropertyVisitorInfo &Info) const

UE_FORCEINLINE_HINT int32	GetOffset_ForDebug () const

UE_FORCEINLINE_HINT int32	GetOffset_ForUFunction () const

UE_FORCEINLINE_HINT int32	GetOffset_ForGC () const

UE_FORCEINLINE_HINT int32	GetOffset_ForInternal () const

UE_FORCEINLINE_HINT int32	GetOffset_ReplaceWith_ContainerPtrToValuePtr () const

void	LinkWithoutChangingOffset (FArchive &Ar)

int32	Link (FArchive &Ar)

virtual COREUOBJECT_API EConvertFromTypeResult	ConvertFromType (const FPropertyTag &Tag, FStructuredArchive::FSlot Slot, uint8 Data, const UStruct DefaultsStruct, const uint8 *Defaults)

bool	Identical_InContainer (const void A, const void B, int32 ArrayIndex=0, uint32 PortFlags=0) const

void	SerializeBinProperty (FStructuredArchive::FSlot Slot, void *Data, int32 ArrayIdx=-1)

void	SerializeNonMatchingBinProperty (FStructuredArchive::FSlot Slot, void Data, void const DefaultData, UStruct *DefaultStruct)

virtual COREUOBJECT_API bool	SupportsNetSharedSerialization () const

void	ExportTextItem_Direct (FString &ValueStr, const void PropertyValue, const void DefaultValue, UObject Parent, int32 PortFlags, UObject ExportRootScope=nullptr) const

void	ExportTextItem_InContainer (FString &ValueStr, const void Container, const void DefaultValue, UObject Parent, int32 PortFlags, UObject ExportRootScope=nullptr) const

const TCHAR *	ImportText_InContainer (const TCHAR Buffer, void Container, UObject OwnerObject, int32 PortFlags, FOutputDevice ErrorText=(FOutputDevice *) GWarn) const

const TCHAR *	ImportText_Direct (const TCHAR Buffer, void PropertyPtr, UObject OwnerObject, int32 PortFlags, FOutputDevice ErrorText=(FOutputDevice *) GWarn) const

void	SetValue_InContainer (void OutContainer, const void InValue) const

void	GetValue_InContainer (void const InContainer, void OutValue) const

COREUOBJECT_API void	SetSingleValue_InContainer (void OutContainer, const void InValue, int32 ArrayIndex) const

COREUOBJECT_API void	GetSingleValue_InContainer (const void InContainer, void OutValue, int32 ArrayIndex) const

COREUOBJECT_API void *	AllocateAndInitializeValue () const

COREUOBJECT_API void	DestroyAndFreeValue (void *InMemory) const

COREUOBJECT_API void	PerformOperationWithSetter (void OutContainer, void DirectPropertyAddress, TFunctionRef< void(void *)> DirectValueAccessFunc) const

COREUOBJECT_API void	PerformOperationWithGetter (void OutContainer, const void DirectPropertyAddress, TFunctionRef< void(const void *)> DirectValueAccessFunc) const

virtual COREUOBJECT_API void *	GetValueAddressAtIndex_Direct (const FProperty Inner, void InValueAddress, int32 Index) const

COREUOBJECT_API bool	ExportText_Direct (FString &ValueStr, const void Data, const void Delta, UObject Parent, int32 PortFlags, UObject ExportRootScope=nullptr) const

UE_FORCEINLINE_HINT bool	ExportText_InContainer (int32 Index, FString &ValueStr, const void Data, const void Delta, UObject Parent, int32 PortFlags, UObject ExportRootScope=nullptr) const

template<typename ValueType >
UE_FORCEINLINE_HINT ValueType *	ContainerPtrToValuePtr (UObject *ContainerPtr, int32 ArrayIndex=0) const

template<typename ValueType >
UE_FORCEINLINE_HINT ValueType *	ContainerPtrToValuePtr (void *ContainerPtr, int32 ArrayIndex=0) const

template<typename ValueType >
UE_FORCEINLINE_HINT ValueType const *	ContainerPtrToValuePtr (UObject const *ContainerPtr, int32 ArrayIndex=0) const

template<typename ValueType >
UE_FORCEINLINE_HINT ValueType const *	ContainerPtrToValuePtr (void const *ContainerPtr, int32 ArrayIndex=0) const

template<typename ValueType >
ValueType *	ContainerPtrToValuePtrForDefaults (const UStruct ContainerClass, UObject ContainerPtr, int32 ArrayIndex=0) const

template<typename ValueType >
ValueType *	ContainerPtrToValuePtrForDefaults (const UStruct ContainerClass, void ContainerPtr, int32 ArrayIndex=0) const

template<typename ValueType >
const ValueType *	ContainerPtrToValuePtrForDefaults (const UStruct ContainerClass, const UObject ContainerPtr, int32 ArrayIndex=0) const

template<typename ValueType >
const ValueType *	ContainerPtrToValuePtrForDefaults (const UStruct ContainerClass, const void ContainerPtr, int32 ArrayIndex=0) const

UE_FORCEINLINE_HINT bool	IsInContainer (int32 ContainerSize) const

UE_FORCEINLINE_HINT bool	IsInContainer (const UStruct *ContainerClass) const

void	CopySingleValue (void Dest, void const Src) const

COREUOBJECT_API uint32	GetValueTypeHash (const void *Src) const

void	CopyCompleteValue (void Dest, void const Src) const

UE_FORCEINLINE_HINT void	CopyCompleteValue_InContainer (void Dest, void const Src) const

virtual COREUOBJECT_API void	CopySingleValueToScriptVM (void Dest, void const Src) const

virtual COREUOBJECT_API void	CopyCompleteValueToScriptVM (void Dest, void const Src) const

virtual COREUOBJECT_API void	CopyCompleteValueToScriptVM_InContainer (void OutValue, void const InContainer) const

virtual COREUOBJECT_API void	CopyCompleteValueFromScriptVM_InContainer (void OutContainer, void const InValue) const

virtual COREUOBJECT_API void	CopySingleValueFromScriptVM (void Dest, void const Src) const

virtual COREUOBJECT_API void	CopyCompleteValueFromScriptVM (void Dest, void const Src) const

void	ClearValue (void *Data) const

void	ClearValue_InContainer (void *Data, int32 ArrayIndex=0) const

void	DestroyValue (void *Dest) const

void	DestroyValue_InContainer (void *Dest) const

bool	ContainsFinishDestroy (TArray< const FStructProperty * > &EncounteredStructProps) const

void	FinishDestroy (void *Data) const

void	FinishDestroy_InContainer (void *Data) const

void	InitializeValue (void *Dest) const

void	InitializeValue_InContainer (void *Dest) const

COREUOBJECT_API bool	ValidateImportFlags (uint32 PortFlags, FOutputDevice *ErrorText=NULL) const

COREUOBJECT_API bool	ShouldPort (uint32 PortFlags=0) const

virtual COREUOBJECT_API FName	GetID () const

virtual COREUOBJECT_API void	InstanceSubobjects (void Data, void const DefaultData, TNotNull< UObject * > Owner, struct FObjectInstancingGraph *InstanceGraph)

virtual COREUOBJECT_API int32	GetMinAlignment () const

virtual COREUOBJECT_API bool	ContainsObjectReference (TArray< const FStructProperty * > &EncounteredStructProps, EPropertyObjectReferenceType InReferenceType=EPropertyObjectReferenceType::Strong) const

bool	ContainsWeakObjectReference () const

UE_FORCEINLINE_HINT bool	ContainsInstancedObjectProperty () const

virtual COREUOBJECT_API void	EmitReferenceInfo (UE::GC::FSchemaBuilder &Schema, int32 BaseOffset, TArray< const FStructProperty * > &EncounteredStructProps, UE::GC::FPropertyStack &DebugPath)

UE_FORCEINLINE_HINT int32	GetSize () const

COREUOBJECT_API bool	ShouldSerializeValue (FArchive &Ar) const

virtual COREUOBJECT_API bool	UseBinaryOrNativeSerialization (const FArchive &Ar) const

bool	ShouldDuplicateValue () const

virtual COREUOBJECT_API bool	LoadTypeName (UE::FPropertyTypeName Type, const FPropertyTag *Tag=nullptr)

virtual COREUOBJECT_API void	SaveTypeName (UE::FPropertyTypeNameBuilder &Type) const

virtual COREUOBJECT_API bool	CanSerializeFromTypeName (UE::FPropertyTypeName Type) const

FProperty *	GetOwnerProperty ()

const FProperty *	GetOwnerProperty () const

UE_FORCEINLINE_HINT EPropertyFlags	GetPropertyFlags () const

UE_FORCEINLINE_HINT void	SetPropertyFlags (EPropertyFlags NewFlags)

UE_FORCEINLINE_HINT void	ClearPropertyFlags (EPropertyFlags NewFlags)

UE_FORCEINLINE_HINT bool	HasAnyPropertyFlags (uint64 FlagsToCheck) const

UE_FORCEINLINE_HINT bool	HasAllPropertyFlags (uint64 FlagsToCheck) const

UE_FORCEINLINE_HINT FProperty *	GetRepOwner ()

UE_FORCEINLINE_HINT bool	IsEditorOnlyProperty () const

virtual COREUOBJECT_API bool	SameType (const FProperty *Other) const

ELifetimeCondition	GetBlueprintReplicationCondition () const

void	SetBlueprintReplicationCondition (ELifetimeCondition InBlueprintReplicationCondition)

virtual bool HasIntrusiveUnsetOptionalState() const PURE_VIRTUAL(FProperty virtual COREUOBJECT_API void	InitializeIntrusiveUnsetOptionalValue (void *Data) const

virtual COREUOBJECT_API bool	IsIntrusiveOptionalValueSet (const void *Data) const

virtual COREUOBJECT_API void	ClearIntrusiveOptionalValue (void *Data) const

virtual COREUOBJECT_API void	EmitIntrusiveOptionalReferenceInfo (UE::GC::FSchemaBuilder &Schema, int32 BaseOffset, TArray< const FStructProperty * > &EncounteredStructProps, UE::GC::FPropertyStack &DebugPath)

Public Member Functions inherited from FField
virtual SIZE_T	GetFieldSize () const

COREUOBJECT_API	FField (EInternal InInernal, FFieldClass *InClass)

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

virtual COREUOBJECT_API	~FField ()

virtual COREUOBJECT_API void	PostLoad ()

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

virtual COREUOBJECT_API void	BeginDestroy ()

virtual COREUOBJECT_API void	AddReferencedObjects (FReferenceCollector &Collector)

COREUOBJECT_API bool	IsRooted () const

COREUOBJECT_API bool	IsNative () const

COREUOBJECT_API bool	IsValidLowLevel () const

COREUOBJECT_API bool	IsIn (const UObject *InOwner) const

COREUOBJECT_API bool	IsIn (const FField *InOwner) const

COREUOBJECT_API FLinkerLoad *	GetLinker () const

virtual COREUOBJECT_API void	AddCppProperty (FProperty *Property)

virtual COREUOBJECT_API void	Bind ()

EObjectFlags	GetFlags () const

void	SetFlags (EObjectFlags NewFlags)

void	ClearFlags (EObjectFlags NewFlags)

bool	HasAnyFlags (EObjectFlags FlagsToCheck) const

bool	HasAllFlags (EObjectFlags FlagsToCheck) const

FFieldClass *	GetClass () const

uint64	GetCastFlags () const

bool	IsA (const FFieldClass *FieldType) const

template<typename T >
bool	IsA () const

bool	HasAnyCastFlags (const uint64 InCastFlags) const

bool	HasAllCastFlags (const uint64 InCastFlags) const

void	AppendName (FString &ResultString) const

FFieldVariant	GetOwnerVariant () const

UObject *	GetOwnerUObject () const

UE_FORCEINLINE_HINT UObject *	InternalGetOwnerAsUObjectUnsafe () const

COREUOBJECT_API UClass *	GetOwnerClass () const

COREUOBJECT_API UStruct *	GetOwnerStruct () const

COREUOBJECT_API UField *	GetOwnerUField () const

COREUOBJECT_API UPackage *	GetOutermost () const

COREUOBJECT_API UObject *	GetTypedOwner (UClass *Target) const

COREUOBJECT_API FField *	GetTypedOwner (FFieldClass *Target) const

template<typename T >
T *	GetOwner () const

template<typename T >
FUNCTION_NON_NULL_RETURN_START T *	GetOwnerChecked () const FUNCTION_NON_NULL_RETURN_END

template<typename T >
T *	GetTypedOwner () const

FName	GetFName () const

FString	GetName () const

void	GetName (FString &OutName) const

COREUOBJECT_API void	Rename (const FName &NewName)

COREUOBJECT_API FString	GetPathName (const UObject *StopOuter=nullptr) const

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

COREUOBJECT_API FString	GetFullName () const

COREUOBJECT_API FString	GetAuthoredName () const

virtual FField *	GetInnerFieldByName (const FName &InName)

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

Static Public Member Functions
static COREUOBJECT_API const TCHAR *	ImportSingleProperty (const TCHAR Str, void DestData, const UStruct ObjectStruct, UObject SubobjectOuter, int32 PortFlags, FOutputDevice *Warn, TArray< struct FDefinedProperty > &DefinedProperties)

static COREUOBJECT_API FName	FindRedirectedPropertyName (const UStruct *ObjectStruct, FName OldName)

Static Public Member Functions inherited from FField
static COREUOBJECT_API FFieldClass *	StaticClass ()

static constexpr EClassCastFlags	StaticClassCastFlagsPrivate ()

static constexpr EClassCastFlags	StaticClassCastFlags ()

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

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

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

static COREUOBJECT_API FField *	Duplicate (const FField *InField, FFieldVariant DestOwner, const FName DestName=NAME_None, EObjectFlags FlagMask=RF_AllFlags, EInternalObjectFlags InternalFlagsMask=EInternalObjectFlags_AllFlags)

static COREUOBJECT_API FName	GenerateFFieldName (FFieldVariant InOwner, FFieldClass *InClass)

Public Attributes
EPropertyFlags	PropertyFlags

uint16	RepIndex

FProperty *	PropertyLinkNext = nullptr

union {

FProperty * NextRef = nullptr

};

union {

FProperty * DestructorLinkNext = nullptr

};

FProperty *	PostConstructLinkNext = nullptr

FName	RepNotifyFunc

virtual FString	GetCPPType (FString *ExtendedTypeText=NULL, uint32 CPPExportFlags=0) const PURE_VIRTUAL(FProperty

virtual bool	Identical (const void A, const void B, uint32 PortFlags=0) const PURE_VIRTUAL(FProperty

virtual void SerializeItem(FStructuredArchive::FSlot Slot, void Value, void const Defaults=NULL) const PURE_VIRTUAL(FProperty virtual COREUOBJECT_API boo	NetSerializeItem )(FArchive &Ar, UPackageMap Map, void Data, TArray< uint8 > *MetaData=NULL) const

Public Attributes inherited from FField
FFieldVariant	Owner

FField *	Next

FName	NamePrivate

EObjectFlags	FlagsPrivate

Protected Member Functions
COREUOBJECT_API void	SetOffset_Internal (int32 NewOffset)

COREUOBJECT_API void	Init ()

virtual COREUOBJECT_API void	LinkInternal (FArchive &Ar)

void *	PointerToValuePtr (void const *ContainerOrPropertyPtr, EPropertyPointerType PropertyPointerType, int32 ArrayIndex=0) const

virtual COREUOBJECT_API void	CopyValuesInternal (void Dest, void const Src, int32 Count) const

virtual COREUOBJECT_API uint32	GetValueTypeHashInternal (const void *Src) const

virtual COREUOBJECT_API void	ClearValueInternal (void *Data) const

virtual COREUOBJECT_API void	DestroyValueInternal (void *Dest) const

virtual COREUOBJECT_API bool	ContainsClearOnFinishDestroyInternal (TArray< const FStructProperty * > &EncounteredStructProps) const

virtual COREUOBJECT_API void	FinishDestroyInternal (void *Data) const

virtual COREUOBJECT_API void	InitializeValueInternal (void *Dest) const

Protected Member Functions inherited from FField
void	SetFlagsTo (EObjectFlags NewFlags)

Protected Attributes
virtual void virtual ExportText_Internal(FString &ValueStr, const void PropertyValueOrContainer, EPropertyPointerType PointerType, const void DefaultValue, UObject Parent, int32 PortFlags, UObject ExportRootScope=nullptr) const PURE_VIRTUAL(FProperty const TCHAR	ImportText_Internal )(const TCHAR Buffer, void ContainerOrPropertyPtr, EPropertyPointerType PointerType, UObject OwnerObject, int32 PortFlags, FOutputDevice ErrorText) const PURE_VIRTUAL(FProperty

Friends
class	FMapProperty

class	UEProperty_Private::FProperty_DoNotUse

const TCHAR *	UE::CoreUObject::Private::ImportEnumFromBuffer (UEnum Enum, const FProperty PropertyToSet, const FNumericProperty UnderlyingProp, const TCHAR PropertyClassName, const TCHAR Buffer, void ContainerOrPropertyPtr, EPropertyPointerType PropertyPointerType, FOutputDevice *ErrorText)

void	UE::CoreUObject::Private::ExportEnumToBuffer (const UEnum Enum, const FProperty Prop, const FNumericProperty NumericProp, FString &ValueStr, const void PropertyValueOrContainer, EPropertyPointerType PropertyPointerType, const void DefaultValue, UObject Parent, int32 PortFlags, UObject *ExportRootScope)

Additional Inherited Members
Public Types inherited from FField
typedef FField	Super

typedef FField	ThisClass

typedef FField	BaseFieldClass

typedef FFieldClass	FieldTypeClass

using	FLinkedListBuilder = TLinkedListBuilder< FField >

Detailed Description

Examples: /work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

Constructor & Destructor Documentation

◆ FProperty() [1/3]

FProperty::FProperty	(	FFieldVariant	InOwner,
		const FName &	InName,
		EObjectFlags	InObjectFlags
	)

◆ FProperty() [2/3]

FProperty::FProperty	(	FFieldVariant	InOwner,
		const UECodeGen_Private::FPropertyParamsBaseWithOffset &	Prop,
		EPropertyFlags	AdditionalPropertyFlags = `CPF_None`
	)

Constructor used for constructing compiled-in properties

Parameters

InOwner	Owner of the property
PropBase	Pointer to the compiled in structure describing the property

◆ FProperty() [3/3]

FProperty::FProperty	(	FFieldVariant	InOwner,
		const UECodeGen_Private::FPropertyParamsBaseWithoutOffset &	Prop,
		EPropertyFlags	AdditionalPropertyFlags = `CPF_None`
	)

Constructor used for constructing compiled-in properties

Parameters

InOwner	Owner of the property
PropBase	Pointer to the compiled in structure describing the property

Member Function Documentation

◆ AllocateAndInitializeValue()

void * FProperty::AllocateAndInitializeValue ( ) const

Allocates and initializes memory to hold a value this property represents

◆ CallGetter()

virtual void FProperty::CallGetter	(	const void *	Container,
		void *	OutValue
	)		const

inlinevirtual

Calls the native getter function for this property

Parameters

Container	Pointer to the owner of this property (either UObject or struct)
OutValue	Pointer to the value where the existing property value will be copied to

◆ CallSetter()

virtual void FProperty::CallSetter	(	void *	Container,
		const void *	InValue
	)		const

inlinevirtual

Calls the native setter function for this property

Parameters

Container	Pointer to the owner of this property (either UObject or struct)
InValue	Pointer to the new value

◆ CanSerializeFromTypeName()

bool FProperty::CanSerializeFromTypeName ( UE::FPropertyTypeName Type ) const

virtual

Returns true if the type of this property matches the type name.

Reimplemented in FEnumProperty, FOptionalProperty, FArrayProperty, FMapProperty, FSetProperty, and FStructProperty.

◆ ClearIntrusiveOptionalValue()

void FProperty::ClearIntrusiveOptionalValue ( void * Data ) const

virtual

Set the value to it's special unset state. Equivalent to TOptional<T>::Reset. Only valid to call if HasIntrusiveUnsetOptionalState returns true.

See also: operator=(FIntrusiveUnsetOptionalState)

Parameters

Data	Address of the alue, already offset.

◆ ClearPropertyFlags()

UE_FORCEINLINE_HINT void FProperty::ClearPropertyFlags ( EPropertyFlags NewFlags )

inline

◆ ClearValue()

void FProperty::ClearValue ( void * Data ) const

inline

Zeros the value for this property. The existing data is assumed valid (so for example this calls FString::Empty) This only does one item and not the entire fixed size array.

Parameters

Data	the address of the value for this property that should be cleared.

◆ ClearValue_InContainer()

void FProperty::ClearValue_InContainer	(	void *	Data,
		int32	ArrayIndex = `0`
	)		const

inline

Zeros the value for this property. The existing data is assumed valid (so for example this calls FString::Empty) This only does one item and not the entire fixed size array.

Parameters

Data	the address of the container of the value for this property that should be cleared.

◆ ClearValueInternal()

void FProperty::ClearValueInternal ( void * Data ) const

protectedvirtual

◆ ContainerPtrToValuePtr() [1/4]

template<typename ValueType >

UE_FORCEINLINE_HINT ValueType * FProperty::ContainerPtrToValuePtr	(	UObject *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

Get the pointer to property value in a supplied 'container'. You can only call this function on a UObject* or a uint8*. If the property you want is a 'top level' UObject property, you must call the function passing in a UObject* and not a uint8*. There are checks inside the function to vertify this.

Parameters

ContainerPtr	UObject* or uint8* to container of property value
ArrayIndex	In array case, index of array element we want

◆ ContainerPtrToValuePtr() [2/4]

template<typename ValueType >

UE_FORCEINLINE_HINT ValueType const * FProperty::ContainerPtrToValuePtr	(	UObject const *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

◆ ContainerPtrToValuePtr() [3/4]

template<typename ValueType >

UE_FORCEINLINE_HINT ValueType * FProperty::ContainerPtrToValuePtr	(	void *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

◆ ContainerPtrToValuePtr() [4/4]

template<typename ValueType >

UE_FORCEINLINE_HINT ValueType const * FProperty::ContainerPtrToValuePtr	(	void const *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

◆ ContainerPtrToValuePtrForDefaults() [1/4]

template<typename ValueType >

const ValueType * FProperty::ContainerPtrToValuePtrForDefaults	(	const UStruct *	ContainerClass,
		const UObject *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

◆ ContainerPtrToValuePtrForDefaults() [2/4]

template<typename ValueType >

const ValueType * FProperty::ContainerPtrToValuePtrForDefaults	(	const UStruct *	ContainerClass,
		const void *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

◆ ContainerPtrToValuePtrForDefaults() [3/4]

template<typename ValueType >

ValueType * FProperty::ContainerPtrToValuePtrForDefaults	(	const UStruct *	ContainerClass,
		UObject *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

◆ ContainerPtrToValuePtrForDefaults() [4/4]

template<typename ValueType >

ValueType * FProperty::ContainerPtrToValuePtrForDefaults	(	const UStruct *	ContainerClass,
		void *	ContainerPtr,
		int32	ArrayIndex = `0`
	)		const

inline

◆ ContainsClearOnFinishDestroyInternal()

bool FProperty::ContainsClearOnFinishDestroyInternal ( TArray< const FStructProperty * > & EncounteredStructProps ) const

protectedvirtual

Reimplemented in FOptionalProperty, FArrayProperty, FMapProperty, FSetProperty, and FStructProperty.

◆ ContainsFinishDestroy()

bool FProperty::ContainsFinishDestroy ( TArray< const FStructProperty * > & EncounteredStructProps ) const

inline

Returns true if the property or any of the child properties should be cleared on FinishDestroy.

◆ ContainsInstancedObjectProperty()

UE_FORCEINLINE_HINT bool FProperty::ContainsInstancedObjectProperty ( ) const

inline

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

Returns: true if property (or sub- properties) contain a FObjectProperty that is marked CPF_NeedCtorLink, false otherwise

◆ ContainsObjectReference()

bool FProperty::ContainsObjectReference	(	TArray< const FStructProperty * > &	EncounteredStructProps,
		EPropertyObjectReferenceType	InReferenceType = `EPropertyObjectReferenceType::Strong`
	)		const

virtual

Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a UObject reference.

Parameters

EncounteredStructProps	used to check for recursion in arrays
InReferenceType	type of object reference (strong / weak)

Returns: true if property (or sub- properties) contains the specified type of UObject reference, false otherwise

Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a UObject reference.

Returns: true if property (or sub- properties) contain a UObject reference, false otherwise

Reimplemented in FFieldPathProperty, FOptionalProperty, TFObjectPropertyBase< InTCppType >, FInterfaceProperty, FArrayProperty, FMapProperty, FSetProperty, FStructProperty, FDelegateProperty, FMulticastDelegateProperty, and FVerseDynamicProperty.

◆ ContainsWeakObjectReference()

bool FProperty::ContainsWeakObjectReference ( ) const

inline

Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a weak UObject reference.

Returns: true if property (or sub- properties) contain a weak UObject reference, false otherwise

◆ ConvertFromType()

EConvertFromTypeResult FProperty::ConvertFromType	(	const FPropertyTag &	Tag,
		FStructuredArchive::FSlot	Slot,
		uint8 *	Data,
		const UStruct *	DefaultsStruct,
		const uint8 *	Defaults
	)

virtual

Allows a property to implement backwards compatibility handling for tagged properties

Parameters

Tag	property tag of the loading data
Ar	the archive the data is being loaded from
Data	a pointer to the container to write the loaded data to
DefaultsStruct
Defaults	if available, a pointer to the container containing the default value for this property, or null

Returns: A state which tells the tagged property system how the property dealt with the data. Converted: the function handled conversion. CannotConvert: the tag is not something that the property can convert. Serialized: the function handled serialization without conversion. UseSerializeItem: no conversion was done on the property - this can mean that the tag is correct and normal serialization applies or that the tag is incompatible.

Reimplemented in FEnumProperty, FFieldPathProperty, FOptionalProperty, FTextProperty, FBoolProperty, FArrayProperty, FMapProperty, FSetProperty, FStructProperty, and FMulticastDelegateProperty.

◆ CopyCompleteValue()

void FProperty::CopyCompleteValue	(	void *	Dest,
		void const *	Src
	)		const

inline

Copy the value for all elements of this property.

Parameters

Dest	the address where the value should be copied to. This should always correspond to the BASE + OFFSET, where BASE = (for member properties) the address of the UObject which contains this data, (for locals/parameters) the address of the space allocated for the function's locals OFFSET = the Offset of this FProperty
Src	the address of the value to copy from. should be evaluated the same way as Dest
InstancingParams	contains information about instancing (if any) to perform

◆ CopyCompleteValue_InContainer()

UE_FORCEINLINE_HINT void FProperty::CopyCompleteValue_InContainer	(	void *	Dest,
		void const *	Src
	)		const

inline

◆ CopyCompleteValueFromScriptVM()

void FProperty::CopyCompleteValueFromScriptVM	(	void *	Dest,
		void const *	Src
	)		const

virtual

Copy the value for all elements of this property. From the script VM.

Parameters

Dest	the address where the value should be copied to. This should always correspond to the BASE + OFFSET, where BASE = (for member properties) the address of the UObject which contains this data, (for locals/parameters) the address of the space allocated for the function's locals OFFSET = the Offset of this FProperty
Src	the address of the value to copy from. should be evaluated the same way as Dest

◆ CopyCompleteValueFromScriptVM_InContainer()

void FProperty::CopyCompleteValueFromScriptVM_InContainer	(	void *	OutContainer,
		void const *	InValue
	)		const

virtual

◆ CopyCompleteValueToScriptVM()

void FProperty::CopyCompleteValueToScriptVM	(	void *	Dest,
		void const *	Src
	)		const

virtual

Copy the value for all elements of this property. To the script VM.

Parameters

Dest	the address where the value should be copied to. This should always correspond to the BASE + OFFSET, where BASE = (for member properties) the address of the UObject which contains this data, (for locals/parameters) the address of the space allocated for the function's locals OFFSET = the Offset of this FProperty
Src	the address of the value to copy from. should be evaluated the same way as Dest

◆ CopyCompleteValueToScriptVM_InContainer()

void FProperty::CopyCompleteValueToScriptVM_InContainer	(	void *	OutValue,
		void const *	InContainer
	)		const

virtual

Equivalent to the above functions, but using the container and aware of getters/setters when the container has them.

◆ CopySingleValue()

void FProperty::CopySingleValue	(	void *	Dest,
		void const *	Src
	)		const

inline

Copy the value for a single element of this property.

Parameters

Dest	the address where the value should be copied to. This should always correspond to the BASE + OFFSET + INDEX * SIZE, where BASE = (for member properties) the address of the UObject which contains this data, (for locals/parameters) the address of the space allocated for the function's locals OFFSET = the Offset of this FProperty INDEX = the index that you want to copy. for properties which are not arrays, this should always be 0 SIZE = the ElementSize of this FProperty
Src	the address of the value to copy from. should be evaluated the same way as Dest
InstancingParams	contains information about instancing (if any) to perform

◆ CopySingleValueFromScriptVM()

void FProperty::CopySingleValueFromScriptVM	(	void *	Dest,
		void const *	Src
	)		const

virtual

Copy the value for a single element of this property. From the script VM.

Parameters

Dest the address where the value should be copied to. This should always correspond to the BASE + OFFSET + INDEX * SIZE, where BASE = (for member properties) the address of the UObject which contains this data, (for locals/parameters) the address of the space allocated for the function's locals OFFSET = the Offset of this FProperty INDEX = the index that you want to copy. for properties which are not arrays, this should always be 0 SIZE = the ElementSize of this FProperty

Src the address of the value to copy from. should be evaluated the same way as Dest

◆ CopySingleValueToScriptVM()

void FProperty::CopySingleValueToScriptVM	(	void *	Dest,
		void const *	Src
	)		const

virtual

Copy the value for a single element of this property. To the script VM.

Parameters

Dest the address where the value should be copied to. This should always correspond to the BASE + OFFSET + INDEX * SIZE, where BASE = (for member properties) the address of the UObject which contains this data, (for locals/parameters) the address of the space allocated for the function's locals OFFSET = the Offset of this FProperty INDEX = the index that you want to copy. for properties which are not arrays, this should always be 0 SIZE = the ElementSize of this FProperty

Src the address of the value to copy from. should be evaluated the same way as Dest

◆ CopyValuesInternal()

void FProperty::CopyValuesInternal	(	void *	Dest,
		void const *	Src,
		int32	Count
	)		const

protectedvirtual

◆ DestroyAndFreeValue()

void FProperty::DestroyAndFreeValue ( void * InMemory ) const

Destroys and frees memory with a value this property represents

◆ DestroyValue()

void FProperty::DestroyValue ( void * Dest ) const

inline

Destroys the value for this property. The existing data is assumed valid (so for example this calls FString::Empty) This does the entire fixed size array.

Parameters

Dest	the address of the value for this property that should be destroyed.

◆ DestroyValue_InContainer()

void FProperty::DestroyValue_InContainer ( void * Dest ) const

inline

Destroys the value for this property. The existing data is assumed valid (so for example this calls FString::Empty) This does the entire fixed size array.

Parameters

Dest	the address of the container containing the value that should be destroyed.

◆ DestroyValueInternal()

void FProperty::DestroyValueInternal ( void * Dest ) const

protectedvirtual

◆ EmitIntrusiveOptionalReferenceInfo()

void FProperty::EmitIntrusiveOptionalReferenceInfo	(	UE::GC::FSchemaBuilder &	Schema,
		int32	BaseOffset,
		TArray< const FStructProperty * > &	EncounteredStructProps,
		UE::GC::FPropertyStack &	DebugPath
	)

virtual

For properties returning true from HasIntrusiveUnsetOptionalState which also contain object references, emit information for the garbage collector to safely gather the references from the value whether the optional value is set or unset.

Reimplemented in FArrayProperty, FMapProperty, FSetProperty, and FStructProperty.

◆ EmitReferenceInfo()

void FProperty::EmitReferenceInfo	(	UE::GC::FSchemaBuilder &	Schema,
		int32	BaseOffset,
		TArray< const FStructProperty * > &	EncounteredStructProps,
		UE::GC::FPropertyStack &	DebugPath
	)

virtual

Emits tokens used by realtime garbage collection code to passed in ReferenceTokenStream. The offset emitted is relative to the passed in BaseOffset which is used by e.g. arrays of structs.

Reimplemented in FFieldPathProperty, FOptionalProperty, FInterfaceProperty, FArrayProperty, FMapProperty, FSetProperty, FStructProperty, and FVerseDynamicProperty.

◆ ExportText_Direct()

bool FProperty::ExportText_Direct	(	FString &	ValueStr,
		const void *	Data,
		const void *	Delta,
		UObject *	Parent,
		int32	PortFlags,
		UObject *	ExportRootScope = `nullptr`
	)		const

◆ ExportText_InContainer()

UE_FORCEINLINE_HINT bool FProperty::ExportText_InContainer	(	int32	Index,
		FString &	ValueStr,
		const void *	Data,
		const void *	Delta,
		UObject *	Parent,
		int32	PortFlags,
		UObject *	ExportRootScope = `nullptr`
	)		const

inline

◆ ExportTextItem_Direct()

void FProperty::ExportTextItem_Direct	(	FString &	ValueStr,
		const void *	PropertyValue,
		const void *	DefaultValue,
		UObject *	Parent,
		int32	PortFlags,
		UObject *	ExportRootScope = `nullptr`
	)		const

inline

◆ ExportTextItem_InContainer()

void FProperty::ExportTextItem_InContainer	(	FString &	ValueStr,
		const void *	Container,
		const void *	DefaultValue,
		UObject *	Parent,
		int32	PortFlags,
		UObject *	ExportRootScope = `nullptr`
	)		const

inline

◆ FindRedirectedPropertyName()

FName FProperty::FindRedirectedPropertyName	(	const UStruct *	ObjectStruct,
		FName	OldName
	)

static

Gets a redirected property name, will return NAME_None if no redirection was found

◆ FinishDestroy()

void FProperty::FinishDestroy ( void * Data ) const

inline

Applies appropriate finish destroy actions for the property if needed. This is used during UObject destruction to e.g. safely clear values which rely on UScriptStructs. This does the entire fixed size array.

Parameters

Data	the address of the value for this property that should be handled for finish destroy.

◆ FinishDestroy_InContainer()

void FProperty::FinishDestroy_InContainer ( void * Data ) const

inline

Applies appropriate finish destroy actions for the property if needed. This is used during UObject destruction to e.g. safely clear values which rely on UScriptStructs. This does the entire fixed size array.

Parameters

Data	the address of the container containing the value that should be handled for finish destroy.

◆ FinishDestroyInternal()

void FProperty::FinishDestroyInternal ( void * Data ) const

protectedvirtual

Reimplemented in FOptionalProperty, FArrayProperty, FMapProperty, FSetProperty, and FStructProperty.

◆ GetBlueprintReplicationCondition()

ELifetimeCondition FProperty::GetBlueprintReplicationCondition ( ) const

inline

◆ GetCPPMacroType()

FString FProperty::GetCPPMacroType ( FString & ExtendedTypeText ) const

virtual

Reimplemented in FEnumProperty, FFieldPathProperty, FOptionalProperty, FBoolProperty, FInterfaceProperty, FArrayProperty, FMapProperty, FSetProperty, FStructProperty, and FVerseDynamicProperty.

◆ GetElementSize()

int32 FProperty::GetElementSize ( ) const

inline

◆ GetID()

FName FProperty::GetID ( ) const

virtual

Reimplemented in FObjectPropertyBase.

◆ GetMinAlignment()

int32 FProperty::GetMinAlignment ( ) const

virtual

◆ GetNameCPP()

FString FProperty::GetNameCPP ( ) const

Returns the C++ name of the property, including the _DEPRECATED suffix if the property is deprecated.

Returns: C++ name of property