1. Epic GamesDeveloper
  3. FRemoteControlField

FRemoteControlField

Represents a property or function that has been exposed to remote control.

API > API/Plugins > API/Plugins/RemoteControl

Inheritance Hierarchy

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FRemoteControlField : public FRemoteControlEntity

Remarks

Represents a property or function that has been exposed to remote control.

Variables

  Type Name Description
Protected variable UProperty uint8 ActiveMasks Holds the actively enabled masks.
Protected variable UProperty bool bIsEditorOnly Whether the field is only available in editor.
Public variable UProperty Category BlueprintReadOnly visibleanywhere FName FieldName The exposed field's name.
Public variable UProperty FRCFieldPathInfo FieldPathInfo Path information pointing to this field
Public variable UProperty Category BlueprintReadOnly visibleanywhere EExposedFieldType FieldType The field's type.
Protected variable UProperty FSoftClassPath OwnerClass The class of the object that can have this field.
Public variable UProperty TSet< FRemoteControlProtocolBinding > ProtocolBindings Stores the bound protocols for this exposed field It could store any types of the implemented protocols such as DMX, OSC, MIDI, etc The map holds protocol bindings stores the protocol mapping and protocol-specific mapping

Constructors

  Type Name Description
Public function    
Protected function  

FRemoteControlField ( URemoteControlPreset* InPreset,
EExposedFieldType InType,
FName InLabel,
FRCFieldPathInfo InFieldPathInfo,
const TArray< URemoteControlBinding* > InBindings
)

  

Functions

  Type Name Description
Public function Virtual void

ClearMask ( ERCMask InMaskBit
)

 Disables the given mask.
Public function Virtual void

EnableMask ( ERCMask InMaskBit
)

 Enables the given mask.
Public function Const ERCMask Retrieves the enabled masks.
Public function Virtual Const bool

HasMask ( ERCMask InMaskBit
)

 Returns true if the given mask is enabled, false otherwise.
Public function Const bool Returns whether the field is only available in editor.
Protected function void

PostSerialize ( const FArchive& Ar
)

  
Public function Virtual Const bool Returns true if this field supports masking.

Overridden from FRemoteControlEntity

  Type Name Description
Public function Virtual void

BindObject ( UObject* InObjectToBind
)

 Change the object this exposed entity is currently pointing to.
Public function Virtual Const bool

CanBindObject ( const UObject* InObjectToBind
)

 Return whether this entity supports binding to a given object.

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< FString > ComponentHierarchy_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function Const TArray< UObject * >

ResolveFieldOwners ( const TArray< UObject* >& SectionObjects
)

 Please use GetBoundObjects.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page