1. Epic GamesDeveloper
  3. FPackageFileSummary

FPackageFileSummary

A "table of contents" for an Unreal package file. Stored at the top of the file.

API > API/Runtime > API/Runtime/CoreUObject

A "table of contents" for an Unreal package file. Stored at the top of the file.

   
Name FPackageFileSummary
Type struct
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/PackageFileSummary.h
Include Path #include "UObject/PackageFileSummary.h"

Syntax

struct FPackageFileSummary

Constructors

Name Remarks Include Path Unreal Specifiers
  UObject/PackageFileSummary.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FPackageFileSummary ( FPackageFileSummary&&
)

 Workaround for clang deprecation warnings for deprecated members in implicit constructors. UObject/PackageFileSummary.h  
Constructor UObject/PackageFileSummary.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetRegistryDataOffset int32 Location into the file on disk for the asset registry tag data UObject/PackageFileSummary.h  
BulkDataStartOffset int64 Offset to the location in the file where the bulkdata starts UObject/PackageFileSummary.h  
bUnversioned bool If true, this file will not be saved with version numbers or was saved without version numbers. UObject/PackageFileSummary.h  
CellExportCount int32 Number of cells contained in this package UObject/PackageFileSummary.h  
CellExportOffset int32 Location into the file on disk for the CellExportMap data UObject/PackageFileSummary.h  
CellImportCount int32 Number of cell imports contained in this package UObject/PackageFileSummary.h  
CellImportOffset int32 Location into the file on disk for the CellImportMap data UObject/PackageFileSummary.h  
ChunkIDs TArray< int32 > Streaming install ChunkIDs UObject/PackageFileSummary.h  
CompatibleWithEngineVersion FEngineVersion Engine version this package is compatible with. UObject/PackageFileSummary.h  
CompressionFlags uint32 Flags used to compress the file on save and uncompress on load. UObject/PackageFileSummary.h  
DataResourceOffset int32 Location into the file of the data resource(s) UObject/PackageFileSummary.h  
DependsOffset int32 Location into the file on disk for the DependsMap data UObject/PackageFileSummary.h  
ExportCount int32 Number of exports contained in this package UObject/PackageFileSummary.h  
ExportOffset int32 Location into the file on disk for the ExportMap data UObject/PackageFileSummary.h  
GatherableTextDataCount int32 Number of gatherable text data items in this package UObject/PackageFileSummary.h  
GatherableTextDataOffset int32 Location into the file on disk for the gatherable text data items UObject/PackageFileSummary.h  
Generations TArray< FGenerationInfo > Data about previous versions of this package UObject/PackageFileSummary.h  
ImportCount int32 Number of imports contained in this package UObject/PackageFileSummary.h  
ImportOffset int32 Location into the file on disk for the ImportMap data UObject/PackageFileSummary.h  
ImportTypeHierarchiesCount int32 Number of import type hierarchy entries UObject/PackageFileSummary.h  
ImportTypeHierarchiesOffset int32 Location into the file on disk for the import type hierarchy map UObject/PackageFileSummary.h  
LocalizationId FString Localization ID of this package UObject/PackageFileSummary.h  
MetaDataOffset int32 Location into the file on disk for the MetaData data UObject/PackageFileSummary.h  
NameCount int32 Number of names used in this package UObject/PackageFileSummary.h  
NameOffset int32 Location into the file on disk for the name data UObject/PackageFileSummary.h  
NamesReferencedFromExportDataCount int32 Number of names that are referenced from serialized export data (sorted first in the name map) UObject/PackageFileSummary.h  
PackageName FString The package name the file was last saved with. UObject/PackageFileSummary.h  
PackageSource uint32 Value that is used to determine if the package was saved by Epic (or licensee) or by a modder, etc UObject/PackageFileSummary.h  
PayloadTocOffset int64 Location into the file on disk for the payload table of contents data UObject/PackageFileSummary.h  
PersistentGuid FGuid Current persistent id for this package UObject/PackageFileSummary.h  
PreloadDependencyCount int32   UObject/PackageFileSummary.h  
PreloadDependencyOffset int32 Location into the file on disk for the preload dependency data UObject/PackageFileSummary.h  
SavedByEngineVersion FEngineVersion Engine version this package was saved with. UObject/PackageFileSummary.h  
SearchableNamesOffset int32 Location into the file on disk for the SearchableNamesMap data UObject/PackageFileSummary.h  
SoftObjectPathsCount int32 Number of soft object paths references contained in this package UObject/PackageFileSummary.h  
SoftObjectPathsOffset int32 Location into the file on disk for the soft object paths reference list UObject/PackageFileSummary.h  
SoftPackageReferencesCount int32 Number of soft package references contained in this package UObject/PackageFileSummary.h  
SoftPackageReferencesOffset int32 Location into the file on disk for the soft package reference list UObject/PackageFileSummary.h  
Tag int32 Magic tag compared against PACKAGE_FILE_TAG to ensure that package is an Unreal package. UObject/PackageFileSummary.h  
ThumbnailTableOffset int32 Thumbnail table offset UObject/PackageFileSummary.h  
TotalHeaderSize int32 Total size of all information that needs to be read in to create a FLinkerLoad. UObject/PackageFileSummary.h  
WorldTileInfoDataOffset int32 Offset to the location in the file where the FWorldTileInfo data starts UObject/PackageFileSummary.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CustomVersionContainer FCustomVersionContainer Custom version numbers. Keyed off a unique tag for each custom component. UObject/PackageFileSummary.h  
FileVersionLicenseeUE int32 Licensee file version UObject/PackageFileSummary.h  
FileVersionUE FPackageFileVersion UE file version UObject/PackageFileSummary.h  
PackageFlags uint32 The flags for the package UObject/PackageFileSummary.h  
SavedHash FIoHash Hash of the Package's bytes when it was saved to disk. Accessed through GetSavedHash/SetSavedHash. UObject/PackageFileSummary.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FCustomVersionContainer & GetCustomVersionContainer()

   UObject/PackageFileSummary.h  

