1. Epic GamesDeveloper
  3. FPackageName

FPackageName

Unreal Engine C++ API Reference > Runtime > CoreUObject > Misc

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/Misc/PackageName.h
Include #include "Misc/PackageName.h"

Syntax

class FPackageName

Functions

  Type Name Description
Public function Static FString

ConvertToLongScriptPackageName ( const TCHAR* InShortName
)

 Helper function for converting short to long script package name (InputCore -> /Script/InputCore)
Public function Static bool

DoesPackageExist ( const FString& LongPackageName,
FString* OutFilename,
bool InAllowTextFormats
)

 Checks if the package exists on disk.
Public function Static bool

DoesPackageExist ( const FPackagePath& PackagePath,
FPackagePath* OutPackagePath
)

 Checks if the package exists on disk. PackagePath must be a mounted path, otherwise returns false
Public function Static bool

DoesPackageExist ( const FPackagePath& PackagePath,
bool bMatchCaseOnDisk,
FPackagePath* OutPackagePath
)

 Checks if the package exists on disk. PackagePath must be a mounted path, otherwise returns false
Public function Static EPackageLocationFilter

DoesPackageExistEx ( const FPackagePath& PackagePath,
EPackageLocationFilter Filterconst,
bool bMatchCaseOnDisk,
FPackagePath* OutPackagePath
)

 Checks if the package exists in IOStore containers, on disk outsode of IOStore, both, or neither
Public function Static FDoesPackageExistOverride &  
Public function Static bool

DoesPackageNameContainInvalidCharacters ( FStringView InLongPackageName,
EErrorCode* OutReason
)

 Checks if a package name contains characters that are invalid for package names.
Public function Static bool

DoesPackageNameContainInvalidCharacters ( FStringView InLongPackageName,
FText* OutReason
)

 Checks if a package name contains characters that are invalid for package names.
Public function Static FString

ExportTextPathToObjectPath ( const TCHAR* InExportTextPath
)

 Returns the path to the object referred to by the supplied export text path, excluding the class name.
Public function Static FString

ExportTextPathToObjectPath ( const FString& InExportTextPath
)

 Returns the path to the object referred to by the supplied export text path, excluding the class name.
Public function Static FAnsiStringView

ExportTextPathToObjectPath ( FAnsiStringView InExportTextPath
)

 Returns the path to the object referred to by the supplied export text path, excluding the class name.
Public function Static FWideStringView

ExportTextPathToObjectPath ( FWideStringView InExportTextPath
)

 Returns the path to the object referred to by the supplied export text path, excluding the class name.
Public function Static FString

FilenameToLongPackageName ( const FString& InFilename
)

 Converts the supplied filename to long package name.
Public function Static bool

FindPackageFileWithoutExtension ( const FString& InPackageFilename,
FString& OutFilename
)

 Checks if a package can be found using known package extensions (header extensions only; files with the extensions of other segments are not returned).
Public function Static bool

FindPackagesInDirectories ( TArray< FString >& OutPackages,
const TArrayView< const FString >& RootDirs
)

 This will recurse over the given list of directory structures looking for packages.
Public function Static bool

FindPackagesInDirectory ( TArray< FString >& OutPackages,
const FString& RootDir
)

 This will recurse over a directory structure looking for packages.
Public function Static FName *

FindScriptPackageName ( FName InShortName
)

 Finds long script package name associated with a short package name.
Public function Static bool

FixPackageNameCase ( FString& LongPackageName,
FStringView Extension
)

 Converts a long package name to the case it exists as on disk.
Public function Static FString

FormatErrorAsString ( FStringView InPath,
EErrorCode ErrorCode
)

 Return a user-readable string for the error code returned from a FPackageName function
Public function Static FText

FormatErrorAsText ( FStringView InPath,
EErrorCode ErrorCode
)

 Return a user-readable string for the error code returned from a FPackageName function
Public function Static const FString & Returns the file extension for packages containing assets.
Public function Static FString

GetContentPathForPackageRoot ( FStringView InPackageRoot
)

 Get the path associated with the given package root
Public function Static FString

GetDelegateResolvedPackagePath ( const FString& InSourcePackagePath
)

 Gets the resolved path of a long package as determined by the delegates registered with FCoreDelegates::PackageNameResolvers.
Public function Static FString

GetLocalizedPackagePath ( const FString& InSourcePackagePath,
const FString& InCultureName
)

 Gets the localized version of a long package path for the given culture, or returns the source package if there is no suitable localized package.
Public function Static FString

GetLocalizedPackagePath ( const FString& InSourcePackagePath
)

 Gets the localized version of a long package path for the current culture, or returns the source package if there is no suitable localized package.
Public function Static FString

GetLongPackageAssetName ( const FString& InLongPackageName
)

 Returns the clean asset name for the specified package, same as GetShortName
