FRemoteControlProperty

Represents a property exposed to remote control.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

RemoteControl

Header

/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlField.h

Include

#include "RemoteControlField.h"

Syntax

USTRUCT(BlueprintType)
struct FRemoteControlProperty : public FRemoteControlField

Remarks

Represents a property exposed to remote control.

Constructors

Name Description

Public function

FRemoteControlProperty()

Public function

FRemoteControlProperty

(
    FName InLabel,
    FRCFieldPathInfo FieldPathInfo,
    TArray< FString > InComponentHierar...
)

This constructor is deprecated. Use the other constructor.

Public function

FRemoteControlProperty

(
    URemoteControlPreset* InPreset,
    FName InLabel,
    FRCFieldPathInfo InFieldPathInfo,
    const TArray< URemoteControlBinding...
)

Functions

Name Description

Public function Virtual Const

bool

 

CheckIsBoundToPropertyPath

(
    const FString& InPropertyPath
)

Check whether given property path is bound to the property

Public function Virtual Const

bool

 

ContainsBoundObjects

(
    TArray< UObject* > InObjects
)

Check whether any of the given objects are bound to this property

Public function

void

 

EnableEditCondition()

Enable the edit condition for the underlying property on the owner objects.

Public function Const

FProperty &#...

 

GetProperty()

Get the underlying property.

Public function Const

TSharedPtr< ...

 

GetPropertyHandle()

Get the property handle with ability set and get property value directly.

Public function Const

bool

 

IsEditableInPackaged()

Returns whether the property is editable in a packaged build.

Public function Virtual

void

 

OnObjectPropertyChanged

(
    UObject* InObject,
    FPropertyChangedEvent& InEvent
)

Should be called when property chanced on bound object

Public function Virtual

void

 

PostLoad()

Called on Post Load on Owner UObject.

Public function

void

 

PostSerialize

(
    const FArchive& Ar
)

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Overridden from FRemoteControlEntity

Name Description

Public function Virtual Const

UClass *

 

GetSupportedBindingClass()

Get the class of the object that can hold this field.

Public function Virtual Const

uint32

 

GetUnderlyingEntityIdentifier()

Get an identifier for the underlying entity.

Public function Virtual Const

bool

 

IsBound()

Returns whether this entity can be resolved using its bound objects.

Constants

Name

Description

MetadataKey_Max

Key for the metadata's Max entry.

MetadataKey_Min

Key for the metadata's Min entry.

Deprecated Functions

Name Description

Public function

 

FRemoteControlProperty

(
    FName InLabel,
    FRCFieldPathInfo FieldPathInfo,
    TArray< FString > InComponentHierar...
)

This constructor is deprecated. Use the other constructor.