1. Epic GamesDeveloper
  3. UWorldPartition

UWorldPartition

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/WorldPartition

Inheritance Hierarchy

References

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

Syntax

class UWorldPartition :  
    public UObject,  
    public TActorDescContainerCollection< TObjectPtr< UActorDescContainer >>,  
    public IWorldPartitionCookPackageGenerator

Variables

  Type Name Description
Public variable TObjectPtr< UActorDescContainer > ActorDescContainer  
Public variable FLoaderAdapterAlwaysLoadedActors * AlwaysLoadedActors  
Public variable bool bEnableStreaming Enables streaming for this world.
Public variable TOptional< bool > bOverrideEnableStreamingInEditor  
Public variable TObjectPtr< UWorldPartitionEditorHash > EditorHash  
Public variable FLoaderAdapterActorList * ForceLoadedActors  
Public variable FActorDescContainerRegistrationDelegate OnActorDescContainerRegistered  
Public variable FActorDescContainerRegistrationDelegate OnActorDescContainerUnregistered  
Public variable FWorldPartitionBeginCookDelegate OnBeginCook  
Public variable FWorldPartitionGenerateStreamingDelegate OnPreGenerateStreaming  
Public variable FLoaderAdapterActorList * PinnedActors  
Public variable TObjectPtr< UWorldPartitionRuntimeHash > RuntimeHash  
Public variable EWorldPartitionServerStreamingMode ServerStreamingMode  
Public variable EWorldPartitionServerStreamingOutMode ServerStreamingOutMode  
Public variable IWorldPartitionEditor * WorldPartitionEditor  

Functions

  Type Name Description
Public function Static void  
Public function Const void  
Public function void Begin Cooking.
Public function Const bool  
Public function Const bool Streaming generation.
Public function Const bool

CanInitialize ( UWorld* InWorld
)

  
Public function Const bool  
Public function Static void  
Public function Const void  
Public function Const bool Editor/Runtime conversions.
Public function UWorldPartitionEditorLoaderAdapter *

CreateEditorLoaderAdapter ( ArgsType&&... Args
)

 Editor loader adapters management.
Public function Static UWorldPartition *  
Public function void  
Public function void

DrawRuntimeCellsDetails ( UCanvas* Canvas,
FVector2D& Offset
)

  
Public function bool

DrawRuntimeHash2D ( FWorldPartitionDraw2DContext& DrawContext
)

 Debugging.
Public function void  
Public function void Debugging.
Public function void

DumpActorDescs ( const FString& Path
)

  
Public function void  
Public function UWorldPartition

final ( const FObjectInitializer& ObjectInitializer
)

  
Public function void  
Public function URuntimeHashExternalStreamingObjectBase *

FlushStreamingToExternalStreamingObject ( const FString& ExternalStreamingObjectName
)

  
Public function bool  
Public function void

GenerateHLOD ( ISourceControlHelper* SourceControlHelper,
bool bCreateActorsOnly
)

  
Public function bool  
Public function Const UActorDescContainer *  
Public function Const UDataLayerManager *  
Public function Const UHLODLayer *  
Public function Const const TSet< FDirtyActor > &  
Public function Const FBox  
Public function Const const FTransform &  
Public function Const bool  
Public function Const const TSet< TObjectPtr< UWorldPartitionEditorLoaderAdapter > > &  
Public function Const FBox  
Public function Const EWorldPartitionStreamingPerformance  
Public function Const const TArray< FWorldPartitionStreamingSource > &  
Public function Const int32  
Public function Const TArray< FBox >  
Public function Virtual Const UWorld *  
Public function Const FName  
Public function Const bool  
Public function void

Initialize ( UWorld* World,
const FTransform& InTransform
)

  
Public function bool  
Public function Const bool

