1. Epic GamesDeveloper
  3. UWorldPartitionBuilder

UWorldPartitionBuilder

API > API/Editor > API/Editor/UnrealEd

   
Name UWorldPartitionBuilder
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/WorldPartition/WorldPartitionBuilder.h
Include Path #include "WorldPartition/WorldPartitionBuilder.h"

Syntax

UCLASS (Abstract, Config=Engine, MinimalAPI)  
class UWorldPartitionBuilder : public UObject

Inheritance Hierarchy

Derived Classes

UWorldPartitionBuilder derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWorldPartitionBuilder ( const FObjectInitializer& ObjectInitializer
)

   WorldPartition/WorldPartitionBuilder.h  

Enums

Public

Name Remarks
ELoadingMode  

Typedefs

Name Type Remarks Include Path
FModifiedFilesHandler TBaseDelegate_TwoParams< bool, const TArray< FString > &, const FString & >   WorldPartition/WorldPartitionBuilder.h

Constants

Name Type Remarks Include Path
Args FString   WorldPartition/WorldPartitionBuilder.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual ELoadingMode GetLoadingMode()

   WorldPartition/WorldPartitionBuilder.h  

virtual bool PreWorldInitialization ( UWorld* World,
FPackageSourceControlHelper& PackageHelper
)

   WorldPartition/WorldPartitionBuilder.h  

virtual bool RequiresCommandletRendering()

   WorldPartition/WorldPartitionBuilder.h  

bool Run ( UWorld* World,
FPackageSourceControlHelper& PackageHelper
)

   WorldPartition/WorldPartitionBuilder.h  

bool RunBuilder ( UWorld* World
)

   WorldPartition/WorldPartitionBuilder.h  

void SetModifiedFilesHandler ( const FModifiedFilesHandler& ModifiedFilesHandler
)

   WorldPartition/WorldPartitionBuilder.h  

virtual bool ShouldProcessAdditionalWorlds ( UWorld* InWorld,
TArray< FString >& OutPackageNames
) const

 Overridable method for derived classes to add additional world to be process by world builder This is called after `RunInternal_ is executed. WorldPartition/WorldPartitionBuilder.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool AutoSubmitFiles ( const TArray< FString >& InModifiedFiles,
const FString& InChangelistDescription
) const

   WorldPartition/WorldPartitionBuilder.h  

bool AutoSubmitPackages ( const TArray< UPackage* >& InModifiedPackages,
const FString& InChangelistDescription
) const

   WorldPartition/WorldPartitionBuilder.h  

virtual bool CanProcessNonPartitionedWorlds()

 Some builders may have the ability to process non partitioned worlds. WorldPartition/WorldPartitionBuilder.h  

const FString & GetBuilderArgs()

 Retrieve the arguments provided to the builder. WorldPartition/WorldPartitionBuilder.h  

bool GetParamValue ( const FString& Param,
T& Value
) const

 Retrieve the given parameter's value. WorldPartition/WorldPartitionBuilder.h  

virtual UWorld::InitializationValues GetWorldInitializationValues()

   WorldPartition/WorldPartitionBuilder.h  

bool HasParam ( const FString& Param
) const

 Test if the builder was provided the given parameter. WorldPartition/WorldPartitionBuilder.h  

bool IsForceExcludedDataLayer ( const UDataLayerInstance* InDataLayerInstance
) const

   WorldPartition/WorldPartitionBuilder.h  

bool IsForceIncludedDataLayer ( const UDataLayerInstance* InDataLayerInstance
) const

   WorldPartition/WorldPartitionBuilder.h  

bool OnFilesModified ( const TArray< FString >& InModifiedFiles,
const FString& InChangelistDescription
) const

   WorldPartition/WorldPartitionBuilder.h  

bool OnPackagesModified ( const TArray< UPackage* >& InModifiedPackages,
const FString& InChangelistDescription
) const

   WorldPartition/WorldPartitionBuilder.h  

virtual bool PostRun ( UWorld* World,
FPackageSourceControlHelper& PackageHelper,
const bool bInRunSuccess
)

 Overridable method for derived classes to perform operations when world builder process completes. WorldPartition/WorldPartitionBuilder.h  

virtual bool PostWorldTeardown ( FPackageSourceControlHelper& PackageHelper
)

 Overridable method for derived classes to perform operations when world builder has unloaded the world. WorldPartition/WorldPartitionBuilder.h  

virtual bool PreRun ( UWorld* World,
FPackageSourceControlHelper& PackageHelper
)

 Overridable method for derived classes to perform operations when world builder process starts. WorldPartition/WorldPartitionBuilder.h  

virtual bool PreWorldInitialization ( FPackageSourceControlHelper& PackageHelper
)

   WorldPartition/WorldPartitionBuilder.h  

virtual bool RunInternal ( UWorld* World,
const FCellInfo& InCellInfo,
FPackageSourceControlHelper& PackageHelper
)

   WorldPartition/WorldPartitionBuilder.h  

virtual bool ShouldProcessWorld ( UWorld* World
) const

 Some builders may decide to skip processing some worlds before initializing them. WorldPartition/WorldPartitionBuilder.h  

virtual bool ShouldSkipCell ( const FWorldBuilderCellCoord& CellCoord
) const

 When using EloadingMode::IterativeCells/IterativeCells2D return true to skip processing of cell. WorldPartition/WorldPartitionBuilder.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool DeletePackages ( const TArray< FString >& PackageNames,
FPackageSourceControlHelper& PackageHelper,
bool bErrorsAsWarnings
)

   WorldPartition/WorldPartitionBuilder.h  

static bool DeletePackages ( const TArray< UPackage* >& Packages,
FPackageSourceControlHelper& PackageHelper,
bool bErrorsAsWarnings
)

   WorldPartition/WorldPartitionBuilder.h  

static bool SavePackages ( const TArray< UPackage* >& Packages,
FPackageSourceControlHelper& PackageHelper,
bool bErrorsAsWarnings
)

   WorldPartition/WorldPartitionBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page