1. Epic GamesDeveloper
  3. ICookPackageSplitter

ICookPackageSplitter

This class is used for packages that need to be split into multiple runtime packages.

API > API/Editor > API/Editor/UnrealEd

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/CookPackageSplitter.h
Include #include "CookPackageSplitter.h"

Syntax

class ICookPackageSplitter

Remarks

This class is used for packages that need to be split into multiple runtime packages. It provides the instructions to the cooker for how to split the package.

Destructors

  Type Name Description
Public function Virtual   Virtual API functions - functions called from the cooker after creating the splitter.

Functions

  Type Name Description
Public function Static FString

ConstructGeneratedPackageName ( FName OwnerPackageName,
FStringView RelPath,
FStringView GeneratedRootOverride
)

 Return the full packagename that will be used for a GeneratedPackage, based on the GeneratorPackage's name and on the RelPath and optional GeneratedRootPath that the splitter provides in the FGeneratedPackage it returns from GetGenerateList.
Public function Virtual EGeneratedRequiresGenerator Return capability setting which indicates which splitter functions acting on the parent generator package must be called on the splitter before splitter functions acting on the generated packages can be called.
Public function Static const TCHAR * The name of the Generated subdirectory that is the parent directory of a splitter's generated packages.
Public function TArray< FGeneratedPackage >

GetGenerateList ( const UPackage* OwnerPackage,
const UObject* OwnerObject
)

 Return the list of packages to generate.
Public function Static FString Return DebugName for this SplitterClass in cook log messages.
Public function Static bool

IsUnderGeneratedPackageSubPath ( FStringView FileOrLongPackagePath
)

 Return true if the given path is a Generated directory, or a subpath under it.
Public function Virtual void

OnOwnerReloaded ( UPackage* OwnerPackage,
UObject* OwnerObject
)

 Called when the Owner package needs to be reloaded after a garbage collect in order to populate a generated package.
Public function Virtual bool

PopulateGeneratedPackage ( UPackage* OwnerPackage,
UObject* OwnerObject,
const FGeneratedPackageForPopulate& GeneratedPackage,
TArray< UObject* >& OutObjectsToMove,
TArray< UPackage* >& OutKeepReferencedPackages
)

 Try to populate a generated package.
Public function Virtual bool

PopulateGeneratorPackage ( UPackage* OwnerPackage,
UObject* OwnerObject,
const TArray< ICookPackageSplitter::FGeneratedPackageForPreSave >& GeneratedPackages,
TArray< UObject* >& OutObjectsToMove,
TArray< UPackage* >& OutKeepReferencedPackages
)

 Called before presaving the parent generator package, to give the generator a chance to inform the cooker which objects will be moved into the generator package that are not already present in it.
Public function Virtual void

PostSaveGeneratedPackage ( UPackage* OwnerPackage,
UObject* OwnerObject,
const FGeneratedPackageForPopulate& GeneratedPackage
)

 Called after saving a generated package.
Public function Virtual void

PostSaveGeneratorPackage ( UPackage* OwnerPackage,
UObject* OwnerObject
)

 Called after saving the parent generator package.
Public function Virtual bool

PreSaveGeneratedPackage ( UPackage* OwnerPackage,
UObject* OwnerObject,
const FGeneratedPackageForPopulate& GeneratedPackage,
TArray< UPackage* >& OutKeepReferencedPackages
)

 Called before saving a generated package, after PopulateGeneratedPackage.
Public function Virtual bool

PreSaveGeneratorPackage ( UPackage* OwnerPackage,
UObject* OwnerObject,
const TArray< FGeneratedPackageForPreSave >& PlaceholderPackages,
TArray< UPackage* >& OutKeepReferencedPackages
)

 Called before saving the parent generator package, after PopulateGeneratorPackage but before PopulateGeneratedPackage for any generated packages.
Public function Static bool Static API functions - these static functions are referenced by REGISTER_COOKPACKAGE_SPLITTER before creating an instance of the class.
Public function Virtual bool An ICookPackageSplitter for a single generator package normally is constructed only once and handles all generated packages for that generator, but during MPCook in cases of load balancing between CookWorkers, it is possible that the original splitter is destructed but then recreated later.
Public function Static bool

ShouldSplit ( UObject* SplitData
)

 Return whether the CookPackageSplitter subclass should handle the given SplitDataClass instance.
Public function Virtual void

Teardown ( ETeardown Status
)

 Do teardown actions after all packages have saved, or when the cook is cancelled.
Public function Virtual bool If true, this splitter forces the Generator package objects it needs to remain referenced, and the cooker should expect them to still be in memory after a garbage collect so long as the splitter is alive.

Classes

  Type Name Description
Public struct FGeneratedPackage Data sent to the cooker to describe each desired generated package  
Public struct FGeneratedPackageForPopulate Representation of a generated package when it itself is being populated.  
Public struct FGeneratedPackageForPreSave Representation of a generated package that is provided when populating the generator package.  

Enums

  Type Name Description
Public enum EGeneratedRequiresGenerator Return value for the DoesGeneratedRequireGenerator function.  
Public enum ETeardown    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page