ICookPackageSplitter

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

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function Virtual

~ICookPackageSplitter()

Functions

Name Description

Public function

TArray< FGen...

 

GetGenerateList

(
    const UPackage* OwnerPackage,
    const UObject* OwnerObject
)

Return the list of packages to generate.

Public function Virtual

void

 

PostSaveGeneratorPackage

(
    UPackage* OwnerPackage,
    UObject* OwnerObject
)

Called after saving the parent generator package.

Public function Virtual

void

 

PreSaveGeneratorPackage

(
    UPackage* OwnerPackage,
    UObject* OwnerObject,
    const TArray< FGeneratedPackageForP...
)

Called before saving the parent generator package.

Public function Static

bool

 

ShouldSplit

(
    UObject* SplitData
)

Return whether the CookPackageSplitter subclass should handle the given SplitDataClass instance.

Public function

bool

 

TryPopulatePackage

(
    const UPackage* OwnerPackage,
    const UObject* OwnerObject,
    const FGeneratedPackageForPopulate ...,
    bool bWasOwnerReloaded
)

Try to populate a generated package.

Public function Virtual

bool

 

UseDeferredPopulate()

If true, this Splitter can handle populating generated packages long after the generator package is finalized and cooked.

Public function Virtual

bool

 

UseInternalReferenceToAvoidGarbageCollect()

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

Name

Description

Public struct

FGeneratedPackage

Data sent to the cooker to describe each desired generated package

Public struct

FGeneratedPackageForPopulate

Public struct

FGeneratedPackageForPreSave