Public function Static FString

GetLongPackagePath ( const FString& InLongPackageName
)

 Returns the path to the specified package, excluding the short package name
Public function Static const FString & Returns the file extension for packages containing assets.
Public function Static FName Return the LongPackageName of module's native script package.
Public function Static FString

GetModuleScriptPackageName ( FStringView ModuleName
)

 Return the LongPackageName of module's native script package.
Public function Static FString

GetNormalizedObjectPath ( const FString& ObjectPath
)

 Gets normalized object path i.e. with long package format.
Public function Static FName

GetPackageMountPoint ( const FString& InPackagePath,
bool InWithoutSlashes
)

 Get the mount point for a given package path
Public function Static FName

GetShortFName ( const FString& LongName
)

 Converts package name to short name.
Public function Static FName

GetShortFName ( const FName& LongName
)

 Converts package name to short name.
Public function Static FName

GetShortFName ( const TCHAR* LongName
)

 Converts package name to short name.
Public function Static FString

GetShortName ( const UPackage* Package
)

 Converts package name to short name.
Public function Static FString

GetShortName ( const FString& LongName
)

 Converts package name to short name.
Public function Static FString

GetShortName ( const FName& LongName
)

 Converts package name to short name.
Public function Static FString

GetShortName ( const TCHAR* LongName
)

 Converts package name to short name.
Public function Static FString

GetSourcePackagePath ( const FString& InLocalizedPackagePath
)

 Gets the source version of a localized long package path (it is also safe to pass non-localized paths into this function).
Public function Static const FString & Returns the file extension for packages containing text assets.
Public function Static const FString & Returns the file extension for packages containing text maps.
Public function Static bool

IsAssetPackageExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a valid binary asset package extension.
Public function Static bool

IsLocalizedPackage ( FStringView InPackageName
)

 Checks the root of the package's path to see if it is a localized package
Public function Static bool

IsMapPackageExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a valid binary map package extension.
Public function Static bool

IsMemoryPackage ( FStringView InPackageName
)

 Checks the root of the package's path to see if it's a memory package This should be set for packages that reside in memory and not on disk, we treat them similar to a script package
Public function Static bool

IsPackageExtension ( EPackageExtension Extension
)

 Returns whether the passed in extension is a valid binary package extension.
Public function Static bool

IsPackageExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a valid binary package extension.
Public function Static bool

IsPackageFilename ( FStringView Filename
)

 Returns whether the passed in filename ends with any of the known package extensions.
Public function Static bool

IsScriptPackage ( FStringView InPackageName
)

 Checks the root of the package's path to see if it is a script package
Public function Static bool

IsShortPackageName ( FStringView PossiblyLongName
)

 Checks if the string is a ShortPackageName.
Public function Static bool

IsShortPackageName ( const FName PossiblyLongName
)

 Checks if the string is a ShortPackageName.
Public function Static bool

IsShortPackageName ( const FString& PossiblyLongName
)

 Checks if the string is a ShortPackageName.
Public function Static bool

IsTempPackage ( FStringView InPackageName
)

 Checks the root of the package's path to see if it is a temp package Temp packages are sometimes saved to disk, and sometimes only exist in memory.
Public function Static bool

IsTextAssetPackageExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a valid text asset package extension.
Public function Static bool

IsTextMapPackageExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a valid text map package extension.
Public function Static bool

IsTextPackageExtension ( const TCHAR* Ext
)

 Returns whether the passed in extension is a valid text package extension.
Public function Static bool

IsTextPackageExtension ( EPackageExtension Extension
)

 Returns whether the passed in extension is a text header extension
Public function Static bool

IsValidLongPackageName ( FStringView InLongPackageName,
bool bIncludeReadOnlyRoots,
EErrorCode* OutReason
)

 Returns true if the path starts with a valid root (i.e. /Game/, /Engine/, etc) and contains no illegal characters.
Public function Static bool

IsValidLongPackageName ( FStringView InLongPackageName,
bool bIncludeReadOnlyRoots,
FText* OutReason
)

 Returns true if the path starts with a valid root (i.e. /Game/, /Engine/, etc) and contains no illegal characters.
Public function Static bool

IsValidObjectPath ( FStringView InObjectPath,
FText* OutReason
)

 Returns true if the path starts with a valid root (i.e. /Game/, /Engine/, etc) and contains no illegal characters.
Public function Static bool

IsValidPath ( FStringView InPath
)

 Returns true if the path starts with a valid root (i.e. /Game/, /Engine/, etc).
Public function Static bool

IsValidTextForLongPackageName ( FStringView InLongPackageName,
EErrorCode* OutReason
)

 Report whether a given name is the proper format for a PackageName, without checking whether it is in one of the registered mount points
Public function Static bool

