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 > Plugins > VariantManagerContent > UPropertyValue

Light Theme

Dark Theme

UPropertyValue

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UPropertyValue

	UPropertyValueColor
	UPropertyValueMaterial
	UPropertyValueOption
	UPropertyValueSoftObject
	UPropertyValueTransform
	UPropertyValueVisibility

References

Module	VariantManagerContent
Header	/Engine/Plugins/Enterprise/VariantManagerContent/Source/VariantManagerContent/Public/PropertyValue.h
Include	#include "PropertyValue.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UPropertyValue : public UObject

Variables

	Name	Description
bool	bHasRecordedData
TArray< FCaptur...	CapturedPropSegments
TArray< uint8 >	DefaultValue
uint32	DisplayOrder
FString	FullDisplayString
FProperty *	LeafProperty	Temp data cached from last resolve.
FFieldClass ...	LeafPropertyClass
FOnPropertyAppl...	OnPropertyApplied
FOnPropertyReco...	OnPropertyRecorded
void *	ParentContainerAddress
UStruct *	ParentContainerClass
UObject *	ParentContainerObject
EPropertyValueC...	PropCategory
UFunction *	PropertySetter
FName	PropertySetterName
TMap< FString, ...	PropertySetterParameterDefaults
uint8 *	PropertyValuePtr
FName	TempName
TSoftObjectPtr<...	TempObjPtr
FString	TempStr
FText	TempText
TArray< uint8 >	ValueBytes

Constructors

	Name	Description
	UPropertyValue ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	ApplyDataToResolvedObject()	Applies our recorded data to the PropertyValuePtr for the resolved object.
void	ApplyViaFunctionSetter ( UObject* TargetObject )	Applies the recorded data to the TargetObject via the PropertySetter function (e.g. SetIntensity instead of setting the Intensity UPROPERTY directly)
void	ClearDefaultValue()
void	ClearLastResolve()	Tries to resolve the property value on the passed object, or the parent binding's bound object if the argument is nullptr.
bool	ContainsProperty ( const FProperty* Prop )
TArray< uint...	GetDataFromResolvedObject()	Fetches the value bytes for this property from the resolved object.
const TArray...	GetDefaultValue()
uint32	GetDisplayOrder()	Get the order with which the VariantManager should display this in a property list.
FString	GetEnumDocumentationLink()
UEnum *	GetEnumPropertyEnum()
const FStrin...	GetFullDisplayString()
FString	GetLeafDisplayString()
const FName ...	GetNamePropertyName()	Utility functions for string properties.
UClass *	GetObjectPropertyObjectClass()
FOnPropertyA...	GetOnPropertyApplied()
FOnPropertyR...	GetOnPropertyRecorded()
UVariantObje...	GetParent()
EPropertyVal...	GetPropCategory()
FProperty &#...	GetProperty()
FFieldClass ...	GetPropertyClass()	Returns the type of FProperty (FObjectProperty, FFloatProperty, etc) If checking for Enums, prefer checking if GetEnumPropertyEnum() != nullptr, as it may be that we received a FNumericProperty that actually represents an enum, which wouldn't be reflected here
FName	GetPropertyName()
int32	GetPropertyOffsetInBytes()
void *	GetPropertyParentContainerAddress()
UStruct *...	GetPropertyParentContainerClass()
uint32	GetPropertyPathHash()	Combined hash of this property and its indices We don't use GetTypeHash for this because almost always we want to hash UPropertyValues by the pointer instead, for complete uniqueness even with the same propertypath This is mostly just used for grouping UPropertyValues together for editing multiple at once
FText	GetPropertyTooltip()
const TArray...	GetRecordedData()
int32	GetRecordedDataAsEnumIndex()	Used RecordedData as an enum value and gets the corresponding index for our Enum.
const FStrin...	GetStrPropertyString()
UScriptStruc...	GetStructPropertyStruct()
const FText ...	GetTextPropertyText()
TArray< FNam...	GetValidEnumsFromPropertyOverride()	Utility functions for UEnumProperties.
int32	GetValueSizeInBytes()
bool	HasRecordedData()
bool	HasValidResolve()	Tries to resolve the property value on the passed object, or the parent binding's bound object if the argument is nullptr.
void	Init ( const TArray< FCapturedPropSegment ..., FFieldClass* InLeafPropertyCla..., const FString& InFullDisplayString, const FName& InPropertySetterName, EPropertyValueCategory InCategory )
bool	IsNumericPropertyFloatingPoint()
bool	IsNumericPropertySigned()
bool	IsNumericPropertyUnsigned()
bool	IsRecordedDataCurrent()	Returns true if our recorded data would remain the same if we called RecordDataFromResolvedObject right now
void	RecordDataFromResolvedObject()	Uses GetDataFromResolvedObject to update our recorded data.
bool	Resolve ( UObject* OnObject )	Tries to resolve the property value on the passed object, or the parent binding's bound object if the argument is nullptr.
bool	ResolvePropertiesRecursive ( UStruct* ContainerClass, void* ContainerAddress, int32 PropertyIndex )
bool	ResolveUSCSNodeRecursive ( const USCS_Node* Node, int32 SegmentIndex )	Recursively navigate the component/USCS_Node hierarchy trying to resolve our property path.
void	SanitizeRecordedEnumData()	Makes sure RecordedData data is a valid Enum index for our Enum (_MAX is not allowed)
void	SetDisplayOrder ( uint32 InDisplayOrder )	Set the order with which the VariantManager should display this in a property list.
void	SetRecordedData ( const uint8* NewDataBytes, int32 NumBytes, int32 Offset )
void	SetRecordedDataFromEnumIndex ( int32 Index )	Sets our RecordedData with the value that matches Index, for our Enum.
void	SetRecordedDataInternal ( const uint8* NewDataBytes, int32 NumBytes, int32 Offset )

Overridden from UObject

		Name	Description
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

	Name	Description
UClass *	LeafPropertyClass_DEPRECATED	We use these mainly to know how to serialize/deserialize the values of properties that need special care (e.g. UObjectProperties, name properties, text properties, etc)
TArray< TFieldP...	Properties_DEPRECATED	Properties were previously stored like this.
TArray< int32 >	PropertyIndices_DEPRECATED

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

Take our survey

Dismiss