1. Epic GamesDeveloper
  3. ISourceControlModule

ISourceControlModule

Interface for talking to source control providers

API > API/Developer > API/Developer/SourceControl

Interface for talking to source control providers

   
Name ISourceControlModule
Type class
Header File /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h
Include Path #include "ISourceControlModule.h"

Syntax

class ISourceControlModule : public IModuleInterface

Implements Interfaces

Functions

Public

Name Remarks Include Path Unreal Specifiers

TUniquePtr< ISourceControlProvider > CreateProvider ( const FName& Name,
const FStringView& OwningSystem,
const FSourceControlInitSettings& InitialSettings
) const

 Creates and returns a unique source control provider that will be owned by the caller. ISourceControlModule.h  

FSourceControlAssetDataCache & GetAssetDataCache()

 Get the source control AssetData information cache. ISourceControlModule.h  
Return information on custom projects under source control ISourceControlModule.h  

const FSourceControlFilesDeletedDelegate & GetOnFilesDeleted ()

 Returns access to the delegate so that it can be broadcast as needed. ISourceControlModule.h  

const FSourceControlPreSubmitFinalizeDelegate & GetOnPreSubmitFinalize ()

 Returns access to the delegate so that it can be broadcast as needed. ISourceControlModule.h  

ISourceControlProvider & GetProvider()

 Get the source control provider that is currently in use. ISourceControlModule.h  

void GetProviderNames ( TArray< FName >& OutProviderNames
)

 Returns a list of the registered source control providers ISourceControlModule.h  

FSourceControlPreSubmitDataValidationDelegate GetRegisteredPreSubmitDataValidation()

 Gets currently registered delegates for pre-submit data validation ISourceControlModule.h  

FSourceControlFileStatusMonitor & GetSourceControlFileStatusMonitor()

 Returns the object used to monitor the source control status of a collection of files. ISourceControlModule.h  

FString GetSourceControlProjectDir()

 Return the main custom project under source control or the uproject dir (FPaths::ProjectDir) if there's no custom project ISourceControlModule.h  

FSourceControlProviderChanging & GetSourceControlProviderChanging()

 Retrieve a reference to a delegate to be called before the source control provider changes ISourceControlModule.h  

bool GetUseGlobalSettings()

 Get whether we should use global or per-project settings ISourceControlModule.h  

bool IsEnabled ()

 Check whether source control is enabled. ISourceControlModule.h  

FSimpleMulticastDelegate & OnCustomProjectsChanged ()

 Delegate called whenever the list of projects that GetCustomProjects returns has changed. ISourceControlModule.h  

void QueueStatusUpdate ( const TArray< FString >& InFilenames
)

 Queues a file to have its source control status updated in the background. ISourceControlModule.h  

void QueueStatusUpdate ( const TArray< UPackage* >& InPackages
)

 Queues a file to have its source control status updated in the background. ISourceControlModule.h  

void QueueStatusUpdate ( const FString& InFilename
)

 Queues a file to have its source control status updated in the background. ISourceControlModule.h  

void QueueStatusUpdate ( UPackage* InPackage
)

 Queues a file to have its source control status updated in the background. ISourceControlModule.h  

void RegisterCustomProjectsDelegate ( FSourceControlCustomProjectsDelegate InCustomProjectsDelegate
)

 Register a delegate that returns information on custom projects under source control ISourceControlModule.h  

FDelegateHandle RegisterFilesDeleted ( const FSourceControlFilesDeletedDelegate::FDelegate& InDelegate
)

 Registers a delegate that is invoked after source control operation deleted files. ISourceControlModule.h  

void RegisterPreSubmitDataValidation ( const FSourceControlPreSubmitDataValidationDelegate& PreSubmitDataValidationDelegate
)

 Register a delegate to be called to validate asset changes before submitting changes ISourceControlModule.h  

FDelegateHandle RegisterPreSubmitFinalize ( const FSourceControlPreSubmitFinalizeDelegate::FDelegate& Delegate
)

 Register a delegate that is invokes right before files are submitted to source control. ISourceControlModule.h  

FDelegateHandle RegisterProviderChanged ( const FSourceControlProviderChanged::FDelegate& SourceControlProviderChanged
)

 Register a delegate to be called when the source control provider changes ISourceControlModule.h  

void RegisterSourceControlProjectDirDelegate ( const FSourceControlProjectDirDelegate& SourceControlProjectDirDelegate
)

   ISourceControlModule.h  

void SetProvider ( const FName& InName
)

 Set the current source control provider to the one specified here by name. ISourceControlModule.h  

void SetUseGlobalSettings ( bool bIsUseGlobalSettings
)

 Set whether we should use global or per-project settings ISourceControlModule.h  

void ShowLoginDialog ( const FSourceControlLoginClosed& InOnSourceControlLoginClosed,
ELoginWindowMode::Type InLoginWindowMode,
EOnLoginWindowStartup::Type InOnLoginWindowStartup
)

 Show the source control login dialog ISourceControlModule.h  

void Tick ()

 Tick the source control module. ISourceControlModule.h  

void UnregisterCustomProjectsDelegate()

 Unregister the FSourceControlCustomProjectsDelegate delegate ISourceControlModule.h  
Unregister a previously registered delegate. ISourceControlModule.h  

void UnregisterPreSubmitDataValidation()

 Unregister a delegate called before submitting changes ISourceControlModule.h  
Unregister a previously registered delegate. ISourceControlModule.h  

void UnregisterProviderChanged ( FDelegateHandle Handle
)

 Unregister a delegate to be called when the source control provider changes ISourceControlModule.h  

void UnregisterSourceControlProjectDirDelegate()

   ISourceControlModule.h  

bool UsesCustomProjectDir()

   ISourceControlModule.h  

Static

Name Remarks Include Path Unreal Specifiers

static ISourceControlModule & Get()

 Gets a reference to the source control module instance. ISourceControlModule.h  

static ISourceControlModule * GetPtr()

 Gets a pointer to the source control module instance, if loaded. ISourceControlModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page