1. Epic GamesDeveloper
  3. IRemoteControlModule

IRemoteControlModule

Interface for the remote control module.

API > API/Plugins > API/Plugins/RemoteControl

Inheritance Hierarchy

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

  Type Name Description
Public function bool

AppendToObjectArrayProperty ( const FRCObjectReference& ObjectAccess,
IStructDeserializerBackend& Backend,
ERCPayloadType InPayloadType,
const TArray< uint8 >& InInterceptPayload
)

 Deserialize the Object Reference from the specified backend and append it to an array property.
Public function FGuid

BeginManualEditorTransaction ( const FText& InDescription,
uint32 TypeHash
)

 Start a manual editor transaction originating from a remote request.
Public function Static void

BroadcastError ( const FString& Message,
ELogVerbosity::Type Verbosity
)

 Broadcast an error to the OnError delegate
Public function Const bool Check Remote Control project settings to configure.
Public function Const bool Returns true when the given object can be reset to its default value, false otherwise.
Public function URemoteControlPreset * Create a transient preset.
Public function bool

DestroyTransientPreset ( const FGuid& PresetId
)

 Destroy a transient preset using its id. * PresetId id of the preset to destroy.
Public function bool

DestroyTransientPreset ( FName PresetName
)

 Destroy a transient preset using its name. * PresetName name of the preset to destroy.
Public function int32

EndManualEditorTransaction ( const FGuid& TransactionId
)

 End a manual editor transaction originating from a remote request.
Public function Static IRemoteControlModule &

Get ()

 Singleton-like access to this module's interface.
Public function Const const TMap< FName, FEntityMetadataInitializer > & Get the map of registered default entity metadata initializers.
Public function Const void Gets all hosted presets currently registered with the module.
Public function Const const TMap< FName, TSharedPtr< IRemoteControlPropertyFactory > > & Get map of the factories which is responsible for the Remote Control property creation
Public function bool Serialize the Object Reference into the specified backend.
Public function Const void

GetPresetAssets ( TArray< FAssetData >& OutPresetAssets,
bool bIncludeTransient
)

 Get all the preset asset currently registered with the module.
Public function Const void Get all the presets currently registered with the module.
Public function TSharedPtr< IPropertyIdHandler >  
Public function Const bool

HasDefaultValueCustomization ( const UObject* InObject,
const FProperty* InProperty
)

 Returns true when the given object and property has custom default value, false otherwise.
Public function bool

InsertToObjectArrayProperty ( int32 Index,
const FRCObjectReference& ObjectAccess,
IStructDeserializerBackend& Backend,
ERCPayloadType InPayloadType,
const TArray< uint8 >& InInterceptPayload
)

 Deserialize the Object Reference from the specified backend and insert it at the given position in an array property.
Public function bool

InvokeCall ( FRCCall& InCall,
ERCPayloadType InPayloadType,
const TArray< uint8 >& InInterceptPayload
)

 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

IsPresetTransient ( const FGuid& PresetId
)

 Check whether a preset is transient using its id. * PresetId id of the preset to check.
Public function Const bool

IsPresetTransient ( FName PresetName
)

 Check whether a preset is transient using its name. * PresetName name of the preset to check.
Public function FOnError &

OnError ()

  
Public function FOnPresetRegistered &  
Public function FOnPresetUnregistered &  
Public function void

PerformMasking ( const TSharedRef< FRCMaskingOperation >& InMaskingOperation,
const ERCModifyOperationFlags ModifyOperationFlags
)

 Performs the given masking operation.
Public function Const bool

PropertySupportsRawModification ( FProperty* InProperty,
const UObject* InObject,
const bool bInWithEditor,
FString* OutError
)

 Returns whether the property can be modified through SetObjectProperties or read through ResolveObjectProperties when running with or without an editor.
Public function Const bool Returns whether the property can be modified through SetObjectProperties when running without an editor.
Public function bool

RegisterDefaultEntityMetadata ( FName MetadataKey,
FEntityMetadataInitializer MetadataInitializer
)

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

RegisterEmbeddedPreset ( URemoteControlPreset* Preset,
bool bReplaceExisting
)

 Registers a hosted (non-asset based) preset with an attached name.
Public function void

RegisterEntityFactory ( const FName InFactoryName,
const TSharedRef< IRemoteControlPropertyFactory >& InFactory
)

 Register factory
Public function void

RegisterMaskingFactoryForType ( UScriptStruct* RemoteControlPropertyType,
const TSharedPtr< IRemoteControlMaskingFactory >& InMaskingFactory
)

 Register a masking factory to handle that masks the supported properties.
Public function bool Register the preset with the module, enabling using the preset remotely using its name.
Public function TSharedRef< InPropertyIdPropertyHandlerType >

RegisterPropertyIdPropertyHandler ( InArgTypes&&... InArgs
)

  
Protected function void  
Public function bool

RemoveFromObjectArrayProperty ( int32 Index,
const FRCObjectReference& ObjectAccess
)

 Remove an item from the referenced array.
Public function bool

ResetObjectProperties ( const FRCObjectReference& ObjectAccess,
const bool bAllowIntercept
)

 Reset the property or the object the Object Reference is pointing to
Public function void Performs actual data reset on the given object.
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 PRAGMA_ENABLE_DEPRECATION_WARNINGSURemoteControlPreset *

ResolvePreset ( FName PresetName
)

 Get a preset using its name. * PresetName name of the preset to resolve.
Public function Const URemoteControlPreset *

ResolvePreset ( const FGuid& PresetId
)

 Get a preset using its id. * PresetId id of the preset to resolve.
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< struct FExposedFunction > Resolve the underlying function from a preset.
Public function Const PRAGMA_ENABLE_DEPRECATION_WARNINGS virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< struct FExp... Resolve the underlying property from a preset.
Public function bool

SetObjectProperties ( const FRCObjectReference& ObjectAccess,
IStructDeserializerBackend& Backend,
ERCPayloadType InPayloadType,
const TArray< uint8 >& InInterceptPayload,
ERCModifyOperation Operation,
const ERCModifyOperationFlags ModifyOperationFlags
)

 Deserialize the Object Reference from the specified backend.
Public function bool

SetPresetController ( const FName PresetName,
URCVirtualPropertyBase* Controller,
IStructDeserializerBackend& Backend,
const TArray< uint8 >& InPayload,
const bool bAllowIntercept
)

 Set a controller's value on a Remote Control Preset
Public function bool

SetPresetController ( const FName PresetName,
const FName ControllerName,
IStructDeserializerBackend& Backend,
const TArray< uint8 >& InPayload,
const bool bAllowIntercept
)

 Set a controller's value on a Remote Control Preset
Public function Const bool

SupportsMasking ( const UScriptStruct* InStruct
)

 Returns true if the given property can be masked, false otherwise.
Public function Const bool

SupportsMasking ( const FProperty* InProperty
)

 Returns true if the given property can be masked, false otherwise.
Public function void Unregister a default entity metadata.
Public function void  
Public function void Unregisters a hosted (non-asset based) preset with the given name.
Public function void

UnregisterEntityFactory ( const FName InFactoryName
)

 Remove factory by name
Public function void

UnregisterMaskingFactoryForType ( UScriptStruct* RemoteControlPropertyType
)

 Unregister a previously registered masking factory.
Public function void Unregister a preset

Typedefs

Name Description
FOnError Delegate triggered when an error occurs, which aren't necessarily written to UE LOG
FOnPresetRegistered Delegate triggered when a preset has been registered
FOnPresetUnregistered Delegate triggered when a preset has been unregistered

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page