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

Light Theme

Dark Theme

Paths

Windows

MacOS

Linux

On this page

Actions

Actions

Automation Dir	Returns the directory for automation save files Target is Blueprint Paths Library
Automation Log Dir	Returns the directory for automation log files Target is Blueprint Paths Library
Automation Transient Dir	Returns the directory for automation save files that are meant to be deleted every run Target is Blueprint Paths Library
Bug It Dir	Returns the directory the engine uses to output BugIt files. Target is Blueprint Paths Library
Change Extension	Changes the extension of the given filename (does nothing if the file has no extension) Target is Blueprint Paths Library
Cloud Dir	Returns the directory for local files used in cloud emulation or support Target is Blueprint Paths Library
Collapse Relative Directories	Takes a fully pathed string and eliminates relative pathing (eg: annihilates ".." with the adjacent directory). Assumes all slashes have been converted to TEXT('/'). For example, takes the string: BaseDirectory/SomeDirectory/../SomeOtherDirectory/Filename.ext and converts it to: BaseDirectory/SomeOtherDirectory/Filename.ext Target is Blueprint Paths Library
Combine	Combine two or more Paths into one single Path Target is Blueprint Paths Library
Convert from Sandbox Path	Converts a sandbox (in Saved/Sandboxes) path to a normal path. Target is Blueprint Paths Library
Convert Relative Path to Full	Converts a relative path name to a fully qualified name relative to the specified BasePath. BasePath will be the process BaseDir() if not BasePath is given Target is Blueprint Paths Library
Convert to Absolute Path	Converts passed in filename to use a absolute path Target is Kismet System Library
Convert to Relative Path	Converts passed in filename to use a relative path Target is Kismet System Library
Convert to Sandbox Path	Converts a normal path to a sandbox path (in Saved/Sandboxes). Target is Blueprint Paths Library
Create Temp Filename	Creates a temporary filename with the specified prefix. Target is Blueprint Paths Library
Diff Dir	Returns the directory for temp files used for diffing Target is Blueprint Paths Library
Directory Exists	Returns true if this directory was found, false otherwise Target is Blueprint Paths Library
Engine Config Dir	Returns the directory the root configuration files are located. Target is Blueprint Paths Library
Engine Content Dir	Returns the content directory of the "core" engine that can be shared across several games or across games & mods. Target is Blueprint Paths Library
Engine Dir	Returns the base directory of the "core" engine that can be shared across several games or across games & mods. Shaders and base localization files e.g. reside in the engine directory. Target is Blueprint Paths Library
Engine Intermediate Dir	Returns the intermediate directory of the engine Target is Blueprint Paths Library
Engine Plugins Dir	Returns the plugins directory of the engine Target is Blueprint Paths Library
Engine Saved Dir	Returns the saved directory of the engine Target is Blueprint Paths Library
Engine Source Dir	Returns the directory where engine source code files are kept Target is Blueprint Paths Library
Engine User Dir	Returns the root directory for user-specific engine files. Always writable. Target is Blueprint Paths Library
Engine Version Agnostic User Dir	Returns the root directory for user-specific engine files which can be shared between versions. Always writable. Target is Blueprint Paths Library
Enterprise Dir	Returns the base directory enterprise directory. Target is Blueprint Paths Library
Enterprise Feature Pack Dir	Returns the enterprise FeaturePack directory Target is Blueprint Paths Library
Enterprise Plugins Dir	Returns the enterprise plugins directory Target is Blueprint Paths Library
Feature Pack Dir	Returns the directory where feature packs are kept Target is Blueprint Paths Library
File Exists	Returns true if this file was found, false otherwise Target is Blueprint Paths Library
Game Agnostic Saved Dir	Returns the saved directory that is not game specific. This is usually the same as EngineSavedDir(). Target is Blueprint Paths Library
Game Developers Dir	Returns the directory that contains subfolders for developer-specific content Target is Blueprint Paths Library
Game Source Dir	Returns the directory where game source code files are kept Target is Blueprint Paths Library
Game User Developer Dir	Returns the directory that contains developer-specific content for the current user Target is Blueprint Paths Library
Generated Config Dir	Returns the directory the engine saves generated config files. Target is Blueprint Paths Library
Get Base Filename	Returns the same thing as GetCleanFilename, but without the extension Target is Blueprint Paths Library
Get Clean Filename	Returns the filename (with extension), minus any path information. Target is Blueprint Paths Library
Get Editor Localization Paths	Returns a list of editor-specific localization paths Target is Blueprint Paths Library
Get Engine Localization Paths	Returns a list of engine-specific localization paths Target is Blueprint Paths Library
Get Extension	Gets the extension for this filename. Target is Blueprint Paths Library
Get Game Localization Paths	Returns a list of game-specific localization paths Target is Blueprint Paths Library
Get Invalid File System Chars	Returns a string containing all invalid characters as dictated by the operating system Target is Blueprint Paths Library
Get Path	Returns the path in front of the filename Target is Blueprint Paths Library
Get Project Content Directory	Get the content directory of the current project Target is Kismet System Library
Get Project Directory	Get the directory of the current project Target is Kismet System Library
Get Project File Path	Gets the path to the project file. Target is Blueprint Paths Library
Get Project Saved Directory	Get the saved directory of the current project Target is Kismet System Library
Get Property Name Localization Paths	Returns a list of property name localization paths Target is Blueprint Paths Library
Get Relative Path to Root	Gets the relative path to get from BaseDir to RootDirectory Target is Blueprint Paths Library
Get Restricted Folder Names	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. Target is Blueprint Paths Library
Get Tool Tip Localization Paths	Returns a list of tool tip localization paths Target is Blueprint Paths Library
Has Project Persistent Download Dir	Returns true if a writable directory for downloaded data that persists across play sessions is available Target is Blueprint Paths Library
Is Drive	Returns true if this path represents a root drive or volume Target is Blueprint Paths Library
Is Project File Path Set	Checks whether the path to the project file, if any, is set. Target is Blueprint Paths Library
Is Relative	Returns true if this path is relative to another path Target is Blueprint Paths Library
Is Restricted Path	Determines if supplied path uses a restricted/internal subdirectory. Note that slashes are normalized and character case is ignored for the comparison. Target is Blueprint Paths Library
Is Same Path	Checks if two paths are the same. Target is Blueprint Paths Library
Launch Dir	Returns the directory the application was launched from (useful for commandline utilities) Target is Blueprint Paths Library
Make Path Relative To	Assuming both paths (or filenames) are relative to the same base dir, converts InPath to be relative to InRelativeTo Target is Blueprint Paths Library
Make Platform Filename	Takes an "Unreal" pathname and converts it to a platform filename. Target is Blueprint Paths Library
Make Standard Filename	Make fully standard "Unreal" pathname: Normalizes path separators [NormalizeFilename] Removes extraneous separators [NormalizeDirectoryName, as well removing adjacent separators] Collapses internal ..'s Makes relative to Engine\Binaries\<Platform> (will ALWAYS start with ..\..\..) Target is Blueprint Paths Library
Make Valid File Name	Returns a string that is safe to use as a filename because all items in GetInvalidFileSystemChars() are removed Optionally specify the character to replace invalid characters with Target is Blueprint Paths Library
Normalize Directory Name	Normalize all / and \ to TEXT("/") and remove any trailing TEXT("/") if the character before that is not a TEXT("/") or a colon Target is Blueprint Paths Library
Normalize Filename	Convert all / and \ to TEXT("/") Target is Kismet System Library
Profiling Dir	Returns the directory the engine uses to output profiling files. Target is Blueprint Paths Library
Project Config Dir	Returns the directory the root configuration files are located. Target is Blueprint Paths Library
Project Content Dir	Returns the content directory of the current game by looking at FApp::GetProjectName(). Target is Blueprint Paths Library
Project Dir	Returns the base directory of the current project by looking at FApp::GetProjectName(). This is usually a subdirectory of the installation root directory and can be overridden on the command line to allow self contained mod support. Target is Blueprint Paths Library
Project Intermediate Dir	Returns the intermediate directory of the current game by looking at FApp::GetProjectName(). Target is Blueprint Paths Library
Project Log Dir	Returns the directory the engine uses to output logs. This currently can't be an .ini setting as the game starts logging before it can read from .ini files. Target is Blueprint Paths Library
Project Mods Dir	Returns the mods directory of the current project by looking at FApp::GetProjectName(). Target is Blueprint Paths Library
Project Persistent Download Dir	Returns the writable directory for downloaded data that persists across play sessions. Target is Blueprint Paths Library
Project Plugins Dir	Returns the plugins directory of the current game by looking at FApp::GetProjectName(). Target is Blueprint Paths Library
Project Saved Dir	Returns the saved directory of the current game by looking at FApp::GetProjectName(). Target is Blueprint Paths Library
Project User Dir	Returns the root directory for user-specific game files. Target is Blueprint Paths Library
Remove Duplicate Slashes	Removes duplicate slashes in paths. Assumes all slashes have been converted to TEXT('/'). For example, takes the string: BaseDirectory/SomeDirectory//SomeOtherDirectory////Filename.ext and converts it to: BaseDirectory/SomeDirectory/SomeOtherDirectory/Filename.ext Target is Blueprint Paths Library
Root Dir	Returns the root directory of the engine directory tree Target is Blueprint Paths Library
Sandboxes Dir	Returns the directory the engine stores sandbox output Target is Blueprint Paths Library
Screen Shot Dir	Returns the directory the engine uses to output screenshot files. Target is Blueprint Paths Library
Set Extension	Sets the extension of the given filename (like ChangeExtension, but also applies the extension if the file doesn't have one) Target is Blueprint Paths Library
Set Project File Path	Sets the path to the project file. Target is Blueprint Paths Library
Shader Working Dir	Returns the Shader Working Directory Target is Blueprint Paths Library
Should Save to User Dir	Should the "saved" directory structures be rooted in the user dir or relative to the "engine/game" Target is Blueprint Paths Library
Source Config Dir	Returns the directory the engine uses to look for the source leaf ini files. This can't be an .ini variable for obvious reasons. Target is Blueprint Paths Library
Split	Parses a fully qualified or relative filename into its components (filename, path, extension). Target is Blueprint Paths Library
Validate Path	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 Target is Blueprint Paths Library
Video Capture Dir	Returns the directory the engine uses to output user requested video capture files. Target is Blueprint Paths Library

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

Take our survey

Dismiss