Navigation
| Name | SourceControl |
| Type | Developer |
| Location | /Engine/Source/Developer/SourceControl/ |
| Module Build Rules | SourceControl.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAnnotationLine | A single line of an annotated file |
| FAsyncCommandHelper | Helper class for receiving the results of async source control operations |
| FCheckIn | Operation used to check files into source control |
| FCheckOut | Operation used to check files out of source control |
| FConnect | Operation used to connect (or test a connection) to source control |
| FCopy | Operation used to copy a file or directory from one location to another |
| FCreateWorkspace | Operation used to create a new workspace if the source control system supports this functionality. |
| FDefaultRevisionControlStyle | The default revision control style the editor ships with. |
| FDelete | Operation used to mark files for delete in source control |
| FDeleteChangelist | Operation used to delete an empty changelist |
| FDeleteShelved | Operation used to delete shelved files from a changelist |
| FDeleteWorkspace | Operation used to delete a workspace |
| FDownloadFile | Operation used to download a file from the source control server directly rather than sync it. |
| FEditChangelist | Operation to change the description of a changelist |
| FGetChangelistDetails | This operations query the source control to extract all the details available for a given changelist. |
| FGetFile | This operation uses p4v print command to get file from specified depot by shelved changelist or file revision returns a package filename |
| FGetFileList | Operation used to get a file list out of source control |
| FGetPendingChangelists | Operation used to retrieve pending changelist(s). |
| FGetSourceControlRevisionInfo | Operation used to get info about file(s) at a revision. |
| FGetSubmittedChangelists | Operation used to retrieve submitted changelist(s). |
| FGetWorkspaces | Operation used to get all workspaces for the current host if the source control system supports this functionality. |
| FMarkForAdd | Operation used to mark files for add in source control |
| FMoveToChangelist | Operation used to move files between changelists |
| FNewChangelist | Operation used to create a new changelist |
| FResolve | Operation used to resolve a file that is in a conflicted state. |
| FRevert | Operation used to revert changes made back to the state they are in source control |
| FRevertUnchanged | Operation to revert unchanged file(s) or all unchanged files in a changelist |
| FRevisionControlStyleManager | The style manager that is used to access the currently active revision control style. |
| FSave | This operation will save files into revision control without actually doing a check-in |
| FScopedSourceControl | Helper class that ensures FSourceControl is properly initialized and shutdown by calling Init/Close in its constructor/destructor respectively. |
| FScopedSourceControlProgress | |
| FShelve | Operation used to shelve files in a changelist |
| FSourceControlAssetDataCache | |
| FSourceControlFileStatusMonitor | Periodically monitors the source controlled status of a collection of files and notifies the latest status, including potential warnings such as 'out of date', 'locked by other', etc. |
| FSourceControlInitSettings | |
| FSourceControlOperationBase | Adds some common functionality to source control operations. |
| FSync | Operation used to sync files to the state they are in source control |
| FSyncPreview | Operation used to determine the files that would be affected by a sync operation |
| FUnshelve | Operation used to unshelve files from a changelist |
| FUpdatePendingChangelistsStatus | Operation used to update the source control status of changelist(s) |
| FUpdateStatus | Operation used to update the source control status of files |
| FWhere | This operation will get info about the location of a file within a source control provider. |
| SSourceControlControls | Widget for displaying Source Control Check in Changes and Sync Latest buttons |
| USourceControlHelpers | Editor source control common functionality. |
| USourceControlPreferences | Settings for the Source Control Integration |
Structs
| Name | Remarks |
|---|---|
| FAssetDataToLoad | |
| FScopedDisableSourceControl | Temporarily disable source control for the lifetime of this scoped object |
| FScWorkspaceInfo | Information on a source control workspace |
| FSourceControlAssetDataEntry | |
| FSourceControlProjectInfo | Describes a custom project that is under source control |
| FSourceControlResultInfo | Accumulated error and info messages for a source control operation. |
| FSourceControlState | Snapshot of source control state of a file |
Interfaces
| Name | Remarks |
|---|---|
| ISourceControlChangelist | An abstraction of a changelist under source control |
| ISourceControlChangelistState | An abstraction of the state of a pending changelist under source control |
| ISourceControlLabel | Abstraction of a source control label/tag. |
| ISourceControlModule | Interface for talking to source control providers |
| ISourceControlOperation | |
| ISourceControlProvider | Interface to talking with source control providers. |
| ISourceControlRevision | Abstraction of a source control revision. |
| ISourceControlState | An abstraction of the state of a file under source control |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAssetDataArrayPtr | TSharedPtr< TArray< FAssetData > > | SourceControlAssetDataCache.h | |
| FGetSourceControlOperation | TBaseDelegate_NoParams< FSourceControlOperationRef > | Delegate used by providers to create source control operations | ISourceControlProvider.h |
| FIsEnabled | TBaseDelegate_NoParams< bool > | SSourceControlControls.h | |
| FIsVisible | TBaseDelegate_NoParams< bool > | SSourceControlControls.h | |
| FNumConflicts | TBaseDelegate_NoParams< int32 > | SSourceControlControls.h | |
| FOnPostCheckOut | TBaseDelegate_ThreeParams< bool, const FString &, const FText &, FText & > | Delegate used for performing operation on files that may need a checkout, but before they are added to source control | SourceControlHelpers.h |
| FSourceControlChangelistPtr | TSharedPtr< class ISourceControlChangelist, ESPMode::ThreadSafe > | ISourceControlState.h | |
| FSourceControlChangelistPtr | TSharedPtr< class ISourceControlChangelist, ESPMode::ThreadSafe > | ISourceControlModule.h | |
| FSourceControlChangelistPtr | TSharedPtr< class ISourceControlChangelist, ESPMode::ThreadSafe > | ISourceControlChangelist.h | |
| FSourceControlChangelistRef | TSharedRef< class ISourceControlChangelist, ESPMode::ThreadSafe > | ISourceControlState.h | |
| FSourceControlChangelistRef | TSharedRef< class ISourceControlChangelist, ESPMode::ThreadSafe > | ISourceControlChangelist.h | |
| FSourceControlChangelistStatePtr | TSharedPtr< class ISourceControlChangelistState, ESPMode::ThreadSafe > | ISourceControlChangelistState.h | |
| FSourceControlChangelistStateRef | TSharedRef< class ISourceControlChangelistState, ESPMode::ThreadSafe > | ISourceControlChangelistState.h | |
| FSourceControlCustomProjectsDelegate | TBaseDelegate_NoParams< TArray< FSourceControlProjectInfo > > | Delegate that returns directory information on custom projects under source control (first entry is the main project) | ISourceControlModule.h |
| FSourceControlFilesDeletedDelegate | TMulticastDelegate_OneParam< void, const TArray< FString > & > | Delegate called after source control operations deleted files. | ISourceControlModule.h |
| FSourceControlLoginClosed | TBaseDelegate_OneParam< void, bool > | Delegate called when the source control login window is closed. | ISourceControlModule.h |
| FSourceControlOperationComplete | TBaseDelegate_TwoParams< void, const FSourceControlOperationRef &, ECommandResult::Type > | Delegate used by providers for when operations finish | ISourceControlProvider.h |
| FSourceControlOperationRef | TSharedRef< class ISourceControlOperation, ESPMode::ThreadSafe > | ISourceControlOperation.h | |
| FSourceControlPreSubmitChangelistValidationDelegate | TBaseDelegate_FourParams< void, FSourceControlChangelistPtr, EDataValidationResult &, TArray< FText > &, TArray< FText > & > | ISourceControlModule.h | |
| FSourceControlPreSubmitDataValidationDelegate | TBaseDelegate_FourParams< void, FSourceControlChangelistPtr, EDataValidationResult &, TArray< FText > &, TArray< FText > & > | Delegate called on pre-submit for data validation | ISourceControlModule.h |
| FSourceControlPreSubmitFilesValidationDelegate | TBaseDelegate_FourParams< void, TArray< FSourceControlStateRef > &, EDataValidationResult &, TArray< FText > &, TArray< FText > & > | ISourceControlModule.h | |
| FSourceControlPreSubmitFinalizeDelegate | TMulticastDelegate_ThreeParams< void, const TArray< FString > &, TArray< FText > &, TArray< FText > & > | Delegate called once the user has confirmed that they want to submit files to source control BUT before the files are actually submitted. | ISourceControlModule.h |
| FSourceControlProjectDirDelegate | TBaseDelegate_NoParams< FString > | Delegate used to specify the project base directory to be used by the source control | ISourceControlModule.h |
| FSourceControlProviderChanged | TMulticastDelegate_TwoParams< void, ISourceControlProvider &, ISourceControlProvider & > | Delegate called when the active source control provider is changed | ISourceControlModule.h |
| FSourceControlProviderChanging | TBaseDelegate_NoParams< bool > | Delegate called when the active source control provider is changing. | ISourceControlModule.h |
| FSourceControlStateChanged | TMulticastDelegate_NoParams< void > | Delegate called when the state of an item (or group of items) has changed. | ISourceControlProvider.h |
| FSourceControlStatePtr | TSharedPtr< class ISourceControlState, ESPMode::ThreadSafe > | ISourceControlState.h | |
| FSourceControlStateRef | TSharedRef< class ISourceControlState, ESPMode::ThreadSafe > | ISourceControlState.h | |
| FSourceControlStateRef | TSharedRef< class ISourceControlState, ESPMode::ThreadSafe > | ISourceControlModule.h | |
| SourceControlHelpers | class USourceControlHelpers | For backwards compatibility. | SourceControlHelpers.h |
Enums
Public
| Name | Remarks |
|---|---|
| ECommandResult::Type | Results of a command execution |
| EConcurrency::Type | Hint for how to execute the operation. |
| ELoginWindowMode::Type | The modality of the login window. |
| EOnLoginWindowStartup::Type | Login window startup behavior |
| EStateCacheUsage::Type | Hint to provider when updating state |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!
(
ISourceControlProvider::EInitFlags E |
ISourceControlProvider.h | ||
bool operator!
(
FSourceControlOperationBase::EFlags E |
SourceControlOperationBase.h | ||
| SourceControlResultInfo.h | |||
| ISourceControlProvider.h | |||
| SourceControlOperationBase.h | |||
| SourceControlResultInfo.h | |||
| ISourceControlProvider.h | |||
| SourceControlOperationBase.h | |||
| SourceControlResultInfo.h | |||
| ISourceControlProvider.h | |||
| SourceControlOperationBase.h | |||
| SourceControlResultInfo.h | |||
| ISourceControlProvider.h | |||
| SourceControlOperationBase.h | |||
| SourceControlResultInfo.h | |||
| ISourceControlProvider.h | |||
| SourceControlOperationBase.h | |||
| SourceControlResultInfo.h | |||
| ISourceControlProvider.h | |||
| SourceControlOperationBase.h | |||
| SourceControlResultInfo.h | |||
| ISourceControlProvider.h | |||
| SourceControlOperationBase.h | |||
| SourceControlResultInfo.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TCHAR * SourceControlProviders::GetDefaultProviderName() |
Returns the default SourceControl provider name, which is the one indicating 'disabled'. | SourceControlProviders.h | |
static const TCHAR * SourceControlProviders::GetLegacySkeinProviderName() |
Returns the old Skein SourceControl provider name | SourceControlProviders.h | |
static const TCHAR * SourceControlProviders::GetPerforceProviderName() |
Returns the Perforce SourceControl provider name | SourceControlProviders.h | |
static const TCHAR * SourceControlProviders::GetUrcProviderName() |
Returns the URC SourceControl provider name | SourceControlProviders.h |