Navigation
Unreal Engine C++ API Reference > Runtime > CoreUObject > UObject
References
| Module | CoreUObject |
| Header | /Engine/Source/Runtime/CoreUObject/Public/UObject/PackageFileSummary.h |
| Include | #include "UObject/PackageFileSummary.h" |
Syntax
struct FPackageFileSummary
Remarks
A "table of contents" for an Unreal package file. Stored at the top of the file.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
int32 | AssetRegistryDataOffset | Location into the file on disk for the asset registry tag data |
 |
int64 | BulkDataStartOffset | Offset to the location in the file where the bulkdata starts |
 |
bool | bUnversioned | If true, this file will not be saved with version numbers or was saved without version numbers. |
 |
TArray< int32 > | ChunkIDs | Streaming install ChunkIDs |
 |
FEngineVersion | CompatibleWithEngineVersion | Engine version this package is compatible with. |
 |
uint32 | CompressionFlags | Flags used to compress the file on save and uncompress on load. |
 |
int32 | DataResourceOffset | Location into the file of the data resource(s) |
 |
int32 | DependsOffset | Location into the file on disk for the DependsMap data |
 |
int32 | ExportCount | Number of exports contained in this package |
 |
int32 | ExportOffset | Location into the file on disk for the ExportMap data |
 |
int32 | GatherableTextDataCount | Number of gatherable text data items in this package |
 |
int32 | GatherableTextDataOffset | Location into the file on disk for the gatherable text data items |
 |
TArray< FGenerationInfo > | Generations | Data about previous versions of this package |
 |
int32 | ImportCount | Number of imports contained in this package |
 |
int32 | ImportOffset | Location into the file on disk for the ImportMap data |
 |
FString | LocalizationId | Localization ID of this package |
 |
int32 | NameCount | Number of names used in this package |
 |
int32 | NameOffset | Location into the file on disk for the name data |
 |
int32 | NamesReferencedFromExportDataCount | Number of names that are referenced from serialized export data (sorted first in the name map) |
 |
FString | PackageName | The package name the file was last saved with. |
 |
uint32 | PackageSource | Value that is used to determine if the package was saved by Epic (or licensee) or by a modder, etc |
 |
int64 | PayloadTocOffset | Location into the file on disk for the payload table of contents data |
 |
FGuid | PersistentGuid | Current persistent id for this package |
 |
int32 | PreloadDependencyCount | |
 |
int32 | PreloadDependencyOffset | Location into the file on disk for the preload dependency data |
 |
FEngineVersion | SavedByEngineVersion | Engine version this package was saved with. |
 |
int32 | SearchableNamesOffset | Location into the file on disk for the SearchableNamesMap data |
 |
int32 | SoftObjectPathsCount | Number of soft object paths references contained in this package |
 |
int32 | SoftObjectPathsOffset | Location into the file on disk for the soft object paths reference list |
 |
int32 | SoftPackageReferencesCount | Number of soft package references contained in this package |
 |
int32 | SoftPackageReferencesOffset | Location into the file on disk for the soft package reference list |
 |
int32 | Tag | Magic tag compared against PACKAGE_FILE_TAG to ensure that package is an Unreal package. |
 |
int32 | ThumbnailTableOffset | Thumbnail table offset |
 |
int32 | TotalHeaderSize | Total size of all information that needs to be read in to create a FLinkerLoad. |
 |
int32 | WorldTileInfoDataOffset | Offset to the location in the file where the FWorldTileInfo data starts |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Constructor | ||
 |
PRAGMA_DISABLE_DEPRECATION_WARNINGS | Workaround for clang deprecation warnings for deprecated members in implicit constructors. | |
 |
FPackageFileSummary
(
const FPackageFileSummary& |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const FCustomVersionContainer & | ||
  |
int32 | ||
  |
FPackageFileVersion | ||
  |
uint32 | Get the summary package flags. | |
  |
bool | Returns true if any of the package file versions are newer than currently supported by the running process | |
  |
bool | Returns true if any of the package file versions are older than the minimum supported versions | |
  |
bool | Returns false if the summary is unversioned and the current process does not support that. | |
 |
void | SetCustomVersionContainer
(
const FCustomVersionContainer& InContainer |
|
 |
void | SetFileVersions
(
const int32 EpicUE4, |
Used to manually set the package file and licensee versions |
 |
void | SetPackageFlags
(
uint32 InPackageFlags |
Set the summary package flags while stripping out temporary flags (i.e. NewlyCreated, IsSaving) |
 |
void | SetToLatestFileVersions
(
const bool bInSaveUnversioned |
Set both the package file versions and the licensee version to the most recent version numbers supported |
Operators
| Type | Name | Description | |
|---|---|---|---|
 |
FPackageFileSummary & | operator=
(
const FPackageFileSummary& |
|
 |
FPackageFileSummary & | operator=
(
FPackageFileSummary&& |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FGuid | Guid | UPackage::Guid has not been used by the engine for a long time and FPackageFileSummary::Guid will be removed. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
int32 | Use GetFileVersionLicenseeUE instead | |
  |
int32 | Use UEVer instead which returns the version as a FPackageFileVersion. See the documentation for further details | |
 |
void | SetFileVersions
(
const int32 EpicUE, |
Use the other overload of SetFileVersions that takes an UE5 version as well |