int32 GetFileVersionLicenseeUE()

   UObject/PackageFileSummary.h  

int32 GetFileVersionLicenseeUE4()

   UObject/PackageFileSummary.h  

FPackageFileVersion GetFileVersionUE()

   UObject/PackageFileSummary.h  

int32 GetFileVersionUE4()

   UObject/PackageFileSummary.h  

uint32 GetPackageFlags()

 Get the summary package flags. UObject/PackageFileSummary.h  

FIoHash GetSavedHash()

 Hash of the package's .uasset/.umap file when it was last saved by the editor. UObject/PackageFileSummary.h  

int64 GetSavedHashRelativeOffset()

   UObject/PackageFileSummary.h  

bool IsFileVersionTooNew()

 Returns true if any of the package file versions are newer than currently supported by the running process UObject/PackageFileSummary.h  

bool IsFileVersionTooOld()

 Returns true if any of the package file versions are older than the minimum supported versions UObject/PackageFileSummary.h  
Returns false if the summary is unversioned and the current process does not support that. UObject/PackageFileSummary.h  

void SetCustomVersionContainer ( const FCustomVersionContainer& InContainer
)

   UObject/PackageFileSummary.h  

void SetFileVersions ( const int32 EpicUE,
const int32 LicenseeUE,
const bool bInSaveUnversioned
)

   UObject/PackageFileSummary.h  

void SetFileVersions ( const int32 EpicUE4,
const int32 EpicUE5,
const int32 LicenseeUE,
const bool bInSaveUnversioned
)

 Used to manually set the package file and licensee versions UObject/PackageFileSummary.h  

void SetPackageFlags ( uint32 InPackageFlags
)

 Set the summary package flags while stripping out temporary flags (i.e. NewlyCreated, IsSaving) UObject/PackageFileSummary.h  

void SetSavedHash ( const FIoHash& InSavedHash
)

   UObject/PackageFileSummary.h  

void SetToLatestFileVersions ( const bool bInSaveUnversioned
)

 Set both the package file versions and the licensee version to the most recent version numbers supported UObject/PackageFileSummary.h  

Operators

Name Remarks Include Path Unreal Specifiers
  UObject/PackageFileSummary.h  
  UObject/PackageFileSummary.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page