ue-world-level-streaming
Use when streaming levels in and out, setting up World Partition, or moving between maps. Also use when the user mentions 'level streaming', 'World Partition', 'data layer', 'UDataLayerManager', 'SetDataLayerRuntimeState', 'LoadStreamLevel', 'UnloadStreamLevel', 'ULevelStreamingDynamic', 'LoadLevelInstance', 'ALevelInstance', 'streaming source', 'streaming volume', 'HLOD', 'OpenLevel', 'ServerTravel', 'seamless travel', 'sub-level', 'open world', or 'UWorldSubsystem'. For replication and net relevancy, see ue-networking-replication; for GameMode travel callbacks, see ue-gameplay-framework; for saving world state to disk, see ue-serialization-savegames.
quodsoler · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add quodsoler/unreal-engine-skills --skill ue-world-level-streamingAbout this skill
name: ue-world-level-streaming description: "Use when streaming levels in and out, setting up World Partition, or moving between maps. Also use when the user mentions 'level streaming', 'World Partition', 'data layer', 'UDataLayerManager', 'SetDataLayerRuntimeState', 'LoadStreamLevel', 'UnloadStreamLevel', 'ULevelStreamingDynamic', 'LoadLevelInstance', 'ALevelInstance', 'streaming source', 'streaming volume', 'HLOD', 'OpenLevel', 'ServerTravel', 'seamless travel', 'sub-level', 'open world', or 'UWorldSubsystem'. For replication and net relevancy, see ue-networking-replication; for GameMode travel callbacks, see ue-gameplay-framework; for saving world state to disk, see ue-serialization-savegames." metadata: version: "2.0.0" engine: "5.8"
UE World & Level Streaming
Target engine: UE 5.8. APIs below are verified against the 5.8 headers; older forms are listed under "Deprecated — do not use".
This skill covers how a UWorld is composed and swapped at runtime: World Partition grids, data layers, HLOD, level instances, classic sub-level streaming, streaming volumes, and map travel. Everything here lives in the Engine module (Engine/Source/Runtime/Engine), so Core, CoreUObject and Engine in PublicDependencyModuleNames is all that is needed. The one exception is the Level Streaming Persistence plugin, which adds the LevelStreamingPersistence module.
For end-to-end configurations per game type (open world, hub-and-spoke, procedural, chapter-based, volume-driven, dedicated server), see streaming patterns.
Context
Read .agents/ue-project-context.md if it exists (module names, conventions, enabled plugins, GAS/networking setup). Do not stop if it is missing.
Identify the area from the request and the codebase. Ask only when two plausible readings would produce different code.
| Request is about… | Go to |
|---|---|
| Picking between World Partition and sub-levels | Choosing a Streaming Model |
| Grid streaming, streaming sources, blocking loads, CVars | World Partition Runtime |
| Turning content on and off inside a partitioned world | Data Layers |
| Reusable level chunks placed in the editor, packed actors | Level Instances |
LoadStreamLevel, ULevelStreaming, volumes, runtime instancing | Sub-Level Streaming |
OpenLevel, ServerTravel, ClientTravel, seamless travel | Level Travel |
| Distant proxies for streamed-out cells | HLOD |
| Keeping actor changes across a streaming cycle | Level Streaming Persistence |
| Per-world managers, state that must survive travel | World Subsystems and Cross-Level State |
Choosing a Streaming Model
| Situation | Use | Why |
|---|---|---|
| One large continuous map | World Partition grid | Automatic spatial cells, no manual sub-level bookkeeping |
| Optional content inside a partitioned map | Data layers | EDataLayerRuntimeState toggles without travel |
| The same level asset placed many times in the editor | ALevelInstance / APackedLevelActor | Edited as a unit, packed into instanced meshes |
| The same level package spawned many times at runtime | ULevelStreamingDynamic::LoadLevelInstance | Creates a uniquely named package per instance |
| Discrete hand-authored zones in a non-partitioned map | ULevelStreaming sub-levels | Explicit load and visibility control per zone |
| Proximity-driven interiors in a non-partitioned map | ALevelStreamingVolume | Camera-position driven, no gameplay code |
| A different map entirely | OpenLevel / ServerTravel | Tears down and rebuilds the world |
World Partition and sub-level streaming are mutually exclusive on the same persistent level. UWorld::IsPartitionedWorld() (Engine/World.h:2968) reports which one is in play; AWorldSettings::GetWorldPartition() (GameFramework/WorldSettings.h:837) returns the partition object (the WorldPartition member is protected).
World Partition Runtime
UWorldPartition (WorldPartition/WorldPartition.h) owns the runtime hash that turns actors into cells. UWorldPartitionSubsystem is the per-world entry point and is a UTickableWorldSubsystem.
#include "WorldPartition/WorldPartition.h"
#include "WorldPartition/WorldPartitionSubsystem.h"
UWorldPartitionSubsystem* Subsystem = GetWorld()->GetSubsystem<UWorldPartitionSubsystem>();
if (Subsystem && Subsystem->IsAllStreamingCompleted())
{
// Every cell has finished loading, adding to or removing from the world.
}
Subsystem->ForEachWorldPartition([](UWorldPartition* Partition)
{
return Partition->IsStreamingEnabled(); // return false to stop iterating
});
UWorldPartitionRuntimeCell is the unit the hash produces. Query readiness at an arbitrary point with a query source instead of polling actors:
#include "WorldPartition/WorldPartitionRuntimeCell.h"
#include "WorldPartition/WorldPartitionStreamingSource.h"
TArray<FWorldPartitionStreamingQuerySource> QuerySources;
QuerySources.Emplace(TargetLocation); // FVector
const bool bReady = Subsystem->IsStreamingCompleted(
EWorldPartitionRuntimeCellState::Activated, QuerySources, /*bExactState=*/false);
EWorldPartitionRuntimeCellState is Unloaded, Loaded, Activated (WorldPartitionRuntimeCell.h:202).
Streaming sources
Any object can drive streaming by implementing IWorldPartitionStreamingSourceProvider (a plain interface struct in WorldPartitionStreamingSource.h) and registering it with the subsystem. For the common "this actor pulls cells in" case, add a UWorldPartitionStreamingSourceComponent instead — it already implements the provider and registers itself.
The two virtuals to override are `virtual bool GetStreamingS
Read the complete source ↗