UWorldPartition

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/WorldPartition/WorldPartition.h

Include

#include "WorldPartition/WorldPartition.h"

Syntax

class UWorldPartition : public UActorDescContainer

Variables

Name Description

Public variable

bool

 

bForceGarbageCollection

Public variable

bool

 

bForceGarbageCollectionPurge

Public variable

bool

 

bIsPIE

Public variable

TObjectPtr< cla...

 

DefaultHLODLayer

Default HLOD layer.

Public variable

TObjectPtr< UWo...

 

EditorHash

Public variable

TArray< FWorldP...

 

LoadedSubobjects

Public variable

FCancelWorldPar...

 

OnCancelWorldPartitionUpdateEditorCells

Public variable

FWorldPartition...

 

OnWorldPartitionInitialized

Public variable

FWorldPartition...

 

OnWorldPartitionUninitialized

Public variable

TObjectPtr< UWo...

 

RuntimeHash

Public variable

IWorldPartition...

 

WorldPartitionEditor

Public variable

TSubclassOf< UW...

 

WorldPartitionStreamingPolicyClass

Class of WorldPartitionStreamingPolicy to be used to manage world partition streaming.

Functions

Name Description

Public function

bool

 

AreEditorCellsLoaded

(
    const FBox& Box
)

Public function Const

bool

 

CanAddLoadedLevelToWorld

(
    ULevel* InLevel
)

Public function Const

bool

 

CanDrawRuntimeHash()

Debugging Methods.

Public function Static

void

 

CheckForErrors

(
    IStreamingGenerationErrorHandler&#...,
    const UActorDescContainer* Act...
)

Public function Const

void

 

CheckForErrors

Public function Static

UWorldPartit...

 

CreateOrRepairWorldPartition

(
    AWorldSettings* WorldSettings,
    TSubclassOf< UWorldPartitionEditorH...,
    TSubclassOf< UWorldPartitionRuntime...
)

Public function

void

 

DrawRuntimeCellsDetails

(
    UCanvas* Canvas,
    FVector2D& Offset
)

Public function

void

 

DrawRuntimeHash2D

(
    UCanvas* Canvas,
    const FVector2D& PartitionCanvasSi...,
    FVector2D& Offset
)

Public function

void

 

DrawRuntimeHash3D()

Public function

void

 

DrawRuntimeHashPreview()

Debugging Methods.

Public function

void

 

DrawStreamingStatusLegend

(
    UCanvas* Canvas,
    FVector2D& Offset
)

Public function

void

 

DumpActorDescs

(
    const FString& Path
)

Public function

UWorldPartit...

 

final

(
    const FObjectInitializer& ObjectIn...
)

Public function

bool

 

FinalizeGeneratorPackageForCook

(
    const TArray< ICookPackageSplitter:...
)

Public function

void

 

GenerateHLOD

(
    ISourceControlHelper* SourceCo...,
    bool bCreateActorsOnly
)

Public function

bool

 

GenerateStreaming

(
    TArray< FString >* OutPackages...
)

PIE/Game/Cook Methods.

Public function Const

FBox

 

GetEditorWorldBounds()

Public function Const

EWorldPartit...

 

GetStreamingPerformance()

Public function Const

const TArray...

 

GetStreamingSources()

Public function Const

TArray< FNam...

 

GetUserLoadedEditorGridCells()

Public function Const

uint32

 

GetWantedEditorCellSize()

Public function Const

FBox

 

GetWorldBounds()

Public function Const

FName

 

GetWorldPartitionEditorName()

Public function

void

 

Initialize

(
    UWorld* World,
    const FTransform& InTransform
)

Public function Const

bool

 

IsInitialized()

Public function Static

bool

 

IsSimulating()

Public function Const

bool

 

IsStreamingCompleted

(
    EWorldPartitionRuntimeCellState Que...,
    const TArray< FWorldPartitionStream...,
    bool bExactState
)

Public function

void

 

LoadEditorCells

(
    const FBox& Box,
    bool bIsFromUserChange
)

Public function

void

 

LoadEditorCells

(
    const TArray< FName >& CellNames,
    bool bIsFromUserChange
)

Public function

bool

 

PopulateGeneratedPackageForCook

(
    UPackage* InPackage,
    const FString& InPackageRelativePa...
)

Cook Methods.

Public function

bool

 

RefreshLoadedEditorCells

(
    bool bIsFromUserChange
)

Public function

void

 

RegisterStreamingSourceProvider

Public function

void

 

RemapSoftObjectPath

(
    FSoftObjectPath& ObjectPath
)

Public function

void

 

SetEditorWantedCellSize

(
    uint32 InCellSize
)

Public function

void

 

Tick

(
    float DeltaSeconds
)

Public function

void

 

UnloadEditorCells

(
    const FBox& Box,
    bool bIsFromUserChange
)

Public function

bool

 

UnregisterStreamingSourceProvider

Public function

void

 

UpdateStreamingState()

Overridden from UActorDescContainer

Name Description

Public function Virtual

void

 

Uninitialize()

Overridden from UObject

Name Description

Public function Virtual

bool

 

ResolveSubobject

(
    const TCHAR* SubObjectPath,
    UObject*& OutObject,
    bool bLoadIfExists
)

Called to defer loading a subobject to its top-level container object.

Typedefs