EpicGamesURL

EpicGamesURL

#Overview

name: EpicGamesURL

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 12 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of EpicGamesURL is to store and provide the URL for the Epic Games website, which is used in the Unreal Engine editor to allow users to visit the Epic Games website directly from within the engine.

This setting variable is primarily used in the Unreal Engine’s editor subsystem, specifically in the UnrealEd and MainFrame modules. It’s utilized in the About screen and in the main frame actions of the editor.

The value of this variable is set using the FUnrealEdMisc::GetURL function, which retrieves the URL from the engine’s configuration. This suggests that the actual URL value is likely stored in a configuration file or system, allowing for easy updates without changing the code.

The EpicGamesURL variable interacts closely with the FPlatformProcess::LaunchURL function, which is used to open the URL in the user’s default web browser.

Developers should be aware that this variable is used in user-facing features of the Unreal Engine editor. Changes to this URL should be made carefully to ensure users are directed to the correct Epic Games resources.

Best practices when using this variable include:

  1. Ensuring the URL is always up-to-date and points to the correct Epic Games resource.
  2. Considering localization if different URLs are needed for different regions or languages.
  3. Implementing error handling in case the URL retrieval fails or the URL is invalid.

Regarding the associated variable EpicGamesURL, it’s a local FString variable used to temporarily store the URL retrieved from the GetURL function. It’s used in the same way as the setting variable, serving as an intermediary between the URL retrieval and the launching of the URL in the browser. The same considerations and best practices apply to this associated variable.

#Setting Variables

#References In INI files

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

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Private/AboutScreen.cpp:203

Scope (from outer to inner):

file
function     FReply SAboutScreen::OnEpicGamesButtonClicked

Source code excerpt:

{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("logo_docs")));
	return FReply::Handled();
}

FReply SAboutScreen::OnEpicGamesButtonClicked()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
	return FReply::Handled();
}

FReply SAboutScreen::OnClose()
{
	TSharedRef<SWindow> ParentWindow = FSlateApplication::Get().FindWidgetWindow( AsShared() ).ToSharedRef();
	FSlateApplication::Get().RequestDestroyWindow( ParentWindow );
	return FReply::Handled();
}

#undef LOCTEXT_NAMESPACE

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitEpicGamesDotCom

Source code excerpt:

	{
		FPlatformProcess::LaunchURL( *SupportWebsiteURL, NULL, NULL );
	}
}

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

void FMainFrameActionCallbacks::DocumentationHome()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("help_menu")));
}

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitEpicGamesDotCom

Source code excerpt:

	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 );
	}
}

void FMainFrameActionCallbacks::DocumentationHome()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("help_menu")));
}

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

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Private/AboutScreen.cpp:202

Scope (from outer to inner):

file
function     FReply SAboutScreen::OnEpicGamesButtonClicked

Source code excerpt:

FReply SAboutScreen::OnUEButtonClicked()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("logo_docs")));
	return FReply::Handled();
}

FReply SAboutScreen::OnEpicGamesButtonClicked()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
	return FReply::Handled();
}

FReply SAboutScreen::OnClose()
{
	TSharedRef<SWindow> ParentWindow = FSlateApplication::Get().FindWidgetWindow( AsShared() ).ToSharedRef();
	FSlateApplication::Get().RequestDestroyWindow( ParentWindow );
	return FReply::Handled();
}

#undef LOCTEXT_NAMESPACE

#Associated Variable and Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Private/AboutScreen.cpp:203

Scope (from outer to inner):

file
function     FReply SAboutScreen::OnEpicGamesButtonClicked

Source code excerpt:

{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("logo_docs")));
	return FReply::Handled();
}

FReply SAboutScreen::OnEpicGamesButtonClicked()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
	return FReply::Handled();
}

FReply SAboutScreen::OnClose()
{
	TSharedRef<SWindow> ParentWindow = FSlateApplication::Get().FindWidgetWindow( AsShared() ).ToSharedRef();
	FSlateApplication::Get().RequestDestroyWindow( ParentWindow );
	return FReply::Handled();
}

#undef LOCTEXT_NAMESPACE

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitEpicGamesDotCom

Source code excerpt:

	{
		FPlatformProcess::LaunchURL( *SupportWebsiteURL, NULL, NULL );
	}
}

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

void FMainFrameActionCallbacks::DocumentationHome()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("help_menu")));
}

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitEpicGamesDotCom

Source code excerpt:

	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 );
	}
}

void FMainFrameActionCallbacks::DocumentationHome()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("help_menu")));
}

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

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Private/AboutScreen.cpp:202

Scope (from outer to inner):

file
function     FReply SAboutScreen::OnEpicGamesButtonClicked

Source code excerpt:

FReply SAboutScreen::OnUEButtonClicked()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("logo_docs")));
	return FReply::Handled();
}

FReply SAboutScreen::OnEpicGamesButtonClicked()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
	return FReply::Handled();
}

FReply SAboutScreen::OnClose()
{
	TSharedRef<SWindow> ParentWindow = FSlateApplication::Get().FindWidgetWindow( AsShared() ).ToSharedRef();
	FSlateApplication::Get().RequestDestroyWindow( ParentWindow );
	return FReply::Handled();
}

#undef LOCTEXT_NAMESPACE

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Private/AboutScreen.cpp:203

Scope (from outer to inner):

file
function     FReply SAboutScreen::OnEpicGamesButtonClicked

Source code excerpt:

{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("logo_docs")));
	return FReply::Handled();
}

FReply SAboutScreen::OnEpicGamesButtonClicked()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
	return FReply::Handled();
}

FReply SAboutScreen::OnClose()
{
	TSharedRef<SWindow> ParentWindow = FSlateApplication::Get().FindWidgetWindow( AsShared() ).ToSharedRef();
	FSlateApplication::Get().RequestDestroyWindow( ParentWindow );
	return FReply::Handled();
}

#undef LOCTEXT_NAMESPACE

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitEpicGamesDotCom

Source code excerpt:

	{
		FPlatformProcess::LaunchURL( *SupportWebsiteURL, NULL, NULL );
	}
}

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

void FMainFrameActionCallbacks::DocumentationHome()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("help_menu")));
}

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::VisitEpicGamesDotCom

Source code excerpt:

	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 );
	}
}

void FMainFrameActionCallbacks::DocumentationHome()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("help_menu")));
}

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

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Private/AboutScreen.cpp:202

Scope (from outer to inner):

file
function     FReply SAboutScreen::OnEpicGamesButtonClicked

Source code excerpt:

FReply SAboutScreen::OnUEButtonClicked()
{
	IDocumentation::Get()->OpenHome(FDocumentationSourceInfo(TEXT("logo_docs")));
	return FReply::Handled();
}

FReply SAboutScreen::OnEpicGamesButtonClicked()
{
	FString EpicGamesURL;
	if(FUnrealEdMisc::Get().GetURL( TEXT("EpicGamesURL"), EpicGamesURL ))
	{
		FPlatformProcess::LaunchURL( *EpicGamesURL, NULL, NULL );
	}
	return FReply::Handled();
}

FReply SAboutScreen::OnClose()
{
	TSharedRef<SWindow> ParentWindow = FSlateApplication::Get().FindWidgetWindow( AsShared() ).ToSharedRef();
	FSlateApplication::Get().RequestDestroyWindow( ParentWindow );
	return FReply::Handled();
}

#undef LOCTEXT_NAMESPACE