USourceControlHelpers

Editor source control common functionality.

Unreal Engine C++ API Reference > Developer > SourceControl

Inheritance Hierarchy

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h
Include #include "SourceControlHelpers.h"

Syntax

class USourceControlHelpers : public [UObject](API\Runtime\CoreUObject\UObject\UObject)  

Remarks

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:-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'

Functions

Type Name Description
TArray< FStr... AbsoluteFilenames ( const TArray< FString >& InFileNam... ) Helper function to convert a filename array to absolute paths.
bool AnnotateFile ( ISourceControlProvider& InProvider, int32 InCheckInIdentifier, const FString& InFile, TArray< FAnnotationLine >& OutLine... ) Helper function to annotate a file using a changelist/checkin identifier
bool AnnotateFile ( ISourceControlProvider& InProvider, const FString& InLabel, const FString& InFile, TArray< FAnnotationLine >& OutLine... ) Helper function to annotate a file using a label
bool ApplyOperationAndReloadPackages ( const TArray< FString >& InPackage..., const TFunctionRef< bool(const TArr..., bool bReloadWorld, bool bInteractive ) Applies the provided function and optionally reloads the world
void AsyncQueryFileState ( FQueryFileStateDelegate FileStateCa..., const FString& InFile, bool bSilent ) Query the source control state of the specified file, asynchronously.
bool BranchPackage ( UPackage* DestPackage, UPackage* SourcePackage, EStateCacheUsage::Type StateCacheUs... ) Helper function to branch/integrate packages from one location to another maintaining a relationship between the files in source control (when possible)
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.
bool CheckInFiles ( const TArray< FString >& InFiles, const FString& InDescription, bool bSilent, bool bKeepCheckedOut ) Use currently set source control provider to check in specified files.
bool CheckOutFile ( const FString& InFile, bool bSilent ) Use currently set source control provider to check out a file. Blocks until action is complete.
bool CheckOutFiles ( const TArray< FString >& InFiles, bool bSilent ) Use currently set source control provider to check out specified files.
bool CheckOutOrAddFile ( const FString& InFile, bool bSilent ) Use currently set source control provider to check out file or mark it for add.
bool CheckOutOrAddFiles ( const TArray< FString >& InFiles, bool bSilent ) Use currently set source control provider to check out files or mark them for add.
bool CheckoutOrMarkForAdd ( const FString& InDestFile, const FText& InFileDescription, const FOnPostCheckOut& OnPostCheck..., FText& OutFailReason ) Helper function perform an operation on files in our 'source controlled' directories, handling checkout/add etc.
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.
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.
bool CopyPackage ( UPackage* DestPackage, UPackage* SourcePackage, EStateCacheUsage::Type StateCacheUs... ) Helper function to copy a package from one location to another
FString CurrentProvider () Determine the name of the current source control provider.
bool GetAssetData ( const FString& InFileName, const FString& InPackageName, TArray< FAssetData >& OutAssets, TArray< FName >* OutDependenci... ) Helper function to retrieve the FAssetData associated with a given file
bool GetAssetData ( const FString& InFileName, TArray< FAssetData >& OutAssets, TArray< FName >* OutDependenci... ) Helper function to retrieve the FAssetData associated with a given file
bool GetAssetDataFromFileHistory ( FSourceControlStatePtr InSourceCont..., TArray< FAssetData >& OutAssets, TArray< FName >* OutDependenci..., int64 MaxFetchSize ) Helper function to get the asset data from a file's history Note: will not query history to prevent recursion
bool GetAssetDataFromFileHistory ( const FString& InFileName, TArray< FAssetData >& OutAssets, TArray< FName >* OutDependenci..., int64 MaxFetchSize ) Helper function to get the asset data from a file's history Note: will not query history to prevent recursion
bool GetAssetDataFromPackage ( const FString& InPackageName, TArray< FAssetData >& OutAssets, TArray< FName >* OutDependenci... ) Helper function to retrieve the FAssetData associated with a given package name
bool GetFilesInDepotAtPath ( const FString& PathToDirectory, TArray< FString >& OutFilesList, bool bIncludeDeleted, bool bSilent ) Use currently set source control provider to query the list of files in the depot under a certain path.
const FStrin... GetGlobalSettingsIni () Helper function to get the ini filename for storing global source control settings
const FStrin... GetSettingsIni () Helper function to get the ini filename for storing source control settings
TArray< FStr... GetSourceControlLocations ( const bool bContentOnly ) Get the list of files and directories that source control should check when looking for changes.
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)
bool IsEnabled () Determine if there is a source control system enabled
FText LastErrorMsg () Get status text set by SourceControl system if an error occurs regardless whether bSilent is set or not.
bool ListRevertablePackages ( TArray< FString >& OutRevertablePa... ) Find packages that can be reverted in Source Control locations
bool MarkFileForAdd ( const FString& InFile, bool bSilent ) Use currently set source control provider to mark a file for add.
bool MarkFileForDelete ( const FString& InFile, bool bSilent ) Use currently set source control provider to remove file from source control and delete the file.
bool MarkFilesForAdd ( const TArray< FString >& InFiles, bool bSilent ) Use currently set source control provider to mark files for add.
bool MarkFilesForDelete ( const TArray< FString >& InFiles, bool bSilent ) Use currently set source control provider to remove files from source control and delete the files.
FString PackageFilename ( const UPackage* InPackage ) Helper function to get a filename for a package.
FString PackageFilename ( const FString& InPackageName ) Helper function to get a filename for a package name.
TArray< FStr... PackageFilenames ( const TArray< UPackage* >& In... ) Helper function to convert package array into filename array.
TArray< FStr... PackageFilenames ( const TArray< FString >& InPackage... ) Helper function to convert package name array into a filename array.
FSourceContr... QueryFileState ( const FString& InFile, bool bSilent ) Use currently set source control provider to query a file's source control state.
bool RevertAllChangesAndReloadWorld () Reverts all changes and then reloads the world.
bool RevertAndReloadPackages ( const TArray< FString >& InPackage..., bool bRevertAll, bool bReloadWorld ) Reverts the provided files then reloads packages.
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.
bool RevertFiles ( const TArray< FString >& InFiles, bool bSilent ) WITH_EDITOR.
bool RevertUnchangedFile ( const FString& InFile, bool bSilent ) Use currently set source control provider to revert a file provided no changes have been made.
bool RevertUnchangedFiles ( const TArray< FString >& InFiles, bool bSilent ) Use currently set source control provider to revert files provided no changes have been made.
void RevertUnchangedFiles ( ISourceControlProvider& InProvider, const TArray< FString >& InFiles ) Helper function to get a list of files that are unchanged & revert them.
bool SyncFile ( const FString& InFile, bool bSilent ) Use currently set source control provider to sync a file or directory to the head revision.
bool SyncFiles ( const TArray< FString >& InFiles, bool bSilent ) Use currently set source control provider to sync files or directories to the head revision.

Classes

Type Name Description
Public class FQueryFileStateDelegate Delegate to broadcast FileState upon AsyncQueryFileState completion.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library