FURL

URL structure.

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

Public variable

FString

 

Host

Optional hostname, i.e. "204.157.115.40" or "unreal.epicgames.com", blank if local.

Public variable

FString

 

Map

Map name, i.e. "SkyCity", default is "Entry".

Public variable

TArray< FString...

 

Op

Options.

Public variable

int32

 

Port

Optional host port.

Public variable

FString

 

Portal

Portal to enter through, default is "".

Public variable

FString

 

Protocol

Protocol, i.e. "unreal" or "http".

Public variable

FString

 

RedirectURL

Optional place to download Map if client does not possess it.

Public variable

int32

 

Valid

Constructors

Name Description

Public function

FURL

(
    ENoInit
)

Prevent default from being generated.

Public function

FURL

(
    const TCHAR* Filename
)

Construct a purely default, local URL from an optional filename.

Public function

FURL

(
    FURL* Base,
    const TCHAR* TextURL,
    ETravelType Type
)

Construct a URL from text and an optional relative base.

Functions

Name Description

Public function

void

 

AddOption

(
    const TCHAR* Str
)

Add a unique option to the URL, replacing any existing one.

Public function Static

void

 

FilterURLString

(
    FString& Str
)

Static: Removes any special URL characters from the specified string

Public function Const

FString

 

GetHostPortString()

Prepares the Host and Port values into a standards compliant string

Public function Const

const TCHAR ...

 

GetOption

(
    const TCHAR* Match,
    const TCHAR* Default
)

Returns the value associated with an option.

Public function Const

bool

 

HasOption

(
    const TCHAR* Test
)

Tests if the URL contains an option string.

Public function Const

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.

Public function Const

bool

 

IsLocalInternal()

Returns whether this URL corresponds to an internal object on this local process.

Public function

void

 

LoadURLConfig

(
    const TCHAR* Section,
    const FString& Filename
)

Load URL from config.

Public function

void

 

RemoveOption

(
    const TCHAR* Key,
    const TCHAR* Section,
    const FString& Filename
)

Remove an option from the URL

Public function Const

void

 

SaveURLConfig

(
    const TCHAR* Section,
    const TCHAR* Item,
    const FString& Filename
)

Save URL to config.

Public function Static

void

 

StaticExit()

Public function Static

void

 

StaticInit()

Public function Const

FString

 

ToString

(
    bool FullyQualified
)

Convert this URL to text.

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FURL& Other
)

Compare two URLs to see if they refer to the same exact thing.

Constants

Name

Description

bDefaultsInitialized

UrlConfig

Statics.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss