Navigation
API > API/Runtime > API/Runtime/Engine
FWorldContext A context for dealing with UWorlds at the engine level. As the engine brings up and destroys world, we need a way to keep straight what world belongs to what.
WorldContexts can be thought of as a track. By default we have 1 track that we load and unload levels on. Adding a second context is adding a second track; another track of progression for worlds to live on.
For the GameEngine, there will be one WorldContext until we decide to support multiple simultaneous worlds. For the EditorEngine, there may be one WorldContext for the EditorWorld and one for the PIE World.
FWorldContext provides both a way to manage 'the current PIE UWorld*' as well as state that goes along with connecting/travelling to new worlds.
FWorldContext should remain internal to the UEngine classes. Outside code should not keep pointers or try to manage FWorldContexts directly. Outside code can still deal with UWorld*, and pass UWorld*s into Engine level functions. The Engine code can look up the relevant context for a given UWorld*.
For convenience, FWorldContext can maintain outside pointers to UWorld*s. For example, PIE can tie UWorld* UEditorEngine::PlayWorld to the PIE world context. If the PIE UWorld changes, the UEditorEngine::PlayWorld pointer will be automatically updated. This is done with AddRef() and SetCurrentWorld().
| Name | FWorldContext |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/Engine.h |
| Include Path | #include "Engine/Engine.h" |
Syntax
USTRUCT ()
struct FWorldContext
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWorldContext() |
Engine/Engine.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveNetDrivers | TArray< FNamedNetDriver > | A list of active net drivers | Engine/Engine.h |
|
| AudioDeviceID | uint32 | Handle to this world context's audio device. | Engine/Engine.h | |
| bIsPrimaryPIEInstance | bool | Is this the 'primary' PIE instance. | Engine/Engine.h | |
| bShouldCommitPendingMapChange | uint32 | If true, commit map change the next frame. | Engine/Engine.h | |
| bWaitingOnOnlineSubsystem | bool | Is this world context waiting for an online login to complete (for PIE) | Engine/Engine.h | |
| ContextHandle | FName | Engine/Engine.h | ||
| CustomDescription | FString | Custom description to be display in blueprint debugger UI | Engine/Engine.h | |
| ExternalReferences | TArray< TObjectPtr< UWorld > * > | Outside pointers to CurrentWorld that should be kept in sync if current world changes | Engine/Engine.h | |
| GameViewport | TObjectPtr< class UGameViewportClient > | Engine/Engine.h | ||
| GarbageObjectsToVerify | TSet< FObjectKey > | On a transition to another level (e.g. LoadMap), the engine will verify that these objects have been cleaned up by garbage collection | Engine/Engine.h | |
| LastRemoteURL | FURL | Last server we connected to (for "reconnect" command) | Engine/Engine.h | |
| LastURL | FURL | URL the last time we traveled | Engine/Engine.h | |
| LevelsToLoadForPendingMapChange | TArray< FName > | Array of package/ level names that need to be loaded for the pending map change. | Engine/Engine.h | |
| LoadedLevelsForPendingMapChange | TArray< TObjectPtr< class ULevel > > | Array of already loaded levels. | Engine/Engine.h | |
| ObjectReferencers | TArray< TObjectPtr< class UObjectReferencer > > | Handles to object references; used by the engine to e.g. the prevent objects from being garbage collected. | Engine/Engine.h | |
| OwningGameInstance | TObjectPtr< class UGameInstance > | Engine/Engine.h | ||
| PackagesToFullyLoad | TArray< struct FFullyLoadedPackagesInfo > | A list of tag/array pairs that is used at LoadMap time to fully load packages that may be needed for the map/game with DLC, but we can't use DynamicLoadObject to load from the packages | Engine/Engine.h | |
| PendingLevelStreamingStatusUpdates | TArray< struct FLevelStreamingStatus > | Engine/Engine.h | ||
| PendingMapChangeFailureDescription | FString | Human readable error string for any failure during a map change request. | Engine/Engine.h | |
| PendingNetGame | TObjectPtr< UPendingNetGame > | Engine/Engine.h | ||
| PIEAccumulatedTickSeconds | float | Engine/Engine.h | ||
| PIEFixedTickSeconds | float | If > 0, tick this world at a fixed rate in PIE. | Engine/Engine.h | |
| PIEInstance | int32 | The PIE instance of this world, -1 is default | Engine/Engine.h | |
| PIEPrefix | FString | The Prefix in front of PIE level names, empty is default | Engine/Engine.h | |
| PIEWorldFeatureLevel | ERHIFeatureLevel::Type | The feature level that PIE world should use | Engine/Engine.h | |
| RunAsDedicated | bool | Is this running as a dedicated server | Engine/Engine.h | |
| SeamlessTravelHandler | FSeamlessTravelHandler | Engine/Engine.h | ||
| TravelType | uint8 | TravelType for pending client connects | Engine/Engine.h | |
| TravelURL | FString | URL to travel to for pending client connect | Engine/Engine.h | |
| WorldType | TEnumAsByte< EWorldType::Type > | Engine/Engine.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ThisCurrentWorld | TObjectPtr< UWorld > | Engine/Engine.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Adds an external reference | Engine/Engine.h | ||
void AddRef
(
TObjectPtr< UWorld >& WorldPtr |
Engine/Engine.h | ||
void AddReferencedObjects
(
FReferenceCollector& Collector, |
Collect FWorldContext references for garbage collection | Engine/Engine.h | |
void RemoveRef
(
UWorld*& WorldPtr |
Removes an external reference | Engine/Engine.h | |
void SetCurrentWorld
(
UWorld* World |
Set CurrentWorld and update external reference pointers to reflect this | Engine/Engine.h | |
UWorld * World() |
Engine/Engine.h |