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 > Editor > SourceControlWindows > FSourceControlWindows

Light Theme

Dark Theme

FSourceControlWindows

Windows

MacOS

Linux

References

Module	SourceControlWindows
Header	/Engine/Source/Editor/SourceControlWindows/Public/SourceControlWindows.h
Include	#include "SourceControlWindows.h"

Syntax

class FSourceControlWindows

Functions

	Name	Description
bool	CanChoosePackagesToCheckIn()	Determines whether we can choose packages to check in (we cant if an operation is already in progress)
bool	ChoosePackagesToCheckIn ( const FSourceControlWindowsOnCheckI... )	Opens a user dialog to choose packages to submit.
void	ChoosePackagesToCheckInCallback ( const FSourceControlOperationRef& ..., ECommandResult::Type InResult, FSourceControlWindowsOnCheckInCompl... )	Callback for ChoosePackagesToCheckIn(), continues to bring up UI once source control operations are complete
void	ChoosePackagesToCheckInCancelled ( FSourceControlOperationRef InOperat... )	Delegate called when the user has decided to cancel the check in process
void	ChoosePackagesToCheckInCompleted ( const TArray< UPackage* >& Lo..., const TArray< FString >& PackageNa..., const TArray< FString >& ConfigFil..., FCheckinResultInfo& OutResultInfo )	Called when the user selection process has completed and we have packages to check in.
void	DisplayRevisionHistory ( const TArray< FString >& InPackage... )	Display file revision history for the provided packages
TArray< FStr...	GetSourceControlLocations ( const bool bContentOnly )	Get the list of files and directories that source control should check when looking for changes.
bool	OnSubmitClicked ( TSharedRef< class SSourceControlSub... )	Delegate called when the user clicks submit.
bool	PromptForCheckin ( bool bUseSourceControlStateCache, const TArray< FString >& InPackage..., const TArray< FString >& InPending..., const TArray< FString >& InConfigF... )	Display check in dialog for the specified packages
bool	PromptForCheckin ( FCheckinResultInfo& OutResultInfo, const TArray< FString >& InPackage..., const TArray< FString >& InPending..., const TArray< FString >& InConfigF..., bool bUseSourceControlStateCache )	Display check in dialog for the specified packages and get additional result information
bool	PromptForRevert ( const TArray< FString >& InPackage... )	Prompt the user with a revert files dialog, allowing them to specify which packages, if any, should be reverted.

Constants

Name	Description
ChoosePackagesToCheckInNotification	The notification in place while we choose packages to check in

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

Take our survey

Dismiss