bDisableSocialOverlay

bDisableSocialOverlay

#Overview

name: bDisableSocialOverlay

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

It is referenced in 4 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of bDisableSocialOverlay is to control the visibility and functionality of the social overlay feature in the Epic Online Services (EOS) SDK integration within Unreal Engine 5.

This setting variable is primarily used by the EOS SDK Manager, which is part of the EOSShared plugin. This plugin is responsible for integrating Epic Online Services functionality into Unreal Engine projects.

The value of this variable is set in multiple ways:

1. It can be set programmatically in the code, as seen in the first code excerpt where it’s set to true for servers and editors.
2. It can be loaded from the engine configuration file (GEngineIni) using the GConfig system.

bDisableSocialOverlay interacts with other EOS-related variables, particularly:

• bDisableOverlay: Controls the overall overlay functionality
• bWindowsEnableOverlayD3D9, bWindowsEnableOverlayD3D10, bWindowsEnableOverlayOpenGL: Control overlay functionality for specific graphics APIs on Windows

Developers must be aware that:

1. This variable specifically targets the social features of the EOS overlay.
2. It’s automatically set to true for server builds and when running in the editor.
3. Its value can affect the user experience and available social features in the game.

Best practices when using this variable include:

1. Consider the target platform and build type when setting this value.
2. Ensure consistency between this setting and other overlay-related settings.
3. Test thoroughly with both enabled and disabled states to ensure proper functionality in all scenarios.
4. Document any custom configuration to maintain consistency across development and production environments.

#Setting Variables

#References In INI files

Location: <Workspace>/Projects/Lyra/Config/Custom/SteamEOS/DefaultEngine.ini:94, section: [EOSSDK.Platform.Lyra]

• INI Section: EOSSDK.Platform.Lyra
• Raw value: false
• Is Array: False

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Plugins/Online/EOSShared/Source/EOSShared/Private/EOSSDKManager.cpp:357

Scope (from outer to inner):

file
function     const FEOSSDKPlatformConfig* FEOSSDKManager::GetPlatformConfig

Source code excerpt:

			// Don't attempt to load overlay for servers or editors.
			PlatformConfig->bDisableOverlay = true;
			PlatformConfig->bDisableSocialOverlay = true;
		}
		else
		{
			// Overlay is on by default, enable additional overlay options.
			PlatformConfig->bWindowsEnableOverlayD3D9 = true;
			PlatformConfig->bWindowsEnableOverlayD3D10 = true;

#Loc: <Workspace>/Engine/Plugins/Online/EOSShared/Source/EOSShared/Private/EOSSDKManager.cpp:371

Scope (from outer to inner):

file
function     const FEOSSDKPlatformConfig* FEOSSDKManager::GetPlatformConfig

Source code excerpt:

	GConfig->GetBool(*SectionName, TEXT("bLoadingInEditor"), PlatformConfig->bLoadingInEditor, GEngineIni);
	GConfig->GetBool(*SectionName, TEXT("bDisableOverlay"), PlatformConfig->bDisableOverlay, GEngineIni);
	GConfig->GetBool(*SectionName, TEXT("bDisableSocialOverlay"), PlatformConfig->bDisableSocialOverlay, GEngineIni);
	GConfig->GetBool(*SectionName, TEXT("bWindowsEnableOverlayD3D9"), PlatformConfig->bWindowsEnableOverlayD3D9, GEngineIni);
	GConfig->GetBool(*SectionName, TEXT("bWindowsEnableOverlayD3D10"), PlatformConfig->bWindowsEnableOverlayD3D10, GEngineIni);
	GConfig->GetBool(*SectionName, TEXT("bWindowsEnableOverlayOpenGL"), PlatformConfig->bWindowsEnableOverlayOpenGL, GEngineIni);
	GConfig->GetBool(*SectionName, TEXT("bEnableRTC"), PlatformConfig->bEnableRTC, GEngineIni);
	GConfig->GetInt(*SectionName, TEXT("TickBudgetInMilliseconds"), PlatformConfig->TickBudgetInMilliseconds, GEngineIni);
	GConfig->GetArray(*SectionName, TEXT("OptionalConfig"), PlatformConfig->OptionalConfig, GEngineIni);

#Loc: <Workspace>/Engine/Plugins/Online/EOSShared/Source/EOSShared/Private/EOSSDKManager.cpp:573

Scope (from outer to inner):

file
function     IEOSPlatformHandlePtr FEOSSDKManager::CreatePlatform

Source code excerpt:

	if (PlatformConfig->bLoadingInEditor) PlatformOptions.Flags |= EOS_PF_LOADING_IN_EDITOR;
	if (PlatformConfig->bDisableOverlay) PlatformOptions.Flags |= EOS_PF_DISABLE_OVERLAY;
	if (PlatformConfig->bDisableSocialOverlay) PlatformOptions.Flags |= EOS_PF_DISABLE_SOCIAL_OVERLAY;

	if (FPlatformMisc::IsCacheStorageAvailable())
	{
		PlatformOptions.CacheDirectory = Utf8CacheDirectory.Length() ? Utf8CacheDirectory.Get() : nullptr;
	}
	else

#Loc: <Workspace>/Engine/Plugins/Online/EOSShared/Source/EOSShared/Public/IEOSSDKManager.h:29

Scope: file

Source code excerpt:

	bool bLoadingInEditor = false;
	bool bDisableOverlay = false;
	bool bDisableSocialOverlay = false;
	bool bWindowsEnableOverlayD3D9 = false;
	bool bWindowsEnableOverlayD3D10 = false;
	bool bWindowsEnableOverlayOpenGL = false;
	bool bEnableRTC = true;
	int32 TickBudgetInMilliseconds = 1;
	TArray<FString> OptionalConfig;