1. Epic GamesDeveloper
  3. URCVirtualPropertyBase

URCVirtualPropertyBase

Base class for dynamic virtual properties Remote Control Virtual Properties using Property Bag and [FInstancedPropertyBag](API\Plugins\StructUtils\FInstancedPropertyBag) to serialize FProperties values and [UStruct](API\Runtime\CoreUObject\UObject\UStruct)

API > API/Plugins > API/Plugins/RemoteControl

Inheritance Hierarchy

References

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

Syntax

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

Remarks

Base class for dynamic virtual properties Remote Control Virtual Properties using Property Bag and FInstancedPropertyBag to serialize FProperties values and UStruct

Variables

  Type Name Description
Public variable UProperty int32 DisplayIndex User configurable Display Index for this Virtual Property (as Logic Controller) when represented as a row in the RC Logic Controllers list
Public variable UProperty FName DisplayName User friendly name of the Controller
Public variable UProperty FName FieldId Property Field Id
Public variable UProperty FGuid Id Property Id
Public variable UProperty TMap< FName, FString > Metadata  
Public variable UProperty TWeakObjectPtr< URemoteControlPreset > PresetWeakPtr Pointer to Remote Control Preset
Public variable UProperty FName PropertyName Unique property name

Functions

  Type Name Description
Public function bool

CopyCompleteValue ( const FProperty* InTargetProperty,
uint8* InTargetValuePtr
)

 Copy this virtual property's data onto a given FProperty
Public function bool

CopyCompleteValue ( URCVirtualPropertyBase* InVirtualProperty
)

 Copy this virtual property's data onto a given Virtual Property
Public function bool Deserialize Virtual Property from a given Backend
Protected function Virtual Const const FPropertyBagPropertyDesc * Return Pointer to Bag Property Description
Protected function Virtual uint8 * Return pointer to memory container
Protected function Virtual Const const uint8 * Return pointer to memory const container
Public function Const UFunction BlueprintCallable, Category FString Infers correct type internally, fetches value from memory and returns the value as a string that can be immediately used for dispaly (without needing to create a generic readonly property widget)
Public function Const FString Get Metadata from the internal PropertyBag
Public function Virtual FProperty * Returns FProperty for this RC virtual property
Public function Virtual Const const FProperty * Returns const FProperty for this RC virtual property
Protected function Virtual Const const FInstancedPropertyBag * Pointer to Instanced property which is holds bag of properties
Public function Const UFunction BlueprintPure, Category FName Get FProperty Name
Public function Const UFunction BlueprintCallable, Category bool

GetValueBool ( bool& OutBoolValue
)

 Get Bool value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueByte ( uint8& OutByte
)

 Get Byte value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueColor ( FColor& OutColor
)

 Get Color value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueDouble ( double& OutDouble
)

 Get Double value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueFloat ( float& OutFloat
)

 Get Float value from Virtual Property
Public function Const UFunction bool

GetValueInt16 ( int16& OutInt16
)

 Get Int16 value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueInt32 ( int32& OutInt32
)

 Get Int32 value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueInt64 ( int64& OuyInt64
)

 Get Int64 value from Virtual Property
Public function Const UFunction bool

GetValueInt8 ( int8& OutInt8
)

 Get Int8 value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueName ( FName& OutNameValue
)

 Get Name value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueNumericInteger ( int64& OutInt64Value
)

 Get Numeric value from Virtual Property
Public function Const UFunction BlueprintCallable, Category UObject * Get Object value from Virtual Property
Protected function Virtual Const const uint8 * Return pointer to const value
Protected function Virtual uint8 * Return pointer to value
Public function Const UFunction BlueprintCallable, Category bool

GetValueRotator ( FRotator& OutRotator
)

 Get Rotator value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueString ( FString& OutStringValue
)

 Get String value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueText ( FText& OutTextValue
)

 Get Text value from Virtual Property
Public function Const EPropertyBagPropertyType Return property bag property type
Public function Const const UObject * Return pointer to object that defines the Enum, Struct, or Class.
Public function Const UFunction bool

GetValueUint16 ( uint16& OutUInt16
)

 Get Uint16 value from Virtual Property
Public function Const UFunction bool

GetValueUInt32 ( uint32& OutUInt32
)

 Get Uint32 value from Virtual Property
Public function Const UFunction bool

GetValueUint64 ( uint64& OuyUInt64
)

 Get Uint64 value from Virtual Property
Public function Const UFunction BlueprintCallable, Category bool

GetValueVector ( FVector& OutVector
)

 Get Vector value from Virtual Property
Public function Static FName

GetVirtualPropertyTypeDisplayName ( const EPropertyBagPropertyType InValueType,
UObject* InValueTypeObject
)

 Fetches a user-friendly representation of the Virtual Property's type name (i.e. Controller type), given a Property Bag type and value object (for structures)
Public function Virtual void

Init ()

 Initialization routine. Called after the parent container has setup data for this property
Public function Const bool Whether this Virtual Property represents an FColor
Public function Const bool Whether this Virtual Property is a numeric type, i.e. an Integral or Floating point type
Public function Const bool Whether this Virtual Property represents an FRotator
Public function Const bool

IsValueEqual ( URCVirtualPropertyBase* InVirtualProperty
)

 Compare this virtual property value with given property value
Public function Const bool Operator > comparison of self with a given virtual property
Public function Const bool Operator >= comparison of self with a given virtual property
Public function Const bool

IsValueLesserThan ( URCVirtualPropertyBase* InVirtualProperty
)

 Operator < comparison of self with a given virtual property
Public function Const bool Operator <= comparison of self with a given virtual property
Public function Const bool Whether this Virtual Property represents an FVector
Protected function Virtual void Notifies post change for Virtual Property value
Protected function Virtual void Notifies pre change for Virtual Property value
Public function void Remove Metadata from the internal PropertyBag
Public function void Serialize Virtual Property to given Backend
Public function void

SetDisplayIndex ( const int32 InDisplayIndex
)

 Updates the display index of the virtual property (transaction aware)
Public function void Add/Set Metadata into the internal PropertyBag
Public function UFunction BlueprintCallable, Category bool

SetValueBool ( const bool InBoolValue
)

 Set Bool value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueByte ( const uint8 InByte
)

 Set Byte value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueColor ( const FColor& InColor
)

 Set Color value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueDouble ( const double InDouble
)

 Set Double value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueFloat ( const float InFloat
)

 Set Float value from Virtual Property
Public function UFunction bool

SetValueInt16 ( const int16 InInt16
)

 Set Int16 value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueInt32 ( const int32 InInt32
)

 Set Int32 value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueInt64 ( const int64 InInt64
)

 Set Int64 value from Virtual Property
Public function UFunction bool

SetValueInt8 ( const int8 InInt8
)

 Set Int8 value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueName ( const FName& InNameValue
)

 Set Name value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueNumericInteger ( const int64 InInt64Value
)

 Set Numeric value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueRotator ( const FRotator& InRotator
)

 Set Rotator value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueString ( const FString& InStringValue
)

 Set String value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueText ( const FText& InTextValue
)

 Set Text value from Virtual Property
Public function UFunction bool

SetValueUint16 ( const uint16 InUInt16
)

 Set Uint16 value from Virtual Property
Public function UFunction bool

SetValueUInt32 ( const uint32 InUInt32
)

 Set Uint32 value from Virtual Property
Public function UFunction bool

SetValueUint64 ( const uint64 InUInt64
)

 Set Uint64 value from Virtual Property
Public function UFunction BlueprintCallable, Category bool

SetValueVector ( const FVector& InVector
)

 Set Vector value from Virtual Property

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page