1. Epic GamesDeveloper
  3. UPropertyValue

UPropertyValue

Unreal Engine C++ API Reference > Plugins > VariantManagerContent

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType&41;  
class UPropertyValue : public UObject

Variables

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

Constructors

  Type Name Description
Public function  

UPropertyValue ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void Applies our recorded data to the PropertyValuePtr for the resolved object.
Protected function Virtual 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)
Public function void  
Public function void Tries to resolve the property value on the passed object, or the parent binding's bound object if the argument is nullptr.
Public function Virtual Const bool

ContainsProperty ( const FProperty* Prop
)

  
Public function Const const TArray< FCapturedPropSegment > & Returns an array of link segments that together describe the full property path.
Public function Virtual Const TArray< uint8 > Fetches the value bytes for this property from the resolved object.
Public function Virtual const TArray< uint8 > &  
Public function Const uint32 Get the order with which the VariantManager should display this in a property list.
Public function FString  
Public function Const UEnum *  
Public function Const UFunction BlueprintCallable, Category const FString &  
Public function Const FString  
Public function Const const FName & Utility functions for string properties.
Public function Virtual Const UClass *  
Public function FOnPropertyApplied &  
Public function FOnPropertyRecorded &  
Public function Const UVariantObjectBinding *  
Public function Const EPropertyValueCategory  
Protected function Const FProperty *  
Public function Virtual Const FFieldClass * 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
Public function Const FName  
Public function Const int32  
Public function Const void *  
Public function Virtual Const UStruct *  
Public function uint32 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
Public function Const UFunction BlueprintCallable, Category FText  
Public function const TArray< uint8 > &  
Public function int32 Used RecordedData as an enum value and gets the corresponding index for our Enum.
Public function Const const FString &  
Public function Virtual Const UScriptStruct *  
Public function Const const FText &  
Public function TArray< FName > Utility functions for UEnumProperties.
Public function Virtual Const int32  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const bool Tries to resolve the property value on the passed object, or the parent binding's bound object if the argument is nullptr.
Public function void

Init ( const TArray< FCapturedPropSegment >& InCapturedPropSegments,
FFieldClass* InLeafPropertyClass,
const FString& InFullDisplayString,
const FName& InPropertySetterName,
EPropertyValueCategory InCategory
)

  
Public function bool  
Public function bool  
Public function bool  
Public function Virtual bool Returns true if our recorded data would remain the same if we called RecordDataFromResolvedObject right now
Protected function void

OnPIEEnded ( const bool bIsSimulatingInEditor
)

  
Public function Virtual void Uses GetDataFromResolvedObject to update our recorded data.
Public function Virtual 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.
Protected function bool

ResolvePropertiesRecursive ( UStruct* ContainerClass,
void* ContainerAddress,
int32 PropertyIndex
)

  
Protected function bool

ResolveUSCSNodeRecursive ( const USCS_Node* Node,
int32 SegmentIndex
)

 Recursively navigate the component/USCS_Node hierarchy trying to resolve our property path.
Public function void Makes sure RecordedData data is a valid Enum index for our Enum (_MAX is not allowed)
Public function void

SetDisplayOrder ( uint32 InDisplayOrder
)

 Set the order with which the VariantManager should display this in a property list.
Public function Virtual void

SetRecordedData ( const uint8* NewDataBytes,
int32 NumBytes,
int32 Offset
)

  
Public function void Sets our RecordedData with the value that matches Index, for our Enum.
Protected function void

SetRecordedDataInternal ( const uint8* NewDataBytes,
int32 NumBytes,
int32 Offset
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Protected variable UProperty TObjectPtr< 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)
Protected variable UProperty TArray< TFieldPath< FProperty > > Properties_DEPRECATED Properties were previously stored like this.
Protected variable UProperty TArray< int32 > PropertyIndices_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page