1. Epic GamesDeveloper
  3. UBlueprintPathsLibrary

UBlueprintPathsLibrary

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Kismet

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Kismet/BlueprintPathsLibrary.h
Include #include "Kismet/BlueprintPathsLibrary.h"

Syntax

class UBlueprintPathsLibrary : public UBlueprintFunctionLibrary

Remarks

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

Constructors

  Type Name Description
Public function  

UBlueprintPathsLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
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 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

CollapseRelativeDirectories ( const FString& InPath,
FString& OutPath
)

 Takes a fully pathed string and eliminates relative pathing (eg: annihilates ".." with the adjacent directory).
Public function Static FString

Combine ( const TArray< FString >& InPaths
)

 Combine two or more Paths into one single Path
Public function Static FString

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

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

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

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

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

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

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

 Creates a temporary filename with the specified prefix.
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 base directory of the "core" engine that can be shared across several games or across games & mods.
Public function Static FString Returns the intermediate directory of the engine
Public function Static FString Returns the plugins directory 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 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 Returns the saved directory that is not game specific.
Public function Static FString Returns the directory that contains subfolders for developer-specific content
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 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

GetCleanFilename ( const FString& InPath
)

 Returns the filename (with extension), minus any path information.
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 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 ( const FString& InPath
)

 Returns the path in front of the filename.
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 FString Returns the directory the application was launched from (useful for commandline utilities)
Public function 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
Public function Static void

MakePlatformFilename ( const FString& InPath,
FString& OutPath
)

 Takes an "Unreal" pathname and converts it to a platform filename.
Public function Static void

MakeStandardFilename ( const FString& InPath,
FString& OutPath
)

 Make fully standard "Unreal" pathname:
Public function 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
Public function 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
Public function Static void

NormalizeFilename ( const FString& InPath,
FString& OutPath
)

 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 plugins directory of the current game by looking at FApp::GetProjectName().
Public function Static 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

RemoveDuplicateSlashes ( const FString& InPath,
FString& OutPath
)

 Removes duplicate slashes in paths.
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 Returns the Shader Working Directory
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

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
Public function Static FString Returns the directory the engine uses to output user requested video capture files.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page