Represents the settings for CEF context initialization and configuration. More...

#include <CefSettings.h>

Public Attributes
FName	BridgeObjectName = TEXT("UCefViewBridge")
	The name of the bridge object injected into all browser frames. This object enables communication between JavaScript running in web content and native C++ code.

FName	BuiltinSchemeName = TEXT("UCefView")
	The name of the built-in custom URI scheme used by the CEF context.

FString	UserAgent
	The user agent string sent by the browser to web servers.

TArray< FArchiveFileResourceMapping >	ArchiveFileResourceMapping
	Archive file resource mappings for serving web content from .zip files. Only zip format is supported. Each mapping associates a virtual URL with a zip archive.

TArray< FLocalFolderResourceMapping >	LocalFolderResroucesMapping
	Local folder resource mappings for serving web content from directories on disk.

FColor	BackgroundColor = FColor::White
	The background color used for browser rendering.

FString	Locale
	The locale to use for browser UI and web content.

TArray< FString >	AcceptLanguageList
	List of accepted languages for HTTP requests, used in the "Accept-Language" header.

bool	PersistSessionCookies = true
	Whether to persist session cookies across browser restarts.

bool	PersistUserPreferences = true
	Whether to persist user preferences (such as autofill data, settings, etc.).

ECefLogLevel	LogLevel = ECefLogLevel::Default
	The log level for CEF diagnostic output.

int32	RemoteDebuggingport = 0
	The port number for remote debugging with Chrome/Edge Dev Tools.

bool	DisableCommandLineArgsPassthrough = false
	Whether to disable passing the application command line arguments to CEF.

bool	DisableSandbox = true
	Whether to disable the Chromium sandbox. (Only applicable on macOS platform.)

TMap< FString, FString >	CommandLineArgs
	Additional command line arguments to be passed to CEF.

Detailed Description

Represents the settings for CEF context initialization and configuration.

UCefSettings allows you to customize the behavior of the embedded Chromium browser in your Unreal Engine project. These settings control aspects such as resource mapping, localization, logging, debugging, and browser interoperability. Changes to these settings should be made before any CEF browser instances are created.

Example usage:

UCefSettings* CefSettings = GetMutableDefault<UCefSettings>();

CefSettings->UserAgent = TEXT("MyCustomUserAgent/1.0");

UCefSettings

Represents the settings for CEF context initialization and configuration.

Definition CefSettings.h:91

UCefSettings::UserAgent

FString UserAgent

The user agent string sent by the browser to web servers.

Definition CefSettings.h:136

Member Data Documentation

◆ AcceptLanguageList

TArray<FString> UCefSettings::AcceptLanguageList

List of accepted languages for HTTP requests, used in the "Accept-Language" header.

Provide a comma-delimited, ordered list of language codes (e.g., "en-US,fr,es"). This helps web servers deliver localized content.

◆ ArchiveFileResourceMapping

TArray<FArchiveFileResourceMapping> UCefSettings::ArchiveFileResourceMapping

Archive file resource mappings for serving web content from .zip files. Only zip format is supported. Each mapping associates a virtual URL with a zip archive.

The file path must be relative to the Game directory. This allows you to package web assets efficiently.

◆ BackgroundColor

FColor UCefSettings::BackgroundColor = FColor::White

The background color used for browser rendering.

This color is used as the default background for web content. Adjust it to match your application's theme.

◆ BridgeObjectName

FName UCefSettings::BridgeObjectName = TEXT("UCefViewBridge")

The name of the bridge object injected into all browser frames. This object enables communication between JavaScript running in web content and native C++ code.

The bridge object is accessible in JavaScript as a property of the window object (e.g., window.bridgeObject). Use this to expose native functions or data to your web UI.

◆ BuiltinSchemeName

FName UCefSettings::BuiltinSchemeName = TEXT("UCefView")

The name of the built-in custom URI scheme used by the CEF context.

This scheme is used for internal resource mapping and communication between the browser and the engine.

◆ CommandLineArgs

TMap<FString, FString> UCefSettings::CommandLineArgs

Initial value:

= 
    {
      { TEXT("remote-allow-origins"), TEXT("*") },
    }

Additional command line arguments to be passed to CEF.

Use this to enable or configure advanced CEF features. Each entry maps a switch name to its value. For example: { "remote-allow-origins", "*" }

◆ DisableCommandLineArgsPassthrough

bool UCefSettings::DisableCommandLineArgsPassthrough = false

Whether to disable passing the application command line arguments to CEF.

Disabling this can help prevent conflicts or unintended behavior caused by command line switches.

◆ DisableSandbox

bool UCefSettings::DisableSandbox = true

Whether to disable the Chromium sandbox. (Only applicable on macOS platform.)

Disabling the sandbox may be required for certain debugging or integration scenarios, but can reduce security.

◆ Locale

FString UCefSettings::Locale

The locale to use for browser UI and web content.

If empty, the default locale "en-US" is used. On Linux, this value is ignored and locale is determined by environment variables. You can also set the locale using the "lang" command-line switch.

◆ LocalFolderResroucesMapping

TArray<FLocalFolderResourceMapping> UCefSettings::LocalFolderResroucesMapping

Local folder resource mappings for serving web content from directories on disk.

The folder path must be relative to the Game Content directory. Use this to expose static assets (HTML, JS, CSS, etc.) to your CEF browser instances.

◆ LogLevel

ECefLogLevel UCefSettings::LogLevel = ECefLogLevel::Default

The log level for CEF diagnostic output.

Adjust this to control the verbosity of CEF logs. Higher verbosity can help with debugging but may impact performance.

◆ PersistSessionCookies

bool UCefSettings::PersistSessionCookies = true

Whether to persist session cookies across browser restarts.

If true, session cookies will be saved and restored. If false, they will be cleared when the browser is closed.

◆ PersistUserPreferences

bool UCefSettings::PersistUserPreferences = true

Whether to persist user preferences (such as autofill data, settings, etc.).

If true, user preferences will be saved and restored between sessions.

◆ RemoteDebuggingport

int32 UCefSettings::RemoteDebuggingport = 0

The port number for remote debugging with Chrome/Edge Dev Tools.

If set to a non-zero value, you can connect to the browser for debugging using Chrome or Edge at "localhost:[port]". Useful for inspecting and debugging web content at runtime.

◆ UserAgent

FString UCefSettings::UserAgent