1. Epic GamesDeveloper
  3. USourceControlHelpers

USourceControlHelpers

Editor source control common functionality.

API > API/Developer > API/Developer/SourceControl

Inheritance Hierarchy

References

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

Syntax

class USourceControlHelpers : public 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
Public function Static TArray< FString >

AbsoluteFilenames ( const TArray< FString >& InFileNames
)

 Helper function to convert a filename array to absolute paths.
Public function Static bool

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

 Helper function to annotate a file using a changelist/checkin identifier
Public function Static bool

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

 Helper function to annotate a file using a label
Public function 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
Public function Static void

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

 Query the source control state of the specified file, asynchronously.
Public function 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)
Public function 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.
Public function 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.
Public function Static bool

CheckOutFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to check out a file. Blocks until action is complete.
Public function Static bool

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

 Use currently set source control provider to check out specified files.
Public function Static bool

CheckOutOrAddFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to check out file or mark it for add.
Public function Static bool

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

 Use currently set source control provider to check out files or mark them for add.
Public function 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.
Public function 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.
Public function 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.
Public function Static bool

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

 Helper function to copy a package from one location to another
Public function Static FString Determine the name of the current source control provider.
Public function 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
Public function Static bool

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

 Helper function to retrieve the FAssetData associated with a given file
Public function 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
Public function 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
Public function Static bool

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

 Helper function to retrieve the FAssetData associated with a given package name
Public function Static 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.
Public function Static const FString & Helper function to get the ini filename for storing global source control settings
Public function Static const FString & Helper function to get the ini filename for storing source control settings
Public function Static TArray< FString >

GetSourceControlLocations ( const bool bContentOnly
)

 Get the list of files and directories that source control should check when looking for changes.
Public function Static bool 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)
Public function Static bool Determine if there is a source control system enabled
Public function Static FText Get status text set by SourceControl system if an error occurs regardless whether bSilent is set or not.
Public function Static bool

ListRevertablePackages ( TArray< FString >& OutRevertablePackageNames
)

 Find packages that can be reverted in Source Control locations
Public function Static bool

MarkFileForAdd ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to mark a file for add.
Public function Static bool

MarkFileForDelete ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to remove file from source control and delete the file.
Public function Static bool

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

 Use currently set source control provider to mark files for add.
Public function 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.
Public function Static FString

PackageFilename ( const UPackage* InPackage
)

 Helper function to get a filename for a package.
Public function Static FString

PackageFilename ( const FString& InPackageName
)

 Helper function to get a filename for a package name.
Public function Static TArray< FString >

PackageFilenames ( const TArray< UPackage* >& InPackages
)

 Helper function to convert package array into filename array.
Public function Static TArray< FString >

PackageFilenames ( const TArray< FString >& InPackageNames
)

 Helper function to convert package name array into a filename array.
Public function Static FSourceControlState

QueryFileState ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to query a file's source control state.
Public function Static bool Reverts all changes and then reloads the world.
Public function Static bool

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

 Reverts the provided files then reloads packages.
Public function 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.
Public function Static bool

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

 WITH_EDITOR.
Public function Static bool

RevertUnchangedFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to revert a file provided no changes have been made.
Public function Static bool

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

 Use currently set source control provider to revert files provided no changes have been made.
Public function Static void

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

 Helper function to get a list of files that are unchanged & revert them.
Public function Static bool

SyncFile ( const FString& InFile,
bool bSilent
)

 Use currently set source control provider to sync a file or directory to the head revision.
Public function Static 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

On this page