1. Epic GamesDeveloper
  3. SourceControl

SourceControl

Unreal Engine C++ API Reference > Developer

Filters

Classes

  Type Name Description
Public class FAnnotationLine A single line of an annotated file  
Public struct FAssetDataToLoad    
Public class FCheckIn Operation used to check files into source control  
Public class FCheckOut Operation used to check files out of source control  
Public class FConnect Operation used to connect (or test a connection) to source control  
Public class FCopy Operation used to copy a file or directory from one location to another  
Public class FCreateWorkspace Operation used to create a new workspace if the source control system supports this functionality.  
Public class FDelete Operation used to mark files for delete in source control  
Public class FDeleteChangelist Operation used to delete an empty changelist  
Public class FDeleteShelved Operation used to delete shelved files from a changelist  
Public class FDeleteWorkspace Operation used to delete a workspace  
Public class FDownloadFile Operation used to download a file from the source control server directly rather than sync it.  
Public class FEditChangelist Operation to change the description of a changelist  
Public class FGetChangelistDetails This operations query the source control to extract all the details available for a given changelist.  
Public class FGetFile This operation uses p4v print command to get file from specified depot by shelved changelist or file revision returns a package filename  
Public class FGetFileList Operation used to get the file list of a folder out of source control  
Public class FGetPendingChangelists Operation used to retrieve pending changelist(s).  
Public class FGetSubmittedChangelists Operation used to retrieve submitted changelist(s).  
Public class FMarkForAdd Operation used to mark files for add in source control  
Public class FMoveToChangelist Operation used to move files between changelists  
Public class FNewChangelist Operation used to create a new changelist  
Public class FResolve Operation used to resolve a file that is in a conflicted state.  
Public class FRevert Operation used to revert changes made back to the state they are in source control  
Public class FRevertUnchanged Operation to revert unchanged file(s) or all unchanged files in a changelist  
Public class FScopedSourceControl Helper class that ensures FSourceControl is properly initialized and shutdown by calling Init/Close in its constructor/destructor respectively.  
Public class FScopedSourceControlProgress    
Public class FShelve Operation used to shelve files in a changelist  
Public class FSourceControlAssetDataCache    
Public struct FSourceControlAssetDataEntry    
Public class FSourceControlFileStatusMonitor Periodically monitors the source controlled status of a collection of files and notifies the latest status, including potential warnings such as 'out of date', 'locked by other', etc.  
Public class FSourceControlInitSettings    
Public class FSourceControlOperationBase Adds some common functionality to source control operations.  
Public struct FSourceControlResultInfo Accumulated error and info messages for a source control operation.  
Public struct FSourceControlState Snapshot of source control state of a file  
Public class FSync Operation used to sync files to the state they are in source control  
Public class FSyncPreview Operation used to determine the files that would be affected by a sync operation  
Public class FUnshelve Operation used to unshelve files from a changelist  
Public class FUpdatePendingChangelistsStatus Operation used to update the source control status of changelist(s)  
Public class FUpdateStatus Operation used to update the source control status of files  
Public class ISourceControlChangelist An abstraction of a changelist under source control  
Public class ISourceControlChangelistState An abstraction of the state of a pending changelist under source control  
Public class ISourceControlLabel Abstraction of a source control label/tag.  
Public class ISourceControlModule Interface for talking to source control providers  
Public class ISourceControlOperation    
Public class ISourceControlProvider Interface to talking with source control providers.  
Public class ISourceControlRevision Abstraction of a source control revision.  
Public class ISourceControlState An abstraction of the state of a file under source control  
Public class USourceControlHelpers Editor source control common functionality.  
Public class USourceControlPreferences Settings for the Source Control Integration  

Typedefs

Name Description
FAssetDataArrayPtr  
FGetSourceControlOperation Delegate used by providers to create source control operations
FOnPostCheckOut Delegate used for performing operation on files that may need a checkout, but before they are added to source control
FSourceControlChangelistPtr  
FSourceControlChangelistPtr  
FSourceControlChangelistPtr  
FSourceControlChangelistRef  
FSourceControlChangelistRef  
FSourceControlChangelistStatePtr  
FSourceControlChangelistStateRef  
FSourceControlFilesDeletedDelegate Delegate called after source control operations deleted files.
FSourceControlLoginClosed Delegate called when the source control login window is closed.
FSourceControlOperationComplete Delegate used by providers for when operations finish
FSourceControlOperationRef  
FSourceControlPreSubmitDataValidationDelegate Delegate called on pre-submit for data validation
FSourceControlPreSubmitFinalizeDelegate Delegate called once the user has confirmed that they want to submit files to source control BUT before the files are actually submitted.
FSourceControlProjectDirDelegate Delegate used to specify the project base directory to be used by the source control
FSourceControlProviderChanged Delegate called when the active source control provider is changed
FSourceControlStateChanged Delegate called when the state of an item (or group of items) has changed.
FSourceControlStatePtr  
FSourceControlStateRef  
SourceControlHelpers For backwards compatibility.

Enums

  Type Name Description
Public enum ECommandResult::Type Results of a command execution  
Public enum EConcurrency::Type Hint for how to execute the operation.  
Public enum ELoginWindowMode::Type The modality of the login window.  
Public enum EOnLoginWindowStartup::Type Login window startup behavior  
Public enum EStateCacheUsage::Type Hint to provider when updating state  

Functions

  Type Name Description
Public function constexpr bool  
Public function constexpr FSourceControlResultInfo::EAdditionalErrorContext  
Public function FSourceControlResultInfo::EAdditionalErrorContext &  
Public function constexpr FSourceControlResultInfo::EAdditionalErrorContext  
Public function FSourceControlResultInfo::EAdditionalErrorContext &  
Public function constexpr FSourceControlResultInfo::EAdditionalErrorContext  
Public function FSourceControlResultInfo::EAdditionalErrorContext &  
Public function constexpr FSourceControlResultInfo::EAdditionalErrorContext  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page