IsValidTextForLongPackageName ( FStringView InLongPackageName,
FText* OutReason
)

 Report whether a given name is the proper format for a PackageName, without checking whether it is in one of the registered mount points
Public function Static bool

IsVersePackage ( FStringView InPackageName
)

 Checks the package's path to see if it's a Verse package
Public function Static void

IteratePackagesInDirectory ( const FString& RootDir,
const FPackageNameVisitor& Visitor
)

  
Public function Static void

IteratePackagesInDirectory ( const FString& RootDir,
const FPackageNameStatVisitor& Visitor
)

  
Public function Static FString

LongPackageNameToFilename ( const FString& InLongPackageName,
const FString& InExtension
)

 Converts a long package name to a file name with the supplied extension.
Public function Static bool

MountPointExists ( const FString& RootPath
)

 Returns whether the specific logical root path is a valid mount point.
Public function Static FString
ObjectPathToObjectName

( const FString& InObjectPath
)

 Returns the name of the leaf object referred to by the specified object path
Public function Static FAnsiStringView
ObjectPathToObjectName

( FAnsiStringView InObjectPath
)

 Returns the name of the leaf object referred to by the specified object path
Public function Static FWideStringView
ObjectPathToObjectName

( FWideStringView InObjectPath
)

 Returns the name of the leaf object referred to by the specified object path
Public function Static FAnsiStringView
ObjectPathToOuterPath

( FAnsiStringView InObjectPath
)

 Returns the path name of the outer of the leaf object referred to by the specified object path
Public function Static FWideStringView
ObjectPathToOuterPath

( FWideStringView InObjectPath
)

 Returns the path name of the outer of the leaf object referred to by the specified object path
Public function Static FString
ObjectPathToOuterPath

( const FString& InObjectPath
)

 Returns the path name of the outer of the leaf object referred to by the specified object path
Public function Static FString
ObjectPathToPackageName

( const FString& InObjectPath
)

 Returns the name of the package referred to by the specified object path
Public function Static FWideStringView
ObjectPathToPackageName

( FWideStringView InObjectPath
)

 Returns the name of the package referred to by the specified object path
Public function Static FAnsiStringView
ObjectPathToPackageName

( FAnsiStringView InObjectPath
)

 Returns the name of the package referred to by the specified object path
Public function Static FString
ObjectPathToPathWithinPackage

( const FString& InObjectPath
)

 Returns any remaining object path after trimming the package name from the specified object path
Public function Static FWideStringView
ObjectPathToPathWithinPackage

( FWideStringView InObjectPath
)

 Returns any remaining object path after trimming the package name from the specified object path
Public function Static FAnsiStringView
ObjectPathToPathWithinPackage

( FAnsiStringView InObjectPath
)

 Returns any remaining object path after trimming the package name from the specified object path
Public function Static FWideStringView
ObjectPathToSubObjectPath

( FWideStringView InObjectPath
)

 Returns the path from (and including) the subobject referred to by the specified object path
Public function Static FString
ObjectPathToSubObjectPath

( const FString& InObjectPath
)

 Returns the path from (and including) the subobject referred to by the specified object path
Public function Static FAnsiStringView
ObjectPathToSubObjectPath

( FAnsiStringView InObjectPath
)

 Returns the path from (and including) the subobject referred to by the specified object path
Public function Static FOnContentPathDismountedEvent &  
Public function Static FOnContentPathMountedEvent &  
Public function Static void If the FLongPackagePathsSingleton is not created yet, this function will create it and thus allow mount points to be added
Public function Static bool

ParseExportTextPath ( FAnsiStringView InExportTextPath,
FAnsiStringView* OutClassName,
FAnsiStringView* OutObjectPath
)

 Converts the supplied export text path to an object path and class name.
Public function Static bool

ParseExportTextPath ( FWideStringView InExportTextPath,
FWideStringView* OutClassName,
FWideStringView* OutObjectPath
)

 Converts the supplied export text path to an object path and class name.
Public function Static bool

ParseExportTextPath ( const TCHAR* InExportTextPath,
FStringView* OutClassName,
FStringView* OutObjectPath
)

 Converts the supplied export text path to an object path and class name.
Public function Static bool

ParseExportTextPath ( const FString& InExportTextPath,
FString* OutClassName,
FString* OutObjectPath
)

 Converts the supplied export text path to an object path and class name.
Public function Static void

QueryRootContentPaths ( TArray< FString >& OutRootContentPaths,
bool bIncludeReadOnlyRoots,
bool bWithoutLeadingSlashes,
bool bWithoutTrailingSlashes
)

 Queries all of the root content paths, like "/Game/", "/Engine/", and any dynamically added paths
Public function Static void

RegisterMountPoint ( const FString& RootPath,
const FString& ContentPath
)

 This will insert a mount point at the head of the search chain (so it can overlap an existing mount point and win).
