| UObjectBase
|
Module |
|
Header |
/Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h |
Include |
#include "SourceControlHelpers.h" |
class USourceControlHelpers : public UObject
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'
Name | Description | ||
---|---|---|---|
|
AbsoluteFilenames |
Helper function to convert a filename array to absolute paths. |
|
|
AnnotateFile ( |
Helper function to annotate a file using a changelist/checkin identifier |
|
|
AnnotateFile ( |
Helper function to annotate a file using a label |
|
|
BranchPackage |
Helper function to branch/integrate packages from one location to another |
|
|
CheckInFile |
Use currently set source control provider to check in a file. Blocks until action is complete. |
|
|
CheckInFiles |
Use currently set source control provider to check in specified files. |
|
|
CheckOutFile |
Use currently set source control provider to check out a file. Blocks until action is complete. |
|
|
CheckOutFiles |
Use currently set source control provider to check out specified files. |
|
|
CheckOutOrAddFile |
Use currently set source control provider to check out file or mark it for add. |
|
|
CheckoutOrMarkForAdd ( |
Helper function perform an operation on files in our 'source controlled' directories, handling checkout/add etc. |
|
|
CopyFile |
Use currently set source control provider to copy a file. Blocks until action is complete. |
|
|
CopyFileUnderSourceControl |
Helper function to copy a file into our 'source controlled' directories, handling checkout/add etc. |
|
|
CurrentProvider() |
Determine the name of the current source control provider. |
|
|
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 |
|
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) |
|
|
IsEnabled() |
Determine if there is a source control system enabled |
|
|
LastErrorMsg() |
Get status text set by SourceControl system if an error occurs regardless whether bSilent is set or not. |
|
|
MarkFileForAdd |
Use currently set source control provider to mark a file for add. |
|
|
MarkFileForDelete |
Use currently set source control provider to remove file from source control and delete the file. |
|
|
MarkFilesForAdd |
Use currently set source control provider to mark files for add. |
|
|
PackageFilename ( |
Helper function to get a filename for a package name. |
|
|
PackageFilename ( |
Helper function to get a filename for a package. |
|
|
PackageFilenames |
Helper function to convert package name array into a filename array. |
|
|
PackageFilenames |
Helper function to convert package array into filename array. |
|
|
FSourceContr... |
QueryFileState |
Use currently set source control provider to query a file's source control state. |
|
RevertFile |
Use currently set source control provider to revert a file regardless whether any changes will be lost or not. |
|
|
RevertFiles |
Use currently set source control provider to revert files regardless whether any changes will be lost or not. |
|
|
RevertUnchangedFile |
Use currently set source control provider to revert a file provided no changes have been made. |
|
|
RevertUnchangedFiles |
Use currently set source control provider to revert files provided no changes have been made. |
|
|
RevertUnchangedFiles ( |
Helper function to get a list of files that are unchanged & revert them. |