APIDocsURL

APIDocsURL

#Overview

name: APIDocsURL

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

#Summary

#Setting Variables

#References In INI files

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

• INI Section: UnrealEd.URLs
• Raw value: "https://docs.unrealengine.com/{VERSION}/{I18N}/API/"
• Is Array: False

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/Documentation/Private/Documentation.cpp:90

Scope (from outer to inner):

file
function     bool FDocumentation::OpenAPIHome

Source code excerpt:

{
	FString Url;
	FUnrealEdMisc::Get().GetURL(TEXT("APIDocsURL"), Url, true);

	if (!Url.IsEmpty())
	{
		FUnrealEdMisc::Get().ReplaceDocumentationURLWildcards(Url, FInternationalization::Get().GetCurrentCulture());
		FPlatformProcess::LaunchURL(*Url, nullptr, nullptr);

#Loc: <Workspace>/Engine/Source/Editor/Documentation/Private/Documentation.cpp:90

Scope (from outer to inner):

file
function     bool FDocumentation::OpenAPIHome

Source code excerpt:

{
	FString Url;
	FUnrealEdMisc::Get().GetURL(TEXT("APIDocsURL"), Url, true);

	if (!Url.IsEmpty())
	{
		FUnrealEdMisc::Get().ReplaceDocumentationURLWildcards(Url, FInternationalization::Get().GetCurrentCulture());
		FPlatformProcess::LaunchURL(*Url, nullptr, nullptr);

#Associated Variable and Callsites

This variable is associated with another variable named Url, which is a popular name and overloaded in many contexts. There are 486 callsites. We have to skip these details.