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 > API/Runtime/Engine/WorldPartition

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

  Type Name Description
Protected variable UProperty bool bIsAlwaysLoaded  
Protected variable UProperty FGuid CellGuid  
Protected variable float DebugStreamingPriority Represents the streaming priority relative to other cells.
Protected variable EDataLayerRuntimeState EffectiveWantedState  
Protected variable int32 EffectiveWantedStateEpoch  
Protected variable UProperty TObjectPtr< const UExternalDataLayerAsset > ExternalDataLayerAsset  
Protected variable FName LevelPackageName  
Public variable UProperty TObjectPtr< UWorldPartitionRuntimeCellData > RuntimeCellData  
Protected variable UProperty FGuid SourceCellGuid Used by injected HLOD cells.
Public variable UProperty TObjectPtr< UActorContainer > UnsavedActorsContainer  

Constructors

  Type Name Description
Public function  

UWorldPartitionRuntimeCell ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const void  
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void

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

  
Public function Virtual void  
Public function Const void  
Public function void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const void  
Public function Virtual Const void  
Public function Virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS void

Fixup ()

  
Public function Virtual Const int32  
Public function Virtual Const TArray< FName >  
Public function Const bool  
Public function Const const FLinearColor &  
Public function Const EDataLayerRuntimeState  
Public function Const EDataLayerRuntimeState

GetCellEffectiveWantedState ( int32 InDataLayersStateEpoch
)

  
Public function Const EDataLayerRuntimeState  
Protected function Const EDataLayerRuntimeState  
Public function Const bool  
Public function Virtual Const FGuid const &  
Public function Virtual Const EWorldPartitionRuntimeCellState  
Public function Const UDataLayerManager *  
Protected function Const const TArray< FName > &  
Public function Virtual Const FLinearColor  
Public function Const const FGuid &

GetGuid ()

  
Public function Const bool  
Public function Virtual Const ULevel *  
Public function Const const FGuid &  
Public function Const FBox Returns the cell's streaming bounds, which is what the underlying runtime hash uses to intersect cells.
Public function Virtual Const EStreamingStatus  
Public function Const T *  
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const void

Load ()

  
Public function Const void  
Public function Const bool  
Public function Virtual bool

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

  
Public function Virtual bool

PopulateGeneratorPackageForCook ( TArray< UPackage* >& OutModifiedPackages
)

  
Public function Virtual bool

PrepareCellForCook ( UPackage* InPackage
)

 Cook methods
Public function Virtual bool

PrepareCellForCook ( const IWorldPartitionCookPackageContext& InCookContext,
UPackage* InGeneratedPackage
)

  
Public function void

SetBlockOnSlowLoading ( bool bInBlockOnSlowLoading
)

  
Public function void

SetCellDebugColor ( const FLinearColor& InCellDebugColor
)

  
Public function void

SetClientOnlyVisible ( bool bInClientOnlyVisible
)

  
Public function void

SetContentBundleUID ( const FGuid& InContentBundleID
)

  
Public function void

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

  
Public function void

SetDebugStreamingPriority ( float InDebugStreamingPriority
)

  
Public function void

SetGuid ( const FGuid& InCellGuid
)

  
Public function Virtual void

SetIsAlwaysLoaded ( bool bInIsAlwaysLoaded
)

  
Public function void

SetIsHLOD ( bool bInIsHLOD
)

  
Public function void

SetLevelPackageName ( const FName& InLevelPackageName
)

  
Public function void

SetSourceCellGuid ( const FGuid& InSourceCellGuid
)

  
Public function Virtual Const void

SetStreamingPriority ( int32 InStreamingPriority
)

  
Protected function Virtual Const bool Instead of this function, server would not not wait for client level visibility for server-only visible cells.
Public function Const int32  
Public function Virtual Const void

Unload ()

  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.

Overridden from IWorldPartitionCell

  Type Name Description
Public function Virtual Const bool

ContainsDataLayer ( const UDataLayerInstance* DataLayerInstance
)

 Returns whether the cell data layers referenced the provided data layer instance or not.
Public function Virtual Const bool

ContainsDataLayer ( const UDataLayerAsset* DataLayerAsset
)

 Returns whether the cell data layers referenced the provided data layer asset or not.
Public function Virtual Const TSet< FName > Returns the referenced actor packages.
Public function Virtual Const FBox Returns the cell's bounds, which is the uniform size of the cell.
Public function Virtual Const const FBox & Returns the cell'content s bounds, which is the sum of all actor bounds inside the cell.
Public function Virtual Const TArray< const UDataLayerInstance * > Returns the cell content associated data layer instances.
Public function Virtual Const const TArray< FName > & Returns the cell content associated data layers.
Public function Virtual Const FString Returns the debug name associated with this cell.
Public function Virtual Const FName Returns the cell content associated external data layer.
Public function Virtual Const const UExternalDataLayerInstance * Returns the cell associated external data layer instance.
Public function Virtual Const FName Returns the associated level package name.
Public function Virtual Const UWorld * REturns the outer world of this cell.
Public function Virtual Const UWorld * Returns the owning world of this cell.
Public function Virtual Const bool

HasAnyDataLayer ( const TSet< FName >& InDataLayers
)

 Returns whether the cell data layers referenced any of the provided data layer or not.
Public function Virtual Const bool Returns whether the cell content is associated with content bundle or not.

Overridden from IWorldPartitionCookPackageObject

  Type Name Description
Public function Virtual Const const UExternalDataLayerAsset *  
Public function Virtual Const FString  
Public function Virtual Const bool  
Public function Virtual bool

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

  
Public function Virtual bool  
Public function Virtual bool

OnPrepareGeneratorPackageForCook ( TArray< UPackage* >& OutModifiedPackages
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page