Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > RemoteControl > FRemoteControlEntity

Light Theme

Dark Theme

FRemoteControlEntity

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

Windows

MacOS

Linux

Inheritance Hierarchy

FRemoteControlEntity

FRemoteControlActor

FRemoteControlField

	FRemoteControlFunction
	FRemoteControlProperty

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FRemoteControlEntity

Remarks

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

Variables

	Name	Description
TArray< TWeakOb...	Bindings	The bound objects that are exposed or that hold the exposed entity.
FGuid	Id	Unique identifier for this entity
FName	Label	This exposed entity's alias.
FOnEntityModifi...	OnEntityModifiedDelegate
TWeakObjectPtr<...	Owner	The preset that owns this entity.
TMap< FName, FS...	UserMetadata	User specified metadata for this entity.

Constructors

	Name	Description
	FRemoteControlEntity()
	FRemoteControlEntity ( URemoteControlPreset* InPreset, FName InLabel, const TArray< URemoteControlBinding... )

Destructors

	Name	Description
	~FRemoteControlEntity()

Functions

	Name	Description
void	BindObject ( UObject* InObjectToBind )	Change the object this exposed entity is currently pointing to.
bool	CanBindObject ( const UObject* InObjectToBind )	Return whether this entity supports binding to a given object.
const TArray...	GetBindings()	Get the unresolved bindings of this exposed entity.
TArray< UObj...	GetBoundObjects()	Get all resolved bindings under this entity.
FGuid	GetId()	Get the id of this entity.
FName	GetLabel()	Get the label of this entity.
const TMap< ...	GetMetadata()	Get the entity's metadata.
URemoteContr...	GetOwner()	Get the preset that owns this entity.
const UScrip...	GetStruct()	Get the type of this remote control entity.
UClass *	GetSupportedBindingClass()	Get the class of the object that can hold this field.
uint32	GetUnderlyingEntityIdentifier()	Get an identifier for the underlying entity.
bool	IsBound()	Returns whether this entity can be resolved using its bound objects.
void	RemoveMetadataEntry ( FName Key )	Remove a metadata entry.
FName	Rename ( FName NewLabel )	Change this entity's label.
void	SetMetadataValue ( FName Key, FString Value )	Find or add a value in the entity's metadata map.

Operators

		Name	Description
	bool	operator== ( const FRemoteControlEntity& InEnti... )
	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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss