1. Epic GamesDeveloper
  3. UBlueprintPathsLibrary

UBlueprintPathsLibrary

Function library to expose [FPaths](API\Runtime\Core\FPaths) to Blueprints and Python

API > API/Runtime > API/Runtime/Engine

Function library to expose FPaths to Blueprints and Python

Function signatures are preserved for the most part with adjustments made to some signatures to better match Blueprints / Python workflow

   
Name UBlueprintPathsLibrary
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Kismet/BlueprintPathsLibrary.h
Include Path #include "Kismet/BlueprintPathsLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="Paths"), MinimalAPI)  
class UBlueprintPathsLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UBlueprintPathsLibrary ( const FObjectInitializer& ObjectInitializer
)

   Kismet/BlueprintPathsLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static FString AutomationDir()

 Returns the directory for automation save files Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString AutomationLogDir()

 Returns the directory for automation log files Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString AutomationTransientDir()

 Returns the directory for automation save files that are meant to be deleted every run Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString BugItDir()

 Returns the directory the engine uses to output BugIt files. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

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

 Changes the extension of the given filename (does nothing if the file has no extension) Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString CloudDir()

 Returns the directory for local files used in cloud emulation or support Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool CollapseRelativeDirectories ( const FString& InPath,
FString& OutPath
)

 Takes a fully pathed string and eliminates relative pathing (eg: annihilates ".." with the adjacent directory). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString Combine ( const TArray< FString >& InPaths
)

 Combine two or more Paths into one single Path Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ConvertFromSandboxPath ( const FString& InPath,
const FString& InSandboxName
)

 Converts a sandbox (in Saved/Sandboxes) path to a normal path. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ConvertRelativePathToFull ( const FString& InPath,
const FString& InBasePath
)

 Converts a relative path name to a fully qualified name relative to the specified BasePath. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ConvertToSandboxPath ( const FString& InPath,
const FString& InSandboxName
)

 Converts a normal path to a sandbox path (in Saved/Sandboxes). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString CreateTempFilename ( const FString& Path,
const FString& Prefix,
const FString& Extension
)

 Creates a temporary filename with the specified prefix. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString DiffDir()

 Returns the directory for temp files used for diffing Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool DirectoryExists ( const FString& InPath
)

 Returns true if this directory was found, false otherwise Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EngineConfigDir()

 Returns the directory the root configuration files are located. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EngineContentDir()

 Returns the content directory of the "core" engine that can be shared across several games or across games & mods. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EngineDir ()

 Returns the base directory of the "core" engine that can be shared across several games or across games & mods. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EngineIntermediateDir()

 Returns the intermediate directory of the engine Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EnginePluginsDir()

 Returns the plugins directory of the engine Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EngineSavedDir()

 Returns the saved directory of the engine Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EngineSourceDir()

 Returns the directory where engine source code files are kept Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EngineUserDir()

 Returns the root directory for user-specific engine files. Always writable. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"
Returns the root directory for user-specific engine files which can be shared between versions. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EnterpriseDir()

 Returns the base directory enterprise directory. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EnterpriseFeaturePackDir()

 Returns the enterprise FeaturePack directory Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString EnterprisePluginsDir()

 Returns the enterprise plugins directory Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString FeaturePackDir()

 Returns the directory where feature packs are kept Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool FileExists ( const FString& InPath
)

 Returns true if this file was found, false otherwise Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"
