Navigation
API > API/Plugins > API/Plugins/RemoteControl
Inheritance Hierarchy
- FRemoteControlEntity
- FRemoteControlField
- FRemoteControlProperty
- FRemoteControlInstanceMaterial
References
| Module | RemoteControl |
| Header | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlField.h |
| Include | #include "RemoteControlField.h" |
Syntax
USTRUCT&40;BlueprintType&41;
struct FRemoteControlProperty : public FRemoteControlField
Remarks
Represents a property exposed to remote control.
Constructors
| Type | Name | Description | |
|---|---|---|---|
FRemoteControlProperty
(
FName InLabel, |
This constructor is deprecated. Use the other constructor. | ||
FRemoteControlProperty
(
URemoteControlPreset* InPreset, |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | CheckIsBoundToPropertyPath
(
const FString& InPropertyPath |
Check whether given property path is bound to the property | |
| bool | CheckIsBoundToString
(
const FString& InPath |
Check whether given property string is bound to the property | |
| bool | ContainsBoundObjects
(
TArray< UObject* > InObjects |
Check whether any of the given objects are bound to this property | |
| void | Enable the edit condition for the underlying property on the owner objects. | ||
| FProperty * | GetProperty () |
Get the underlying property. This field's binding must be valid to get the property. | |
| TSharedPtr< IRemoteControlPropertyHandle > | Get the property handle with ability set and get property value directly. | ||
| bool | Returns whether the property is editable in a packaged build. | ||
| void | OnObjectPropertyChanged
(
UObject* InObject, |
Should be called when property changed on bound object | |
| void | PostLoad () |
Called on Post Load on Owner UObject. | |
| void | PostSerialize
(
const FArchive& Ar |
||
| bool |
Overridden from FRemoteControlField
| Type | Name | Description | |
|---|---|---|---|
| bool | Returns true if this field supports masking. |
Overridden from FRemoteControlEntity
| Type | Name | Description | |
|---|---|---|---|
| UClass * | Get the class of the object that can hold this field. | ||
| uint32 | Get an identifier for the underlying entity. | ||
| 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
| Type | Name | Description | |
|---|---|---|---|
FRemoteControlProperty
(
FName InLabel, |
This constructor is deprecated. Use the other constructor. |