1. Epic GamesDeveloper
  3. URemoteControlSettings

URemoteControlSettings

Global remote control settings

API > API/Plugins > API/Plugins/RemoteControlCommon

Global remote control settings

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

Syntax

UCLASS (Config=RemoteControl)  
class URemoteControlSettings : public UDeveloperSettings

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActionPanelSplitRatio float The split widget control ratio between entity tree and details/protocol binding list. RemoteControlSettings.h
  • Config
AllowedOrigin FString Origin that can make requests to the remote control server. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
  • Meta=(EditCondition=bRestrictServerAccess)
AllowlistedClients TSet< FRCNetworkAddressRange > List of IP Addresses that are allowed to access the Web API without authentication. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
  • DisplayName="Range of Allowlisted Clients"
  • Meta=(EditCondition=bRestrictServerAccess, EditConditionHides)
bAllowConsoleCommandRemoteExecution bool Enable calling 'ExecuteConsoleCommand' through the web api. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
  • Meta=(editCondition=bRestrictServerAccess)
bAutoStartWebServer bool Whether web server is started automatically. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Server"
bAutoStartWebSocketServer bool Whether web socket server is started automatically. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Server"
bDisplayInEditorOnlyWarnings bool Show a warning icon for exposed editor-only fields. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
  • DisplayName="Show a warning when exposing editor-only entities."
bEnableRemotePythonExecution bool Enable remote python execution, enabling this could open you up to vulnerabilities if an outside actor has access to your server. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
  • Meta=(editCondition=bRestrictServerAccess)
bEnforcePassphraseForRemoteClients bool Controls whether a passphrase should be required when remote control is accessed by a client outside of localhost. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
  • Meta=(EditCondition=bRestrictServerAccess)
bForceWebAppBuildAtStartup bool Should force a build of the WebApp at startup. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Interface"
  • DisplayName="Force WebApp build at startup"
bIgnoreGetterSetterCheck bool   RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
  • DisplayName="Ignore Remote Control Getter/Setter Check"
bIgnoreProtectedCheck bool   RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
  • DisplayName="Ignore Remote Control Protected Check"
bIgnoreWarnings bool   RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
bLogicPanelVisibility bool   RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
  • DisplayName="Hide or Show the Logic panel by default"
bRefreshExposedEntitiesOnObjectPropertyUpdate bool Refresh all widgets in the exposed properties list when object properties are updated RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
  • DisplayName="Refresh all exposed entities widgets on object properties update"
bRestrictServerAccess bool Whether to restrict access to a list of hostname/IPs in the AllowedOrigins setting. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
bShowPassphraseDisabledWarning bool Whether the User should be warned that Passphrase usage is disabled or now. Initially activated RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
  • DisplayName="Warn that Passphrase might be disabled "
  • Meta=(EditCondition=bRestrictServerAccess)
bUseRebindingContext bool   RemoteControlSettings.h
  • Config
bWebAppLogRequestDuration bool Should WebApp log timing. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Interface"
  • DisplayName="Log WebApp requests handle duration"
DefaultPanelMode FName   RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
  • DisplayName="Default mode (e.g. Setup/Operation)"
EntitiesListHiddenColumns TSet< FName >   RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Preset"
  • DisplayName="Which columns to hide in the exposed entities list"
Passphrases TArray< FRCPassphrase > List of passphrases used for accessing remote control outside of localhost. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control | Security"
  • DisplayName="Remote Control Passphrase"
  • Meta=(EditCondition=bEnforcePassphraseForRemoteClients, EditConditionHides)
RemoteControlHttpServerPort uint32 The web remote control HTTP server's port. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Server"
  • DisplayName="Remote Control HTTP Server Port"
RemoteControlWebInterfaceBindAddress FString The remote control web app bind address. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Interface"
  • DisplayName="Remote Control Web Interface bind address"
RemoteControlWebInterfacePort uint32 The remote control web app http port. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Interface"
  • DisplayName="Remote Control Web Interface http Port"
RemoteControlWebsocketServerBindAddress FString The address to bind the websocket server to. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Server"
  • DisplayName="Remote Control Websocket Bind Address"
RemoteControlWebSocketServerPort uint32 The web remote control WebSocket server's port. RemoteControlSettings.h
  • Config
  • EditAnywhere
  • Category="Remote Control Web Server"
  • DisplayName="Remote Control WebSocket Server Port"
TreeBindingSplitRatio float The split widget control ratio between entity tree and details/protocol binding list. RemoteControlSettings.h
  • Config

Protected

Name Type Remarks Include Path Unreal Specifiers
bSecuritySettingsReviewed bool   RemoteControlSettings.h
  • Config

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AllowClient ( const FString& InClientAddressStr
)

   RemoteControlSettings.h  

virtual FName GetCategoryName()

 Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc. RemoteControlSettings.h  

virtual FName GetContainerName()

 Gets the settings container name for the settings, either Project or Editor RemoteControlSettings.h  

virtual TArray< FString > GetHashedPassphrases()

   RemoteControlSettings.h  

virtual FName GetSectionName()

 The unique name for your section of settings, uses the class's FName. RemoteControlSettings.h  

virtual FText GetSectionText()

   RemoteControlSettings.h  

virtual bool IsClientAllowed ( const FString& InClientAddressStr
) const

   RemoteControlSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static const TSet< FName > & GetExposedEntitiesColumnNames()

 Returns the names of the columns visualized in the RC Panel Entities list. RemoteControlSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bProtocolsGenerateTransactions_DEPRECATED bool DEPRECATED 5.5 RemoteControlSettings.h
  • Config

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page