FRemoteControlTarget

Represents objects grouped under a single alias that contain exposed functions and properties.

Windows
MacOS
Linux

References

Module

RemoteControl

Header

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

Include

#include "RemoteControlPreset.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FRemoteControlTarget

Remarks

Represents objects grouped under a single alias that contain exposed functions and properties.

Variables

Name Description

Public variable UProperty

FName

 

Alias

The alias for this target.

Public variable UProperty

UClass *

 

Class

The common class of the target's underlying objects.

Public variable UProperty

TSet< FRemoteCo...

 

ExposedFunctions

The target's exposed functions.

Public variable UProperty

TSet< FRemoteCo...

 

ExposedProperties

The target's exposed properties.

Constructors

Functions

Name Description

Public function

void

 

BindObjects

(
    const TArray< UObject* >& Obj...
)

Adds objects to the target's underlying objects, binding them to the target's alias.

Public function Const

bool

 

CanBindObjects

(
    const TArray< UObject* >& Obj...
)

Returns whether the provided list of objects can be bound under this target.

Public function

TOptional< F...

 

ExposeFunction

(
    FString RelativeFieldPath,
    const FString& DesiredDisplayName,
    FGuid GroupId,
    bool bAppendAliasToLabel
)

Expose a function in this target.

Public function

TOptional< F...

 

ExposeProperty

(
    FRCFieldPathInfo FieldPathInfo,
    const FString& DesiredDisplayName,
    FGuid GroupId,
    bool bAppendAliasToLabel
)

Expose a property in this target.

Public function Const

FName

 

FindFieldLabel

(
    const FRCFieldPathInfo& Path
)

Find a field label using a a field path info.

Public function Const

FName

 

FindFieldLabel

(
    FName FieldName
)

Find a field label using a property name.

Public function Const

TOptional< F...

 

GetFunction

(
    FGuid FunctionId
)

Get an exposed function using it's name.

Public function Const

TOptional< F...

 

GetProperty

(
    FGuid PropertyId
)

Get a property using its label.

Public function Const

bool

 

HasBoundObject

(
    const UObject* ObjectToTest
)

Verifies if an object is bound under this target's alias.

Public function Const

bool

 

HasBoundObjects

(
    const TArray< UObject* >& Obj...
)

Verifies if the list of objects provided is bound under this target's alias.

Public function Const

TArray< UObj...

 

ResolveBoundObjects()

Resolve the target bindings to return the target's underlying objects.

Public function Const

TOptional< F...

 

ResolveExposedFunction

(
    FGuid FunctionId
)

Resolve a remote controlled function to its UFunction and owner objects.

Public function Const

TOptional< F...

 

ResolveExposedProperty

(
    FGuid PropertyId
)

Resolve a remote controlled property to its FProperty and owner objects.

Public function

void

 

Unexpose

(
    FGuid TargetFieldId
)

Unexpose a field from this target.

Deprecated Functions

Name Description

Public function

TOptional< F...

 

ExposeProperty

(
    FRCFieldPathInfo FieldPathInfo,
    TArray< FString > ComponentHierarch...,
    const FString& DesiredDisplayName,
    FGuid GroupId
)

A component hierarchy is no longer needed to expose properties, use the overloaded function instead.

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