1. Epic GamesDeveloper
  3. UPackage

UPackage

A package.

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

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

  Type Name Description
Public variable uint8: 1 bCanBeImported Whether this package can be imported, i.e. its package name is a package that exists on disk.
Public variable uint8: 1 bHasBeenFullyLoaded Whether this package has been fully loaded (aka had all it's exports created) at some point.
Public variable uint8: 1 bIsCookedForEditor True if this packages has been cooked for the editor / opened cooked by the editor

Constructors

  Type Name Description
Public function  

UPackage ( FVTableHelper& Helper
)

 DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
Public function  

UPackage ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void  
Public function Static UObject *  
Public function FThumbnailMap & Access the thumbnail map for this package. Only call this if HasThumbnailMap returns true!
Public function Static void Static class override of UObject::AddReferencedObjects
Public function Const bool Returns whether the package can be imported.
Public function void Clear the package dirty flag without any transaction tracking
Public function void

ClearPackageFlags ( uint32 NewFlags
)

 Set the specified flags to false. Does not affect any other flags.
Public function Const bool Returns whether this package contains a ULevel or UWorld object.
Public function Const UObject *

FindAssetInPackage ( EObjectFlags RequiredTopLevelFlags
)

 Utility function to find Asset in this package, if any
Public function void Fully loads this package. Safe to call multiple times and won't clobber already loaded assets.
Public function Const const TArray< int32 > & Returns our ChunkIDs
Public function Const TArray< UPackage * > Return the list of packages found assigned to object outer-ed to the top level objects of this package
Public function Const int64 Returns our FileSize
Public function Const bool  
Public function Const FLinkerLoad *  
Public function Const const FCustomVersionContainer &  
Public function Const int32  
Public function Const const FPackageFileVersion &  
Public function Const const FPackagePath & Get the path this package was loaded from; may be different than packagename, and may not be set if the package was not loaded from disk
Public function Const float Returns the time it took the last time this package was fully loaded, 0 otherwise.
Public function UMetaData * Gets (after possibly creating) a metadata object for this package
Public function Const uint32 Gets the package flags.
Public function Const FPackageId Returns the unique package id
Public function Const FPackageId Returns the unique package id to load
Public function Const FGuid Returns our persistent Guid
Public function Const int32 Returns the PIE instance id used by the package if any, or INDEX_NONE otherwise
Public function Const const TArray< UFunction * > &  
Public function Const const FThumbnailMap & Returns the thumbnail map for this package (const).
Public function Const FWorldTileInfo * Get the world tile info if any
Public function Const bool

HasAllPackagesFlags ( uint32 FlagsToCheck
)

 Used to safely check whether all of the passed in flags are set.
Public function Const bool

HasAnyPackageFlags ( uint32 FlagsToCheck
)

 Used to safely check whether the passed in flag is set.
Public function Static bool Return true if SAVE_Async file writes are pending
Public function Const bool Return if the package currently has an assigned metadata object
Public function Const bool Returns true if this package has a thumbnail map
Public function Const bool

IsDirty ()

 Returns whether the package needs to be saved.
Public function Const bool Returns the bIsDynamicPIEPackagePending flag
Public function Static bool

IsEmptyPackage ( UPackage* Package,
const UObject* LastReferencer
)

 Determines if a package contains no more assets.
Public function Const bool  
Public function Const bool Returns whether the package is fully loaded.
Public function Const bool Returns true when the package is only referenced by editor-only flag
Public function void Marks this package as being fully loaded.
Public function void Marks this package as newly created (has no corresponding file on disk).
Public function void Marks this package as unloaded.
Public function Const bool Returns whether this package contains data required to be gathered for localization.
Public function Static FSavePackageResultStruct

Save ( UPackage* InOuter,
UObject* InAsset,
const TCHAR* Filename,
const FSavePackageArgs& SaveArgs
)

 Save one specific object (along with any objects it references contained within the same Outer) into an Unreal package.
Public function Static ESavePackageResult

SaveConcurrent ( TArrayView< FPackageSaveInfo > InPackages,
const FSavePackageArgs& SaveArgs,
TArray< FSavePackageResultStruct >& OutResults
)

 Save a list of packages concurrently using Save2 mechanism SaveConcurrent is currently experimental and shouldn't be used until it can safely replace Save.
Public function Static bool

SavePackage ( UPackage* InOuter,
UObject* InAsset,
const TCHAR* Filename,
const FSavePackageArgs& SaveArgs
)

 Save one specific object (along with any objects it references contained within the same Outer) into an Unreal package.
Public function void

SetCanBeImportedFlag ( bool bInCanBeImported
)

 Marks/Unmarks the package's bCanBeImported flag.
Public function void

SetChunkIDs ( const TArray< int32 >& InChunkIDs
)

 Sets our ChunkIDs
Public function void

SetDirtyFlag ( bool bIsDirty
)

 Marks/Unmarks the package's bDirty flag, save the package to the transaction buffer if a transaction is ongoing
Public function void

SetDynamicPIEPackagePending ( bool bInIsDynamicPIEPackagePending
)

 Sets the bIsDynamicPIEPackagePending flag
Public function void

SetHasBeenEndLoaded ( bool bValue
)

  
Public function void Sets whether or not the package is ExternallyReferenceable
Public function void

SetLoadedByEditorPropertiesOnly ( bool bIsEditorOnly,
bool bRecursive
)

 Sets the bLoadedByEditorPropertiesOnly flag
Public function void

SetLoadedPath ( const FPackagePath& PackagePath
)

 Set the path this package was loaded from; typically called only by the linker during load
Public function void

SetLoadTime ( float InLoadTime
)

 Sets the time it took to load this package.
Public function void

SetPackageFlags ( uint32 NewFlags
)

 Set the specified flags to true. Does not affect any other flags.
Public function void

SetPackageFlagsTo ( uint32 NewFlags
)

  
Public function void

SetPackageId ( FPackageId InPackageId
)

 Sets the unique package id
Public function void

SetPersistentGuid ( FGuid NewPersistentGuid
)

 Sets a specific persistent Guid
Public function void

SetPIEInstanceID ( int32 InPIEInstanceID
)

 Set the PIE instance id for this package
Public function void

SetReloadDelegates ( TArray< UFunction* > InDelegates
)

  
Public function void

SetThumbnailMap ( TUniquePtr< FThumbnailMap > InThumbnailMap
)

 Set the internal thumbnail map for this package.
Public function void

SetWorldTileInfo ( TUniquePtr< FWorldTileInfo > InWorldTileInfo
)

 Set the world tile info
Public function Static UClass * Returns a UClass object representing this class at runtime
Public function Static EClassCastFlags Returns the static cast flags for this class
Public function Static const TCHAR * Returns the package this class belongs in
Public function Static void  
Public function void Called to indicate that this package contains a ULevel or UWorld object.
Public function void Called to indicate that this package contains data required to be gathered for localization.
Public function Static void Wait for any SAVE_Async file writes to complete

Overridden from UObject

  Type Name Description
Public function Virtual void Called to finish destroying the object.
Public function Virtual Const bool

IsAsset ()

 Packages are never assets
Public function Virtual Const bool Called during garbage collection to determine if an object can have its destructor called on a worker thread.
Public function Virtual Const bool IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, but before the config has been loaded, etc.
Public function Virtual void Serializer
Public function Virtual void

TagSubobjects ( EObjectFlags NewFlags
)

 Tags the Package's metadataTags generated objects with flags

Operators

  Type Name Description
Public function void

operator delete ( void* InMem
)

 Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy.
Public function 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.
Public function 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 )
FOnPackageSavedWithContext Delegate type for package saved events ( Params: const FString& PackageFileName, UObject* Outer, FObjectPostSaveContext ObjectSaveContext )
FPreSavePackage Delegate type for when a package is about to be saved
FPreSavePackageWithContext 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
bSupportCookerSoftGC Functionality to support SoftGC in the cooker.
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 Note: Unlike FOnPackageDirtyStateChanged, this is always called, even when the package is already dirty Use bWasDirty to check the previous dirty state of the package Use Package->IsDirty() to get the updated dirty state of the package
PackageSavedEvent  
PackageSavedWithContextEvent Delegate to notify subscribers when a package has been saved.
PreSavePackageEvent  
PreSavePackageWithContextEvent Delegate to notify subscribers when a package is about to be saved.
SoftGCPackageToObjectList  
StaticClassFlags Bitwise union of EClassFlags pertaining to this class.

