Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > FURL

Light Theme

Dark Theme

FURL

URL structure.

Choose your operating system:

Windows

macOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/EngineBaseTypes.h
Include	#include "Engine/EngineBaseTypes.h"

Syntax

struct FURL

Remarks

URL structure.

Variables

		Name	Description
	FString	Host	Optional hostname, i.e. "204.157.115.40" or "unreal.epicgames.com", blank if local.
	FString	Map	Map name, i.e. "SkyCity", default is "Entry".
	TArray< FString...	Op	Options.
	int32	Port	Optional host port.
	FString	Portal	Portal to enter through, default is "".
	FString	Protocol	Protocol, i.e. "unreal" or "http".
	FString	RedirectURL	Optional place to download Map if client does not possess it.
	int32	Valid

Constructors

	Name	Description
	FURL ( ENoInit )	Prevent default from being generated.
	FURL ( const TCHAR* Filename )	Construct a purely default, local URL from an optional filename.
	FURL ( FURL* Base, const TCHAR* TextURL, ETravelType Type )	Construct a URL from text and an optional relative base.

Functions

		Name	Description
	void	AddOption ( const TCHAR* Str )	Add a unique option to the URL, replacing any existing one.
	void	FilterURLString ( FString& Str )	Static: Removes any special URL characters from the specified string
	FString	GetHostPortString()	Prepares the Host and Port values into a standards compliant string
	const TCHAR ...	GetOption ( const TCHAR* Match, const TCHAR* Default )	Returns the value associated with an option.
	bool	HasOption ( const TCHAR* Test )	Tests if the URL contains an option string.
	bool	IsInternal()	Returns whether this URL corresponds to an internal object, i.e. an Unreal level which this app can try to connect to locally or on the net.
	bool	IsLocalInternal()	Returns whether this URL corresponds to an internal object on this local process.
	void	LoadURLConfig ( const TCHAR* Section, const FString& Filename )	Load URL from config.
	void	RemoveOption ( const TCHAR* Key, const TCHAR* Section, const FString& Filename )	Remove an option from the URL
	void	SaveURLConfig ( const TCHAR* Section, const TCHAR* Item, const FString& Filename )	Save URL to config.
	void	StaticExit()
	void	StaticInit()
	FString	ToString ( bool FullyQualified )	Convert this URL to text.

Operators

		Name	Description
	bool	operator== ( const FURL& Other )	Compare two URLs to see if they refer to the same exact thing.

Constants

Name	Description
bDefaultsInitialized
UrlConfig	Statics.