className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
ISourceControlModule::RegisterProviderChanged | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Register a delegate to be called when the source control provider changes | SourceControl | [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterProviderChanged ( const FSourceControlProviderChanged::FDelegate & SourceControlProviderChanged ) | [] |
ISourceControlModule::RegisterSourceControlProjectDirDelegate | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Register a delegate used to specify the project base directory to be used by the source control | SourceControl | void RegisterSourceControlProjectDirDelegate ( const [FSourceControlProjectDirDelegate](API\Developer\SourceControl\FSourceControlProjectDirDelegate) & SourceControlProjectDirDelegate ) | [] |
ISourceControlModule::SetProvider | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Set the current source control provider to the one specified here by name. This will assert if the provider does not exist. | SourceControl | void SetProvider ( const [FName](API\Runtime\Core\UObject\FName) & InName ) | [] |
ISourceControlModule::SetUseGlobalSettings | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Set whether we should use global or per-project settings | SourceControl | void SetUseGlobalSettings ( bool bIsUseGlobalSettings ) | [] |
ISourceControlModule::ShowLoginDialog | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Show the source control login dialog | SourceControl | void ShowLoginDialog ( const [FSourceControlLoginClosed](API\Developer\SourceControl\FSourceControlLoginClosed) & InOnSourceControlLoginClosed, [ELoginWindowMode::Type](API\Developer\SourceControl\ELoginWindowMode__Type) InLoginWindowMode, [EOnLoginWindowStartup::Type](API\Developer\SourceControl\EOnLoginWindowStartup__Type) InOnLoginWindowStartup ) | [] |
ISourceControlModule::Tick | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Tick the source control module. This is responsible for dispatching batched/queued status requests & for callingISourceControlProvider::Tick() | SourceControl | void Tick() | [] |
ISourceControlModule::UnregisterFilesDeleted | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | FSourceControlFilesDeletedDelegate | SourceControl | void UnregisterFilesDeleted ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle ) | [] |
ISourceControlModule::UnregisterPreSubmitDataValidation | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Unregister a delegate called before submitting changes | SourceControl | void UnregisterPreSubmitDataValidation() | [] |
ISourceControlModule::UnregisterPreSubmitFinalize | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | FSourceControlPreSubmitFinalizeDelegate | SourceControl | void UnregisterPreSubmitFinalize ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle ) | [] |
ISourceControlModule::UnregisterSourceControlProjectDirDelegate | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Unregister the FSourceControlProjectDirDelegate delegate | SourceControl | void UnregisterSourceControlProjectDirDelegate() | [] |
ISourceControlModule::UsesCustomProjectDir | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Returns whether a delegate has been registered to specify the project base directory to be used by the source control | SourceControl | bool UsesCustomProjectDir() const | [] |
ISourceControlModule | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Interface for talking to source control providers | SourceControl | class ISourceControlModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
ISourceControlOperation::AddErrorMessge | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Add error message. | SourceControl | virtual void AddErrorMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InError ) | [] |
ISourceControlOperation::AddInfoMessge | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Add info/warning message. | SourceControl | virtual void AddInfoMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InInfo ) | [] |
ISourceControlOperation::AddTag | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Add tag. | SourceControl | virtual void AddTag ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) | [] |
ISourceControlOperation::AppendResultInfo | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Append any info or error messages that may have accumulated during the operation prior to returning a result, ensuring to keep any already accumulated info. | SourceControl | virtual void AppendResultInfo ( const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & InResultInfo ) | [] |
ISourceControlOperation::CanBeCalledFromBackgroundThreads | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | This will return true if the operation can be safely called from a background thread. Currently it is assumed to only the operation 'FDownloadFile' will return true at least until the API is made thread safe. | SourceControl | virtual bool CanBeCalledFromBackgroundThreads() const | [] |
ISourceControlOperation::Create | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Factory method for easier operation creation | SourceControl | template<typename Type, typename... TArgs> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< Type, ESPMode::ThreadSafe > Create ( TArgs &&... Args ) | [] |
ISourceControlOperation::GetInProgressString | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Get the string to display when this operation is in progress | SourceControl | virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const | [] |
ISourceControlModule::UnregisterProviderChanged | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Unregister a delegate to be called when the source control provider changes | SourceControl | void UnregisterProviderChanged ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle ) | [] |
ISourceControlOperation::GetName | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Get the name of this operation, used as a unique identifier | SourceControl | [FName](API\Runtime\Core\UObject\FName) GetName() const | [] |
ISourceControlOperation::GetResultInfo | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Retrieve any info or error messages that may have accumulated during the operation. | SourceControl | virtual const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & GetResultInfo() const | [] |
ISourceControlOperation::~ISourceControlOperation | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | Virtual destructor | SourceControl | virtual ~ISourceControlOperation() | [] |
ISourceControlOperation | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | SourceControl | class ISourceControlOperation : public [TSharedFromThis< ISourceControlOperation, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis) | [] |
|
ISourceControlProvider::AllowsDiffAgainstDepot | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Whether the provider allow a diff between a changed file and the depot | SourceControl | bool AllowsDiffAgainstDepot() const | [] |
ISourceControlProvider::CanCancelOperation | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Check to see if we can cancel an operation.
true if the operation was cancelled. | SourceControl | bool CanCancelOperation ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation ) const | [] |
ISourceControlProvider::CancelOperation | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Attempt to cancel an operation in progress. | SourceControl | void CancelOperation ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation ) | [] |
ISourceControlProvider::CanExecuteOperation | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Check to see if we can execute an operation.
true if the operation can be executed. | SourceControl | bool CanExecuteOperation ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation ) const | [] |
ISourceControlProvider::Close | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Shut down source control provider. | SourceControl | void Close() | [] |
ISourceControlProvider::Create | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | ISourceControlModule::CreateProvider | SourceControl | virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) > Create ( const FStringView & OwnerName, const [FSourceControlInitSettings](API\Developer\SourceControl\FSourceControlInitSettings) & InitialSettings ) const | [] |
EStatus | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | SourceControl | enum EStatus { Enabled, Connected, Port, User, Client, Repository, Remote, Branch, Email, ScmVersion, PluginVersion, Workspace, WorkspacePath, Changeset, } | [] |
|
ISourceControlProvider::Execute | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for operation execution, seeExecute(). | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::Execute | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for operation execution, seeExecute(). | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::Execute | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for operation execution, seeExecute(). | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::Execute | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for operation execution, seeExecute(). | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [FString](API\Runtime\Core\Containers\FString) & InFile, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::Execute | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for operation execution, seeExecute(). | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr) InChangelist, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::Execute | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for operation execution, seeExecute(). | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [TArray](API\Runtime\Core\Containers\TArray)< [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > & InPackages, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::Execute | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Attempt to execute an operation on the passed-in files (if any are required).
the result of the operation. | SourceControl | [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr) InChangelist, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::GetCachedStateByPredicate | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get all cached source control state objects for which the supplied predicate returns true | SourceControl | [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > GetCachedStateByPredicate ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) &)> Predicate ) const | [] |
ISourceControlProvider::GetChangelists | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Returns the list of available changelists if the underlying source control supports the 'changelist' concept. | SourceControl | [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) > GetChangelists ( [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage ) | [] |
ISourceControlProvider::GetLabel | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get a label matching the passed-in name.
the label, if any | SourceControl | virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlLabel](API\Developer\SourceControl\ISourceControlLabel) > GetLabel ( const [FString](API\Runtime\Core\Containers\FString) & InLabelName ) const | [] |
ISourceControlProvider::GetLabels | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get an array of labels matching the passed-in spec.
an array of labels matching the spec. | SourceControl | [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlLabel](API\Developer\SourceControl\ISourceControlLabel) > > GetLabels ( const [FString](API\Runtime\Core\Containers\FString) & InMatchingSpec ) const | [] |
ISourceControlProvider::GetName | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get the source control provider name | SourceControl | const [FName](API\Runtime\Core\UObject\FName) & GetName() const | [] |
ISourceControlProvider::GetNumLocalChanges | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Returns the number of changes in the local workspace NOTE: This concept is currently only implemented for the Skein source control provider.
The result of the operation if supported by the provider | SourceControl | [TOptional](API\Runtime\Core\IO\TOptional)< int > GetNumLocalChanges() const | [] |
ISourceControlProvider::GetState | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for state retrieval, seeGetState(). | SourceControl | virtual [FSourceControlStatePtr](API\Developer\SourceControl\FSourceControlStatePtr) GetState ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage ) | [] |
ISourceControlProvider::GetState | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for state retrieval, seeGetState(). | SourceControl | virtual [FSourceControlStatePtr](API\Developer\SourceControl\FSourceControlStatePtr) GetState ( const [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage ) | [] |
ISourceControlProvider::GetState | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for state retrieval, seeGetState(). | SourceControl | virtual [FSourceControlChangelistStatePtr](API\Developer\SourceControl\FSourceControlChangelistStatePtr) GetState ( const [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) & InChangelist, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage ) | [] |
ISourceControlProvider::GetState | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get the state of each of the passed-in files. State may be cached for faster queries. Note states can be NULL!
the result of the operation. | SourceControl | [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) GetState ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > & OutState, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage ) | [] |
ISourceControlProvider::GetState | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Helper overload for state retrieval, seeGetState(). | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) GetState ( const [TArray](API\Runtime\Core\Containers\TArray)< [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > & InPackages, [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > & OutState, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage ) | [] |
ISourceControlProvider::GetState | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get the state of each of the passed-in changelists. State may be cached for faster queries. Note states can be NULL!
the result of the operation. | SourceControl | [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) GetState ( const [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) > & InChangelists, [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistStateRef](API\Developer\SourceControl\FSourceControlChangelistStateRef) > & OutState, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage ) | [] |
ISourceControlProvider::GetStateBranchIndex | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Gets the state index of the specified branch, higher index branches are generally closer to releases
the index of the specified branch | SourceControl | int32 GetStateBranchIndex ( const [FString](API\Runtime\Core\Containers\FString) & BranchName ) const | [] |
ISourceControlProvider::GetStatus | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get the source control status as a series of key value pairs | SourceControl | [TMap](API\Runtime\Core\Containers\TMap)< [EStatus](API\Developer\SourceControl\ISourceControlProvider\EStatus), [FString](API\Runtime\Core\Containers\FString) > GetStatus() const | [] |
ISourceControlProvider::GetStatusText | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Get the source control status as plain, human-readable text | SourceControl | [FText](API\Runtime\Core\Internationalization\FText) GetStatusText() const | [] |
ISourceControlProvider::Init | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Initialize source control provider. | SourceControl | void Init ( bool bForceConnection ) | [] |
ISourceControlProvider::IsAtLatestRevision | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | This concept is currently only implemented for the Skein source control provider.
The result of the operation if supported by the provider | SourceControl | [TOptional](API\Runtime\Core\IO\TOptional)< bool > IsAtLatestRevision() const | [] |
ISourceControlProvider::IsAvailable | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Quick check if source control is available for use (server-based providers can use this to return whether the server is available or not)
true if source control is available, false if it is not | SourceControl | bool IsAvailable() const | [] |
ISourceControlProvider::IsEnabled | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Quick check if source control is enabled. Specifically, it returns true if a source control provider is set (regardless of whether the provider is available) and false if no provider is set. So all providers except the stub DefalutSourceProvider will return true. | SourceControl | bool IsEnabled() const | [] |
ISourceControlProvider::Login | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Login to the source control server (if any). This is just a wrapper aroundExecute().
the result of the operation. | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Login ( const [FString](API\Runtime\Core\Containers\FString) & InPassword, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate ) | [] |
ISourceControlProvider::MakeSettingsWidget | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Create a settings widget for display in the login window.
a widget used to edit the providers settings required prior to connection. | SourceControl | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MakeSettingsWidget() const | [] |
ISourceControlProvider::QueryStateBranchConfig | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Queries branch configuration from source control | SourceControl | bool QueryStateBranchConfig ( const [FString](API\Runtime\Core\Containers\FString) & ConfigSrc, const [FString](API\Runtime\Core\Containers\FString) & ConfigDest ) | [] |
ISourceControlProvider::RegisterSourceControlStateChanged_Handle | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Register a delegate to be called when source control state(s) change | SourceControl | [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterSourceControlStateChanged_Handle ( const FSourceControlStateChanged::FDelegate & SourceControlStateChanged ) | [] |
ISourceControlProvider::RegisterStateBranches | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Register branches to query for state in addition to the current branch | SourceControl | void RegisterStateBranches ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & BranchNames, const [FString](API\Runtime\Core\Containers\FString) & ContentRoot ) | [] |
ISourceControlProvider::SwitchWorkspace | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Used to switch the provider from one workspace to another. NOTE: This concept is currently only implemented for the perforce source control provider.
The result of the operation. | SourceControl | virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) SwitchWorkspace ( FStringView NewWorkspaceName, [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & OutResultInfo, [FString](API\Runtime\Core\Containers\FString) * OutOldWorkspaceName ) | [] |
ISourceControlProvider::Tick | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Called every update. | SourceControl | void Tick() | [] |
ISourceControlProvider::TryToDownloadFileFromBackgroundThread | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Executes theFDownloadFileoperation, but unlike theExecutemethod this can be called from a background thread, this works becauseFDownloadFileis thread safe and it does not change the state of source control. NOTE: This is only intended for use by the virtualization module and will be deprecated at some point in the future when thread safety is built into the system. NOTE: This is only implemented for the perforce source control provider with no plans to extend this to other providers.
True if the operation was a success, otherwise false. | SourceControl | bool TryToDownloadFileFromBackgroundThread ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FDownloadFile](API\Developer\SourceControl\FDownloadFile) > & InOperation, const [FString](API\Runtime\Core\Containers\FString) & InFile ) | [] |
ISourceControlProvider::TryToDownloadFileFromBackgroundThread | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Executes theFDownloadFileoperation, but unlike theExecutemethod this can be called from a background thread, this works becauseFDownloadFileis thread safe and it does not change the state of source control. NOTE: This is only intended for use by the virtualization module and will be deprecated at some point in the future when thread safety is built into the system. NOTE: This is only implemented for the perforce source control provider with no plans to extend this to other providers.
True if the operation was a success, otherwise false. | SourceControl | virtual bool TryToDownloadFileFromBackgroundThread ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FDownloadFile](API\Developer\SourceControl\FDownloadFile) > & InOperation, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles ) | [] |
ISourceControlProvider::UnregisterSourceControlStateChanged_Handle | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Unregister a delegate to be called when source control state(s) change | SourceControl | void UnregisterSourceControlStateChanged_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle ) | [] |
ISourceControlProvider::UsesChangelists | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Whether the provider uses changelists to identify commits/revisions | SourceControl | bool UsesChangelists() const | [] |
ISourceControlProvider::UsesCheckout | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Whether the provider uses the checkout workflow | SourceControl | bool UsesCheckout() const | [] |
ISourceControlProvider::UsesFileRevisions | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Whether the provider uses individual file revisions | SourceControl | bool UsesFileRevisions() const | [] |
ISourceControlProvider::UsesLocalReadOnlyState | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Whether the provider uses local read-only state to signal whether a file is editable. | SourceControl | bool UsesLocalReadOnlyState() const | [] |
ISourceControlProvider::UsesSnapshots | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Whether the provider uses snapshots | SourceControl | bool UsesSnapshots() const | [] |
ISourceControlProvider::UsesUncontrolledChangelists | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Whether the provider supports uncontrolled changelists to allow work offline | SourceControl | bool UsesUncontrolledChangelists() const | [] |
ISourceControlProvider::~ISourceControlProvider | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Virtual destructor | SourceControl | virtual ~ISourceControlProvider() | [] |
ISourceControlProvider | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Interface to talking with source control providers. | SourceControl | class ISourceControlProvider : public [IModularFeature](API\Runtime\Core\Features\IModularFeature) | [] |
ISourceControlRevision::Get | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Get this revision of the file & store it in a temp file.
true if the operation succeeded. | SourceControl | bool Get ( [FString](API\Runtime\Core\Containers\FString) & InOutFilename, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency ) const | [] |
ISourceControlRevision::GetAction | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Action taken to the file this revision (branch/integrate/edit/etc.) | SourceControl | const [FString](API\Runtime\Core\Containers\FString) & GetAction() const | [] |
ISourceControlRevision::GetAnnotated | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Get an annotated revision of the file & store it in a temp file.
true if the operation succeeded. | SourceControl | bool GetAnnotated ( [TArray](API\Runtime\Core\Containers\TArray)< [FAnnotationLine](API\Developer\SourceControl\FAnnotationLine) > & OutLines ) const | [] |
ISourceControlRevision::GetAnnotated | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Get an annotated revision of the file & store it in a temp file.
true if the operation succeeded. | SourceControl | bool GetAnnotated ( [FString](API\Runtime\Core\Containers\FString) & InOutFilename ) const | [] |
ISourceControlRevision::GetBranchSource | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Source of branch, if any | SourceControl | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > GetBranchSource() const | [] |
ISourceControlRevision::GetCheckInIdentifier | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Changelist number/revision number of the revision - an identifier for the check-in | SourceControl | int32 GetCheckInIdentifier() const | [] |
ISourceControlRevision::GetClientSpec | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Workspace/Clientspec of the submitter (if any) | SourceControl | const [FString](API\Runtime\Core\Containers\FString) & GetClientSpec() const | [] |
ISourceControlRevision::GetDate | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Date of the revision | SourceControl | const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetDate() const | [] |
ISourceControlRevision::GetDescription | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Changelist/Commit description | SourceControl | const [FString](API\Runtime\Core\Containers\FString) & GetDescription() const | [] |
ISourceControlRevision::GetFilename | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Get the local filename of this file. | SourceControl | const [FString](API\Runtime\Core\Containers\FString) & GetFilename() const | [] |
ISourceControlRevision::GetRevision | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | String representation of the revision | SourceControl | const [FString](API\Runtime\Core\Containers\FString) & GetRevision() const | [] |
ISourceControlRevision::GetFileSize | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | File size of the revision (0 if the file was deleted) | SourceControl | int32 GetFileSize() const | [] |
ISourceControlRevision::GetRevisionNumber | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Number of the revision | SourceControl | int32 GetRevisionNumber() const | [] |
ISourceControlRevision::GetUserName | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | User name of the submitter | SourceControl | const [FString](API\Runtime\Core\Containers\FString) & GetUserName() const | [] |
ISourceControlRevision::~ISourceControlRevision | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Virtual destructor | SourceControl | virtual ~ISourceControlRevision() | [] |
ISourceControlRevision | /Engine/Source/Developer/SourceControl/Public/ISourceControlRevision.h | Abstraction of a source control revision. | SourceControl | class ISourceControlRevision : public [TSharedFromThis< ISourceControlRevision, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis) | [] |
ISourceControlState::CanAdd | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Get whether this file can be added to source control (i.e. is part of the directory structure currently under source control) | SourceControl | bool CanAdd() const | [] |
ISourceControlState::CanCheckIn | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Get whether this file can be checked in. | SourceControl | bool CanCheckIn() const | [] |
ISourceControlState::CanCheckout | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Get whether this file can be checked out | SourceControl | bool CanCheckout() const | [] |
ISourceControlState::CanDelete | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Get whether source control allows this file to be deleted. | SourceControl | bool CanDelete() const | [] |
ISourceControlState::CanEdit | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Get whether source control allows this file to be edited | SourceControl | bool CanEdit() const | [] |
ISourceControlState::CanRevert | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Get whether this file can be reverted, i.e. its changes are discarded and the file will no longer be checked-out. | SourceControl | bool CanRevert() const | [] |
ISourceControlState::FindHistoryRevision | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Find an item from the history with the specified revision number.
a history item or NULL if the item could not be found | SourceControl | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > FindHistoryRevision ( int32 RevisionNumber ) const | [] |
ISourceControlState::FindHistoryRevision | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | Find an item from the history with the specified revision.
a history item or NULL if the item could not be found | SourceControl | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > FindHistoryRevision ( const [FString](API\Runtime\Core\Containers\FString) & InRevision ) const | [] |
ISourceControlState::FResolveInfo::operator bool | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | SourceControl | operator bool&40;&41; const | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.