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

Public function Static

ISourceContr...

 

Get()

Gets a reference to the source control module instance.

Public function

FSourceContr...

 

GetAssetDataCache()

Get the source control AssetData information cache.

Public function Const

const FSourc...

 

GetOnPreSubmitFinalize()

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

Public function Const

ISourceContr...

 

GetProvider()

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

FSourceContr...

 

GetRegisteredPreSubmitDataValidation()

Gets currently registered delegates for pre-submit data validation

Public function Const

bool

 

GetUseGlobalSettings()

Get whether we should use global or per-project settings

Public function Const

bool

 

IsEnabled()

Check whether source control is enabled.

Public function

void

 

QueueStatusUpdate

(
    const TArray< FString >& InFilenam...
)

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

Public function

void

 

QueueStatusUpdate

(
    const TArray< UPackage* >& In...
)

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

void

 

QueueStatusUpdate

(
    UPackage* InPackage
)

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

Public function

void

 

RegisterPreSubmitDataValidation

(
    const FSourceControlPreSubmitDataVa...
)

Register a delegate to be called to validate asset changes before submitting changes

Public function

FDelegateHan...

 

RegisterPreSubmitFinalize

(
    const FSourceControlPreSubmitFinali...
)

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

Public function

FDelegateHan...

 

RegisterProviderChanged

(
    const FSourceControlProviderChanged...
)

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

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& I...,
    ELoginWindowMode::Type InLoginWindo...,
    EOnLoginWindowStartup::Type InOnLog...
)

Show the source control login dialog

that this function blocks if the modality is Modal.

Public function

void

 

Tick()

Tick the source control module.

Public function

void

 

UnregisterPreSubmitDataValidation()

Unregister a delegate called before submitting changes

Public function

void

 

UnregisterPreSubmitFinalize

(
    FDelegateHandle Handle
)

Unregister a previously registered delegate.

Public function

void

 

UnregisterProviderChanged

(
    FDelegateHandle Handle
)

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