1. Epic GamesDeveloper
  3. FPaths

FPaths

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

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

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

  Type Name Description
Public function Static FString Returns the directory the engine uses to output user requested audio capture files.
Public function Static FString Returns the directory for automation save files
Public function Static FString Returns the directory for automation log files
Public function Static FString Returns the directory for results of automation tests. May be deleted every run.
Public function Static FString Returns the directory for automation save files that are meant to be deleted every run
Public function Static FString Returns the directory the engine uses to output BugIt files.
Public function Static FString

ChangeExtension ( const FString& InPath,
const FString& InNewExtension
)

 Changes the extension of the given filename (does nothing if the file has no extension)
Public function Static FString Returns the directory for local files used in cloud emulation or support
Public function Static bool Takes a fully pathed string and eliminates relative pathing (eg: annihilates ".." with the adjacent directory).
Public function Static FString

Combine ( PathTypes&&... InPaths
)

  
Protected function Static FString

CombineInternal ( const FStringView* Paths,
int32 NumPaths
)

  
Public function Static FString

ConvertFromSandboxPath ( const FString& InPath,
const TCHAR* InSandboxName
)

 Converts a sandbox (in Saved/Sandboxes) path to a normal path.
Public function Static FString

ConvertRelativePathToFull ( const FString& BasePath,
const FString& InPath
)

 Converts a relative path name to a fully qualified name relative to the specified BasePath.
Public function Static FString

ConvertRelativePathToFull ( const FString& BasePath,
FString&& InPath
)

 Converts a relative path name to a fully qualified name relative to the specified BasePath.
Public function Static FString

ConvertRelativePathToFull ( FString&& BasePath,
const FString& InPath
)

 Converts a relative path name to a fully qualified name relative to the specified BasePath.
Public function Static FString

ConvertRelativePathToFull ( FString&& BasePath,
FString&& InPath
)

 Converts a relative path name to a fully qualified name relative to the specified BasePath.
Public function Static FString Converts a relative path name to a fully qualified name relative to the process BaseDir().
Public function Static FString Converts a relative path name to a fully qualified name relative to the process BaseDir().
Public function Static FString

ConvertToSandboxPath ( const FString& InPath,
const TCHAR* InSandboxName
)

 Converts a normal path to a sandbox path (in Saved/Sandboxes).
Public function Static FString

CreateStandardFilename ( const FString& InPath
)

 Make fully standard "Unreal" pathname:
Public function Static FString

CreateTempFilename ( const TCHAR* Path,
const TCHAR* Prefix,
const TCHAR* Extension
)

 Creates a temporary filename with the specified prefix.
Public function Static FStringView Returns the name of the subfolder for developer-specific content Example: "Developers"
Public function Static FString

DiffDir ()

 Returns the directory for temp files used for diffing
Public function Static bool
DirectoryExists

( const FString& InPath
)

 Returns true if this directory was found, false otherwise
Public function Static FString Returns the directory the root configuration files are located.
Public function Static FString Returns the content directory of the "core" engine that can be shared across several games or across games & mods.
Public function Static FString Returns the directory for default Editor UI Layout files of the engine
Public function Static FString Returns the base directory of the "core" engine that can be shared across several games or across games & mods.
Public function Static FString Returns the Editor Settings directory of the engine
Public function Static FString Returns the intermediate directory of the engine
Public function Static FString Returns the directory where engine platform extensions reside
Public function Static FString Returns the plugins directory of the engine
Public function Static FString Returns the directory for project Editor UI Layout files of the engine
Public function Static FString Returns the saved directory of the engine
Public function Static FString Returns the directory where engine source code files are kept
Public function Static FString Returns the root directory for user-specific engine files. Always writable.
Public function Static FString Returns the directory for user-generated Editor UI Layout files of the engine
Public function Static FString Returns the root directory for user-specific engine files which can be shared between versions.
Public function Static FString Returns the base directory enterprise directory.
Public function Static FString Returns the enterprise FeaturePack directory
Public function Static FString Returns the enterprise plugins directory
Public function Static FString Returns the directory where feature packs are kept
Public function Static bool

FileExists ( const FString& InPath
)

 Returns true if this file was found, false otherwise
Public function Static FString

FindCorrectCase ( const FString& Path
)

 Converts the path casing to match the casing found on disk without resolving directory junctions
Public function Static FString Returns the saved directory that is not game specific.
Public function Static FString Returns the directory that contains subfolders for developer-specific content Example: "../../../ProjectName/Content/Developers
Public function Static const TCHAR * Returns the special path used when mounting FeaturePaks in editor
Public function Static FString Returns the directory where game source code files are kept
Public function Static FString Returns The directory that contains developer-specific content for the current user
Public function Static FString Returns The folder name for the developer-specific directory for the current user
Public function Static FString Returns the directory the engine saves generated config files.
Public function Static FString

GetBaseFilename ( const FString& InPath,
bool bRemovePath
)

 Returns the same thing as GetCleanFilename, but without the extension.
Public function Static FString

