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

UCLASS (AutoExpandCategories=(WorldPartition), MinimalAPI)  
class UWorldPartition :  
    public UObject ,  
    public TActorDescContainerInstanceCollection< TObjectPtr< UActorDescContainerInstance > > ,  
    public IWorldPartitionCookPackageGenerator

Variables

  Type Name Description
Public variable FLoaderAdapterAlwaysLoadedActors * AlwaysLoadedActors  
Public variable UProperty bool bEnableStreaming Enables streaming for this world.
Public variable TOptional< bool > bOverrideEnableStreamingInEditor  
Public variable UProperty duplicatetransient TObjectPtr< UWorldPartitionEditorHash > EditorHash  
Public variable FLoaderAdapterActorList * ForceLoadedActors  
Public variable FLoaderAdapterStateChangedDelegate LoaderAdapterStateChanged  
Public variable FActorDescContainerInstancePreInitializeDelegate OnActorDescContainerInstancePreInitialize  
Public variable FActorDescContainerInstanceRegistrationDelegate OnActorDescContainerInstanceRegistered  
Public variable FActorDescContainerInstanceRegistrationDelegate OnActorDescContainerInstanceUnregistered  
Public variable FActorDescContainerRegistrationDelegate OnActorDescContainerRegistered  
Public variable FActorDescContainerRegistrationDelegate OnActorDescContainerUnregistered  
Public variable FWorldPartitionCookEventDelegate OnBeginCook  
Public variable FWorldPartitionCookEventDelegate OnEndCook  
Public variable FWorldPartitionGenerateStreamingActorDescsMutatePhase OnGenerateStreamingActorDescsMutatePhase  
Public variable FWorldPartitionGenerateStreamingDelegate OnPreGenerateStreaming  
Public variable FLoaderAdapterActorList * PinnedActors  
Public variable UProperty TObjectPtr< UWorldPartitionRuntimeHash > RuntimeHash  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta EWorldPartitionServerStreamingMode ServerStreamingMode  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta EWorldPartitionServerStreamingOutMode ServerStreamingOutMode  
Public variable IWorldPartitionEditor * WorldPartitionEditor  

Functions

  Type Name Description
Public function Static void  
Public function Const void

AppendAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Const void  
Public function void  
Public function void  
Public function Const bool  
Public function Const bool  
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 Static PRAGMA_ENABLE_DEPRECATION_WARNINGS void

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

  
Public function Const void  
Public function Const bool

ConvertContainerPathToEditorPath ( const FActorContainerID& InContainerID,
const FSoftObjectPath& InPath,
FSoftObjectPath& OutPath
)

  
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  
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 void  
Public function UWorldPartition

final ( const FObjectInitializer& ObjectInitializer
)

  
Public function void  
Public function URuntimeHashExternalStreamingObjectBase *

FlushStreamingToExternalStreamingObject ( const FString& ExternalStreamingObjectName
)

  
Public function URuntimeHashExternalStreamingObjectBase *  
Public function Const void  
Public function void  
Public function Const void  
Public function void  
Public function bool  
Public function bool

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

  
Public function bool  
Public function bool

GenerateStreaming ( TArray< FString >* OutPackagesToGenerate
)

  
Public function TUniquePtr< IStreamingGenerationContext >  
Public function Const UActorDescContainer *  
Public function Const UActorDescContainerInstance *  
Public function Const UDataLayerManager *  
Public function Const EWorldPartitionDataLayersLogicOperator  
Public function Const UHLODLayer *  
Public function Const FBox  
Public function Const UExternalDataLayerManager *  
Public function Const const FTransform &  
Public function Const bool  
Public function Const const TSet< TObjectPtr< UWorldPartitionEditorLoaderAdapter > > &  
Public function Const UDataLayerManager *  
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 TArray< UWorldPartitionRuntimeCell * >

GetWorldAssetStreamingCells ( const FGuid& InWorldAssetStreamingGuid
)

  
Public function Const FName  
Public function Const bool  
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 Const bool  
Public function Const bool  
Public function Const bool  
Public function Static bool

IsSimulating ( bool bIncludeTestEnableSimulationStreamingSource
)

  
Public function Const bool

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

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

IsValidPackageName ( const FString& InPackageName
)

  
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  
Public function void

PinActors ( const TArray< FGuid >& ActorGuids
)

 Actors pinning.
Public function UActorDescContainer *

RegisterActorDescContainer ( const FName& ContainerPackage
)

  
Public function UActorDescContainer *

RegisterActorDescContainer ( const FContainerRegistrationParams& InRegistrationParameters
)

  
Public function UActorDescContainerInstance *  
Public function FGuid  
Public function void  
Public function Const void  
Public function bool  
Public function Static bool  
Public function void

SetCanBeUsedByLevelInstance ( bool bInCanBeUsedByLevelInstance
)

  
Public function void  
Public function void

SetDefaultHLODLayer ( UHLODLayer* InDefaultHLODLayer
)

  
Public function void

SetEnableStreaming ( bool bInEnableStreaming
)

  
Public function void

SetInstanceTransform ( const FTransform& InInstanceTransform
)

  
Public function void  
Public function Const bool  
Public function bool

SupportsWorldAssetStreaming ( const FName& InTargetGrid
)

  
Public function void  
Public function void  
Public function void

UnpinActors ( const TArray< FGuid >& ActorGuids
)

  
Public function bool  
Public function bool  
Public function bool

UnregisterWorldAssetStreaming ( const FGuid& InWorldAssetStreamingGuid
)

  
Public function void

Update ()

  
Public function void  
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 void This alternate version of PostEditChange is called when properties inside structs are 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 *

GetCellForPackage ( const FWorldPartitionCookPackage& InPackageToCook
)

  
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 class FDisableNonDirtyActorTrackingScope Use scope around actor package save calls to prevent newly created spatial actors from being pinned (actors will get unloaded instead)  
Public struct FGenerateStreamingContext    
Public struct FGenerateStreamingParams    
Public struct FRegisterWorldAssetStreamingParams Experimental: World Asset Streaming can be used to inject streaming levels into the runtime grids dynamically, with one level of HLODs support.  
Public struct FSetupHLODActorsParams Struct of optional parameters passed to SetupHLODActors function.  

Typedefs

Name Description
FActorDescContainerInstancePreInitializeDelegate Event when world partition was enabled/disabled in the world.
FActorDescContainerInstanceRegistrationDelegate  
FActorDescContainerRegistrationDelegate  
FLoaderAdapterStateChangedDelegate  
FStreamingGenerationErrorHandlerOverride  
FWorldPartitionChangedEvent Event when world partition was enabled/disabled in the world.
FWorldPartitionCookEventDelegate Cooking events.
FWorldPartitionGenerateStreamingActorDescsMutatePhase Experimental: event used to gather actor descriptor mutators.
FWorldPartitionGenerateStreamingDelegate  

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page