IssueTrackerURL

IssueTrackerURL

#Overview

name: IssueTrackerURL

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 IssueTrackerURL is to store and provide the URL for the issue tracker system used by the Unreal Engine development team. This setting variable is part of the editor’s user interface and functionality, specifically related to accessing external resources for support and issue reporting.

The Unreal Engine subsystem that relies on this setting variable is the MainFrame module, which is part of the editor’s user interface. This can be seen from the file path Engine/Source/Editor/MainFrame/Private/Frame/MainFrameActions.cpp.

The value of this variable is set externally and retrieved using the FUnrealEdMisc::Get().GetURL() function. This suggests that the actual URL is likely stored in a configuration file or another external source that the engine reads from.

The IssueTrackerURL interacts with a local FString variable of the same name within the OpenIssueTracker() function. This local variable is used to store the retrieved URL before launching it in the user’s default web browser.

Developers should be aware that this variable is used to provide a direct link to the issue tracker from within the Unreal Editor. Changing this URL could affect the ability of users to report issues or access support resources directly from the editor.

Best practices when using this variable include:

  1. Ensuring that the URL is always up-to-date and points to the correct issue tracker.
  2. Considering the security implications of launching URLs from within the application.
  3. Providing appropriate error handling if the URL cannot be retrieved or launched.

Regarding the associated variable IssueTrackerURL: This is a local FString variable used within the OpenIssueTracker() function to temporarily store the retrieved URL. It’s not a separate setting variable but rather a local variable that shares the same name as the setting for clarity. The function retrieves the URL using the setting name “IssueTrackerURL” and stores it in this local variable before launching it.

The best practice when using this local variable is to ensure proper error checking, as demonstrated in the code. The URL is only launched if it can be successfully retrieved from the settings.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditor.ini:301, 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:620

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::OpenIssueTracker

Source code excerpt:

}

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

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::OpenIssueTracker

Source code excerpt:

	}
}

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

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

#Associated Variable and Callsites

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::OpenIssueTracker

Source code excerpt:

}

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

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::OpenIssueTracker

Source code excerpt:

	}
}

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

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