Returns the saved directory that is not game specific. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GameDevelopersDir()

 Returns the directory that contains subfolders for developer-specific content Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GameSourceDir()

 Returns the directory where game source code files are kept Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GameUserDeveloperDir()

 Returns the directory that contains developer-specific content for the current user Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GeneratedConfigDir()

 Returns the directory the engine saves generated config files. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GetBaseFilename ( const FString& InPath,
bool bRemovePath
)

 Returns the same thing as GetCleanFilename, but without the extension. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GetCleanFilename ( const FString& InPath
)

 Returns the filename (with extension), minus any path information. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static const TArray< FString > & GetEditorLocalizationPaths()

 Returns a list of editor-specific localization paths Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static const TArray< FString > & GetEngineLocalizationPaths()

 Returns a list of engine-specific localization paths Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GetExtension ( const FString& InPath,
bool bIncludeDot
)

 Gets the extension for this filename. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static const TArray< FString > & GetGameLocalizationPaths()

 Returns a list of game-specific localization paths Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GetInvalidFileSystemChars()

 Returns a string containing all invalid characters as dictated by the operating system Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GetPath ( const FString& InPath
)

 Returns the path in front of the filename. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString GetProjectFilePath()

 Gets the path to the project file. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static const TArray< FString > & GetPropertyNameLocalizationPaths()

 Returns a list of property name localization paths Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static const FString & GetRelativePathToRoot()

 Gets the relative path to get from BaseDir to RootDirectory Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static const TArray< FString > & 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. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static const TArray< FString > & GetToolTipLocalizationPaths()

 Returns a list of tool tip localization paths Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool HasProjectPersistentDownloadDir()

 Returns true if a writable directory for downloaded data that persists across play sessions is available Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool IsDrive ( const FString& InPath
)

 Returns true if this path represents a root drive or volume Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool IsProjectFilePathSet()

 Checks whether the path to the project file, if any, is set. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool IsRelative ( const FString& InPath
)

 Returns true if this path is relative to another path Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool IsRestrictedPath ( const FString& InPath
)

 Determines if supplied path uses a restricted/internal subdirectory. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

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

 Checks if two paths are the same. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString LaunchDir()

 Returns the directory the application was launched from (useful for commandline utilities) Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool MakePathRelativeTo ( const FString& InPath,
const FString& InRelativeTo,
FString& OutPath
)

 Assuming both paths (or filenames) are relative to the same base dir, converts InPath to be relative to InRelativeTo Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static void MakePlatformFilename ( const FString& InPath,
FString& OutPath
)

 Takes an "Unreal" pathname and converts it to a platform filename. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static void MakeStandardFilename ( const FString& InPath,
FString& OutPath
)

 Make fully standard "Unreal" pathname: Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString MakeValidFileName ( const FString& InString,
const FString& InReplacementChar
)

 Returns a string that is safe to use as a filename because all items in GetInvalidFileSystemChars() are removed Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static void NormalizeDirectoryName ( const FString& InPath,
FString& OutPath
)

 Normalize all / and \ to TEXT("/") and remove any trailing TEXT("/") if the character before that is not a TEXT("/") or a colon Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static void NormalizeFilename ( const FString& InPath,
FString& OutPath
)

 Convert all / and \ to TEXT("/") Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProfilingDir()

 Returns the directory the engine uses to output profiling files. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectConfigDir()

 Returns the directory the root configuration files are located. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectContentDir()

 Returns the content directory of the current game by looking at FApp::GetProjectName(). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectDir ()

 Returns the base directory of the current project by looking at FApp::GetProjectName(). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectIntermediateDir()

 Returns the intermediate directory of the current game by looking at FApp::GetProjectName(). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"
Returns the directory the engine uses to output logs. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectModsDir()

 Returns the mods directory of the current project by looking at FApp::GetProjectName(). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectPersistentDownloadDir()

 Returns the writable directory for downloaded data that persists across play sessions. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectPluginsDir()

 Returns the plugins directory of the current game by looking at FApp::GetProjectName(). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectSavedDir()

 Returns the saved directory of the current game by looking at FApp::GetProjectName(). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ProjectUserDir()

 Returns the root directory for user-specific game files. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static void RemoveDuplicateSlashes ( const FString& InPath,
FString& OutPath
)

 Removes duplicate slashes in paths. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString RootDir()

 Returns the root directory of the engine directory tree Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString SandboxesDir()

 Returns the directory the engine stores sandbox output Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString ScreenShotDir()

 Returns the directory the engine uses to output screenshot files. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

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) Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static void SetProjectFilePath ( const FString& NewGameProjectFilePath
)

 Sets the path to the project file. Kismet/BlueprintPathsLibrary.h
  • BlueprintCallable
  • Category="Utilities|Paths"

static FString ShaderWorkingDir()

 Returns the Shader Working Directory Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static bool ShouldSaveToUserDir()

 Should the "saved" directory structures be rooted in the user dir or relative to the "engine/game" Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"
Returns the directory the engine uses to look for the source leaf ini files. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

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). Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static void ValidatePath ( const FString& InPath,
bool& bDidSucceed,
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 Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

static FString VideoCaptureDir()

 Returns the directory the engine uses to output user requested video capture files. Kismet/BlueprintPathsLibrary.h
  • BlueprintPure
  • Category="Utilities|Paths"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page