1. Epic GamesDeveloper
  3. ISourceControlModule

ISourceControlModule

Interface for talking to source control providers

API > API/Developer > API/Developer/SourceControl

Inheritance Hierarchy

References

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

Syntax

class ISourceControlModule : public IModuleInterface

Remarks

Interface for talking to source control providers

Functions

  Type Name Description
Public function Const TUniquePtr< ISourceControlProvider >

CreateProvider ( const FName& Name,
const FStringView& OwningSystem,
const FSourceControlInitSettings& InitialSettings
)

 Creates and returns a unique source control provider that will be owned by the caller.
Public function Static ISourceControlModule &

Get ()

 Gets a reference to the source control module instance.
Public function FSourceControlAssetDataCache & Get the source control AssetData information cache.
Public function Const const FSourceControlFilesDeletedDelegate & Returns access to the delegate so that it can be broadcast as needed.
Public function Const ISourceControlProvider & Get the source control provider that is currently in use.
Public function void

GetProviderNames ( TArray< FName >& OutProviderNames
)

 Returns a list of the registered source control providers
Public function FSourceControlPreSubmitDataValidationDelegate Gets currently registered delegates for pre-submit data validation
Public function FSourceControlFileStatusMonitor & Returns the object used to monitor the source control status of a collection of files.
Public function Const FString Returns the project base directory to be used by the source control
Public function Const bool Get whether we should use global or per-project settings
Public function Const bool Check whether source control is enabled.
Public function void

QueueStatusUpdate ( const TArray< FString >& InFilenames
)

 Queues a file to have its source control status updated in the background.
Public function void

QueueStatusUpdate ( const TArray< UPackage* >& InPackages
)

 Queues a file to have its source control status updated in the background.
Public function void

QueueStatusUpdate ( UPackage* InPackage
)

 Queues a file to have its source control status updated in the background.
Public function void

QueueStatusUpdate ( const FString& InFilename
)

 Queues a file to have its source control status updated in the background.
Public function FDelegateHandle

RegisterFilesDeleted ( const FSourceControlFilesDeletedDelegate::FDelegate& InDelegate
)

 Registers a delegate that is invoked after source control operation deleted files.
Public function void Register a delegate to be called to validate asset changes before submitting changes
Public function FDelegateHandle

RegisterProviderChanged ( const FSourceControlProviderChanged::FDelegate& SourceControlProviderChanged
)

 Register a delegate to be called when the source control provider changes
Public function void Register a delegate used to specify the project base directory to be used by the source control
Public function void

SetProvider ( const FName& InName
)

 Set the current source control provider to the one specified here by name.
Public function void

SetUseGlobalSettings ( bool bIsUseGlobalSettings
)

 Set whether we should use global or per-project settings
Public function void

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

 Show the source control login dialog
Public function void

Tick ()

 Tick the source control module.
Public function void Unregister a previously registered delegate.
Public function void Unregister a delegate called before submitting changes
Public function void Unregister a delegate to be called when the source control provider changes
Public function void Unregister the FSourceControlProjectDirDelegate delegate
Public function Const bool Returns whether a delegate has been registered to specify the project base directory to be used by the source control

Deprecated Functions

  Type Name Description
Public function Const const FSourceControlPreSubmitFinalizeDelegate & ISourceControlModule::GetOnPreSubmitFinalize is deprecated, the functionality will be removed
Public function FDelegateHandle

RegisterPreSubmitFinalize ( const FSourceControlPreSubmitFinalizeDelegate::FDelegate& Delegate
)

 ISourceControlModule::RegisterPreSubmitFinalize is deprecated, the functionality will be removed
Public function void ISourceControlModule::UnregisterPreSubmitFinalize is deprecated, the functionality will be removed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page