Navigation
API > API/Runtime > API/Runtime/CoreUObject
A reference-counted mountpoint that has been registered with FPackageName. It might not be mounted; mountpoints can be preregistered before mounting, or can be kept allocated after unmounting. If mounted, a MountPoint provides a location on disk from which packages can be loaded (and saved in most cases), and provides a two-way mapping from LongPackageName <-> LocalPath.
Multiple MountPoints can be mapped from a single LongPackageName to multiple LocalPaths, or from a single LocalPath to multiple LongPackageNames. Only the last MountPoint mounted for a LongPackageName or LocalPath is returned from queries for those paths, but all mounted MountPoints can still be used to load packages, they report IsMounted == true, and they are reported in query functions that report the list of mounted MountPoints.
Most MountPoints have a one-segment length path in their LongPackageName, such as /Game/ or /PluginName/, but the system supports paths of any length as long as they are rooted. MountPoints that are subpaths of existing MountPoints will take precedence for mapping files under their path, even if their parent MountPoint is higher priority because it was added later. This feature is used for example by the UnrealEd templates system in FUnrealEdMisc::MountTemplateSharedPaths, which mounts some providers for feature templates in a mountpoint subdirectory of /Game/ such as /Game/Weapons/.
| Name | IMountPoint |
| Type | class |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/Misc/MountPoint.h |
| Include Path | #include "Misc/MountPoint.h" |
Syntax
class IMountPoint : public IRefCountedObject
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStringView GetLocalPathAbsolute () |
LocalPath, absolute, that is the parent directory of filenames in this mountpoint. | Misc/MountPoint.h | |
FStringView GetLocalPathStandard () |
LocalPath, in Unreal standard path form (normalized and relative to Engine/Binaries/ |
Misc/MountPoint.h | |
FStringView GetLongPackageName () |
PackageName path that is the parent directory of packagenames in this mountpoint. | Misc/MountPoint.h | |
bool IsMounted () |
Whether the MountPoint is currently mounted. | Misc/MountPoint.h | |
bool IsReadOnly () |
Whether new Packages are unable to be saved into the mountpoint. | Misc/MountPoint.h | |
bool IsRemovable () |
Whether the mountpoint was created by InsertMountPoint and can be removed by RemoveMountPoint. | Misc/MountPoint.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMountPoint * AsFMountPoint () |
A downcast function to the implementation class inside FPackageName. | Misc/MountPoint.h |