1. Epic GamesDeveloper
  3. IRemoteControlModule

IRemoteControlModule

Interface for the remote control module.

API > API/Plugins > API/Plugins/RemoteControl

Interface for the remote control module.

   
Name IRemoteControlModule
Type class
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/IRemoteControlModule.h
Include Path #include "IRemoteControlModule.h"

Syntax

class IRemoteControlModule : public IModuleInterface

Implements Interfaces

Typedefs

Name Type Remarks Include Path
FOnError TMulticastDelegate_TwoParams< void, const FString &, ELogVerbosity::Type > Delegate triggered when an error occurs, which aren't necessarily written to UE LOG IRemoteControlModule.h
FOnPresetRegistered TMulticastDelegate_OneParam< void, FName > Delegate triggered when a preset has been registered IRemoteControlModule.h
FOnPresetUnregistered TMulticastDelegate_OneParam< void, FName > Delegate triggered when a preset has been unregistered IRemoteControlModule.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

FGuid BeginManualEditorTransaction ( const FText& InDescription,
uint32 TypeHash
)

 Start a manual editor transaction originating from a remote request. IRemoteControlModule.h  

bool CanBeAccessedRemotely ( UObject* InObject
) const

 Check Remote Control project settings to configure. IRemoteControlModule.h  

bool CanResetToDefaultValue ( UObject* InObject,
const FRCResetToDefaultArgs& InArgs
) const

 Returns true when the given object can be reset to its default value, false otherwise. IRemoteControlModule.h  
Create a transient preset. IRemoteControlModule.h  

bool DestroyTransientPreset ( const FGuid& PresetId
)

 Destroy a transient preset using its id. * PresetId id of the preset to destroy. IRemoteControlModule.h  

bool DestroyTransientPreset ( FName PresetName
)

 Destroy a transient preset using its name. * PresetName name of the preset to destroy. IRemoteControlModule.h  

int32 EndManualEditorTransaction ( const FGuid& TransactionId
)

 End a manual editor transaction originating from a remote request. IRemoteControlModule.h  

const TMap< FName, FEntityMetadataInitializer > & GetDefaultMetadataInitializers()

 Get the map of registered default entity metadata initializers. IRemoteControlModule.h  

void GetEmbeddedPresets ( TArray< TWeakObjectPtr< URemoteControlPreset > >& OutEmbeddedPresets
) const

 Gets all hosted presets currently registered with the module. IRemoteControlModule.h  

const TMap< FName, TSharedPtr< IRemoteControlPropertyFactory > > & GetEntityFactories()

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

bool GetObjectProperties ( const FRCObjectReference& ObjectAccess,
IStructSerializerBackend& Backend
)

 Serialize the Object Reference into the specified backend. IRemoteControlModule.h  

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

 Get all the preset asset currently registered with the module. IRemoteControlModule.h  

void GetPresets ( TArray< TSoftObjectPtr< URemoteControlPreset > >& OutPresets
) const

 Get all the presets currently registered with the module. IRemoteControlModule.h  

TSharedPtr< IPropertyIdHandler > GetPropertyIdHandlerFor ( FProperty* InProperty
)

   IRemoteControlModule.h  

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

 Returns true when the given object and property has custom default value, false otherwise. IRemoteControlModule.h  

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

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

bool IsPresetTransient ( const FGuid& PresetId
) const

 Check whether a preset is transient using its id. * PresetId id of the preset to check. IRemoteControlModule.h  

bool IsPresetTransient ( FName PresetName
) const

 Check whether a preset is transient using its name. * PresetName name of the preset to check. IRemoteControlModule.h  

FOnError & OnError()

   IRemoteControlModule.h  

FOnPresetRegistered & OnPresetRegistered()

   IRemoteControlModule.h  

FOnPresetUnregistered & OnPresetUnregistered()

   IRemoteControlModule.h  

