1. Epic GamesDeveloper
  3. FURL

FURL

URL structure.

API > API/Runtime > API/Runtime/Engine

URL structure.

   
Name FURL
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Engine/EngineBaseTypes.h
Include Path #include "Engine/EngineBaseTypes.h"

Syntax

USTRUCT ()  
struct FURL

Constructors

Name Remarks Include Path Unreal Specifiers
Prevent default from being generated. Engine/EngineBaseTypes.h  

FURL ( const TCHAR* Filename
)

 Construct a purely default, local URL from an optional filename. Engine/EngineBaseTypes.h  

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

 Construct a URL from text and an optional relative base. Engine/EngineBaseTypes.h  

Constants

Name Type Remarks Include Path
bDefaultsInitialized bool   Engine/EngineBaseTypes.h
UrlConfig FUrlConfig Statics. Engine/EngineBaseTypes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Host FString Optional hostname, i.e. "204.157.115.40" or "unreal.epicgames.com", blank if local. Engine/EngineBaseTypes.h  
Map FString Map name, i.e. "SkyCity", default is "Entry". Engine/EngineBaseTypes.h  
Op TArray< FString > Options. Engine/EngineBaseTypes.h  
Port int32 Optional host port. Engine/EngineBaseTypes.h  
Portal FString Portal to enter through, default is "". Engine/EngineBaseTypes.h  
Protocol FString Protocol, i.e. "unreal" or "http". Engine/EngineBaseTypes.h  
RedirectURL FString Optional place to download Map if client does not possess it. Engine/EngineBaseTypes.h  
Valid int32   Engine/EngineBaseTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddOption ( const TCHAR* Str
)

 Add a unique option to the URL, replacing any existing one. Engine/EngineBaseTypes.h  

FString GetHostPortString()

 Prepares the Host and Port values into a standards compliant string Engine/EngineBaseTypes.h  

const TCHAR * GetOption ( const TCHAR* Match,
const TCHAR* Default
) const

 Returns the value associated with an option. Engine/EngineBaseTypes.h  

bool HasOption ( const TCHAR* Test
) const

 Tests if the URL contains an option string. Engine/EngineBaseTypes.h  

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. Engine/EngineBaseTypes.h  

bool IsLocalInternal ()

 Returns whether this URL corresponds to an internal object on this local process. Engine/EngineBaseTypes.h  

void LoadURLConfig ( const TCHAR* Section,
const FString& Filename
)

 Load URL from config. Engine/EngineBaseTypes.h  

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

 Remove an option from the URL Engine/EngineBaseTypes.h  

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

 Save URL to config. Engine/EngineBaseTypes.h  

FString ToString ( bool FullyQualified
) const

 Convert this URL to text. Engine/EngineBaseTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

static void FilterURLString ( FString& Str
)

 Static: Removes any special URL characters from the specified string Engine/EngineBaseTypes.h  

static void StaticExit()

   Engine/EngineBaseTypes.h  

static void StaticInit()

   Engine/EngineBaseTypes.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FURL& Other
) const

 Compare two URLs to see if they refer to the same exact thing. Engine/EngineBaseTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page