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 > URemoteControlPreset

Light Theme

Dark Theme

URemoteControlPreset

Holds targets that contain exposed functions and properties.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

URemoteControlPreset

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, EditInlineNew)
class URemoteControlPreset : public UObject

Remarks

Holds targets that contain exposed functions and properties.

Variables

	Name	Description
TArray< URemote...	Bindings	This preset's list of objects that are exposed or that have exposed fields.
FRemoteControlP...	Layout	The visual layout for this preset.
TMap< FString, ...	Metadata	This preset's metadata.

Constructors

	Name	Description
	URemoteControlPreset()

Functions

	Name	Description
void	CacheLayoutData()	Cache this preset's layout data.
TWeakPtr< FR...	ExposeActor ( AActor* Actor, FRemoteControlPresetExposeArgs Args )	Expose an actor on this preset.
TWeakPtr< FR...	ExposeFunction ( UObject* Object, UFunction* Function, FRemoteControlPresetExposeArgs Args )	Expose a function on this preset.
TWeakPtr< FR...	ExposeProperty ( UObject* Object, FRCFieldPathInfo FieldPath, FRemoteControlPresetExposeArgs Args )	Expose a property on this preset.
TArray< TWea...	GetExposedEntities()	Get the exposed entities of a certain type.
TArray< TWea...	GetExposedEntities()	Get the exposed entities of a certain type.
TWeakPtr< co...	GetExposedEntity ( const FGuid& ExposedEntityId )	Get a copy of an exposed entity on the preset.
TWeakPtr< Ex...	GetExposedEntity ( const FGuid& ExposedEntityId )	Get a pointer to an exposed entity on the preset.
FGuid	GetExposedEntityId ( FName Label )	Get the ID of an exposed entity using its label.
const UScrip...	GetExposedEntityType ( const FGuid& ExposedEntityId )	Get the type of an exposed entity by querying with its id.
const FGuid ...	GetPresetId()	Get this preset's unique ID.
bool	IsExposed ( const FGuid& ExposedEntityId )	Returns whether an entity is exposed on the preset.
FOnActorProp...	OnActorPropertyModified()
FOnPresetEnt...	OnEntitiesUpdated()	Delegate called when the exposed entity wrapper itself is updated (ie. binding change, rename)
FOnPresetEnt...	OnEntityExposed()
FOnPresetEnt...	OnEntityUnexposed()
FOnPresetExp...	OnExposedPropertiesModified()	Delegate called with the list of exposed property that were modified in the last frame.
FOnPresetFie...	OnFieldRenamed()
FOnPresetMet...	OnMetadataModified()
void	RebindUnboundEntities()	Attempt to rebind all currently unbound properties.
FName	RenameExposedEntity ( const FGuid& ExposedEntityId, FName NewLabel )	Change the label of an entity.
void	Unexpose ( FName EntityLabel )	Unexpose an entity from the preset.
void	Unexpose ( const FGuid& EntityId )	Unexpose an entity from the preset.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
FOnActorPropertyModified
FOnPostLoadRemoteControlPreset	Callback for post remote control preset load, called by URemoteControlPreset::PostLoad function
FOnPresetEntitiesUpdatedEvent
FOnPresetEntityEvent
FOnPresetExposedPropertiesModified
FOnPresetFieldRenamed
FOnPresetMetadataModified
FOnPresetPropertyExposed
FOnPresetPropertyUnexposed

Constants

Name	Description
OnPostLoadRemoteControlPreset

Deprecated Functions

	Name	Description
FRemoteContr...	CreateAndGetTarget ( const TArray< UObject* >& Tar... )	Targets are deprecated in favor of exposing directly on the preset. You do not need to create a target beforehand.
FName	CreateTarget ( const TArray< UObject* >& Tar... )	Targets are deprecated in favor of exposing directly on the preset. You do not need to create a target beforehand.
void	DeleteTarget ( FName TargetName )	Targets are deprecated, you do not need to delete them anymore.
TOptional< F...	GetField ( FGuid FieldId )	Use GetExposedEntity instead.
FGuid	GetFieldId ( FName FieldLabel )	Use URemoteControlPreset::GetExposedEntityId instead.
TOptional< F...	GetFunction ( FName FunctionLabel )	Use GetExposedEntity instead.
TOptional< F...	GetFunction ( FGuid FunctionId )	Use GetExposedEntity instead.
FName	GetOwnerAlias ( FGuid FieldId )	FRemoteControlTarget is deprecated, access the entity's bindings by accessing FRemoteControlEntity::Bindings.
TOptional< F...	GetProperty ( FName PropertyLabel )	Use GetExposedEntity instead.
TOptional< F...	GetProperty ( FGuid PropertyId )	Use GetExposedEntity instead.
const TMap< ...	GetRemoteControlTargets()	FRemoteControlTarget is deprecated, use URemoteControlPreset::Bindings instead.
TMap< FName,...	GetRemoteControlTargets()	FRemoteControlTarget is deprecated, use URemoteControlPreset::Bindings instead.
void	NotifyExposedPropertyChanged ( FName PropertyLabel )	This function is deprecated.
FOnPresetPro...	OnPropertyExposed()	This delegate is deprecated, use OnEntityExposed instead.
FOnPresetPro...	OnPropertyUnexposed()	This delegate is deprecated, use OnEntityUnexposed instead.
void	RenameField ( FName OldFieldLabel, FName NewFieldLabel )	Use RenameExposedEntity instead.
void	RenameTarget ( FName TargetName, FName NewTargetName )	Targets are deprecated in favor of bindings, you can now change the name of the binding directly.
TArray< UObj...	ResolvedBoundObjects ( FName FieldLabel )	ResolvedBoundObjects is deprecated, you can now resolve bound objects using FRemoteControlEntity.
TOptional< F...	ResolveExposedFunction ( FName FunctionLabel )	Use FRemoteControlFunction::ResolveFieldOwners instead.
TOptional< F...	ResolveExposedProperty ( FName PropertyLabel )	Use FRemoteControlProperty::GetProperty and FRemoteControlProperty::ResolveFieldOwners instead.

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

Take our survey

Dismiss