FAssetRegistryGenerator

Helper class for generating streaming install manifests

Windows
MacOS
Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/Commandlets/AssetRegistryGenerator.h

Include

#include "Commandlets/AssetRegistryGenerator.h"

Syntax

class FAssetRegistryGenerator

Remarks

Helper class for generating streaming install manifests

Constructors

Name Description

Public function

FAssetRegistryGenerator

(
    const ITargetPlatform* InPlatf...
)

Constructor

Destructors

Name Description

Public function

~FAssetRegistryGenerator()

Destructor

Functions

Name Description

Public function

void

 

AddAssetToFileOrderRecursive

(
    const FName& InPackageName,
    TArray< FName >& OutFileOrder,
    TSet< FName >& OutEncounteredNames,
    const TSet< FName >& InPackageName...,
    const TSet< FName >& InTopLevelAss...
)

Follows an assets dependency chain to build up a list of package names in the same order as the runtime would attempt to load them

Public function

void

 

AddPackageToChunkManifest

(
    const FName& PackageFName,
    const FString& PackagePathName,
    const FString& SandboxFilename,
    const FString& LastLoadedMapName,
    FSandboxPlatformFile* InSandbo...
)

Adds a package to chunk manifest (just calls the other AddPackageToChunkManifestFunction with more parameters)

Public function

void

 

AddUnassignedPackageToManifest

(
    UPackage* Package,
    const FString& PackageSandboxPath
)

Add a package to the manifest but don't assign it to any chunk yet, packages which are not assigned by the end of the cook will be put into chunk 0

Public function

void

 

BuildChunkManifest

(
    const TSet< FName >& CookedPackage...,
    const TSet< FName >& DevelopmentOn...,
    FSandboxPlatformFile* InSandbo...,
    bool bGenerateStreamingInstallManif...
)

GenerateChunkManifest generate chunk manifest for the packages passed in using the asset registry to determine dependencies

Public function

void

 

CleanManifestDirectories()

Deletes temporary manifest directories.

Public function

void

 

ComputePackageDifferences

(
    TSet< FName >& ModifiedPackages,
    TSet< FName >& NewPackages,
    TSet< FName >& RemovedPackages,
    TSet< FName >& IdenticalCookedPack...,
    TSet< FName >& IdenticalUncookedPa...,
    bool bRecurseModifications,
    bool bRecurseScriptModifications
)

Computes differences between the previous asset registry and the current one

Public function Const

bool

 

ContainsMap

(
    const FName& PackageName
)

ContainsMap Does this package contain a map file (determined by finding if this package contains a UWorld / ULevel object)

Public function

FAssetPackag...

 

GetAssetPackageData

(
    const FName& PackageName
)

Returns editable version of the asset package state being generated

Public function Const

const ITarge...

 

GetTargetPlatform()

Public function

void

 

Initialize

(
    const TArray< FName >& StartupPack...
)

Initializes manifest generator - creates manifest lists, hooks up delegates.

Public function

bool

 

LoadPreviousAssetRegistry

(
    const FString& Filename
)

Loads asset registry from a previous run that is used for iterative or DLC cooking

Public function

void

 

PostSave()

PostSave Notify generator that we are finished saving registry

Public function

void

 

PreSave

(
    const TSet< FName >& InCookedPacka...
)

PreSave Notify generator that we are about to save the registry and chunk manifests

Public function

void

 

RegisterChunkDataGenerator

(
    TSharedRef< IChunkDataGenerator > I...
)

Register a chunk data generator with this generator.

Should be called prior to SaveManifests.

Public function

bool

 

SaveAssetRegistry

(
    const FString& SandboxPath,
    bool bSerializeDevelopmentAssetRegi...,
    bool bForceNoFilterAssets
)

Saves generated asset registry data for each platform.

Public function

bool

 

SaveManifests

(
    FSandboxPlatformFile* InSandbo...,
    int64 InExtraFlavorChunkSize
)

Saves all generated manifests for each target platform.

Public function

void

 

UpdateKeptPackages

(
    const TArray< FName >& InKeptPacka...
)

Tracks packages that were kept from a previous cook.

Public function

bool

 

WriteCookerOpenOrder()

Writes out CookerOpenOrder.log file

Typedefs

Name

Description

FChunkPackageSet

Map of Package name to Sandbox Paths
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss