Navigation
API > API/Plugins > API/Plugins/RemoteControl
Represents a property exposed to remote control.
| Name | FRemoteControlProperty |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlField.h |
| Include Path | #include "RemoteControlField.h" |
Syntax
USTRUCT (BlueprintType )
struct FRemoteControlProperty : public FRemoteControlField
Inheritance Hierarchy
- FRemoteControlEntity → FRemoteControlField → FRemoteControlProperty
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RemoteControlField.h | |||
FRemoteControlProperty
(
FName InLabel, |
RemoteControlField.h | ||
FRemoteControlProperty
(
URemoteControlPreset* InPreset, |
RemoteControlField.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MetadataKey_Max | FName | Key for the metadata's Max entry. | RemoteControlField.h |
| MetadataKey_Min | FName | Key for the metadata's Min entry. | RemoteControlField.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsEditableInPackaged | bool | Whether the property is blueprint read only. | RemoteControlField.h | |
| CachedEditConditionPath | FRCFieldPathInfo | Cached edit condition path used to enable the exposed property's edit condition. | RemoteControlField.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CheckIsBoundToPropertyPath
(
const FString& InPropertyPath |
Check whether given property path is bound to the property | RemoteControlField.h | |
virtual bool CheckIsBoundToString
(
const FString& InPath |
Check whether given property string is bound to the property | RemoteControlField.h | |
| Check whether any of the given objects are bound to this property | RemoteControlField.h | ||
void EnableEditCondition() |
Enable the edit condition for the underlying property on the owner objects. | RemoteControlField.h | |
void * GetFieldContainerAddress() |
Get the container address. This field's binding must be valid to get the container address. | RemoteControlField.h | |
FProperty * GetProperty() |
Get the underlying property. This field's binding must be valid to get the property. | RemoteControlField.h | |
TSharedPtr< IRemoteControlPropertyHandle > GetPropertyHandle() |
Get the property handle with ability set and get property value directly. | RemoteControlField.h | |
bool IsEditable
(
FString* OutError |
Returns whether the property is editable, will check for editor or packaged automatically | RemoteControlField.h | |
bool IsEditableInEditor
(
FString* OutError |
Returns whether the property is editable in the Editor. | RemoteControlField.h | |
bool IsEditableInPackaged
(
FString* OutError |
Returns whether the property is editable in a packaged build. | RemoteControlField.h | |
virtual void OnObjectPropertyChanged
(
UObject* InObject, |
Should be called when property changed on bound object | RemoteControlField.h | |
virtual void PostLoad () |
Called on Post Load on Owner UObject. | RemoteControlField.h | |
void PostSerialize
(
const FArchive& Ar |
RemoteControlField.h | ||
bool Serialize
(
FArchive& Ar |
RemoteControlField.h |
Overridden from FRemoteControlField
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool SupportsMasking() |
RemoteControlField.h |
Overridden from FRemoteControlEntity
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UClass * GetSupportedBindingClass() |
Get the class of the object that can hold this field. | RemoteControlField.h | |
virtual uint32 GetUnderlyingEntityIdentifier () |
Get an identifier for the underlying entity. | RemoteControlField.h | |
virtual bool IsBound() |
Returns whether this entity can be resolved using its bound objects. | RemoteControlField.h |