void PerformMasking ( const TSharedRef< FRCMaskingOperation >& InMaskingOperation
)

 Performs the given masking operation. IRemoteControlModule.h  

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

 Returns whether the property can be modified through SetObjectProperties or read through ResolveObjectProperties when running with or without an editor. IRemoteControlModule.h  

bool PropertySupportsRawModificationWithoutEditor ( FProperty* Property,
UClass* OwnerClass
) const

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

bool RegisterDefaultEntityMetadata ( FName MetadataKey,
FEntityMetadataInitializer MetadataInitializer
)

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

bool RegisterEmbeddedPreset ( URemoteControlPreset* Preset,
bool bReplaceExisting
)

 Registers a hosted (non-asset based) preset with an attached name. IRemoteControlModule.h  

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

 Register factory IRemoteControlModule.h  

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

 Register a masking factory to handle that masks the supported properties. IRemoteControlModule.h  

bool RegisterPreset ( FName Name,
URemoteControlPreset* Preset
)

 Register the preset with the module, enabling using the preset remotely using its name. IRemoteControlModule.h  

TSharedRef< InPropertyIdPropertyHandlerType > RegisterPropertyIdPropertyHandler ( InArgTypes&&... InArgs
)

   IRemoteControlModule.h  

bool RemoveFromObjectArrayProperty ( int32 Index,
const FRCObjectReference& ObjectAccess
)

 Remove an item from the referenced array. IRemoteControlModule.h  

bool ResetObjectProperties ( const FRCObjectReference& ObjectAccess,
const bool bAllowIntercept
)

 Reset the property or the object the Object Reference is pointing to IRemoteControlModule.h  

void ResetToDefaultValue ( UObject* InObject,
FRCResetToDefaultArgs& InArgs
)

 Performs actual data reset on the given object. IRemoteControlModule.h  

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

 Resolve a RemoteCall Object and Function. IRemoteControlModule.h  

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

 Resolve a remote object reference to a property IRemoteControlModule.h  

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

 Resolve a remote object reference to a property IRemoteControlModule.h  

URemoteControlPreset * ResolvePreset ( FName PresetName
) const

 Get a preset using its name. * PresetName name of the preset to resolve. IRemoteControlModule.h  

URemoteControlPreset * ResolvePreset ( const FGuid& PresetId
) const

 Get a preset using its id. * PresetId id of the preset to resolve. IRemoteControlModule.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< struct FExposedFunction > ResolvePresetFunction ( const FResolvePresetFieldArgs& Args
) const

 Resolve the underlying function from a preset. IRemoteControlModule.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< struct FExposedProperty > ResolvePresetProperty ( const FResolvePresetFieldArgs& Args
) const

 Resolve the underlying property from a preset. IRemoteControlModule.h  

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

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

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

bool SupportsMasking ( const UScriptStruct* InStruct
) const

 Returns true if the given property can be masked, false otherwise. IRemoteControlModule.h  

bool SupportsMasking ( const FProperty* InProperty
) const

 Returns true if the given property can be masked, false otherwise. IRemoteControlModule.h  

void UnregisterDefaultEntityMetadata ( FName MetadataKey
)

 Unregister a default entity metadata. IRemoteControlModule.h  
  IRemoteControlModule.h  
Unregisters a hosted (non-asset based) preset with the given name. IRemoteControlModule.h  

void UnregisterEntityFactory ( const FName InFactoryName
)

 Remove factory by name IRemoteControlModule.h  

void UnregisterMaskingFactoryForType ( UScriptStruct* RemoteControlPropertyType
)

 Unregister a previously registered masking factory. IRemoteControlModule.h  

void UnregisterPreset ( FName Name
)

 Unregister a preset IRemoteControlModule.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RegisterPropertyIdPropertyHandlerImpl ( const TSharedRef< IPropertyIdHandler >& InKeyPropertyHandler
)

   IRemoteControlModule.h  

Static

Name Remarks Include Path Unreal Specifiers

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

 Broadcast an error to the OnError delegate IRemoteControlModule.h  
Singleton-like access to this module's interface. IRemoteControlModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page