1. Epic GamesDeveloper
  3. FSourceControlWindows

FSourceControlWindows

API > API/Editor > API/Editor/SourceControlWindows

References

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

Syntax

class FSourceControlWindows

Functions

  Type Name Description
Public function Static bool Determines whether we can choose packages to check in (we can't if an operation is already in progress)
Public function Static bool Determines whether we can sync to latest
Public function Static bool

ChoosePackagesToCheckIn ( const FSourceControlWindowsOnCheckInComplete& OnCompleteDelegate
)

 Opens a user dialog to choose packages to submit.
Protected function Static void

ChoosePackagesToCheckInCallback ( const FSourceControlOperationRef& InOperation,
ECommandResult::Type InResult,
FSourceControlWindowsOnCheckInComplete OnCompleteDelegate
)

 Callback for ChoosePackagesToCheckIn(), continues to bring up UI once source control operations are complete
Protected function Static void Delegate called when the user has decided to cancel the check in process
Protected function Static void

ChoosePackagesToCheckInCompleted ( const TArray< UPackage* >& LoadedPackages,
const TArray< FString >& PackageNames,
const TArray< FString >& ConfigFiles,
FCheckinResultInfo& OutResultInfo
)

 Called when the user selection process has completed and we have packages to check in.
Public function Static bool Displays file diff against shelved file
Public function Static bool

DiffAgainstWorkspace ( const FString& InFileName
)

 Displays file diff against workspace version
Public function Static void

DisplayRevisionHistory ( const TArray< FString >& InPackagesNames
)

 Display file revision history for the provided packages
Protected function Static bool

OnSubmitClicked ( TSharedRef< class SSourceControlSubmitWidget > SourceControlWidget
)

 Delegate called when the user clicks submit.
Public function Static bool

PromptForCheckin ( bool bUseSourceControlStateCache,
const TArray< FString >& InPackageNames,
const TArray< FString >& InPendingDeletePaths,
const TArray< FString >& InConfigFiles
)

 Display check in dialog for the specified packages
Public function Static bool

PromptForCheckin ( FCheckinResultInfo& OutResultInfo,
const TArray< FString >& InPackageNames,
const TArray< FString >& InPendingDeletePaths,
const TArray< FString >& InConfigFiles,
bool bUseSourceControlStateCache
)

 Display check in dialog for the specified packages and get additional result information
Public function Static bool

PromptForRevert ( const TArray< FString >& InPackageNames,
bool bInReloadWorld
)

 Prompt the user with a revert files dialog, allowing them to specify which packages, if any, should be reverted.
Public function Static bool Revert all locally modified files, and reload the world
Public function Static bool Determines if the Submit Content action should be visible or not
Public function Static bool Saves all unsaved levels and assets and then - conditionally - performs an FSync operation to get latest and reloads the world

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page