ReportABugURL

ReportABugURL

#Overview

name: ReportABugURL

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 ReportABugURL is to store and provide the URL for reporting bugs in the Unreal Engine editor. This setting variable is part of the editor’s user interface and feedback system.

The Unreal Engine subsystem that relies on this setting variable is the MainFrame module, specifically within the editor’s action callbacks. This is evident from the file location and function name where the variable is used.

The value of this variable is set through the FUnrealEdMisc::GetURL function, which retrieves the URL associated with the “ReportABugURL” key. The actual setting of the URL likely occurs elsewhere in the engine’s configuration files or initialization process.

The ReportABugURL variable interacts with the FPlatformProcess::LaunchURL function, which opens the URL in the user’s default web browser.

Developers must be aware that this variable is crucial for the “Report a Bug” functionality in the Unreal Engine editor. If not set correctly, users won’t be able to report bugs directly from the editor interface.

Best practices when using this variable include:

  1. Ensuring the URL is always up-to-date and points to the correct bug reporting page.
  2. Considering region-specific URLs if necessary for different user locations.
  3. Implementing proper error handling if the URL retrieval fails.

Regarding the associated variable ReportABugURL:

The purpose of ReportABugURL is to temporarily store the retrieved URL string within the ReportABug function.

This local variable is used within the MainFrame module, specifically in the FMainFrameActionCallbacks::ReportABug function.

The value of ReportABugURL is set by the FUnrealEdMisc::GetURL function, which retrieves the URL associated with the “ReportABugURL” key.

ReportABugURL interacts directly with the FPlatformProcess::LaunchURL function, providing the actual URL to be opened.

Developers should be aware that this local variable is used to store the retrieved URL before launching it. If the URL retrieval fails, this variable will remain empty.

Best practices for using ReportABugURL include:

  1. Checking if the URL was successfully retrieved before attempting to launch it.
  2. Considering adding error handling or user feedback if the URL retrieval or launching fails.
  3. Ensuring that the scope of this variable is limited to the ReportABug function to avoid any unintended side effects.

#Setting Variables

#References In INI files

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::ReportABug

Source code excerpt:

}

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

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::ReportABug

Source code excerpt:

	return false;
}

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

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

#Associated Variable and Callsites

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::ReportABug

Source code excerpt:

}

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

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

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

Scope (from outer to inner):

file
function     void FMainFrameActionCallbacks::ReportABug

Source code excerpt:

	return false;
}

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

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