DocumentationURL

DocumentationURL

#Overview

name: DocumentationURL

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

#Summary

#Setting Variables

#References In INI files

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

#References in C++ code

#Callsites

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

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

Scope (from outer to inner):

file
function     FString FDocumentation::GetBaseUrl

Source code excerpt:


	FString DefaultUrl;
	FUnrealEdMisc::Get().GetURL(TEXT("DocumentationURL"), DefaultUrl, true);
	return DefaultUrl;
}

bool FDocumentation::AddSourcePath(const FString& Path)
{
	if (!Path.IsEmpty() && FPaths::DirectoryExists(Path))

#Loc: <Workspace>/Engine/Source/Editor/Documentation/Private/DocumentationLink.h:25

Scope (from outer to inner):

file
class        class FDocumentationLink
function     static FString GetHomeUrl

Source code excerpt:

	{
		FString Url;
		FUnrealEdMisc::Get().GetURL( TEXT("DocumentationURL"), Url, true );
		FUnrealEdMisc::Get().ReplaceDocumentationURLWildcards(Url, Culture);

		return Url;
	}

	static FString ToUrl(const FString& Link, FDocumentationSourceInfo const& Source, const FString& BaseUrlId = FString())

#Loc: <Workspace>/Engine/Plugins/Enterprise/DatasmithImporter/Source/DatasmithImporter/Private/UI/DatasmithImportOptionsWindow.cpp:20

Scope: file

Source code excerpt:

#define LOCTEXT_NAMESPACE "DatasmithOptionsWindow"

FString SDatasmithOptionsWindow::DocumentationURL = TEXT("https://docs.unrealengine.com/en-US/WorkingWithContent/Importing/Datasmith/");

void SDatasmithOptionsWindow::Construct(const FArguments& InArgs)
{
	ImportOptions = InArgs._ImportOptions;
	Window = InArgs._WidgetWindow;
	bShouldProceed = false;

#Loc: <Workspace>/Engine/Plugins/Enterprise/DatasmithImporter/Source/DatasmithImporter/Public/UI/DatasmithImportOptionsWindow.h:59

Scope (from outer to inner):

file
class        class SDatasmithOptionsWindow : public SCompoundWidget
function     static const FString& GetDocumentationURL

Source code excerpt:

	}

	static const FString& GetDocumentationURL() { return DocumentationURL; }

private:
	FReply OnProceed()
	{
		bShouldProceed = true;
		if (Window.IsValid())

#Loc: <Workspace>/Engine/Plugins/Enterprise/DatasmithImporter/Source/DatasmithImporter/Public/UI/DatasmithImportOptionsWindow.h:94

Scope (from outer to inner):

file
class        class SDatasmithOptionsWindow : public SCompoundWidget

Source code excerpt:

	bool bShouldProceed;
	bool bUseSameOptions;
	static FString DocumentationURL;
};

#Loc: <Workspace>/Engine/Plugins/Experimental/Mutable/Source/CustomizableObjectEditor/Private/MuCOE/CustomizableObjectEditor.cpp:1248

Scope (from outer to inner):

file
function     FString FCustomizableObjectEditor::GetDocumentationLink

Source code excerpt:

FString FCustomizableObjectEditor::GetDocumentationLink() const
{
	return DocumentationURL;
}


void FCustomizableObjectEditor::ExtendToolbar()
{
	TSharedPtr<FUICommandList> CommandList = GetToolkitCommands();

#Loc: <Workspace>/Engine/Plugins/Experimental/Mutable/Source/CustomizableObjectEditor/Private/MuCOE/CustomizableObjectEditor.h:453

Scope (from outer to inner):

file
class        class FCustomizableObjectEditor : public ICustomizableObjectEditor, public FGCObject, public FNotifyHook, public FTickableEditorObject, public FEditorUndoClient

Source code excerpt:


	/** URL to open when pressing the documentation button generated by UE */
	const FString DocumentationURL{ TEXT("https://github.com/anticto/Mutable-Documentation/wiki") };

	/** Postponed work to do when OnUpdatePreviewInstance is called. Emptied at the end on each OnUpdatePreviewInstance call. */
	TArray<TFunction<void()>> OnUpdatePreviewInstanceWork;

	TObjectPtr<UProjectorParameter> ProjectorParameter = nullptr;

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

Scope (from outer to inner):

file
function     FString FDocumentation::GetBaseUrl

Source code excerpt:


	FString DefaultUrl;
	FUnrealEdMisc::Get().GetURL(TEXT("DocumentationURL"), DefaultUrl, true);
	return DefaultUrl;
}

bool FDocumentation::AddSourcePath(const FString& Path)
{
	if (!Path.IsEmpty() && FPaths::DirectoryExists(Path))

#Loc: <Workspace>/Engine/Source/Editor/Documentation/Private/DocumentationLink.h:25

Scope (from outer to inner):

file
class        class FDocumentationLink
function     static FString GetHomeUrl

Source code excerpt:

	{
		FString Url;
		FUnrealEdMisc::Get().GetURL( TEXT("DocumentationURL"), Url, true );
		FUnrealEdMisc::Get().ReplaceDocumentationURLWildcards(Url, Culture);

		return Url;
	}

	static FString ToUrl(const FString& Link, FDocumentationSourceInfo const& Source, const FString& BaseUrlId = FString())

#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 426 callsites. We have to skip these details.