1. Epic GamesDeveloper
  3. UWorldPartitionStreamingPolicy

UWorldPartitionStreamingPolicy

API > API/Runtime > API/Runtime/Engine

   
Name UWorldPartitionStreamingPolicy
Type class
Header File /Engine/Source/Runtime/Engine/Public/WorldPartition/WorldPartitionStreamingPolicy.h
Include Path #include "WorldPartition/WorldPartitionStreamingPolicy.h"

Syntax

UCLASS (Abstract, Within=WorldPartition)  
class UWorldPartitionStreamingPolicy : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UWorldPartitionStreamingPolicy ( const FObjectInitializer& ObjectInitializer
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

Structs

Name Remarks
FUpdateStreamingStateParams  

Constants

Name Type Remarks Include Path
CVarAsyncUpdateStreamingStateEnabled FAutoConsoleVariableRef   WorldPartition/WorldPartitionStreamingPolicy.h
CVarForceUpdateFrameCount FAutoConsoleVariableRef   WorldPartition/WorldPartitionStreamingPolicy.h
CVarUpdateOptimEnabled FAutoConsoleVariableRef   WorldPartition/WorldPartitionStreamingPolicy.h
ForceUpdateFrameCount int32   WorldPartition/WorldPartitionStreamingPolicy.h
IsAsyncUpdateStreamingStateEnabled bool   WorldPartition/WorldPartitionStreamingPolicy.h
IsUpdateOptimEnabled bool CVars to control update optimization. WorldPartition/WorldPartitionStreamingPolicy.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AsyncShouldSkipUpdateCounter int32   WorldPartition/WorldPartitionStreamingPolicy.h  
AsyncTaskCurrentState FWorldPartitionUpdateStreamingCurrentState Asynchronous update task input payload. WorldPartition/WorldPartitionStreamingPolicy.h
  • Transient
AsyncTaskTargetState FWorldPartitionUpdateStreamingTargetState Asynchronous update task output payload. WorldPartition/WorldPartitionStreamingPolicy.h
  • Transient
AsyncUpdateStreamingStateTask UE::Tasks::TTask< void >   WorldPartition/WorldPartitionStreamingPolicy.h  
AsyncUpdateTaskState EAsyncUpdateTaskState Asynchronous update task. WorldPartition/WorldPartitionStreamingPolicy.h  
bCriticalPerformanceRequestedBlockTillOnWorld bool   WorldPartition/WorldPartitionStreamingPolicy.h  
bCurrentBlockOnSlowStreaming bool Current block on slow streaming. WorldPartition/WorldPartitionStreamingPolicy.h
  • Transient
bOnScreenMessageShouldBlock bool   WorldPartition/WorldPartitionStreamingPolicy.h  
bShouldMergeStreamingSourceInfo bool   WorldPartition/WorldPartitionStreamingPolicy.h  
CachedServerDisallowStreamingOutDataLayers TOptional< TSet< FName > >   WorldPartition/WorldPartitionStreamingPolicy.h  
CriticalPerformanceBlockTillLevelStreamingCompletedEpoch int32   WorldPartition/WorldPartitionStreamingPolicy.h  
CurrentState FWorldPartitionUpdateStreamingCurrentState Current streaming state. WorldPartition/WorldPartitionStreamingPolicy.h
  • Transient
CurrentStreamingPerformance EWorldPartitionStreamingPerformance Current streaming performance. WorldPartition/WorldPartitionStreamingPolicy.h
  • Transient
FrameActivateCells TSet< const UWorldPartitionRuntimeCell * > Used internally by UpdateStreamingStateInternal (avoids re-allocations) WorldPartition/WorldPartitionStreamingPolicy.h  
FrameAnalysePerformanceCells TSet< const UWorldPartitionRuntimeCell * >   WorldPartition/WorldPartitionStreamingPolicy.h  
FrameLoadCells TSet< const UWorldPartitionRuntimeCell * >   WorldPartition/WorldPartitionStreamingPolicy.h  
OnScreenMessageStartTime double   WorldPartition/WorldPartitionStreamingPolicy.h  
OnScreenMessageStreamingPerformance EWorldPartitionStreamingPerformance   WorldPartition/WorldPartitionStreamingPolicy.h  
ProcessedToActivateCells int32   WorldPartition/WorldPartitionStreamingPolicy.h  
ProcessedToLoadCells int32   WorldPartition/WorldPartitionStreamingPolicy.h  
ServerStreamingEnabledEpoch int32   WorldPartition/WorldPartitionStreamingPolicy.h  
ServerStreamingStateEpoch int32   WorldPartition/WorldPartitionStreamingPolicy.h  
TargetState FWorldPartitionUpdateStreamingTargetState Target state. WorldPartition/WorldPartitionStreamingPolicy.h
  • Transient
UpdateStreamingHash uint32   WorldPartition/WorldPartitionStreamingPolicy.h  
UpdateStreamingSourcesHash uint32   WorldPartition/WorldPartitionStreamingPolicy.h  
UpdateStreamingStateCounter uint32   WorldPartition/WorldPartitionStreamingPolicy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanAddCellToWorld ( const UWorldPartitionRuntimeCell* InCell
) const

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool CanAddLoadedLevelToWorld ( ULevel* InLevel
) const

   WorldPartition/WorldPartitionStreamingPolicy.h  

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

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool ConvertEditorPathToRuntimePath ( const FSoftObjectPath& InPath,
FSoftObjectPath& OutPath
) const

 Editor/Runtime conversions. WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void DrawRuntimeCellsDetails ( UCanvas* Canvas,
FVector2D& Offset
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool DrawRuntimeHash2D ( FWorldPartitionDraw2DContext& DrawContext
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void DrawRuntimeHash3D()

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool GetIntersectingCells ( const TArray< FWorldPartitionStreamingQuerySource >& InSources,
TArray< const IWorldPartitionCell* >& OutCells
) const

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void GetOnScreenMessages ( FCoreDelegates::FSeverityMessageMap& OutMessages
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual TSubclassOf< class UWorldPartitionRuntimeCell > GetRuntimeCellClass()

   WorldPartition/WorldPartitionStreamingPolicy.h  

EWorldPartitionStreamingPerformance GetStreamingPerformance()

   WorldPartition/WorldPartitionStreamingPolicy.h  

const TArray< FWorldPartitionStreamingSource > & GetStreamingSources()

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual UObject * GetSubObject ( const TCHAR* SubObjectPath
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool InjectExternalStreamingObject ( URuntimeHashExternalStreamingObjectBase* ExternalStreamingObject
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

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

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool IsStreamingCompleted ( const TArray< FWorldPartitionStreamingSource >* InStreamingSources
) const

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void OnCellHidden ( const UWorldPartitionRuntimeCell* InCell
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void OnCellShown ( const UWorldPartitionRuntimeCell* InCell
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void PrepareActorToCellRemapping()

 PIE/Game methods. WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void RemapSoftObjectPath ( FSoftObjectPath& ObjectPath
) const

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool RemoveExternalStreamingObject ( URuntimeHashExternalStreamingObjectBase* ExternalStreamingObject
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void SetContainerResolver ( const FWorldPartitionRuntimeContainerResolver& InContainerResolver
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void SetShouldMergeStreamingSourceInfo ( bool bInShouldMergeStreamingSourceInfo
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool StoreStreamingContentToExternalStreamingObject ( URuntimeHashExternalStreamingObjectBase& OutExternalStreamingObject
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual bool StoreToExternalStreamingObject ( URuntimeHashExternalStreamingObjectBase& OutExternalStreamingObject
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void UpdateStreamingState()

   WorldPartition/WorldPartitionStreamingPolicy.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void GetCellsToReprioritize ( TArray< const UWorldPartitionRuntimeCell* >& OutToLoadCells,
TArray< const UWorldPartitionRuntimeCell* >& OutToActivateCells
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void GetCellsToUpdate ( TArray< const UWorldPartitionRuntimeCell* >& OutToLoadCells,
TArray< const UWorldPartitionRuntimeCell* >& OutToActivateCells
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

bool IsInBlockTillLevelStreamingCompleted ( bool bIsCausedByBadStreamingPerformance
) const

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void SetCellsStateToUnloaded ( const TArray< TObjectPtr< const UWorldPartitionRuntimeCell > >& ToUnloadCells
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void SetCellStateToActivated ( const UWorldPartitionRuntimeCell* InCell,
int32& InOutMaxCellsToLoad
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void SetCellStateToLoaded ( const UWorldPartitionRuntimeCell* InCell,
int32& InOutMaxCellsToLoad
)

   WorldPartition/WorldPartitionStreamingPolicy.h  
  WorldPartition/WorldPartitionStreamingPolicy.h  

void UpdateStreamingPerformance ( EWorldPartitionStreamingPerformance NewStreamingPerformance,
bool bBlockOnSlowStreaming
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

virtual void UpdateStreamingSources ( bool bCanOptimizeUpdate
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsUpdateStreamingOptimEnabled()

   WorldPartition/WorldPartitionStreamingPolicy.h  

static void UpdateDebugCellsStreamingPriority ( const TSet< const UWorldPartitionRuntimeCell* >& InActivateStreamingCells,
const TSet< const UWorldPartitionRuntimeCell* >& InLoadStreamingCells,
bool bInShouldMergeStreamingSourceInfo
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

static void UpdateStreamingStateInternal ( const FUpdateStreamingStateParams& InParams,
FWorldPartitionUpdateStreamingTargetState& OutTargetState
)

   WorldPartition/WorldPartitionStreamingPolicy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page