Deprecated Variables

  Type Name Description
Public variable TArray< UFunction * > Delegates Use Get/SetReloadDelegates instead
Public variable FName FileName Use GetLoadedPath instead
Public variable uint64 FileSize Use Get/SetFileSize instead
Public variable FCustomVersionContainer LinkerCustomVersion Use Get/SetLinkerCustomVersions instead
Public variable int32 LinkerLicenseeVersion Use Get/SetLinkerLicenseeVersion instead
Public variable FLinkerLoad * LinkerLoad Use Get/SetLinker instead
Public variable FPackageFileVersion LinkerPackageVersion Use Get/SetLinkerPackageVersion instead
Public variable UMetaData * MetaData Use Get/HasMetaData instead
Public variable int32 PIEInstanceID Use Get/SetPIEInstanceID instead
Public variable TUniquePtr< FThumbnailMap > ThumbnailMap Use Get/SetThumbnailMap instead
Public variable TUniquePtr< FWorldTileInfo > WorldTileInfo Use Get/SetWorldTileInfo instead

Deprecated Functions

  Type Name Description
Public function Const FName Unused property to be removed. Use something like FPackageName::GetLongPackagePath if requiring something similar.
Public function Const FGuid

GetGuid ()

 UPackage::Guid has not been used by the engine for a long time and GetGuid will be removed.
Public function FGuid UPackage::Guid has not been used by the engine for a long time and MakeNewGuid will be removed.
Public function Static bool

SavePackage ( UPackage* InOuter,
UObject* Base,
EObjectFlags TopLevelFlags,
const TCHAR* Filename,
FOutputDevice* Error,
FLinkerNull* Conform,
bool bForceByteSwapping,
bool bWarnOfLongFilename,
uint32 SaveFlags,
const ITargetPlatform* TargetPlatform,
const FDateTime& FinalTimeStamp,
bool bSlowTask
)

 Pack the arguments into FSavePackageArgs and call the function overload that takes FSavePackageArgs. Note that Conform is no longer implemented.
Public function void

SetFolderName ( FName name
)

 Unused property to be removed. Use something like FPackageName::GetLongPackagePath if requiring something similar.
Public function void

SetGuid ( FGuid NewGuid
)

 UPackage::Guid has not been used by the engine for a long time and SetGuid will be removed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page