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

Light Theme

Dark Theme

FRCPropertyVariant

Container that can hold either a PropertyHandle, or Property/Data pair.

Windows

MacOS

Linux

References

Module	RemoteControlCommon
Header	/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlCommon/Public/RCPropertyUtilities.h
Include	#include "RCPropertyUtilities.h"

Syntax

class FRCPropertyVariant

Remarks

Container that can hold either a PropertyHandle, or Property/Data pair. Similar to FFieldVariant

Constructors

	Name	Description
	FRCPropertyVariant()
	FRCPropertyVariant ( const TSharedPtr< IPropertyHandle >... )	Construct from an IPropertyHandle.
	FRCPropertyVariant ( const FProperty* InProperty, const void* InPropertyData, const int32& InNumElements )	Construct from a Property, PropertyData ptr, and the expected element count (needed for arrays, strings, etc.).
	FRCPropertyVariant ( const FProperty* InProperty, TArray< uint8 >& InPropertyData, const int32& InNumElements )	Construct from a Property and backing data array. Preferred over a raw ptr.

Destructors

	Name	Description
	~FRCPropertyVariant()

Functions

	Name	Description
int32	GetElementSize()	Gets individual element size (for arrays, etc.).
PropertyType...	GetProperty()	Gets the typed property, returns nullptr if not cast.
FProperty &#...	GetProperty()	Gets the property.
TArray< uint...	GetPropertyContainer()	Gets the property container (byte array), if available.
void *	GetPropertyData ( const FProperty* InContainer, int32 InIdx )	Gets the data pointer
FString *...	GetPropertyValue ( const FProperty* InContainer, int32 InIdx )
ValueType &#...	GetPropertyValue ( const FProperty* InContainer, int32 InIdx )	Returns the data as the ValueType.
void	InferNum ( const FRCPropertyVariant* InOt... )	Calculate number of elements based on available info.
void	Init ( int32 InSize )	Initialize/allocate if necessary.
bool	IsHandle()	Is this backed by an IPropertyHandle?
int32	Num()	Gets the number of elements, more than 1 if an array.
int32	Size()	Gets the size of the underlying data.

Operators

		Name	Description
	bool	operator!= ( const FRCPropertyVariant& InOther )
	bool	operator== ( const FRCPropertyVariant& InOther )	Comparison is by property, not by property instance value.

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

Take our survey

Dismiss