1. Epic GamesDeveloper
  3. UWorldPartitionRuntimeCell

UWorldPartitionRuntimeCell

Represents a PIE/Game streaming cell which points to external actor/data chunk packages

API > API/Runtime > API/Runtime/Engine

Represents a PIE/Game streaming cell which points to external actor/data chunk packages

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

Syntax

UCLASS (Abstract, MinimalAPI)  
class UWorldPartitionRuntimeCell :  
    public UObject ,  
    public IWorldPartitionCell ,  
    public IWorldPartitionCookPackageObject

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UWorldPartitionRuntimeCell ( const FObjectInitializer& ObjectInitializer
)

   WorldPartition/WorldPartitionRuntimeCell.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
RuntimeCellData TObjectPtr< UWorldPartitionRuntimeCellData >   WorldPartition/WorldPartitionRuntimeCell.h  
UnsavedActorsContainer TObjectPtr< UActorContainer >   WorldPartition/WorldPartitionRuntimeCell.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bBlockOnSlowLoading bool   WorldPartition/WorldPartitionRuntimeCell.h  
bClientOnlyVisible bool   WorldPartition/WorldPartitionRuntimeCell.h  
bIsCustomHLODPlaceholderCell bool   WorldPartition/WorldPartitionRuntimeCell.h  
bIsHLOD bool   WorldPartition/WorldPartitionRuntimeCell.h  
CellDebugColor FLinearColor   WorldPartition/WorldPartitionRuntimeCell.h  
ContentBundleID FGuid   WorldPartition/WorldPartitionRuntimeCell.h  
DataLayers FDataLayerInstanceNames   WorldPartition/WorldPartitionRuntimeCell.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void Activate()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void AddActorToCell ( const FWorldPartitionActorDescView& ActorDescView,
const FActorContainerID& InContainerID,
const FTransform& InContainerTransform,
const UActorDescContainer* InContainer
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void AddActorToCell ( const FStreamingGenerationActorDescView& ActorDescView
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void AppendStreamingSourceInfo ( const FWorldPartitionStreamingSource& Source,
const FSphericalSector& SourceShape,
const FWorldPartitionStreamingContext& Context
) const

   WorldPartition/WorldPartitionRuntimeCell.h  
  WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool CanAddToWorld()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool CanUnload()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void Deactivate()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void DumpStateLog ( FHierarchicalLogArchive& Ar
) const

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void Fixup()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual int32 GetActorCount()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual TArray< FName > GetActors()

   WorldPartition/WorldPartitionRuntimeCell.h  

bool GetBlockOnSlowLoading()

   WorldPartition/WorldPartitionRuntimeCell.h  

const FLinearColor & GetCellDebugColor()

   WorldPartition/WorldPartitionRuntimeCell.h  
  WorldPartition/WorldPartitionRuntimeCell.h  

EDataLayerRuntimeState GetCellEffectiveWantedState ( int32 InDataLayersStateEpoch
) const

   WorldPartition/WorldPartitionRuntimeCell.h  
  WorldPartition/WorldPartitionRuntimeCell.h  

bool GetClientOnlyVisible()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual FGuid const & GetContentBundleID()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual EWorldPartitionRuntimeCellState GetCurrentState()

   WorldPartition/WorldPartitionRuntimeCell.h  

UDataLayerManager * GetDataLayerManager()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual FLinearColor GetDebugColor ( EWorldPartitionRuntimeCellVisualizeMode VisualizeMode
) const

   WorldPartition/WorldPartitionRuntimeCell.h  

const FGuid & GetGuid()

   WorldPartition/WorldPartitionRuntimeCell.h  

bool GetIsCustomHLODPlaceholderCell()

   WorldPartition/WorldPartitionRuntimeCell.h  

bool GetIsHLOD()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual ULevel * GetLevel()

   WorldPartition/WorldPartitionRuntimeCell.h  

const FGuid & GetSourceCellGuid()

   WorldPartition/WorldPartitionRuntimeCell.h  
Returns the cell's streaming bounds, which is what the underlying runtime hash uses to intersect cells. WorldPartition/WorldPartitionRuntimeCell.h  

virtual EStreamingStatus GetStreamingStatus()

   WorldPartition/WorldPartitionRuntimeCell.h  

T * GetTypedOuter()

   WorldPartition/WorldPartitionRuntimeCell.h  

bool HasDataLayers()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool IsAddedToWorld()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool IsAlwaysLoaded()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool IsDebugShown()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool IsLoading()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool IsSpatiallyLoaded()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void Load()

   WorldPartition/WorldPartitionRuntimeCell.h  

void MergeStreamingSourceInfo()

   WorldPartition/WorldPartitionRuntimeCell.h  

bool NeedsActorToCellRemapping()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool PopulateGeneratedPackageForCook ( UPackage* InPackage,
TArray< UPackage* >& OutModifiedPackages
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool PopulateGeneratorPackageForCook ( TArray< UPackage* >& OutModifiedPackages
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool PrepareCellForCook ( UPackage* InPackage
)

 Cook methods WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool PrepareCellForCook ( const IWorldPartitionCookPackageContext& InCookContext,
UPackage* InGeneratedPackage
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetBlockOnSlowLoading ( bool bInBlockOnSlowLoading
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetCellDebugColor ( const FLinearColor& InCellDebugColor
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetClientOnlyVisible ( bool bInClientOnlyVisible
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetContentBundleUID ( const FGuid& InContentBundleID
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetDataLayers ( const TArray< const UDataLayerInstance* >& InDataLayerInstances
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetDebugStreamingPriority ( float InDebugStreamingPriority
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetGuid ( const FGuid& InCellGuid
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void SetIsAlwaysLoaded ( bool bInIsAlwaysLoaded
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetIsCustomHLODPlaceholderCell ( bool bInIsCustomHLODPlaceholderCell
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetIsHLOD ( bool bInIsHLOD
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void SetIsSpatiallyLoaded ( bool bInIsSpatiallyLoaded
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetLevelPackageName ( const FName& InLevelPackageName
)

   WorldPartition/WorldPartitionRuntimeCell.h  

void SetSourceCellGuid ( const FGuid& InSourceCellGuid
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void SetStreamingPriority ( int32 InStreamingPriority
) const

   WorldPartition/WorldPartitionRuntimeCell.h  

int32 SortCompare ( const UWorldPartitionRuntimeCell* Other
) const

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual void Unload()

   WorldPartition/WorldPartitionRuntimeCell.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   WorldPartition/WorldPartitionRuntimeCell.h  

Overridden from IWorldPartitionCell

Name Remarks Include Path Unreal Specifiers

virtual bool ContainsDataLayer ( const UDataLayerInstance* DataLayerInstance
) const

 Returns whether the cell data layers referenced the provided data layer instance or not. WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool ContainsDataLayer ( const UDataLayerAsset* DataLayerAsset
) const

 Returns whether the cell data layers referenced the provided data layer asset or not. WorldPartition/WorldPartitionRuntimeCell.h  

virtual TSet< FName > GetActorPackageNames()

 Returns the referenced actor packages. WorldPartition/WorldPartitionRuntimeCell.h  

virtual FBox GetCellBounds()

 Returns the cell's bounds, which is the uniform size of the cell. WorldPartition/WorldPartitionRuntimeCell.h  

virtual const FBox & GetContentBounds()

 Returns the cell'content s bounds, which is the sum of all actor bounds inside the cell. WorldPartition/WorldPartitionRuntimeCell.h  

virtual TArray< const UDataLayerInstance * > GetDataLayerInstances()

 Returns the cell content associated data layer instances. WorldPartition/WorldPartitionRuntimeCell.h  

virtual const TArray< FName > & GetDataLayers()

 Returns the cell content associated data layers. WorldPartition/WorldPartitionRuntimeCell.h  

virtual FString GetDebugName()

 Returns the debug name associated with this cell. WorldPartition/WorldPartitionRuntimeCell.h  

virtual FName GetExternalDataLayer()

 Returns the cell content associated external data layer. WorldPartition/WorldPartitionRuntimeCell.h  

virtual const UExternalDataLayerInstance * GetExternalDataLayerInstance()

 Returns the cell associated external data layer instance. WorldPartition/WorldPartitionRuntimeCell.h  

virtual FName GetLevelPackageName()

 Returns the associated level package name. WorldPartition/WorldPartitionRuntimeCell.h  

virtual UWorld * GetOuterWorld()

 REturns the outer world of this cell. WorldPartition/WorldPartitionRuntimeCell.h  

virtual UWorld * GetOwningWorld()

 Returns the owning world of this cell. WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool HasAnyDataLayer ( const TSet< FName >& InDataLayers
) const

 Returns whether the cell data layers referenced any of the provided data layer or not. WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool HasContentBundle()

 Returns whether the cell content is associated with content bundle or not. WorldPartition/WorldPartitionRuntimeCell.h  

Overridden from IWorldPartitionCookPackageObject

Name Remarks Include Path Unreal Specifiers

virtual const UExternalDataLayerAsset * GetExternalDataLayerAsset()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual FWorldPartitionPackageHash GetGenerationHash()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual FString GetPackageNameToCreate()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool IsLevelPackage()

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool OnPopulateGeneratedPackageForCook ( const IWorldPartitionCookPackageContext& InCookContext,
UPackage* InPackage,
TArray< UPackage* >& OutModifiedPackages
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool OnPopulateGeneratorPackageForCook ( const IWorldPartitionCookPackageContext& InCookContext,
UPackage* InPackage
)

   WorldPartition/WorldPartitionRuntimeCell.h  

virtual bool OnPrepareGeneratorPackageForCook ( TArray< UPackage* >& OutModifiedPackages
)

   WorldPartition/WorldPartitionRuntimeCell.h  

Protected

Name Remarks Include Path Unreal Specifiers

EDataLayerRuntimeState GetCellEffectiveWantedStateRaw()

   WorldPartition/WorldPartitionRuntimeCell.h  

const TArray< FName > & GetDataLayersInline()

   WorldPartition/WorldPartitionRuntimeCell.h  
Instead of this function, server would not not wait for client level visibility for server-only visible cells. WorldPartition/WorldPartitionRuntimeCell.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page