BlueprintPathsLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "UObject/TextProperty.h"
#include "BlueprintPathsLibrary.generated.h"
 
UCLASS(meta = (ScriptName = "Paths"), MinimalAPI)
class UBlueprintPathsLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
    
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool ShouldSaveToUserDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString LaunchDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineUserDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineVersionAgnosticUserDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineContentDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineConfigDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineIntermediateDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineSavedDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EnginePluginsDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EnterpriseDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EnterprisePluginsDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EnterpriseFeaturePackDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString RootDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectUserDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectContentDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectConfigDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectSavedDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectIntermediateDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ShaderWorkingDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectPluginsDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectModsDir();
 
    /*
    * Returns true if a writable directory for downloaded data that persists across play sessions is available
    */
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool HasProjectPersistentDownloadDir();
 
    /*
    * Returns the writable directory for downloaded data that persists across play sessions.
    */
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectPersistentDownloadDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString SourceConfigDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GeneratedConfigDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString SandboxesDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProfilingDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ScreenShotDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString BugItDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString VideoCaptureDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ProjectLogDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString AutomationDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString AutomationTransientDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString AutomationLogDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString CloudDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GameDevelopersDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GameUserDeveloperDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString DiffDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API const TArray<FString>& GetEngineLocalizationPaths();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API const TArray<FString>& GetEditorLocalizationPaths();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API const TArray<FString>& GetPropertyNameLocalizationPaths();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API const TArray<FString>& GetToolTipLocalizationPaths();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API const TArray<FString>& GetGameLocalizationPaths();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API const TArray<FString>& GetRestrictedFolderNames();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool IsRestrictedPath(const FString& InPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GameAgnosticSavedDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString EngineSourceDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GameSourceDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString FeaturePackDir();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool IsProjectFilePathSet();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GetProjectFilePath();
 
    UFUNCTION(BlueprintCallable, Category = "Utilities|Paths")
    static ENGINE_API void SetProjectFilePath(const FString& NewGameProjectFilePath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GetExtension(const FString& InPath, bool bIncludeDot = false);
 
    // Returns the filename (with extension), minus any path information.
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GetCleanFilename(const FString& InPath);
 
    // Returns the same thing as GetCleanFilename, but without the extension
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GetBaseFilename(const FString& InPath, bool bRemovePath = true);
 
    // Returns the path in front of the filename
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GetPath(const FString& InPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ChangeExtension(const FString& InPath, const FString& InNewExtension);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString SetExtension(const FString& InPath, const FString& InNewExtension);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool FileExists(const FString& InPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool DirectoryExists(const FString& InPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool IsDrive(const FString& InPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool IsRelative(const FString& InPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API void NormalizeFilename(const FString& InPath, FString& OutPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool IsSamePath(const FString& PathA, const FString& PathB);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API void NormalizeDirectoryName(const FString& InPath, FString& OutPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool CollapseRelativeDirectories(const FString& InPath, FString& OutPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API void RemoveDuplicateSlashes(const FString& InPath, FString& OutPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API void MakeStandardFilename(const FString& InPath, FString& OutPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API void MakePlatformFilename(const FString& InPath, FString& OutPath);
 
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API bool MakePathRelativeTo(const FString& InPath, const FString& InRelativeTo, FString& OutPath);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ConvertRelativePathToFull(const FString& InPath, const FString& InBasePath = TEXT(""));
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ConvertToSandboxPath(const FString& InPath, const FString& InSandboxName);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString ConvertFromSandboxPath(const FString& InPath, const FString& InSandboxName);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString CreateTempFilename(const FString& Path, const FString& Prefix = TEXT(""), const FString& Extension = TEXT(".tmp"));
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString GetInvalidFileSystemChars();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString MakeValidFileName(const FString& InString, const FString& InReplacementChar = TEXT(""));
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API void ValidatePath(const FString& InPath, bool& bDidSucceed, FText& OutReason);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API void Split(const FString& InPath, FString& PathPart, FString& FilenamePart, FString& ExtensionPart);
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API const FString& GetRelativePathToRoot();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Paths")
    static ENGINE_API FString Combine(const TArray<FString>& InPaths);
 
};