Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > SourceControl > ISourceControlModule

Light Theme

Dark Theme

ISourceControlModule

Interface for talking to source control providers

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

ISourceControlModule

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

	Name	Description
ISourceContr...	Get()	Gets a reference to the source control module instance.
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
bool	GetUseGlobalSettings()	Get whether we should use global or per-project settings
bool	IsEnabled()	Check whether source control is enabled.
void	QueueStatusUpdate ( const TArray< UPackage* >& In... )	Queues a file to have its source control status updated in the background.
void	QueueStatusUpdate ( const TArray< FString >& InFilenam... )	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...	RegisterProviderChanged ( const FSourceControlProviderChanged... )	Register a delegate to be called when the source control provider changes
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	UnregisterProviderChanged ( FDelegateHandle Handle )	Unregister a delegate to be called when the source control provider changes

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss