Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → URemoteControlSettings
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 |
|
| AllowedOrigin | FString | Origin that can make requests to the remote control server. | RemoteControlSettings.h |
|
| AllowlistedClients | TSet< FRCNetworkAddressRange > | List of IP Addresses that are allowed to access the Web API without authentication. | RemoteControlSettings.h |
|
| bAllowConsoleCommandRemoteExecution | bool | Enable calling 'ExecuteConsoleCommand' through the web api. | RemoteControlSettings.h |
|
| bAutoStartWebServer | bool | Whether web server is started automatically. | RemoteControlSettings.h |
|
| bAutoStartWebSocketServer | bool | Whether web socket server is started automatically. | RemoteControlSettings.h |
|
| bDisplayInEditorOnlyWarnings | bool | Show a warning icon for exposed editor-only fields. | RemoteControlSettings.h |
|
| 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 |
|
| bEnforcePassphraseForRemoteClients | bool | Controls whether a passphrase should be required when remote control is accessed by a client outside of localhost. | RemoteControlSettings.h |
|
| bForceWebAppBuildAtStartup | bool | Should force a build of the WebApp at startup. | RemoteControlSettings.h |
|
| bIgnoreGetterSetterCheck | bool | RemoteControlSettings.h |
|
|
| bIgnoreProtectedCheck | bool | RemoteControlSettings.h |
|
|
| bIgnoreWarnings | bool | RemoteControlSettings.h |
|
|
| bLogicPanelVisibility | bool | RemoteControlSettings.h |
|
|
| bRefreshExposedEntitiesOnObjectPropertyUpdate | bool | Refresh all widgets in the exposed properties list when object properties are updated | RemoteControlSettings.h |
|
| bRestrictServerAccess | bool | Whether to restrict access to a list of hostname/IPs in the AllowedOrigins setting. | RemoteControlSettings.h |
|
| bShowPassphraseDisabledWarning | bool | Whether the User should be warned that Passphrase usage is disabled or now. Initially activated | RemoteControlSettings.h |
|
| bUseRebindingContext | bool | RemoteControlSettings.h |
|
|
| bWebAppLogRequestDuration | bool | Should WebApp log timing. | RemoteControlSettings.h |
|
| DefaultPanelMode | FName | RemoteControlSettings.h |
|
|
| EntitiesListHiddenColumns | TSet< FName > | RemoteControlSettings.h |
|
|
| Passphrases | TArray< FRCPassphrase > | List of passphrases used for accessing remote control outside of localhost. | RemoteControlSettings.h |
|
| RemoteControlHttpServerPort | uint32 | The web remote control HTTP server's port. | RemoteControlSettings.h |
|
| RemoteControlWebInterfaceBindAddress | FString | The remote control web app bind address. | RemoteControlSettings.h |
|
| RemoteControlWebInterfacePort | uint32 | The remote control web app http port. | RemoteControlSettings.h |
|
| RemoteControlWebsocketServerBindAddress | FString | The address to bind the websocket server to. | RemoteControlSettings.h |
|
| RemoteControlWebSocketServerPort | uint32 | The web remote control WebSocket server's port. | RemoteControlSettings.h |
|
| TreeBindingSplitRatio | float | The split widget control ratio between entity tree and details/protocol binding list. | RemoteControlSettings.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bSecuritySettingsReviewed | bool | RemoteControlSettings.h |
|
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 |
RemoteControlSettings.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| 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 |
|