Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UWorldPartitionSubsystem |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/WorldPartition/WorldPartitionSubsystem.h |
| Include Path | #include "WorldPartition/WorldPartitionSubsystem.h" |
Syntax
UCLASS (MinimalAPI)
class UWorldPartitionSubsystem :
public UTickableWorldSubsystem ,
public IStreamingWorldSubsystemInterface
Inheritance Hierarchy
- FTickableObjectBase → FTickableGameObject → UTickableWorldSubsystem → UWorldPartitionSubsystem
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UWorldSubsystem → UTickableWorldSubsystem → UWorldPartitionSubsystem
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWorldPartitionSubsystem() |
WorldPartition/WorldPartitionSubsystem.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FWorldPartitionStreamingSourceProviderFilter | TBaseDelegate_OneParam< bool, const IWorldPartitionStreamingSourceProvider * > | WorldPartition/WorldPartitionSubsystem.h | |
| FWorldPartitionStreamingStateUpdated | TMulticastDelegate_NoParams< void > | WorldPartition/WorldPartitionSubsystem.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnWorldPartitionSubsystemDeinitialized | TMulticastDelegate< void(UWorldPartitionSubsystem *, UWorld *)> | WorldPartition/WorldPartitionSubsystem.h | |
| OnWorldPartitionSubsystemInitialized | TMulticastDelegate< void(UWorldPartitionSubsystem *, UWorld *)> | WorldPartition/WorldPartitionSubsystem.h | |
| OverriddenLoadingRanges | TMap< FName, int32 > | WorldPartition/WorldPartitionSubsystem.h | |
| OverriddenLoadingRangesEpoch | uint32 | WorldPartition/WorldPartitionSubsystem.h | |
| OverrideLoadingRangeCommand | class FAutoConsoleCommand | WorldPartition/WorldPartitionSubsystem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SelectedActorHandles | TSet< FWorldPartitionHandle > | WorldPartition/WorldPartitionSubsystem.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasBegunPlay | bool | WorldPartition/WorldPartitionSubsystem.h | ||
| bIsRunningConvertWorldPartitionCommandlet | bool | WorldPartition/WorldPartitionSubsystem.h | ||
| DrawHandle | FDelegateHandle | WorldPartition/WorldPartitionSubsystem.h | ||
| IncrementalUpdateWorldPartitions | TSet< TObjectPtr< UWorldPartition > > | WorldPartition/WorldPartitionSubsystem.h | ||
| IncrementalUpdateWorldPartitionsPendingAdd | TSet< TObjectPtr< UWorldPartition > > | WorldPartition/WorldPartitionSubsystem.h | ||
| IsStreamingSourceProviderFiltered | FWorldPartitionStreamingSourceProviderFilter | WorldPartition/WorldPartitionSubsystem.h | ||
| LevelStreamingContinuouslyIncrementalGCWhileLevelsPendingPurge | int32 | GC backup values. | WorldPartition/WorldPartitionSubsystem.h | |
| LevelStreamingForceGCAfterLevelStreamedOut | int32 | WorldPartition/WorldPartitionSubsystem.h | ||
| NumWorldPartitionServerStreamingEnabled | int32 | Server information. | WorldPartition/WorldPartitionSubsystem.h | |
| RegisteredWorldPartitions | TArray< TObjectPtr< UWorldPartition > > | Registered world partitions & incremental update. | WorldPartition/WorldPartitionSubsystem.h | |
| ServerClientsVisibleLevelNames | TSet< FName > | WorldPartition/WorldPartitionSubsystem.h | ||
| ServerClientsVisibleLevelsHash | uint32 | WorldPartition/WorldPartitionSubsystem.h | ||
| StreamingSourceProviders | TSet< IWorldPartitionStreamingSourceProvider * > | Streaming Sources. | WorldPartition/WorldPartitionSubsystem.h | |
| StreamingSources | TArray< FWorldPartitionStreamingSource > | WorldPartition/WorldPartitionSubsystem.h | ||
| StreamingSourcesHash | uint32 | WorldPartition/WorldPartitionSubsystem.h | ||
| StreamingSourcesVelocity | TMap< FName, FStreamingSourceVelocity > | WorldPartition/WorldPartitionSubsystem.h | ||
| StreamingStateUpdated | FWorldPartitionStreamingStateUpdated | WorldPartition/WorldPartitionSubsystem.h | ||
| WorldPartitionLoadingAndPendingLoadStreamingLevels | TSet< TWeakObjectPtr< const ULevelStreaming > > | Tracks world partition loading and pending loads. | WorldPartition/WorldPartitionSubsystem.h | |
| WorldPartitionsDraw2DContext | TArray< FWorldPartitionDraw2DContext > | Debug draw. | WorldPartition/WorldPartitionSubsystem.h | |
| WorldPartitionUninitializationPendingStreamingLevels | TMap< FSoftObjectPath, TSet< TWeakObjectPtr< UWorldPartitionLevelStreamingDynamic > > > | Tracks streaming levels of uninitialized world partition used to delay next initialization until they're done being removed. | WorldPartition/WorldPartitionSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DumpStreamingSources
(
FOutputDevice& OutputDevice |
WorldPartition/WorldPartitionSubsystem.h | ||
void DumpWorldPartitions
(
FOutputDevice& OutputDevice |
WorldPartition/WorldPartitionSubsystem.h | ||
void ForEachWorldPartition
(
TFunctionRef< bool(UWorldPartition*)> Func |
WorldPartition/WorldPartitionSubsystem.h | ||
FBox GetContainerBounds
(
FName PackageName |
WorldPartition/WorldPartitionSubsystem.h | ||
TMap< FActorContainerID, TSet< FGuid > > GetFilteredActorsPerContainer
(
const FActorContainerID& InContainerID, |
WorldPartition/WorldPartitionSubsystem.h | ||
TSet< IWorldPartitionStreamingSourceProvider * > GetStreamingSourceProviders() |
WorldPartition/WorldPartitionSubsystem.h | ||
FWorldPartitionActorFilter GetWorldPartitionActorFilter
(
const FString& InWorldPackage, |
WorldPartition/WorldPartitionSubsystem.h | ||
bool IsAllStreamingCompleted() |
Returns true if world partition is done streaming levels, adding them to the world or removing them from the world. | WorldPartition/WorldPartitionSubsystem.h |
|
bool IsStreamingCompleted
(
EWorldPartitionRuntimeCellState QueryState, |
WorldPartition/WorldPartitionSubsystem.h |
|
|
bool IsStreamingCompleted
(
const IWorldPartitionStreamingSourceProvider* InStreamingSourceProvider |
Returns true if world partition is done streaming levels, adding them to the world or removing them from the world. | WorldPartition/WorldPartitionSubsystem.h | |
bool IsStreamingSourceProviderRegistered
(
IWorldPartitionStreamingSourceProvider* StreamingSource |
WorldPartition/WorldPartitionSubsystem.h | ||
FWorldPartitionStreamingSourceProviderFilter & OnIsStreamingSourceProviderFiltered() |
WorldPartition/WorldPartitionSubsystem.h | ||
FWorldPartitionStreamingStateUpdated & OnStreamingStateUpdated() |
WorldPartition/WorldPartitionSubsystem.h | ||
UActorDescContainer * RegisterContainer
(
FName PackageName |
WorldPartition/WorldPartitionSubsystem.h | ||
void RegisterStreamingSourceProvider
(
IWorldPartitionStreamingSourceProvider* StreamingSource |
WorldPartition/WorldPartitionSubsystem.h | ||
void UnregisterContainer
(
UActorDescContainer* Container |
WorldPartition/WorldPartitionSubsystem.h | ||
bool UnregisterStreamingSourceProvider
(
IWorldPartitionStreamingSourceProvider* StreamingSource |
WorldPartition/WorldPartitionSubsystem.h | ||
void UpdateContainerBounds
(
FName PackageName |
WorldPartition/WorldPartitionSubsystem.h |
Overridden from UWorldSubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnWorldBeginPlay
(
UWorld& InWorld |
Called when world is ready to start gameplay before the game mode transitions to the correct state and call BeginPlay on all actors | WorldPartition/WorldPartitionSubsystem.h | |
virtual void OnWorldComponentsUpdated
(
UWorld& World |
Called after world components (e.g. line batcher and all level components) have been updated | WorldPartition/WorldPartitionSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
Implement this for deinitialization of instances of the system | WorldPartition/WorldPartitionSubsystem.h | |
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
USubsystem implementation Begin. | WorldPartition/WorldPartitionSubsystem.h |
Overridden from FTickableGameObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsTickableInEditor () |
Used to determine whether the object should be ticked in the editor when there is no gameplay world. | WorldPartition/WorldPartitionSubsystem.h |
Overridden from FTickableObjectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TStatId GetStatId() |
Return the stat id used to track the performance of this object | WorldPartition/WorldPartitionSubsystem.h | |
virtual ETickableTickType GetTickableTickType () |
Virtual that can be overloaded by the inheriting class and is called before first tick. | WorldPartition/WorldPartitionSubsystem.h | |
virtual void Tick
(
float DeltaTime |
Pure virtual that must be overloaded by the inheriting class. | WorldPartition/WorldPartitionSubsystem.h |
Overridden from IStreamingWorldSubsystemInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUpdateStreamingState() |
WorldPartition/WorldPartitionSubsystem.h |
Protected
Overridden from UWorldSubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool DoesSupportWorldType
(
const EWorldType::Type WorldType |
WorldPartition/WorldPartitionSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint32 GetOverriddenLoadingRangesEpoch() |
WorldPartition/WorldPartitionSubsystem.h | ||
static bool GetOverrideLoadingRange
(
FName Name, |
WorldPartition/WorldPartitionSubsystem.h | ||
static bool IsRunningConvertWorldPartitionCommandlet() |
WorldPartition/WorldPartitionSubsystem.h | ||
static bool IsServer
(
const UWorld* InWorld |
WorldPartition/WorldPartitionSubsystem.h | ||
static void SetOverrideLoadingRange
(
FName Name, |
WorldPartition/WorldPartitionSubsystem.h | ||
static void UpdateStreamingStateInternal
(
const UWorld* InWorld, |
WorldPartition/WorldPartitionSubsystem.h |