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 > Core > Misc > FPaths

Light Theme

Dark Theme

FPaths

Path helpers for retrieving game dir, engine dir, etc.

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/Paths.h
Include	#include "Misc/Paths.h"

Syntax

class FPaths

Remarks

Path helpers for retrieving game dir, engine dir, etc.

Functions

	Name	Description
FString	AutomationDir()	Returns the directory for automation save files
FString	AutomationLogDir()	Returns the directory for automation log files
FString	AutomationReportsDir()	Returns the directory for results of automation tests. May be deleted every run.
FString	AutomationTransientDir()	Returns the directory for automation save files that are meant to be deleted every run
FString	BugItDir()	Returns the directory the engine uses to output BugIt files.
FString	ChangeExtension ( const FString& InPath, const FString& InNewExtension )	Changes the extension of the given filename (does nothing if the file has no extension)
FString	CloudDir()	Returns the directory for local files used in cloud emulation or support
bool	CollapseRelativeDirectories ( FString& InPath )	Takes a fully pathed string and eliminates relative pathing (eg: annihilates ".." with the adjacent directory).
FString	Combine ( PathTypes&&... InPaths )
void	CombineInternal ( FString& OutPath, const TCHAR** Paths, int32 NumPaths )
FString	ConvertFromSandboxPath ( const FString& InPath, const TCHAR* InSandboxName )	Converts a sandbox (in Saved/Sandboxes) path to a normal path.
FString	ConvertRelativePathToFull ( const FString& BasePath, const FString& InPath )	Converts a relative path name to a fully qualified name relative to the specified BasePath.
FString	ConvertRelativePathToFull ( const FString& BasePath, FString&& InPath )	Converts a relative path name to a fully qualified name relative to the specified BasePath.
FString	ConvertRelativePathToFull ( FString&& BasePath, const FString& InPath )	Converts a relative path name to a fully qualified name relative to the specified BasePath.
FString	ConvertRelativePathToFull ( FString&& BasePath, FString&& InPath )	Converts a relative path name to a fully qualified name relative to the specified BasePath.
FString	ConvertRelativePathToFull ( FString&& InPath )	Converts a relative path name to a fully qualified name relative to the process BaseDir().
FString	ConvertRelativePathToFull ( const FString& InPath )	Converts a relative path name to a fully qualified name relative to the process BaseDir().
FString	ConvertToSandboxPath ( const FString& InPath, const TCHAR* InSandboxName )	Converts a normal path to a sandbox path (in Saved/Sandboxes).
FString	CreateStandardFilename ( const FString& InPath )	Make fully standard "Unreal" pathname:
FString	CreateTempFilename ( const TCHAR* Path, const TCHAR* Prefix, const TCHAR* Extension )	Creates a temporary filename with the specified prefix.
FString	DiffDir()	Returns the directory for temp files used for diffing
bool	DirectoryExists ( const FString& InPath )	Returns true if this directory was found, false otherwise
FString	EngineConfigDir()	Returns the directory the root configuration files are located.
FString	EngineContentDir()	Returns the content directory of the "core" engine that can be shared across several games or across games & mods.
FString	EngineDefaultLayoutDir()	Returns the directory for default Editor UI Layout files of the engine
FString	EngineDir()	Returns the base directory of the "core" engine that can be shared across several games or across games & mods.
FString	EngineEditorSettingsDir()	Returns the Editor Settings directory of the engine
FString	EngineIntermediateDir()	Returns the intermediate directory of the engine
FString	EnginePlatformExtensionsDir()	Returns the directory where engine platform extensions reside
FString	EnginePluginsDir()	Returns the plugins directory of the engine
FString	EngineProjectLayoutDir()	Returns the directory for project Editor UI Layout files of the engine
FString	EngineSavedDir()	Returns the saved directory of the engine
FString	EngineSourceDir()	Returns the directory where engine source code files are kept
FString	EngineUserDir()	Returns the root directory for user-specific engine files. Always writable.
FString	EngineUserLayoutDir()	Returns the directory for user-generated Editor UI Layout files of the engine
FString	EngineVersionAgnosticUserDir()	Returns the root directory for user-specific engine files which can be shared between versions.
FString	EnterpriseDir()	Returns the base directory enterprise directory.
FString	EnterpriseFeaturePackDir()	Returns the enterprise FeaturePack directory
FString	EnterprisePluginsDir()	Returns the enterprise plugins directory
FString	FeaturePackDir()	Returns the directory where feature packs are kept
bool	FileExists ( const FString& InPath )	Returns true if this file was found, false otherwise
FString	GameAgnosticSavedDir()	Returns the saved directory that is not game specific.
FString	GameDevelopersDir()	Returns the directory that contains subfolders for developer-specific content
FString	GameSourceDir()	Returns the directory where game source code files are kept
FString	GameUserDeveloperDir()	Returns The directory that contains developer-specific content for the current user
FString	GameUserDeveloperFolderName()	Returns The folder name for the developer-specific directory for the current user
FString	GeneratedConfigDir()	Returns the directory the engine saves generated config files.
FString	GetBaseFilename ( FString&& InPath, bool bRemovePath )	Returns the same thing as GetCleanFilename, but without the extension.
FString	GetBaseFilename ( const FString& InPath, bool bRemovePath )	Returns the same thing as GetCleanFilename, but without the extension.
FString	GetCleanFilename ( FString&& InPath )	Returns the filename (with extension), minus any path information.
FString	GetCleanFilename ( const FString& InPath )	Returns the filename (with extension), minus any path information.
const TArray...	GetEditorLocalizationPaths()	Returns a list of editor-specific localization paths
const TArray...	GetEngineLocalizationPaths()	Returns a list of engine-specific localization paths
FString	GetExtension ( const FString& InPath, bool bIncludeDot )	Gets the extension for this filename.
TArray< FStr...	GetExtensionDirs ( const FString& BaseDir, const FString& SubDir )	Returns platform and restricted extensions that are present and valid (for platforms, it uses FDataDrivePlatformInfo to determine valid platforms, it doesn't just use what's present)
const TArray...	GetGameLocalizationPaths()	Returns a list of game-specific localization paths
FString	GetInvalidFileSystemChars()	Returns a string containing all invalid characters as dictated by the operating system
FString	GetPath ( const FString& InPath )	Returns the path in front of the filename.
FString	GetPath ( FString&& InPath )	Returns the path in front of the filename.
FString	GetPathLeaf ( FString&& InPath )	Returns the leaf in the path.
FString	GetPathLeaf ( const FString& InPath )	Returns the leaf in the path.
FString	GetPlatformLocalizationFolderName()	Get the name of the platform-specific localization sub-folder
FString	GetProjectFilePath()	Gets the path to the project file.
const TArray...	GetPropertyNameLocalizationPaths()	Returns a list of property name localization paths
const FStrin...	GetRelativePathToRoot()	Gets the relative path to get from BaseDir to RootDirectory
const TArray...	GetRestrictedFolderNames()	Returns a list of restricted/internal folder names (without any slashes) which may be tested against full paths to determine if a path is restricted or not.
const TArray...	GetToolTipLocalizationPaths()	Returns a list of tool tip localization paths
bool	HasProjectPersistentDownloadDir()	Returns true if a writable directory for downloaded data that persists across play sessions is available
bool	IsDrive ( const FString& InPath )	Returns true if this path represents a root drive or volume
bool	IsProjectFilePathSet()	Checks whether the path to the project file, if any, is set.
bool	IsRelative ( const FString& InPath )	Returns true if this path is relative to another path
bool	IsRestrictedPath ( const FString& InPath )	Determines if supplied path uses a restricted/internal subdirectory.
bool	IsSamePath ( const FString& PathA, const FString& PathB )	Checks if two paths are the same.
bool	IsUnderDirectory ( const FString& InPath, const FString& InDirectory )	Determines if a path is under a given directory
FString	LaunchDir()	Returns the directory the application was launched from (useful for commandline utilities)
bool	MakePathRelativeTo ( FString& InPath, const TCHAR* InRelativeTo )	Assuming both paths (or filenames) are relative to the same base dir, modifies InPath to be relative to InRelativeTo
void	MakePlatformFilename ( FString& InPath )	Takes an "Unreal" pathname and converts it to a platform filename.
void	MakeStandardFilename ( FString& InPath )
FString	MakeValidFileName ( const FString& InString, const TCHAR InReplacementChar )	Returns a string that is safe to use as a filename because all items in GetInvalidFileSystemChars() are removed
void	NormalizeDirectoryName ( FString& InPath )	Normalize all / and \ to TEXT("/") and remove any trailing TEXT("/") if the character before that is not a TEXT("/") or a colon
void	NormalizeFilename ( FString& InPath )	Convert all / and \ to TEXT("/")
FString	ProfilingDir()	Returns the directory the engine uses to output profiling files.
FString	ProjectConfigDir()	Returns the directory the root configuration files are located.
FString	ProjectContentDir()	Returns the content directory of the current game by looking at FApp::GetProjectName().
FString	ProjectDir()	Returns the base directory of the current project by looking at FApp::GetProjectName().
FString	ProjectIntermediateDir()	Returns the intermediate directory of the current game by looking at FApp::GetProjectName().
FString	ProjectLogDir()	Returns the directory the engine uses to output logs.
FString	ProjectModsDir()	Returns the mods directory of the current project by looking at FApp::GetProjectName().
FString	ProjectPersistentDownloadDir()	Returns the writable directory for downloaded data that persists across play sessions.
FString	ProjectPlatformExtensionsDir()	Returns the directory where the project's platform extensions reside
FString	ProjectPluginsDir()	Returns the plugins directory of the current game by looking at FApp::GetProjectName().
const FStrin...	ProjectSavedDir()	Returns the saved directory of the current game by looking at FApp::GetProjectName().
FString	ProjectUserDir()	Returns the root directory for user-specific game files.
void	RemoveDuplicateSlashes ( FString& InPath )	Removes duplicate slashes in paths.
FString	RootDir()	Returns the root directory of the engine directory tree
FString	SandboxesDir()	Returns the directory the engine stores sandbox output
FString	ScreenShotDir()	Returns the directory the engine uses to output screenshot files.
FString	SetExtension ( const FString& InPath, const FString& InNewExtension )	Sets the extension of the given filename (like ChangeExtension, but also applies the extension if the file doesn't have one)
void	SetProjectFilePath ( const FString& NewGameProjectFileP... )	Sets the path to the project file.
FString	ShaderWorkingDir()
bool	ShouldSaveToUserDir()	Should the "saved" directory structures be rooted in the user dir or relative to the "engine/game"
FString	SourceConfigDir()	Returns the directory the engine uses to look for the source leaf ini files.
void	Split ( const FString& InPath, FString& PathPart, FString& FilenamePart, FString& ExtensionPart )	Parses a fully qualified or relative filename into its components (filename, path, extension).
void	TearDown()	Frees any memory retained by FPaths.
bool	ValidatePath ( const FString& InPath, FText* OutReason )	Validates that the parts that make up the path contain no invalid characters as dictated by the operating system
FString	VideoCaptureDir()	Returns the directory the engine uses to output user requested video capture files.

Classes

	Name	Description
	FStaticData

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

Take our survey

Dismiss