Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > WorldPartition > UWorldPartition

Light Theme

Dark Theme

UWorldPartition

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UWorldPartition

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/WorldPartition/WorldPartition.h
Include	#include "WorldPartition/WorldPartition.h"

Syntax

class UWorldPartition :
    public UObject,
    public FActorDescContainerCollection,
    public IWorldPartitionCookPackageGenerator

Variables

	Name	Description
TObjectPtr< UAc...	ActorDescContainer
FLoaderAdapterA...	AlwaysLoadedActors
bool	bEnableStreaming	Enables streaming for this world.
TObjectPtr< UWo...	EditorHash
FLoaderAdapterA...	ForceLoadedActors
FActorDescConta...	OnActorDescContainerRegistered
FActorDescConta...	OnActorDescContainerUnregistered
FWorldPartition...	OnBeginCook
FWorldPartition...	OnPreGenerateStreaming
FLoaderAdapterA...	PinnedActors
TObjectPtr< UWo...	RuntimeHash
TObjectPtr< UWo...	World
IWorldPartition...	WorldPartitionEditor

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	AppendAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )
void	BeginCook ( IWorldPartitionCookPackageContext&... )	Begin Cooking.
bool	CanAddLoadedLevelToWorld ( ULevel* InLevel )
bool	CanBeUsedByLevelInstance()
bool	CanDebugDraw()	Debugging.
bool	CanGenerateStreaming()	Streaming generation.
bool	CanStream()
void	CheckForErrors ( const FCheckForErrorsParams& Param... )
void	CheckForErrors ( IStreamingGenerationErrorHandler&#... )
bool	ConvertEditorPathToRuntimePath ( const FSoftObjectPath& InPath, FSoftObjectPath& OutPath )	Editor/Runtime conversions.
UWorldPartit...	CreateEditorLoaderAdapter ( ArgsType&&... Args )	Editor loader adapters management.
UWorldPartit...	CreateOrRepairWorldPartition ( AWorldSettings* WorldSettings, TSubclassOf< UWorldPartitionEditorH..., TSubclassOf< UWorldPartitionRuntime... )
void	DisableStreamingIn()
void	DrawRuntimeCellsDetails ( UCanvas* Canvas, FVector2D& Offset )
bool	DrawRuntimeHash2D ( UCanvas* Canvas, const FVector2D& PartitionCanvasSi..., const FVector2D& Offset, FVector2D& OutUsedCanvasSize )
void	DrawRuntimeHash3D()
void	DrawRuntimeHashPreview()	Debugging.
void	DrawStreamingStatusLegend ( UCanvas* Canvas, FVector2D& Offset )
void	DumpActorDescs ( const FString& Path )
void	EnableStreamingIn()
UWorldPartit...	final ( const FObjectInitializer& ObjectIn... )
void	FlushStreaming()
bool	GenerateContainerStreaming ( const UActorDescContainer* Act..., TArray< FString >* OutPackages... )
void	GenerateHLOD ( ISourceControlHelper* SourceCo..., bool bCreateActorsOnly )
bool	GenerateStreaming ( TArray< FString >* OutPackages... )
UActorDescCo...	GetActorDescContainer()
UHLODLayer &...	GetDefaultHLODLayer()
const TMap< ...	GetDirtyActors()
FBox	GetEditorWorldBounds()
const FTrans...	GetInstanceTransform()
bool	GetIntersectingCells ( const TArray< FWorldPartitionStream..., TArray< const IWorldPartitionCell&... )
const TSet< ...	GetRegisteredEditorLoaderAdapters()
FBox	GetRuntimeWorldBounds()
EWorldPartit...	GetStreamingPerformance()
const TArray...	GetStreamingSources()
TArray< FBox...	GetUserLoadedEditorRegions()
UWorld *	GetWorld()
FName	GetWorldPartitionEditorName()
bool	HasLoadedUserCreatedRegions()
void	Initialize ( UWorld* World, const FTransform& InTransform )
bool	IsActorPinned ( const FGuid& ActorGuid )
bool	IsEnablingStreamingJustified()
bool	IsInitialized()
bool	IsMainWorldPartition()
bool	IsServer()
bool	IsServerStreamingEnabled()
bool	IsServerStreamingOutEnabled()
bool	IsSimulating ( bool bIncludeTestEnableSimulationSt... )
bool	IsStreamingCompleted ( EWorldPartitionRuntimeCellState Que..., const TArray< FWorldPartitionStream..., bool bExactState )
bool	IsStreamingCompleted ( const TArray< FWorldPartitionStream... )
bool	IsStreamingEnabled()
bool	IsStreamingInEnabled()
bool	IsValidPackageName ( const FString& InPackageName )
void	LoadLastLoadedRegions()
void	LoadLastLoadedRegions ( const TArray< FBox >& EditorLastLo... )
void	OnCellHidden ( const UWorldPartitionRuntimeCell&#... )
void	OnCellShown ( const UWorldPartitionRuntimeCell&#... )
void	OnEnableStreamingChanged()
void	OnUserCreatedRegionLoaded()
void	OnUserCreatedRegionUnloaded()
void	PinActors ( const TArray< FGuid >& ActorGuids )	Actors pinning.
UActorDescCo...	RegisterActorDescContainer ( const FName& ContainerPackage )
void	ReleaseEditorLoaderAdapter ( UWorldPartitionEditorLoaderAdapter ... )
void	RemapSoftObjectPath ( FSoftObjectPath& ObjectPath )
bool	RemoveWorldPartition ( AWorldSettings* WorldSettings )
void	SetCanBeUsedByLevelInstance ( bool bInCanBeUsedByLevelInstance )
void	SetDefaultHLODLayer ( UHLODLayer* InDefaultHLODLayer )
void	SetEnableStreaming ( bool bInEnableStreaming )
void	SetInstanceTransform ( const FTransform& InInstanceTransf... )
bool	SupportsStreaming()
void	Tick ( float DeltaSeconds )
void	Uninitialize()
void	UninitializeActorDescContainers()
void	UnpinActors ( const TArray< FGuid >& ActorGuids )
bool	UnregisterActorDescContainer ( UActorDescContainer* Container )
void	Update()
void	UpdateStreamingState()
bool	UseMakingInvisibleTransactionRequests()
bool	UseMakingVisibleTransactionRequests()

Overridden from UObject

		Name	Description
	bool	ResolveSubobject ( const TCHAR* SubObjectPath, UObject*& OutObject, bool bLoadIfExists )	Called to defer loading a subobject to its top-level container object.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IWorldPartitionCookPackageGenerator

		Name	Description
	bool	GatherPackagesToCook ( IWorldPartitionCookPackageContext&... )
	UWorldPartit...	GetCellForPackage ( const FWorldPartitionCookPackage& ... )
	bool	PopulateGeneratedPackageForCook ( IWorldPartitionCookPackageContext&..., const FWorldPartitionCookPackage& ..., TArray< UPackage* >& OutModif... )
	bool	PopulateGeneratorPackageForCook ( IWorldPartitionCookPackageContext&..., const TArray< FWorldPartitionCookPa..., TArray< UPackage* >& OutModif... )
	bool	PrepareGeneratorPackageForCook ( IWorldPartitionCookPackageContext&..., TArray< UPackage* >& OutModif... )

Classes

	Name	Description
	FCheckForErrorsParams	Struct of optional parameters passed to check for errors function.

Typedefs

Name	Description
FActorDescContainerRegistrationDelegate
FWorldPartitionBeginCookDelegate
FWorldPartitionGenerateStreamingDelegate
FWorldPartitionInitializeDelegate

Constants

Name	Description
bEnableServerStreamingOut
bUseMakingInvisibleTransactionRequests
bUseMakingVisibleTransactionRequests
CVarDebugDedicatedServerStreaming
CVarEnableServerStreaming
CVarEnableServerStreamingOut
CVarEnableSimulationStreamingSource
CVarLoadingRangeBugItGo
CVarUseMakingInvisibleTransactionRequests
CVarUseMakingVisibleTransactionRequests
CVarWorldExtentToEnableStreaming
DebugDedicatedServerStreaming
EnableServerStreaming
EnableSimulationStreamingSource
LoadingRangeBugItGo
WorldExtentToEnableStreaming

Deprecated Variables

		Name	Description
	FWorldPartition...	OnWorldPartitionInitialized	Please use FWorldPartitionInitializedEvent& UWorld::OnWorldPartitionInitialized() instead.
	FWorldPartition...	OnWorldPartitionUninitialized	Please use FWorldPartitionInitializedEvent& UWorld::OnWorldPartitionUninitialized() instead.

Deprecated Functions

		Name	Description
	void	CheckForErrors ( IStreamingGenerationErrorHandler&#..., const UActorDescContainer* Act..., bool bEnableStreaming, bool bIsChangelistValidation )	CheckForErrors is deprecated, CheckForErrors with FCheckForErrorsParams should be used instead.
	FBox	GetWorldBounds()	GetWorldBounds is deprecated, use GetEditorWorldBounds or GetRuntimeWorldBounds instead.

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

Take our survey

Cancel