APlayerController::ClientTravel

Travel to a different map or IP address.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerController.h

Include

#include "GameFramework/PlayerController.h"

Source

/Engine/Source/Runtime/Engine/Private/PlayerController.cpp

Syntax

void ClientTravel
(
    const FString & URL,
    enum ETravelType TravelType,
    bool bSeamless,
    FGuid MapPackageGuid
)

Remarks

Travel to a different map or IP address. Calls the PreClientTravel event before doing anything. NOTE: This is implemented as a locally executed wrapper for ClientTravelInternal, to avoid API compatability breakage

Parameters

Parameter

Description

URL

A string containing the mapname (or IP address) to travel to, along with option key/value pairs

TravelType

specifies whether the client should append URL options used in previous travels; if true is specified for the bSeamlesss parameter, this value must be TRAVEL_Relative.

bSeamless

Indicates whether to use seamless travel (requires TravelType of TRAVEL_Relative)

MapPackageGuid

The GUID of the map package to travel to - this is used to find the file when it has been autodownloaded, so it is only needed for clients

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