ULevelStreamingDynamic::LoadLevelInstance

Stream in a level with a specific location and rotation.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/LevelStreamingDynamic.h

Include

#include "Engine/LevelStreamingDynamic.h"

Source

/Engine/Source/Runtime/Engine/Private/LevelStreaming.cpp

Syntax

static ULevelStreamingDynamic * LoadLevelInstance
(
    UObject * WorldContextObject,
    FString LevelName,
    FVector Location,
    FRotator Rotation,
    bool & bOutSuccess,
    const FString & OptionalLevelNameOverride
)

Remarks

Stream in a level with a specific location and rotation. You can create multiple instances of the same level!

The level to be loaded does not have to be in the persistent map's Levels list, however to ensure that the .umap does get packaged, please be sure to include the .umap in your Packaging Settings:

Project Settings -> Packaging -> List of Maps to Include in a Packaged Build (you may have to show advanced or type in filter)

this is necessary for server and client networking because the level must have the same name on both.

Returns

Streaming level object for a level instance

Parameters

Parameter

Description

LevelName

Level package name to load, ex: /Game/Maps/MyMapName, specifying short name like MyMapName will force very slow search on disk

Location

World space location where the level should be spawned

Rotation

World space rotation for rotating the entire level

bOutSuccess

Whether operation was successful (map was found and added to the sub-levels list)

OptionalLevelNameOverride

If set, the loaded level package have this name, which is used by other functions like UnloadStreamLevel.

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