FSeamlessTravelHandler Class Reference

#include <World.h>

Public Member Functions
	FSeamlessTravelHandler ()
bool	StartTravel (UWorld *InCurrentWorld, const FURL &InURL)
bool	IsInTransition () const
bool	HasSwitchedToDefaultMap () const
FString	GetDestinationMapName () const
const UWorld *	GetLoadedWorld () const
void	CancelTravel ()
void	SetPauseAtMidpoint (bool bNowPaused)
ENGINE_API UWorld *	Tick ()

Detailed Description

class that encapsulates seamless world traveling

Constructor & Destructor Documentation

FSeamlessTravelHandler()

FSeamlessTravelHandler::FSeamlessTravelHandler ( )

inline

Member Function Documentation

CancelTravel()

void FSeamlessTravelHandler::CancelTravel

(

)

cancels transition in progress

GetDestinationMapName()

FString FSeamlessTravelHandler::GetDestinationMapName ( ) const

inline

Returns

the destination map that is being travelled to via seamless travel

GetLoadedWorld()

const UWorld * FSeamlessTravelHandler::GetLoadedWorld ( ) const

inline

Returns

the destination world that has been loaded asynchronously by the seamless travel handler.

HasSwitchedToDefaultMap()

bool FSeamlessTravelHandler::HasSwitchedToDefaultMap ( ) const

inline

Returns

if current transition has switched to the default map; returns false if no transition is in progress

IsInTransition()

bool FSeamlessTravelHandler::IsInTransition ( ) const

inline

Returns

whether a transition is already in progress

SetPauseAtMidpoint()

void FSeamlessTravelHandler::SetPauseAtMidpoint

(

bool

bNowPaused

)

turns on/off pausing after loading the transition map only valid during travel, before we've started loading the final destination

Parameters

bNowPaused

- whether the transition should now be paused

StartTravel()

bool FSeamlessTravelHandler::StartTravel	(	UWorld *	InCurrentWorld,
		const FURL &	InURL
	)

starts traveling to the given URL. The required packages will be loaded async and Tick() will perform the transition once we are ready

Parameters

InURL

the URL to travel to

Returns

whether or not we succeeded in starting the travel

Tick()

UWorld * FSeamlessTravelHandler::Tick

(

)

Ticks the transition; handles performing the world switch once the required packages have been loaded

Returns

The new primary world if the world has changed, null if it has not

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/Engine/World.h
• Engine/Source/Runtime/Engine/Private/World.cpp