Navigation
API > API/Plugins > API/Plugins/RemoteControl
Base class for exposed objects, properties, functions etc...
| Name | FRemoteControlEntity |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlEntity.h |
| Include Path | #include "RemoteControlEntity.h" |
Syntax
USTRUCT (BlueprintType )
struct FRemoteControlEntity
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRemoteControlEntity
(
URemoteControlPreset* InPreset, |
RemoteControlEntity.h | ||
| RemoteControlEntity.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRemoteControlEntity() |
RemoteControlEntity.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnEntityModified | TBaseDelegate_OneParam< void, const FGuid & > | Delegate called when the label of this entity changes or if one of its binding is updated. | RemoteControlEntity.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BindObject
(
UObject* InObjectToBind |
Change the object this exposed entity is currently pointing to. | RemoteControlEntity.h | |
virtual bool CanBindObject
(
const UObject* InObjectToBind |
Return whether this entity supports binding to a given object. | RemoteControlEntity.h | |
const TArray< TWeakObjectPtr< URemoteControlBinding > > & GetBindings() |
Get the unresolved bindings of this exposed entity. | RemoteControlEntity.h | |
UObject * GetBoundObject() |
Resolve the first binding for this entity. | RemoteControlEntity.h | |
| Return the Entity Object in the given world | RemoteControlEntity.h | ||
| Get all resolved bindings under this entity. | RemoteControlEntity.h | ||
FGuid GetId() |
Get the id of this entity. | RemoteControlEntity.h | |
FName GetLabel() |
Get the label of this entity. | RemoteControlEntity.h | |
FSoftObjectPath GetLastBindingPath() |
Get the last valid binding path for this entity. | RemoteControlEntity.h | |
| Get the entity's metadata. | RemoteControlEntity.h | ||
URemoteControlPreset * GetOwner() |
Get the preset that owns this entity. | RemoteControlEntity.h | |
const UScriptStruct * GetStruct() |
Get the type of this remote control entity. | RemoteControlEntity.h | |
virtual UClass * GetSupportedBindingClass() |
Get the class of the object that can hold this field. | RemoteControlEntity.h | |
virtual uint32 GetUnderlyingEntityIdentifier () |
Get an identifier for the underlying entity. | RemoteControlEntity.h | |
virtual bool IsBound() |
Returns whether this entity can be resolved using its bound objects. | RemoteControlEntity.h | |
void RemoveMetadataEntry
(
FName Key |
Remove a metadata entry. | RemoteControlEntity.h | |
| Change this entity's label. | RemoteControlEntity.h | ||
| Find or add a value in the entity's metadata map. | RemoteControlEntity.h |
Protected
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FRemoteControlEntity& InEntity |
RemoteControlEntity.h | ||
bool operator==
(
FGuid InEntityId |
RemoteControlEntity.h |