GetBaseFilename ( FString&& InPath,
bool bRemovePath
)

 Returns the same thing as GetCleanFilename, but without the extension.
Public function Static FString

GetCleanFilename ( FString&& InPath
)

 Returns the filename (with extension), minus any path information.
Public function Static FString

GetCleanFilename ( const FString& InPath
)

 Returns the filename (with extension), minus any path information.
Public function Static const TArray< FString > & Returns a list of cooked editor-specific localization paths
Public function Static const TArray< FString > & Returns a list of editor-specific localization paths
Public function Static const TArray< FString > & Returns a list of engine-specific localization paths
Public function Static FString

GetExtension ( const FString& InPath,
bool bIncludeDot
)

 Gets the extension for this filename.
Public function Static TArray< FString >

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)
Public function Static const TArray< FString > & Returns a list of game-specific localization paths
Public function Static FString Returns a string containing all invalid characters as dictated by the operating system
Public function Static FString

GetPath ( FString&& InPath
)

 Returns the path in front of the filename.
Public function Static FString

GetPath ( const FString& InPath
)

 Returns the path in front of the filename.
Public function Static FString

GetPathLeaf ( const FString& InPath
)

 Returns the leaf in the path.
Public function Static FString

GetPathLeaf ( FString&& InPath
)

 Returns the leaf in the path.
Public function Static FString Get the name of the platform-specific localization sub-folder
Public function Static FString Gets the path to the project file.
Public function Static const TArray< FString > & Returns a list of property name localization paths
Public function Static const FString & Gets the relative path to get from BaseDir to RootDirectory
Public function Static const TArray< FString > & 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.
Public function Static const TArray< FString > & Returns a list of tool tip localization paths
Public function Static bool Returns true if a writable directory for downloaded data that persists across play sessions is available
Public function Static bool

IsDrive ( const FString& InPath
)

 Returns true if this path represents a root drive or volume
Public function Static bool Checks whether the path to the project file, if any, is set.
Public function Static bool

IsRelative ( const FString& InPath
)

 Returns true if this path is relative to another path
Public function Static bool

IsRestrictedPath ( const FString& InPath
)

 Determines if supplied path uses a restricted/internal subdirectory.
Public function Static bool

IsSamePath ( const FString& PathA,
const FString& PathB
)

 Checks if two paths are the same.
Public function Static bool

IsUnderDirectory ( const FString& InPath,
const FString& InDirectory
)

 Determines if a path is under a given directory
Public function Static FString Returns the directory the application was launched from (useful for commandline utilities)
Public function Static 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
Public function Static void Takes an "Unreal" pathname and converts it to a platform filename.
Public function Static void  
Public function Static 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
Public function Static void Normalize all / and \ to TEXT("/") and remove any trailing TEXT("/") if the character before that is not a TEXT("/") or a colon
Public function Static void Convert all / and \ to TEXT("/")
Public function Static FString Returns the directory the engine uses to output profiling files.
Public function Static FString Returns the directory the root configuration files are located.
Public function Static FString Returns the content directory of the current game by looking at FApp::GetProjectName().
Public function Static FString Returns the base directory of the current project by looking at FApp::GetProjectName().
Public function Static FString Returns the intermediate directory of the current game by looking at FApp::GetProjectName().
Public function Static FString Returns the directory the engine uses to output logs.
Public function Static FString Returns the mods directory of the current project by looking at FApp::GetProjectName().
Public function Static FString Returns the writable directory for downloaded data that persists across play sessions.
Public function Static FString Returns the directory where the project's platform extensions reside
Public function Static FString Returns the plugins directory of the current game by looking at FApp::GetProjectName().
Public function Static const FString & Returns the saved directory of the current game by looking at FApp::GetProjectName().
Public function Static FString Returns the root directory for user-specific game files.
Public function Static void Removes duplicate slashes in paths.
Public function Static FString

RemoveDuplicateSlashes ( const FString& InPath
)

 Returns a copy of the given path on which duplicate slashes were removed (see the inplace version for more details).
Public function Static FString

RootDir ()

 Returns the root directory of the engine directory tree
Public function Static FString Returns the directory the engine stores sandbox output
Public function Static FString Returns the directory the engine uses to output screenshot files.
Public function Static 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)
Public function Static void

SetProjectFilePath ( const FString& NewGameProjectFilePath
)

 Sets the path to the project file.
Public function Static FString  
Public function Static bool Should the "saved" directory structures be rooted in the user dir or relative to the "engine/game"
Public function Static FString Returns the directory the engine uses to look for the source leaf ini files.
Public function Static void

Split ( const FString& InPath,
FString& PathPart,
FString& FilenamePart,
FString& ExtensionPart
)

 Parses a fully qualified or relative filename into its components (filename, path, extension).
Public function Static void Frees any memory retained by FPaths.
Public function Static 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 Note that this is a different set of restrictions to those imposed by FPackageName
Public function Static FString Returns the directory the engine uses to output user requested video capture files.

Classes

  Type Name Description
Public struct FStaticData    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page