IRemoteControlModule

Interface for the remote control module.

Choose your operating system:

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

Public function Static

IRemoteContr...

 

Get()

Singleton-like access to this module's interface.

Public function Const

const TMap< ...

 

GetDefaultMetadataInitializers()

Get the map of registered default entity metadata initializers.

Public function Const

const TMap< ...

 

GetEntityFactories()

Get map of the factories which is responsible for the Remote Control property creation

Public function

bool

 

GetObjectProperties

(
    const FRCObjectReference& ObjectAc...,
    IStructSerializerBackend& Backend
)

Serialize the Object Reference into the specified backend.

Public function Const

void

 

GetPresetAssets

(
    TArray< FAssetData >& OutPresetAss...
)

Get all the preset asset currently registered with the module.

Public function Const

void

 

GetPresets

Get all the presets currently registered with the module.

Public function

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.

Public function Const

bool

 

PropertySupportsRawModificationWithoutEditor

(
    FProperty* Property,
    UClass* OwnerClass
)

Returns whether the property can be modified through SetObjectProperties when running without an editor.

Public function

bool

 

RegisterDefaultEntityMetadata

(
    FName MetadataKey,
    FEntityMetadataInitializer Metadata...
)

Register a default entity metadata which will show up in an entity's detail panel.

Public function

void

 

RegisterEntityFactory

(
    const FName InFactoryName,
    const TSharedRef< IRemoteControlPro...
)

Register factory

Public function

bool

 

ResetObjectProperties

(
    const FRCObjectReference& ObjectAc...,
    const bool bAllowIntercept
)

Reset the property or the object the Object Reference is pointing to

Public function

bool

 

ResolveCall

(
    const FString& ObjectPath,
    const FString& FunctionName,
    FRCCallReference& OutCallRef,
    FString* OutErrorText
)

Resolve a RemoteCall Object and Function.

Public function

bool

 

ResolveObject

(
    ERCAccess AccessType,
    const FString& ObjectPath,
    const FString& PropertyName,
    FRCObjectReference& OutObjectRef,
    FString* OutErrorText
)

Resolve a remote object reference to a property

Public function

bool

 

ResolveObjectProperty

(
    ERCAccess AccessType,
    UObject* Object,
    FRCFieldPathInfo PropertyPath,
    FRCObjectReference& OutObjectRef,
    FString* OutErrorText
)

Resolve a remote object reference to a property

Public function Const

URemoteContr...

 

ResolvePreset

(
    FName PresetName
)

Get a preset using its name.

  • PresetName name of the preset to resolve.

Public function Const

URemoteContr...

 

ResolvePreset

(
    const FGuid& PresetId
)

Get a preset using its id.

  • PresetId id of the preset to resolve.

Public function

bool

 

SetObjectProperties

(
    const FRCObjectReference& ObjectAc...,
    IStructDeserializerBackend& Backen...,
    ERCPayloadType InPayloadType,
    const TArray< uint8 >& InIntercept...
)

Deserialize the Object Reference from the specified backend.

Public function

void

 

UnregisterDefaultEntityMetadata

(
    FName MetadataKey
)

Unregister a default entity metadata.

Public function

void

 

UnregisterEntityFactory

(
    const FName InFactoryName
)

Remove factory by name

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

Public function

FOnPresetReg...

 

OnPresetRegistered()

OnPresetUnregistered is deprecated.

Public function

FOnPresetUnr...

 

OnPresetUnregistered()

OnPresetUnregistered is deprecated.

Public function

bool

 

RegisterPreset

(
    FName Name,
    URemoteControlPreset* Preset
)

RegisterPreset is deprecated.

Public function Const

TOptional< s...

 

ResolvePresetFunction

(
    const FResolvePresetFieldArgs& Arg...
)

This function is deprecated, please resolve directly on the preset.

Public function Const

TOptional< s...

 

ResolvePresetProperty

(
    const FResolvePresetFieldArgs& Arg...
)

This function is deprecated, please resolve directly on the preset.

Public function

void

 

UnregisterPreset

(
    FName Name
)

UnregisterPreset is deprecated.