Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > UObject > UPackage

Light Theme

Dark Theme

UPackage

A package.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UPackage

References

Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/UObject/Package.h
Include	#include "UObject/Package.h"

Syntax

class UPackage : public UObject

Remarks

A package.

Variables

	Name	Description
uint8: 1	bCanBeImported	Whether this package can be imported, i.e. its package name is a package that exists on disk.
uint8: 1	bHasBeenFullyLoaded	Whether this package has been fully loaded (aka had all it's exports created) at some point.
uint8: 1	bIsCookedForEditor	True if this packages has been cooked for the editor / opened cooked by the editor
FName	FileName	The name of the file that this package was loaded from
uint64	FileSize	Size of the file for this package; if the package was not loaded from a file or was a forced export in another package, this will be zero
FCustomVersionC...	LinkerCustomVersion	Linker custom version container this package has been serialized with.
int32	LinkerLicenseeVersion	Linker licensee version this package has been serialized with. This is mostly used by PostLoad
FLinkerLoad ...	LinkerLoad	Linker load associated with this package
int32	LinkerPackageVersion	Linker package version this package has been serialized with. This is mostly used by PostLoad
UMetaData *	MetaData	MetaData for the editor, or NULL in the game.
int32	PIEInstanceID	Editor only: PIE instance ID this package belongs to, INDEX_NONE otherwise
TUniquePtr< FTh...	ThumbnailMap	Editor only: Thumbnails stored in this package
TUniquePtr< FWo...	WorldTileInfo	World browser information.

Constructors

	Name	Description
	UPackage ( FVTableHelper& Helper )	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
	UPackage ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	__DefaultConstructor ( const FObjectInitializer& X )
UObject *...	__VTableCtorCaller ( FVTableHelper& Helper )
FThumbnailMa...	AccessThumbnailMap()	Access the thumbnail map for this package. Only call this if HasThumbnailMap returns true!
bool	CanBeImported()	Returns whether the package can be imported.
void	ClearDirtyFlag()	Clear the package dirty flag without any transaction tracking
void	ClearPackageFlags ( uint32 NewFlags )	Set the specified flags to false. Does not affect any other flags.
bool	ContainsMap()	Returns whether this package contains a ULevel or UWorld object.
UObject *...	FindAssetInPackage()	Utility function to find Asset in this package, if any
void	FullyLoad()	Fully loads this package. Safe to call multiple times and won't clobber already loaded assets.
const TArray...	GetChunkIDs()	Returns our ChunkIDs
TArray< UPac...	GetExternalPackages()	Return the list of packages found assigned to object outer-ed to the top level objects of this package
int64	GetFileSize()	Returns our FileSize
FName	GetFolderName()	Get the package's folder name
float	GetLoadTime()	Returns the time it took the last time this package was fully loaded, 0 otherwise.
UMetaData &#...	GetMetaData()	Gets (after possibly creating) a metadata object for this package
uint32	GetPackageFlags()	Gets the package flags.
FPackageId	GetPackageId()	Returns the unique package id
FGuid	GetPersistentGuid()	Returns our persistent Guid
const FThumb...	GetThumbnailMap()	Returns the thumbnail map for this package (const).
bool	HasAllPackagesFlags ( uint32 FlagsToCheck )	Used to safely check whether all of the passed in flags are set.
bool	HasAnyPackageFlags ( uint32 FlagsToCheck )	Used to safely check whether the passed in flag is set.
bool	HasThumbnailMap()	Returns true if this package has a thumbnail map
bool	IsDirty()	Returns whether the package needs to be saved.
bool	IsEmptyPackage ( UPackage* Package, const UObject* LastReferencer )	Determines if a package contains no more assets.
bool	IsFullyLoaded()	Returns whether the package is fully loaded.
bool	IsLoadedByEditorPropertiesOnly()	Returns true when the package is only referenced by editor-only flag
void	MarkAsFullyLoaded()	Marks this package as being fully loaded.
bool	RequiresLocalizationGather()	Returns whether this package contains data required to be gathered for localization.
FSavePackage...	Save ( UPackage* InOuter, UObject* Base, EObjectFlags TopLevelFlags, const TCHAR* Filename, FOutputDevice* Error, FLinkerNull* Conform, bool bForceByteSwapping, bool bWarnOfLongFilename, uint32 SaveFlags, const ITargetPlatform* TargetP..., const FDateTime& FinalTimeStamp, bool bSlowTask, FArchiveDiffMap* InOutDiffMap, FSavePackageContext* SavePacka... )	Save one specific object (along with any objects it references contained within the same Outer) into an Unreal package.
FSavePackage...	Save2 ( UPackage* InPackage, UObject* InAsset, const TCHAR* InFilename, FSavePackageArgs& SaveArgs )	Save an asset into an Unreal Package Save2 is currently experimental and shouldn't be used until it can safely replace Save.
ESavePackage...	SaveConcurrent ( TArrayView< FPackageSaveInfo > InPa..., FSavePackageArgs& SaveArgs, TArray< FSavePackageResultStruct > ... )	Save a list of packages concurrently using Save2 mechanism SaveConcurrent is currently experimental and shouldn't be used until it can safely replace Save.
bool	SavePackage ( UPackage* InOuter, UObject* Base, EObjectFlags TopLevelFlags, const TCHAR* Filename, FOutputDevice* Error, FLinkerNull* Conform, bool bForceByteSwapping, bool bWarnOfLongFilename, uint32 SaveFlags, const ITargetPlatform* TargetP..., const FDateTime& FinalTimeStamp, bool bSlowTask )	Save one specific object (along with any objects it references contained within the same Outer) into an Unreal package.
void	SetCanBeImportedFlag ( bool bInCanBeImported )	Marks/Unmarks the package's bCanBeImported flag.
void	SetChunkIDs ( const TArray< int32 >& InChunkIDs )	Sets our ChunkIDs
void	SetDirtyFlag ( bool bIsDirty )	Marks/Unmarks the package's bDirty flag, save the package to the transaction buffer if a transaction is ongoing
void	SetFolderName ( FName name )	Set the package's folder name
void	SetLoadedByEditorPropertiesOnly ( bool bIsEditorOnly, bool bRecursive )	Sets the bLoadedByEditorPropertiesOnly flag
void	SetLoadTime ( float InLoadTime )	Sets the time it took to load this package.
void	SetPackageFlags ( uint32 NewFlags )	Set the specified flags to true. Does not affect any other flags.
void	SetPackageFlagsTo ( uint32 NewFlags )
void	SetPackageId ( FPackageId InPackageId )	Sets the unique package id
void	SetPersistentGuid ( FGuid NewPersistentGuid )	Sets a specific persistent Guid
UClass *	StaticClass()	Returns a UClass object representing this class at runtime
EClassCastFl...	StaticClassCastFlags()	Returns the static cast flags for this class
const TCHAR ...	StaticPackage()	Returns the package this class belongs in
void	StaticRegisterNativesUPackage()
void	ThisContainsMap()	Called to indicate that this package contains a ULevel or UWorld object.
void	ThisRequiresLocalizationGather ( bool Value )	Called to indicate that this package contains data required to be gathered for localization.
void	WaitForAsyncFileWrites()	Wait for any SAVE_Async file writes to complete

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	IsAsset()	Packages are never assets
bool	IsDestructionThreadSafe()	Called during garbage collection to determine if an object can have its destructor called on a worker thread.
bool	IsNameStableForNetworking()	IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
bool	NeedsLoadForClient()	Called during saving to determine the load flags to save with the object.
bool	NeedsLoadForServer()	Called during saving to determine the load flags to save with the object.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, but before the config has been loaded, etc.
void	Serialize ( FArchive& Ar )	Serializer
void	TagSubobjects ( EObjectFlags NewFlags )	Tags the Package's metadata Tags generated objects with flags

Operators

		Name	Description
	void *	operator new ( const size_t InSize, EInternal InInternalOnly, UObject* InOuter, FName InName, EObjectFlags InSetFlags )	For internal use only; use StaticConstructObject() to create new objects.
	void *	operator new ( const size_t InSize, EInternal* InMem )	For internal use only; use StaticConstructObject() to create new objects.

Typedefs

Name	Description
FOnPackageDirtyStateChanged	Delegate type for package dirty state events. ( Params: UPackage* ModifiedPackage )
FOnPackageMarkedDirty	Delegate type for when a package is marked as dirty via UObjectBaseUtilty::MarkPackageDirty ( Params: UPackage* ModifiedPackage, bool bWasDirty )
FOnPackageSaved	Delegate type for package saved events ( Params: const FString& PackageFileName, UObject* Outer )
FPreSavePackage	Delegate type for when a package is about to be saved
Super	Typedef for the base class (UObject)
ThisClass	Typedef for UPackage.

Constants

Name	Description
EditorPackage	UE-21181 - trying to track when a flag gets set on a package due to PIE.
PackageDirtyStateChangedEvent	Delegate to notify subscribers when the dirty state of a package is changed.
PackageMarkedDirtyEvent	Delegate to notify subscribers when a package is marked as dirty via UObjectBaseUtilty::MarkPackageDirty
PackageSavedEvent	Delegate to notify subscribers when a package has been saved.
PreSavePackageEvent	Delegate to notify subscribers when a package is about to be saved.
StaticClassFlags	Bitwise union of EClassFlags pertaining to this class.

Deprecated Functions

	Name	Description
FGuid	GetGuid()	UPackage::Guid has not been used by the engine for a long time and GetGuid will be removed.
FGuid	MakeNewGuid()	UPackage::Guid has not been used by the engine for a long time and MakeNewGuid will be removed.
void	SetGuid ( FGuid NewGuid )	UPackage::Guid has not been used by the engine for a long time and SetGuid will be removed.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss