ISourceControlModule

Interface for talking to source control providers

Unreal Engine C++ API Reference > Developer > SourceControl

Inheritance Hierarchy

References

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

Syntax

class ISourceControlModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)  

Remarks

Interface for talking to source control providers

Functions

Type Name Description
TUniquePtr< ... CreateProvider ( const FName& Name, const FStringView& OwningSystem, const FSourceControlInitSettings& ... ) Creates and returns a unique source control provider that will be owned by the caller.
ISourceContr... Get () Gets a reference to the source control module instance.
FSourceContr... GetAssetDataCache () Get the source control AssetData information cache.
const FSourc... GetOnFilesDeleted () Returns access to the delegate so that it can be broadcast as needed.
ISourceContr... GetProvider () Get the source control provider that is currently in use.
void GetProviderNames ( TArray< FName >& OutProviderNames ) Returns a list of the registered source control providers
FSourceContr... GetRegisteredPreSubmitDataValidation () Gets currently registered delegates for pre-submit data validation
FSourceContr... GetSourceControlFileStatusMonitor () Returns the object used to monitor the source control status of a collection of files.
FString GetSourceControlProjectDir () Returns the project base directory to be used by the source control
bool GetUseGlobalSettings () Get whether we should use global or per-project settings
bool IsEnabled () Check whether source control is enabled.
void QueueStatusUpdate ( const TArray< FString >& InFilenam... ) Queues a file to have its source control status updated in the background.
void QueueStatusUpdate ( const TArray< UPackage* >& In... ) Queues a file to have its source control status updated in the background.
void QueueStatusUpdate ( UPackage* InPackage ) Queues a file to have its source control status updated in the background.
void QueueStatusUpdate ( const FString& InFilename ) Queues a file to have its source control status updated in the background.
FDelegateHan... RegisterFilesDeleted ( const FSourceControlFilesDeletedDel... ) Registers a delegate that is invoked after source control operation deleted files.
void RegisterPreSubmitDataValidation ( const FSourceControlPreSubmitDataVa... ) Register a delegate to be called to validate asset changes before submitting changes
FDelegateHan... RegisterProviderChanged ( const FSourceControlProviderChanged... ) Register a delegate to be called when the source control provider changes
void RegisterSourceControlProjectDirDelegate ( const FSourceControlProjectDirDeleg... ) Register a delegate used to specify the project base directory to be used by the source control
void SetProvider ( const FName& InName ) Set the current source control provider to the one specified here by name.
void SetUseGlobalSettings ( bool bIsUseGlobalSettings ) Set whether we should use global or per-project settings
void ShowLoginDialog ( const FSourceControlLoginClosed& I..., ELoginWindowMode::Type InLoginWindo..., EOnLoginWindowStartup::Type InOnLog... ) Show the source control login dialog
void Tick () Tick the source control module.
void UnregisterFilesDeleted ( FDelegateHandle InHandle ) Unregister a previously registered delegate.
void UnregisterPreSubmitDataValidation () Unregister a delegate called before submitting changes
void UnregisterProviderChanged ( FDelegateHandle Handle ) Unregister a delegate to be called when the source control provider changes
void UnregisterSourceControlProjectDirDelegate () Unregister the FSourceControlProjectDirDelegate delegate
bool UsesCustomProjectDir () 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
const FSourc... GetOnPreSubmitFinalize () ISourceControlModule::GetOnPreSubmitFinalize is deprecated, the functionality will be removed
FDelegateHan... RegisterPreSubmitFinalize ( const FSourceControlPreSubmitFinali... ) ISourceControlModule::RegisterPreSubmitFinalize is deprecated, the functionality will be removed
void UnregisterPreSubmitFinalize ( FDelegateHandle Handle ) 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