Navigation
API > API/Plugins > API/Plugins/RemoteControl
Represents a property or function that has been exposed to remote control.
| Name | FRemoteControlField |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlField.h |
| Include Path | #include "RemoteControlField.h" |
Syntax
USTRUCT (BlueprintType )
struct FRemoteControlField : public FRemoteControlEntity
Inheritance Hierarchy
- FRemoteControlEntity → FRemoteControlField
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRemoteControlField
(
URemoteControlPreset* InPreset, |
RemoteControlField.h | ||
| RemoteControlField.h | |||
PRAGMA_DISABLE_DEPRECATION_WARNINGS FRemoteControlField
(
const FRemoteControlField& |
RemoteControlField.h | ||
| RemoteControlField.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FieldName | FName | The exposed field's name. | RemoteControlField.h |
|
| FieldPathInfo | FRCFieldPathInfo | Path information pointing to this field | RemoteControlField.h | |
| FieldType | EExposedFieldType | The field's type. | RemoteControlField.h |
|
| PropertyId | FName | The exposed field's identifier. | RemoteControlField.h |
|
| ProtocolBindings | TSet< FRemoteControlProtocolBinding > | 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 | RemoteControlField.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearMask
(
ERCMask InMaskBit |
Disables the given mask. | RemoteControlField.h | |
virtual void EnableMask
(
ERCMask InMaskBit |
Enables the given mask. | RemoteControlField.h | |
ERCMask GetActiveMasks() |
Retrieves the enabled masks. | RemoteControlField.h | |
virtual bool HasMask
(
ERCMask InMaskBit |
Returns true if the given mask is enabled, false otherwise. | RemoteControlField.h | |
bool IsEditorOnly() |
Returns whether the field is only available in editor. | RemoteControlField.h | |
| Resolve the field's owners using the section's top level objects. | RemoteControlField.h | ||
virtual bool SupportsMasking() |
Returns true if this field supports masking. | RemoteControlField.h |
Overridden from FRemoteControlEntity
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BindObject
(
UObject* InObjectToBind |
Change the object this exposed entity is currently pointing to. | RemoteControlField.h | |
virtual bool CanBindObject
(
const UObject* InObjectToBind |
Return whether this entity supports binding to a given object. | RemoteControlField.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void PostSerialize
(
const FArchive& Ar |
RemoteControlField.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RemoteControlField.h | |||
FRemoteControlField & operator=
(
const FRemoteControlField& |
RemoteControlField.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveMasks_DEPRECATED | uint8 | Holds the actively enabled masks. | RemoteControlField.h | |
| ComponentHierarchy_DEPRECATED | TArray< FString > | RemoteControlField.h |