1. Epic GamesDeveloper
  3. FAssetRegistryGenerator

FAssetRegistryGenerator

Helper class for generating streaming install manifests

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Commandlets

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

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function void

AddAssetToFileOrderRecursive ( const FName& InPackageName,
TArray< FName >& OutFileOrder,
TSet< FName >& OutEncounteredNames,
const TSet< FName >& InPackageNameSet,
const TSet< FName >& InTopLevelAssets
)

 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 Deletes temporary manifest directories.
Public function void Used by DLC which does not Clone the entire global AR.
Public function void

ComputePackageDifferences ( const FComputeDifferenceOptions& Options,
const FAssetRegistryState& PreviousState,
FAssetRegistryDifference& OutDifference
)

 Computes differences between the current asset registry state and the provided previous state.
Public function void

ComputePackageRemovals ( const FAssetRegistryState& PreviousState,
TArray< FName >& OutRemovedPackages,
TMap< FName, FGeneratorPackageInfo >& OutGeneratorPackages,
int32& OutNumNeverCookPlaceHolderPackages
)

 Computes just the list of packages in the PreviousState that no longer exist in the current state.
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 void

FinalizeChunkIDs ( const TSet< FName >& CookedPackages,
const TSet< FName >& DevelopmentOnlyPackages,
FSandboxPlatformFile& InSandboxFile,
bool bGenerateStreamingInstallManifest
)

 FinalizeChunkIDs Create the list of packages to store in each Chunk; each Chunk corresponds to a pak file, or group of pak files if the chunk is split.
Public function FAssetPackageData *

GetAssetPackageData ( const FName& PackageName
)

 Returns editable version of the asset package state being generated
Public function Const void

GetChunkAssignments ( TArray< TSet< FName >>& OutAssignments
)

 Returns the chunks
Public function Const int32

GetPakchunkIndex ( int32 ChunkId
)

 Get pakchunk file index from ChunkID
Public function Const const ITargetPlatform *  
Public function Const bool Whether *this cloned the global the AssetRegistry during its construction.
Public function void

Initialize ( const TArray< FName >& StartupPackages,
bool bInitializeFromExisting
)

 Initializes manifest generator - creates manifest lists, hooks up delegates.
Public function void PostSave Notify generator that we are finished saving registry
Public function void

PreSave ( const TSet< FName >& InCookedPackages
)

 PreSave Notify generator that we are about to save the registry and chunk manifests
Public function void Register a chunk data generator with this generator. Should be called prior to SaveManifests.
Public function bool

SaveAssetRegistry ( const FString& SandboxPath,
bool bSerializeDevelopmentAssetRegistry,
bool bForceNoFilterAssets,
uint64& OutDevelopmentAssetRegistryHash
)

 Saves generated asset registry data for each platform.
Public function bool

SaveManifests ( FSandboxPlatformFile& InSandboxFile,
int64 InOverrideChunkSize,
const TCHAR* InManifestSubDir
)

 Saves all generated manifests for each target platform.
Public function void Sets asset registry from a previous run that is used for iterative cooking.
Public function Static void Check config to see whether chunk assignments use the AssetManager.
Public function void

UpdateAssetRegistryData ( UE::Cook::FMPCollectorServerMessageContext& Context,
UE::Cook::FAssetRegistryPackageMessage&& Message
)

  
Public function void

UpdateAssetRegistryData ( FName PackageName,
const UPackage* Package,
UE::Cook::ECookResult CookResult,
FSavePackageResultStruct* SavePackageResult,
FCookTagList&& InArchiveCookTagList,
bool bIncludeOnlyDiskAssets,
TOptional< FAssetPackageData >&& OverrideAssetPackageData,
TOptional< TArray< FAssetDependency >>&& OverridePackageDependencies
)

 Attempts to update the metadata for a package in an asset registry generator.
Public function bool Writes out CookerOpenOrder.log file

Classes

  Type Name Description
Public struct FAssetRegistryDifference Differences between the current and the previous state.  
Public struct FComputeDifferenceOptions Options when computing the differences between current and previous state.  
Public struct FGeneratorPackageInfo Info about a GeneratorPackage (see ICookPackageSplitter) loaded from previous iterative cooks.  

Enums

  Type Name Description
Public enum EDifference    

Typedefs

Name Description
FChunkPackageSet Map of Package name to Sandbox Paths
FCreateOrFindArray Ensures all assets in the input package are present in the registry

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page