1. Epic GamesDeveloper
  3. USourceControlHelpers

USourceControlHelpers

Editor source control common functionality.

API > API/Developer > API/Developer/SourceControl

Editor source control common functionality.

Many of these source control methods use smart file strings which can be one of:

  • fully qualified path
  • relative path
  • long package name
  • asset path
  • export text path (often stored on clipboard)

For example:

  • D:\Epic\Dev-Ent\Projects\Python3rdBP\Content\Mannequin\Animations\ThirdPersonIdle.uasset
  • Content\Mannequin\Animations\ThirdPersonIdle.uasset
  • /Game/Mannequin/Animations/ThirdPersonIdle
  • /Game/Mannequin/Animations/ThirdPersonIdle.ThirdPersonIdle
  • AnimSequence'/Game/Mannequin/Animations/ThirdPersonIdle.ThirdPersonIdle'
   
Name USourceControlHelpers
Type class
Header File /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h
Include Path #include "SourceControlHelpers.h"

Syntax

UCLASS (MinimalAPI, Abstract, Transient, Meta=(ScriptName="SourceControl"))  
class USourceControlHelpers : public UObject

Inheritance Hierarchy

Classes

Name Remarks
FQueryFileStateDelegate Delegate to broadcast FileState upon AsyncQueryFileState completion.

Functions

Static

Name Remarks Include Path Unreal Specifiers

static TArray< FString > AbsoluteFilenames ( const TArray< FString >& InFileNames
)

 Helper function to convert a filename array to absolute paths. SourceControlHelpers.h  

static bool AnnotateFile ( ISourceControlProvider& InProvider,
int32 InCheckInIdentifier,
const FString& InFile,
TArray< FAnnotationLine >& OutLines
)

 Helper function to annotate a file using a changelist/checkin identifier SourceControlHelpers.h  

static bool AnnotateFile ( ISourceControlProvider& InProvider,
const FString& InLabel,
const FString& InFile,
TArray< FAnnotationLine >& OutLines
)

 Helper function to annotate a file using a label SourceControlHelpers.h  

static bool ApplyOperationAndReloadPackages ( const TArray< FString >& InPackagesToApplyOperation,
const TFunctionRef< bool(const TArray< FString >&)>& InOperation,
bool bReloadWorld,
bool bInteractive
)

 Applies the provided function and optionally reloads the world SourceControlHelpers.h  

static void AsyncQueryFileState ( FQueryFileStateDelegate FileStateCallback,
const FString& InFile,
bool bSilent
)

 Query the source control state of the specified file, asynchronously. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static void AsyncQueryFileStates ( FQueryFileStateDelegate FileStateCallback,
TArray< FString > InFiles,
bool bSilent
)

   SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool BranchPackage ( UPackage* DestPackage,
UPackage* SourcePackage,
EStateCacheUsage::Type StateCacheUsage
)

 Helper function to branch/integrate packages from one location to another maintaining a relationship between the files in source control (when possible) SourceControlHelpers.h  

static bool CheckInFile ( const FString& InFile,
const FString& InDescription,
bool bSilent,
bool bKeepCheckedOut
)

 Use currently set source control provider to check in a file. Blocks until action is complete. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool CheckInFiles ( const TArray< FString >& InFiles,
const FString& InDescription,
bool bSilent,
bool bKeepCheckedOut
)

 Use currently set source control provider to check in specified files. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool CheckOutFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to check out a file. Blocks until action is complete. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool CheckOutFiles ( const TArray< FString >& InFiles,
bool bSilent
)

 Use currently set source control provider to check out specified files. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool CheckOutOrAddFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to check out file or mark it for add. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool CheckOutOrAddFiles ( const TArray< FString >& InFiles,
bool bSilent
)

 Use currently set source control provider to check out files or mark them for add. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool CheckoutOrMarkForAdd ( const FString& InDestFile,
const FText& InFileDescription,
const FOnPostCheckOut& OnPostCheckOut,
FText& OutFailReason
)

 Helper function perform an operation on files in our 'source controlled' directories, handling checkout/add etc. SourceControlHelpers.h  

static bool CopyFile ( const FString& InSourceFile,
const FString& InDestFile,
bool bSilent
)

 Use currently set source control provider to copy a file. Blocks until action is complete. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool CopyFileUnderSourceControl ( const FString& InDestFile,
const FString& InSourceFile,
const FText& InFileDescription,
FText& OutFailReason
)

 Helper function to copy a file into our 'source controlled' directories, handling checkout/add etc. SourceControlHelpers.h  

static bool CopyPackage ( UPackage* DestPackage,
UPackage* SourcePackage,
EStateCacheUsage::Type StateCacheUsage
)

 Helper function to copy a package from one location to another SourceControlHelpers.h  

static FString CurrentProvider()

 Determine the name of the current source control provider. SourceControlHelpers.h
  • BlueprintPure
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool GetAssetData ( const FString& InFileName,
const FString& InPackageName,
TArray< FAssetData >& OutAssets,
TArray< FName >* OutDependencies
)

 Helper function to retrieve the FAssetData associated with a given file SourceControlHelpers.h  

