Navigation
API > API/Runtime > API/Runtime/Engine
Class that encapsulates seamless world traveling
| Name | FSeamlessTravelHandler |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/World.h |
| Include Path | #include "Engine/World.h" |
Syntax
class FSeamlessTravelHandler
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSeamlessTravelHandler() |
Engine/World.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bNeedCancelCleanUp | bool | Set when we started a new travel in the middle of a previous one and still need to clean up that previous attempt | Engine/World.h | |
| bPauseAtMidpoint | bool | While set, pause at midpoint (after loading transition level, before loading final destination) | Engine/World.h | |
| bSwitchedToDefaultMap | bool | Whether or not we've transitioned to the entry level and are now moving on to the specified map | Engine/World.h | |
| bTransitionInProgress | bool | Set when a transition is in progress | Engine/World.h | |
| CurrentWorld | UWorld * | The world we are travelling from | Engine/World.h | |
| LoadedPackage | UObject * | Set to the loaded package once loading is complete. | Engine/World.h | |
| LoadedWorld | UWorld * | Set to the loaded world object inside that package. | Engine/World.h | |
| PendingTravelURL | FURL | URL we're traveling to | Engine/World.h | |
| SeamlessTravelStartTime | double | Real time which we started traveling at | Engine/World.h | |
| WorldContextHandle | FName | The context we are running in. | Engine/World.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelTravel() |
Cancels transition in progress | Engine/World.h | |
FString GetDestinationMapName() |
Engine/World.h | ||
const UWorld * GetLoadedWorld() |
Engine/World.h | ||
bool HasSwitchedToDefaultMap() |
Engine/World.h | ||
bool IsInTransition() |
Engine/World.h | ||
void SetPauseAtMidpoint
(
bool bNowPaused |
Turns on/off pausing after loading the transition map only valid during travel, before we've started loading the final destination | Engine/World.h | |
bool StartTravel
(
UWorld* InCurrentWorld, |
Starts traveling to the given URL. | Engine/World.h | |
UWorld * Tick() |
Ticks the transition; handles performing the world switch once the required packages have been loaded | Engine/World.h |