IsActorPinned ( const FGuid& ActorGuid
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Static bool

IsSimulating ( bool bIncludeTestEnableSimulationStreamingSource
)

  
Public function Const bool  
Public function Const bool

IsStreamingCompleted ( EWorldPartitionRuntimeCellState QueryState,
const TArray< FWorldPartitionStreamingQuerySource >& QuerySources,
bool bExactState
)

  
Public function Const bool  
Public function Const bool  
Public function bool

IsValidPackageName ( const FString& InPackageName
)

  
Public function void  
Public function void

LoadLastLoadedRegions ( const TArray< FBox >& EditorLastLoadedRegions
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

PinActors ( const TArray< FGuid >& ActorGuids
)

 Actors pinning.
Public function UActorDescContainer *

RegisterActorDescContainer ( const FContainerRegistrationParams& InRegistrationParameters
)

  
Public function void  
Public function Const void  
Public function bool  
Public function Static bool  
Public function void

SetDefaultHLODLayer ( UHLODLayer* InDefaultHLODLayer
)

  
Public function void

SetEnableStreaming ( bool bInEnableStreaming
)

  
Public function void

SetInstanceTransform ( const FTransform& InInstanceTransform
)

  
Public function Const bool  
Public function void

Tick ( float DeltaSeconds
)

  
Public function void  
Public function void  
Public function void

UnpinActors ( const TArray< FGuid >& ActorGuids
)

  
Public function bool  
Public function void

Update ()

  
Public function Const bool  
Public function Const bool  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual bool

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

 Called to defer loading a subobject to its top-level container object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IWorldPartitionCookPackageGenerator

  Type Name Description
Public function Virtual bool  
Public function Virtual Const UWorldPartitionRuntimeCell *  
Public function Virtual bool

PopulateGeneratedPackageForCook ( IWorldPartitionCookPackageContext& CookContext,
const FWorldPartitionCookPackage& InPackagesToCool,
TArray< UPackage* >& OutModifiedPackages
)

  
Public function Virtual bool

PopulateGeneratorPackageForCook ( IWorldPartitionCookPackageContext& CookContext,
const TArray< FWorldPartitionCookPackage* >& InPackagesToCook,
TArray< UPackage* >& OutModifiedPackages
)

  
Public function Virtual bool  

Classes

  Type Name Description
Public struct FCheckForErrorsParams Struct of optional parameters passed to check for errors function.  
Public struct FContainerRegistrationParams    
Public struct FGenerateStreamingContext    
Public struct FGenerateStreamingParams    

Typedefs

Name Description
FActorDescContainerRegistrationDelegate  
FStreamingGenerationErrorHandlerOverride  
FWorldPartitionBeginCookDelegate  
FWorldPartitionChangedEvent Event when world partition was enabled/disabled in the world.
FWorldPartitionGenerateStreamingDelegate  

Constants

Name Description
bGlobalEnableServerStreamingOut  
bUseMakingInvisibleTransactionRequests  
bUseMakingVisibleTransactionRequests  
CVarDebugDedicatedServerStreaming  
CVarEnableServerStreaming  
CVarEnableServerStreamingOut  
CVarEnableSimulationStreamingSource  
CVarLoadingRangeBugItGo  
CVarUseMakingInvisibleTransactionRequests  
CVarUseMakingVisibleTransactionRequests  
CVarWorldExtentToEnableStreaming  
DebugDedicatedServerStreaming  
EnableSimulationStreamingSource  
GlobalEnableServerStreaming  
LoadingRangeBugItGo  
StreamingGenerationErrorHandlerOverride  
WorldExtentToEnableStreaming  
WorldPartitionChangedEvent  

Deprecated Functions

  Type Name Description
Public function Const bool CanAddLoadedLevelToWorld is deprecated, use CanAddCellToWorld instead.
Public function Const bool CanBeUsedByLevelInstance is deprecated.
Public function Static void

CheckForErrors ( IStreamingGenerationErrorHandler* ErrorHandler,
const UActorDescContainer* ActorDescContainer,
bool bEnableStreaming,
bool bIsChangelistValidation
)

 CheckForErrors is deprecated, CheckForErrors with FCheckForErrorsParams should be used instead.
Public function bool

GenerateContainerStreaming ( const UActorDescContainer* ActorDescContainer,
TArray< FString >* OutPackagesToGenerate
)

 GenerateContainerStreaming is deprecated, use GenerateContainerStreaming with a param struct instead
Public function bool

GenerateStreaming ( TArray< FString >* OutPackagesToGenerate
)

 GenerateStreaming is deprecated, use GenerateStreaming with a param struct instead
Public function Const FBox GetWorldBounds is deprecated, use GetEditorWorldBounds or GetRuntimeWorldBounds instead.
Public function UActorDescContainer *

RegisterActorDescContainer ( const FName& ContainerPackage
)

 Use RegisterActorDescContainer with FContainerRegistrationParams instead.
Public function void

SetCanBeUsedByLevelInstance ( bool bInCanBeUsedByLevelInstance
)

 SetCanBeUsedByLevelInstance is deprecated.
Public function void UpdateStreamingState is deprecated, use UWorldPartitionSubsystem::UpdateStreamingState instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page