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

Light Theme

Dark Theme

IRemoteControlModule

Interface for the remote control module.

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

IRemoteControlModule

References

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

Syntax

class IRemoteControlModule : public IModuleInterface

Remarks

Interface for the remote control module.

Functions

	Name	Description
IRemoteContr...	Get()	Singleton-like access to this module's interface.
const TMap< ...	GetDefaultMetadataInitializers()	Get the map of registered default entity metadata initializers.
bool	GetObjectProperties ( const FRCObjectReference& ObjectAc..., IStructSerializerBackend& Backend )	Serialize the Object Reference into the specified backend.
void	GetPresetAssets ( TArray< FAssetData >& OutPresetAss... )	Get all the preset asset currently registered with the module.
void	GetPresets ( TArray< TSoftObjectPtr< URemoteCont... )	Get all the presets currently registered with the module.
bool	InvokeCall ( FRCCall& InCall, ERCPayloadType InPayloadType, const TArray< uint8 >& InIntercept... )	Invoke a Remote Call This is a thin wrapper around UObject::ProcessEvent This expects that the caller has already validated the call as it will assert otherwise.
bool	PropertySupportsRawModificationWithoutEditor ( FProperty* Property )	Returns whether the property can be modified through SetObjectProperties when running without an editor.
bool	RegisterDefaultEntityMetadata ( FName MetadataKey, FEntityMetadataInitializer Metadata... )	Register a default entity metadata which will show up in an entity's detail panel.
bool	ResetObjectProperties ( const FRCObjectReference& ObjectAc..., const bool bAllowIntercept )	Reset the property or the object the Object Reference is pointing to
bool	ResolveCall ( const FString& ObjectPath, const FString& FunctionName, FRCCallReference& OutCallRef, FString* OutErrorText )	Resolve a RemoteCall Object and Function.
bool	ResolveObject ( ERCAccess AccessType, const FString& ObjectPath, const FString& PropertyName, FRCObjectReference& OutObjectRef, FString* OutErrorText )	Resolve a remote object reference to a property
bool	ResolveObjectProperty ( ERCAccess AccessType, UObject* Object, FRCFieldPathInfo PropertyPath, FRCObjectReference& OutObjectRef, FString* OutErrorText )	Resolve a remote object reference to a property
URemoteContr...	ResolvePreset ( FName PresetName )	Get a preset using its name. PresetName name of the preset to resolve.
URemoteContr...	ResolvePreset ( const FGuid& PresetId )	Get a preset using its id. PresetId id of the preset to resolve.
TOptional< s...	ResolvePresetFunction ( const FResolvePresetFieldArgs& Arg... )	Resolve the underlying function from a preset.
TOptional< s...	ResolvePresetProperty ( const FResolvePresetFieldArgs& Arg... )	Resolve the underlying property from a preset.
bool	SetObjectProperties ( const FRCObjectReference& ObjectAc..., IStructDeserializerBackend& Backen..., ERCPayloadType InPayloadType, const TArray< uint8 >& InIntercept... )	Deserialize the Object Reference from the specified backend.
void	UnregisterDefaultEntityMetadata ( FName MetadataKey )	Unregister a default entity metadata.

Typedefs

Name	Description
FOnPresetRegistered	Delegate triggered when a preset has been registered
FOnPresetUnregistered	Delegate triggered when a preset has been unregistered

Deprecated Functions

	Name	Description
FOnPresetReg...	OnPresetRegistered()	OnPresetUnregistered is deprecated.
FOnPresetUnr...	OnPresetUnregistered()	OnPresetUnregistered is deprecated.
bool	RegisterPreset ( FName Name, URemoteControlPreset* Preset )	RegisterPreset is deprecated.
void	UnregisterPreset ( FName Name )	UnregisterPreset is deprecated.

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

Take our survey

Dismiss