SupportWebsiteURL

SupportWebsiteURL

#Overview

name: SupportWebsiteURL

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 SupportWebsiteURL is to store and provide the URL for the Unreal Engine support website. This setting variable is used in the Unreal Engine editor to allow users to quickly access the support website when needed.

The Unreal Engine subsystem that relies on this setting variable is the MainFrame module, specifically in the MainFrameActions.cpp file. This module is responsible for handling various actions in the main editor interface.

The value of this variable is set through the FUnrealEdMisc::Get().GetURL() function, which retrieves the URL from the engine’s configuration. The actual setting of the value likely occurs in a configuration file or during the engine’s initialization process.

The SupportWebsiteURL variable interacts with the FPlatformProcess::LaunchURL() function, which is used to open the support website in the user’s default web browser.

Developers should be aware that this variable is used in a function called VisitSupportWebSite(), which is likely triggered by a menu item or button in the Unreal Engine editor interface. Modifying this variable will change the destination of this action.

Best practices when using this variable include:

  1. Ensuring the URL is always up-to-date and points to the correct support website.
  2. Considering localization if support websites differ by region or language.
  3. Implementing proper error handling if the URL cannot be retrieved or launched.

Regarding the associated variable SupportWebsiteURL, it is a local FString variable used within the VisitSupportWebSite() function to temporarily store the URL retrieved from the engine’s configuration. This variable is used to pass the URL to the FPlatformProcess::LaunchURL() function.

The associated variable follows the same usage pattern as the main SupportWebsiteURL setting. Developers should ensure that when working with this local variable, they handle potential failures in retrieving the URL or launching the browser. It’s also important to note that this local variable is scoped to the VisitSupportWebSite() function and does not persist beyond that function call.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditor.ini:292, section: [UnrealEd.URLs]

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/MainFrame/Private/Frame/MainFrameActions.cpp:638

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitSupportWebSite

Source code excerpt:

}

void FMainFrameActionCallbacks::VisitSupportWebSite()
{
	FString SupportWebsiteURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("SupportWebsiteURL"), SupportWebsiteURL, true ))
	{
		FPlatformProcess::LaunchURL( *SupportWebsiteURL, NULL, NULL );
	}
}

void FMainFrameActionCallbacks::VisitEpicGamesDotCom()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );

#Loc: <Workspace>/Engine/Source/Editor/MainFrame/Private/Frame/MainFrameActions.cpp:637

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitSupportWebSite

Source code excerpt:

	}
}

void FMainFrameActionCallbacks::VisitSupportWebSite()
{
	FString SupportWebsiteURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("SupportWebsiteURL"), SupportWebsiteURL, true ))
	{
		FPlatformProcess::LaunchURL( *SupportWebsiteURL, NULL, NULL );
	}
}

void FMainFrameActionCallbacks::VisitEpicGamesDotCom()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
}

#Associated Variable and Callsites

This variable is associated with another variable named SupportWebsiteURL. They share the same value. See the following C++ source code.

#Loc: <Workspace>/Engine/Source/Editor/MainFrame/Private/Frame/MainFrameActions.cpp:638

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitSupportWebSite

Source code excerpt:

}

void FMainFrameActionCallbacks::VisitSupportWebSite()
{
	FString SupportWebsiteURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("SupportWebsiteURL"), SupportWebsiteURL, true ))
	{
		FPlatformProcess::LaunchURL( *SupportWebsiteURL, NULL, NULL );
	}
}

void FMainFrameActionCallbacks::VisitEpicGamesDotCom()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );

#Loc: <Workspace>/Engine/Source/Editor/MainFrame/Private/Frame/MainFrameActions.cpp:637

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitSupportWebSite

Source code excerpt:

	}
}

void FMainFrameActionCallbacks::VisitSupportWebSite()
{
	FString SupportWebsiteURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("SupportWebsiteURL"), SupportWebsiteURL, true ))
	{
		FPlatformProcess::LaunchURL( *SupportWebsiteURL, NULL, NULL );
	}
}

void FMainFrameActionCallbacks::VisitEpicGamesDotCom()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
}