1. Epic GamesDeveloper
  3. FRemoteControlEntity

FRemoteControlEntity

Base class for exposed objects, properties, functions etc...

API > API/Plugins > API/Plugins/RemoteControl

Inheritance Hierarchy

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FRemoteControlEntity

Remarks

Base class for exposed objects, properties, functions etc...

Variables

  Type Name Description
Protected variable UProperty TArray< TWeakObjectPtr< URemoteControlBinding > > Bindings The bound objects that are exposed or that hold the exposed entity.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FGuid Id Unique identifier for this entity
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FName Label This exposed entity's alias.
Protected variable FOnEntityModified OnEntityModifiedDelegate  
Protected variable UProperty Category BlueprintReadOnly TWeakObjectPtr< URemoteControlPreset > Owner The preset that owns this entity.
Protected variable UProperty TMap< FName, FString > UserMetadata User specified metadata for this entity.

Constructors

  Type Name Description
Public function    
Protected function  

FRemoteControlEntity ( URemoteControlPreset* InPreset,
FName InLabel,
const TArray< URemoteControlBinding* >& InBindings
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  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.
Public function Const const TArray< TWeakObjectPtr< URemoteControlBinding > > & Get the unresolved bindings of this exposed entity.
Public function Const UObject * Resolve the first binding for this entity.
Public function Const TArray< UObject * > Get all resolved bindings under this entity.
Public function Const FGuid

GetId ()

 Get the id of this entity.
Public function Const FName Get the label of this entity.
Public function Const FSoftObjectPath Get the last valid binding path for this entity.
Public function Const const TMap< FName, FString > & Get the entity's metadata.
Public function URemoteControlPreset * Get the preset that owns this entity.
Public function Const const UScriptStruct * Get the type of this remote control entity.
Public function Virtual Const UClass * Get the class of the object that can hold this field.
Public function Virtual Const uint32 Get an identifier for the underlying entity.
Public function Virtual Const bool

IsBound ()

 Returns whether this entity can be resolved using its bound objects.
Public function void Remove a metadata entry.
Public function FName

Rename ( FName NewLabel
)

 Change this entity's label.
Public function void

SetMetadataValue ( FName Key,
FString Value
)

 Find or add a value in the entity's metadata map.

Operators

  Type Name Description
Public function Const bool

operator== ( const FRemoteControlEntity& InEntity
)

  
Public function Const bool

operator== ( FGuid InEntityId
)

  

Typedefs

Name Description
FOnEntityModified Delegate called when the label of this entity changes or if one of its binding is updated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page