static bool GetAssetData ( const FString& InFileName,
TArray< FAssetData >& OutAssets,
TArray< FName >* OutDependencies
)

 Helper function to retrieve the FAssetData associated with a given file SourceControlHelpers.h  

static bool GetAssetDataFromFileHistory ( FSourceControlStatePtr InSourceControlState,
TArray< FAssetData >& OutAssets,
TArray< FName >* OutDependencies,
int64 MaxFetchSize
)

 Helper function to get the asset data from a file's history Note: will not query history to prevent recursion SourceControlHelpers.h  

static bool GetAssetDataFromFileHistory ( const FString& InFileName,
TArray< FAssetData >& OutAssets,
TArray< FName >* OutDependencies,
int64 MaxFetchSize
)

 Helper function to get the asset data from a file's history Note: will not query history to prevent recursion SourceControlHelpers.h  

static bool GetAssetDataFromPackage ( const FString& InPackageName,
TArray< FAssetData >& OutAssets,
TArray< FName >* OutDependencies
)

 Helper function to retrieve the FAssetData associated with a given package name SourceControlHelpers.h  

static bool GetFilesInDepotAtPath ( const FString& Path,
TArray< FString >& OutFilesList,
bool bIncludeDeleted,
bool bSilent,
bool bIsFileRegexSearch
)

 Use currently set source control provider to query the list of files in the depot under a certain path. SourceControlHelpers.h  

static bool GetFilesInDepotAtPaths ( const TArray< FString >& Paths,
TArray< FString >& OutFilesList,
bool bIncludeDeleted,
bool bSilent,
bool bIsFileRegexSearch
)

 Use currently set source control provider to query the list of files in the depot under a list of paths. SourceControlHelpers.h  

static const FString & GetGlobalSettingsIni()

 Helper function to get the ini filename for storing global source control settings SourceControlHelpers.h  

static const FString & GetSettingsIni()

 Helper function to get the ini filename for storing source control settings SourceControlHelpers.h  

static TArray< FString > GetSourceControlLocations ( const bool bContentOnly
)

 Get the list of files and directories that source control should check when looking for changes. SourceControlHelpers.h  

static bool IsAvailable()

 Quick check if currently set source control provider is enabled and available for use (server-based providers can use this to return whether the server is available or not) SourceControlHelpers.h
  • BlueprintPure
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool IsEnabled()

 Determine if there is a source control system enabled SourceControlHelpers.h
  • BlueprintPure
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static FText LastErrorMsg ()

 Get status text set by SourceControl system if an error occurs regardless whether bSilent is set or not. SourceControlHelpers.h
  • BlueprintPure
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool ListRevertablePackages ( TArray< FString >& OutRevertablePackageNames
)

 Find packages that can be reverted in Source Control locations SourceControlHelpers.h  

static bool MarkFileForAdd ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to mark a file for add. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool MarkFileForDelete ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to remove file from source control and delete the file. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool MarkFilesForAdd ( const TArray< FString >& InFiles,
bool bSilent
)

 Use currently set source control provider to mark files for add. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool MarkFilesForDelete ( const TArray< FString >& InFiles,
bool bSilent
)

 Use currently set source control provider to remove files from source control and delete the files. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static FString PackageFilename ( const UPackage* InPackage
)

 Helper function to get a filename for a package. SourceControlHelpers.h  

static FString PackageFilename ( const FString& InPackageName
)

 Helper function to get a filename for a package name. SourceControlHelpers.h  

static TArray< FString > PackageFilenames ( const TArray< UPackage* >& InPackages
)

 Helper function to convert package array into filename array. SourceControlHelpers.h  

static TArray< FString > PackageFilenames ( const TArray< FString >& InPackageNames
)

 Helper function to convert package name array into a filename array. SourceControlHelpers.h  

static FSourceControlState QueryFileState ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to query a file's source control state. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static TArray< FSourceControlState > QueryFileStates ( TArray< FString > InFiles,
bool bSilent
)

   SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool RevertAllChangesAndReloadWorld()

 Reverts all changes and then reloads the world. SourceControlHelpers.h  

static bool RevertAndReloadPackages ( const TArray< FString >& InPackagesToRevert,
bool bRevertAll,
bool bReloadWorld
)

 Reverts the provided files then reloads packages. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool RevertFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to revert a file regardless whether any changes will be lost or not. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool RevertFiles ( const TArray< FString >& InFiles,
bool bSilent
)

 WITH_EDITOR. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool RevertUnchangedFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to revert a file provided no changes have been made. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool RevertUnchangedFiles ( const TArray< FString >& InFiles,
bool bSilent
)

 Use currently set source control provider to revert files provided no changes have been made. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static void RevertUnchangedFiles ( ISourceControlProvider& InProvider,
const TArray< FString >& InFiles
)

 Helper function to get a list of files that are unchanged & revert them. SourceControlHelpers.h  

static bool SyncFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to sync a file or directory to the head revision. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

static bool SyncFiles ( const TArray< FString >& InFiles,
bool bSilent
)

 Use currently set source control provider to sync files or directories to the head revision. SourceControlHelpers.h
  • BlueprintCallable
  • Category="Editor Scripting | Editor Revision Control Helpers"
  • Meta=(Keywords="Source Control")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page