Public function Static void Registers all short package names found in ini files.
Public function Static bool

SearchForPackageOnDisk ( const FString& PackageName,
FString* OutLongPackageName,
FString* OutFilename
)

 Attempts to find a package given its short name on disk (very slow).
Public function Static void

SplitFullObjectPath ( FStringView InFullObjectPath,
FStringView& OutClassName,
FStringView& OutPackageName,
FStringView& OutObjectName,
FStringView& OutSubObjectName,
bool bDetectClassName
)

  
Public function Static void

SplitFullObjectPath ( const FString& InFullObjectPath,
FString& OutClassName,
FString& OutPackageName,
FString& OutObjectName,
FString& OutSubObjectName,
bool bDetectClassName
)

 Split a full object path (Class /Path/To/A/Package.Object:SubObject) into its constituent pieces
Public function Static bool

SplitLongPackageName ( const FString& InLongPackageName,
FString& OutPackageRoot,
FString& OutPackagePath,
FString& OutPackageName,
const bool bStripRootLeadingSlash
)

 Convert a long package name into root, path, and name components
Public function Static FStringView

SplitPackageNameRoot ( FStringView InPackageName,
FStringView* OutRelativePath
)

 Returns the top level 'directory' in a package name.
Public function Static bool

TryConvertFilenameToLongPackageName ( const FString& InFilename,
FString& OutPackageName,
FString* OutFailureReason
)

 Tries to convert the supplied relative or absolute filename to a long package name/path starting with a root like /game This works on both package names and directories, and it does not validate that it actually exists on disk.
Public function Static bool

TryConvertGameRelativePackagePathToLocalPath ( FStringView RelativePackagePath,
FString& OutLocalPath
)

 Tries to convert a file or directory in game-relative package name format to the corresponding local path Game-relative package names can be a full package path (/Game/Folder/File, /Engine/Folder/File, /PluginName/Folder/File) or a relative path (Folder/File).
Public function Static bool

TryConvertLongPackageNameToFilename ( const FString& InLongPackageName,
FString& OutFilename,
const FString& InExtension
)

 Tries to convert a long package name to a file name with the supplied extension.
Public function Static bool

TryConvertShortPackagePathToLongInObjectPath ( const FString& ObjectPath,
FString& ConvertedObjectPath
)

 Tries to convert object path with short package name to object path with long package name found on disk (very slow)
Public function Static bool

TryConvertToMountedPath ( FStringView InPath,
FString* OutLocalPathNoExtension,
FString* OutPackageName,
FString* OutObjectName,
FString* OutSubObjectName,
FString* OutExtension,
EFlexNameType* OutFlexNameType,
EErrorCode* OutFailureReason
)

 Find the MountPoint for a LocalPath, LongPackageName, or ObjectPath and return its elements.
Public function Static bool

TryGetMountPointForPath ( FStringView InFilePathOrPackageName,
FStringBuilderBase& OutMountPointPackageName,
FStringBuilderBase& OutMountPointFilePath,
FStringBuilderBase& OutRelPath,
EFlexNameType* OutFlexNameType,
EErrorCode* OutFailureReason
)

 Find a mount point that contains the given LocalFilePath or PackageName, and if found, return the MountPoint and RelativePath
Public function Static void

UnRegisterMountPoint ( const FString& RootPath,
const FString& ContentPath
)

 This will remove a previously inserted mount point.

Enums

  Type Name Description
Public enum EErrorCode    
Public enum EFlexNameType Indicates the format the input was in in functions that take flexible input that can be a LocalPath, PackageName, or ObjectPath  
Public enum EPackageLocationFilter    

Typedefs

Name Description
FDoesPackageExistOverride Override whether a package exist or not.
FOnContentPathDismountedEvent Event that is triggered when a new content path is removed
FOnContentPathMountedEvent Event that is triggered when a new content path is mounted
FPackageNameStatVisitor  
FPackageNameVisitor This will recurse over a directory structure looking for packages.

Constants

Name Description
DoesPackageExistOverrideDelegate Delegate used to check whether a package exist without using the filesystem.
OnContentPathDismountedEvent Event that is triggered when a new content path is removed
OnContentPathMountedEvent Event that is triggered when a new content path is mounted

Deprecated Functions

  Type Name Description
Public function Static bool

DoesPackageExist ( const FString& LongPackageName,
const FGuid* Guid,
FString* OutFilename,
bool InAllowTextFormats
)

 Deprecated. UPackage::Guid has not been used by the engine for a long time. Call DoesPackageExist without a Guid.
Public function Static bool

FindPackageFileWithoutExtension ( const FString& InPackageFilename,
FString& OutFilename,
bool InAllowTextFormats
)

 Specifying AllowTextFormats is no longer supported. Text format is instead specified as a field on the result struct from IPackageResourceManager->OpenReadPackage.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page