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
|
---|---|---|---|---|---|
FRevert::GetDeletedFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetDeletedFiles() const | [] |
|
FRevert::GetInProgressString | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Get the string to display when this operation is in progress | SourceControl | virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const | [] |
FRevert::GetName | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Get the name of this operation, used as a unique identifier | SourceControl | virtual [FName](API\Runtime\Core\UObject\FName) GetName() const | [] |
FRevert::IsRevertAll | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | bool IsRevertAll() const | [] |
|
FRevert::SetRevertAll | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | void SetRevertAll ( const bool bInRevertAll ) | [] |
|
FRevert::IsSoftRevert | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | bool IsSoftRevert() const | [] |
|
FRevert::SetSoftRevert | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | void SetSoftRevert ( const bool bInSoftRevert ) | [] |
|
FRevert::ShouldDeleteNewFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | bool ShouldDeleteNewFiles() const | [] |
|
FRevert | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Operation used to revert changes made back to the state they are in source control | SourceControl | class FRevert : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase) | [
{
"type": "bool",
"name": "bIsRevertAll",
"description": ""
},
{
"type": "bool",
"name": "bIsSoftRevert",
"description": ""
},
{
"type": "TArray<FString...",
"name": "DeletedFiles",
"description": ""
}
] |
FRevertUnchanged::GetInProgressString | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Get the string to display when this operation is in progress | SourceControl | virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const | [] |
FRevertUnchanged::GetName | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Get the name of this operation, used as a unique identifier | SourceControl | virtual [FName](API\Runtime\Core\UObject\FName) GetName() const | [] |
FRevertUnchanged | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Operation to revert unchanged file(s) or all unchanged files in a changelist | SourceControl | class FRevertUnchanged : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase) | [] |
FScopedSourceControl::GetProvider | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Get the provider we are using | SourceControl | [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & GetProvider() | [] |
FScopedSourceControl::~FScopedSourceControl | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Destructor; Closes Source Control Provider | SourceControl | ~FScopedSourceControl() | [] |
FScopedSourceControl::FScopedSourceControl | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Constructor; Initializes Source Control Provider | SourceControl | FScopedSourceControl() | [] |
FScopedSourceControl | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Helper class that ensures FSourceControl is properly initialized and shutdown by calling Init/Close in its constructor/destructor respectively. | SourceControl | class FScopedSourceControl | [] |
FScopedSourceControlProgress::Tick | /Engine/Source/Developer/SourceControl/Public/ScopedSourceControlProgress.h | Makes sure the dialog is ticked | SourceControl | void Tick() | [] |
FScopedSourceControlProgress | /Engine/Source/Developer/SourceControl/Public/ScopedSourceControlProgress.h | SourceControl | class FScopedSourceControlProgress | [] |
|
FShelve::GetDescription | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | const [FText](API\Runtime\Core\Internationalization\FText) & GetDescription() const | [] |
|
FScopedSourceControlProgress::~FScopedSourceControlProgress | /Engine/Source/Developer/SourceControl/Public/ScopedSourceControlProgress.h | Destructor - closes the dialog | SourceControl | ~FScopedSourceControlProgress() | [] |
FShelve::GetInProgressString | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Get the string to display when this operation is in progress | SourceControl | virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const | [] |
FShelve::GetName | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Get the name of this operation, used as a unique identifier | SourceControl | virtual [FName](API\Runtime\Core\UObject\FName) GetName() const | [] |
FShelve::SetDescription | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | SourceControl | void SetDescription ( const [FText](API\Runtime\Core\Internationalization\FText) & InDescription ) | [] |
|
FShelve | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Operation used to shelve files in a changelist | SourceControl | class FShelve : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase) | [] |
FAssetDataCache | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | SourceControl | typedef [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FSourceControlAssetDataEntry](API\Developer\SourceControl\FSourceControlAssetDataEntry) > FAssetDataCache | [] |
|
FSourceControlAssetDataCache::GetAssetDataArray | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | Attempt to get AssetData for the provided SourceControlled file.
True if processing is complete for the requested asset. False if the process is incomplete and AssetData could still be updated in the future. | SourceControl | bool GetAssetDataArray ( [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) InFileState, [FAssetDataArrayPtr](API\Developer\SourceControl\FAssetDataArrayPtr) & OutAssetDataArrayPtr ) | [] |
FSourceControlAssetDataCache::OnSourceControlDialogShown | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | Called when Source Control Dialog is shown. Prevents tasks to run while the dialog is opened. | SourceControl | void OnSourceControlDialogShown() | [] |
FSourceControlAssetDataCache::Shutdown | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | Called when SourceControl module is shutting down. | SourceControl | void Shutdown() | [] |
FSourceControlAssetDataCache::OnSourceControlDialogClosed | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | Called when Source Control Dialog is closed. Allow work to be resumed. | SourceControl | void OnSourceControlDialogClosed() | [] |
FScopedSourceControlProgress::FScopedSourceControlProgress | /Engine/Source/Developer/SourceControl/Public/ScopedSourceControlProgress.h | Constructor. Progress dialog is shown immediately (if possible) and is closed when this object goes out of scope. | SourceControl | FScopedSourceControlProgress ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, const FSimpleDelegate & InOnCancelled ) | [] |
FSourceControlAssetDataCache::Startup | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | Called when SourceControl module is starting up. | SourceControl | void Startup() | [] |
FSourceControlAssetDataCache::Tick | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | Called every update. | SourceControl | void Tick() | [] |
FSourceControlAssetDataCache | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | SourceControl | class FSourceControlAssetDataCache | [] |
|
FSourceControlAssetDataEntry | /Engine/Source/Developer/SourceControl/Public/SourceControlAssetDataCache.h | SourceControl | struct FSourceControlAssetDataEntry | [
{
"type": "FAssetDataArray...",
"name": "AssetDataArrayPtr",
"description": ""
},
{
"type": "bool",
"name": "bInitialized",
"description": ""
},
{
"type": "TFuture< void >",
"name": "FetchAssetDataTask",
"description": ""
}
] |
|
FSourceControlChangelistPtr | /Engine/Source/Developer/SourceControl/Public/ISourceControlChangelist.h | SourceControl | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlChangelist](API\Developer\SourceControl\ISourceControlChangelist), ESPMode::ThreadSafe > FSourceControlChangelistPtr | [] |
|
FSourceControlChangelistPtr | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | SourceControl | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlChangelist](API\Developer\SourceControl\ISourceControlChangelist), ESPMode::ThreadSafe > FSourceControlChangelistPtr | [] |
|
FSourceControlChangelistPtr | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | SourceControl | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlChangelist](API\Developer\SourceControl\ISourceControlChangelist), ESPMode::ThreadSafe > FSourceControlChangelistPtr | [] |
|
FSourceControlChangelistRef | /Engine/Source/Developer/SourceControl/Public/ISourceControlChangelist.h | SourceControl | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlChangelist](API\Developer\SourceControl\ISourceControlChangelist), ESPMode::ThreadSafe > FSourceControlChangelistRef | [] |
|
FSourceControlChangelistRef | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | SourceControl | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlChangelist](API\Developer\SourceControl\ISourceControlChangelist), ESPMode::ThreadSafe > FSourceControlChangelistRef | [] |
|
FSourceControlChangelistStatePtr | /Engine/Source/Developer/SourceControl/Public/ISourceControlChangelistState.h | SourceControl | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlChangelistState](API\Developer\SourceControl\ISourceControlChangelistState), ESPMode::ThreadSafe > FSourceControlChangelistStatePtr | [] |
|
FSourceControlChangelistStateRef | /Engine/Source/Developer/SourceControl/Public/ISourceControlChangelistState.h | SourceControl | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlChangelistState](API\Developer\SourceControl\ISourceControlChangelistState), ESPMode::ThreadSafe > FSourceControlChangelistStateRef | [] |
|
FSourceControlFilesDeletedDelegate | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Delegate called after source control operations deleted files. | SourceControl | typedef TMulticastDelegate_OneParam< void, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & > FSourceControlFilesDeletedDelegate | [] |
FOnSourceControlFileStatus | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Invoked when the status of a source controlled files is updated. The state can be null when the source control provider is changed. | SourceControl | typedef TBaseDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [ISourceControlState](API\Developer\SourceControl\ISourceControlState) * > FOnSourceControlFileStatus | [] |
FSourceControlFileStatusMonitor::GetMaxFilePerRequestPolicy | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SourceControl | int32 GetMaxFilePerRequestPolicy() const | [] |
|
FSourceControlFileStatusMonitor::GetMonitoredFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Returns the set of files being monitored by the specifed owner. | SourceControl | [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > GetMonitoredFiles ( uintptr_t OwnerId ) | [] |
FSourceControlFileStatusMonitor::GetNewRequestProbationPeriodPolicy | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SourceControl | [FTimespan](API\Runtime\Core\Misc\FTimespan) GetNewRequestProbationPeriodPolicy() const | [] |
|
FSourceControlFileStatusMonitor::GetStatusAge | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Returns the file status age, i.e. (now - last_status_update) if the file is monitored. If the initial status request hasn't been received yet, returns zero. | SourceControl | [TOptional](API\Runtime\Core\IO\TOptional)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > GetStatusAge ( const [FString](API\Runtime\Core\Containers\FString) & AbsPathname ) const | [] |
FSourceControlFileStatusMonitor::GetUpdateStatusPeriodPolicy | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SourceControl | [FTimespan](API\Runtime\Core\Misc\FTimespan) GetUpdateStatusPeriodPolicy() const | [] |
|
FSourceControlFileStatusMonitor::SetMaxFilePerRequestPolicy | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Sets the maximum number of files to batch into a single request.Bydefault, a maximum of 100 files status is requested. | SourceControl | void SetMaxFilePerRequestPolicy ( int32 MaxNum ) | [] |
FSourceControlFileStatusMonitor::SetMonitoringFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Starts monitoring files that weren't monitored yet by the specified owner, stops monitoring those that were monitored by the owner but are not in the updated list and keep monitoring files that were monitored before and still in the updated list. | SourceControl | void SetMonitoringFiles ( uintptr_t OwnerId, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > && AbsPathnames, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus ) | [] |
FSourceControlFileStatusMonitor::SetNewRequestProbationPeriodPolicy | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Set the times waited before a newly added file status request is sent to the source control provider. This is used batch several status for file added closed in time into a single server request, for example ifStartMonitoringFile()is called in a loop or when the user scroll a long list of files for which the status needs to be updated. Setting a value of 0 remove the probation period.Bydefault, the propbation period is 1 second. | SourceControl | void SetNewRequestProbationPeriodPolicy ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InPropbationPeriod ) | [] |
FSourceControlFileStatusMonitor::SetSuspendMonitoringPolicy | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Sets a function invoked to detect if the monitor should suspend its activities, for example, if no user is currently interacting with the application, it may not worth checking the file status periodically.Bydefault, the monitor will suspends if there are not Slate interaction within 5 minutes and resume at the next user interaction. | SourceControl | void SetSuspendMonitoringPolicy ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool()> IsMonitoringSuspended ) | [] |
FSourceControlFileStatusMonitor::SetUpdateStatusPeriodPolicy | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SetSuspendMonitoringPolicy | SourceControl | void SetUpdateStatusPeriodPolicy ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InRefreshPeriod ) | [] |
FSourceControlFileStatusMonitor::StartMonitoringFile | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | GetStatusAge() | SourceControl | void StartMonitoringFile ( uintptr_t OwnerId, const [FString](API\Runtime\Core\Containers\FString) & AbsPathname, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus ) | [] |
FSourceControlFileStatusMonitor::StartMonitoringFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SourceControl | void StartMonitoringFiles ( uintptr_t OwnerId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus ) | [] |
|
FSourceControlFileStatusMonitor::StartMonitoringFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SourceControl | void StartMonitoringFiles ( uintptr_t OwnerId, const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus ) | [] |
|
FSourceControlFileStatusMonitor::StopMonitoringFile | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | This can be called fron the FOnSourceControlFileStatus callback passed toStartMonitoringFile(). | SourceControl | void StopMonitoringFile ( uintptr_t OwnerId, const [FString](API\Runtime\Core\Containers\FString) & AbsPathname ) | [] |
FSourceControlFileStatusMonitor::StopMonitoringFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | Stops monitoring all the files that were registered by the specified owner Id. | SourceControl | void StopMonitoringFiles ( uintptr_t OwnerId ) | [] |
FSourceControlFileStatusMonitor::StopMonitoringFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | This can be called fron the FOnSourceControlFileStatus callback passed toStartMonitoringFile(). | SourceControl | void StopMonitoringFiles ( uintptr_t OwnerId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames ) | [] |
FSourceControlFileStatusMonitor::StopMonitoringFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | This can be called fron the FOnSourceControlFileStatus callback passed toStartMonitoringFile(). | SourceControl | void StopMonitoringFiles ( uintptr_t OwnerId, const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames ) | [] |
FSourceControlFileStatusMonitor::FSourceControlFileStatusMonitor | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SourceControl | FSourceControlFileStatusMonitor() | [] |
|
FSourceControlFileStatusMonitor::~FSourceControlFileStatusMonitor | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | SourceControl | virtual ~FSourceControlFileStatusMonitor() | [] |
|
FSourceControlFileStatusMonitor | /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h | 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. This service is meant to throttle and batch non-time sensitiveFUpdateStatusrequests to the source control provider because those requests are expensive and can add an undesired load on the provider server. | SourceControl | class FSourceControlFileStatusMonitor : public [TSharedFromThis< FSourceControlFileStatusMonitor >](API\Runtime\Core\Templates\TSharedFromThis) | [] |
FSourceControlInitSettings::CanReadFromConfigFile | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | bool CanReadFromConfigFile() const | [] |
|
FSourceControlInitSettings::AddSetting | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | void AddSetting ( FStringView SettingName, FStringView SettingValue ) | [] |
|
FSourceControlInitSettings::CanWriteToConfigFile | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | bool CanWriteToConfigFile() const | [] |
|
EConfigBehavior | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | enum EConfigBehavior { ReadWrite, ReadOnly, None, } | [] |
|
EBehavior | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | enum EBehavior { OverrideAll, OverrideExisting, } | [] |
|
FSourceControlInitSettings::HasOverrides | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | bool HasOverrides() const | [] |
|
FSourceControlInitSettings::IsOverridden | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | bool IsOverridden ( FStringView SettingName ) const | [] |
|
FSourceControlInitSettings::OverrideSetting | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | void OverrideSetting ( FStringView SettingName, [FString](API\Runtime\Core\Containers\FString) & InOutSettingValue ) | [] |
|
FSourceControlInitSettings::SetConfigBehavior | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | void SetConfigBehavior ( [EConfigBehavior](API\Developer\SourceControl\FSourceControlInitSettings\EConfigBehavior) Behavior ) | [] |
|
FSourceControlInitSettings::FSourceControlInitSettings | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | FSourceControlInitSettings ( [EBehavior](API\Developer\SourceControl\FSourceControlInitSettings\EBehavior) Behavior ) | [] |
|
FSourceControlInitSettings::~FSourceControlInitSettings | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | ~FSourceControlInitSettings() | [] |
|
FSourceControlInitSettings | /Engine/Source/Developer/SourceControl/Public/SourceControlInitSettings.h | SourceControl | class FSourceControlInitSettings | [] |
|
FSourceControlLoginClosed | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Delegate called when the source control login window is closed. Parameter determines if source control is enabled or not | SourceControl | typedef TBaseDelegate_OneParam< void, bool > FSourceControlLoginClosed | [] |
FSourceControlOperationBase::AddErrorMessge | /Engine/Source/Developer/SourceControl/Public/SourceControlOperationBase.h | Add error message. | SourceControl | virtual void AddErrorMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InError ) | [] |
FSourceControlOperationBase::AddInfoMessge | /Engine/Source/Developer/SourceControl/Public/SourceControlOperationBase.h | Add info/warning message. | SourceControl | virtual void AddInfoMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InInfo ) | [] |
FSourceControlOperationBase::AppendResultInfo | /Engine/Source/Developer/SourceControl/Public/SourceControlOperationBase.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 ) | [] |
FSourceControlOperationBase::AddTag | /Engine/Source/Developer/SourceControl/Public/SourceControlOperationBase.h | Add tag. | SourceControl | virtual void AddTag ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) | [] |
FSourceControlOperationBase::GetResultInfo | /Engine/Source/Developer/SourceControl/Public/SourceControlOperationBase.h | Retrieve any info or error messages that may have accumulated during the operation. | SourceControl | virtual const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & GetResultInfo() const | [] |
FSourceControlOperationBase | /Engine/Source/Developer/SourceControl/Public/SourceControlOperationBase.h | Adds some common functionality to source control operations. | SourceControl | class FSourceControlOperationBase : public [ISourceControlOperation](API\Developer\SourceControl\ISourceControlOperation) | [
{
"type": "FSourceControlR...",
"name": "ResultInfo",
"description": ""
}
] |
FSourceControlOperationComplete | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Delegate used by providers for when operations finish | SourceControl | typedef TBaseDelegate_TwoParams< void, const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) &, [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) > FSourceControlOperationComplete | [] |
FSourceControlOperationRef | /Engine/Source/Developer/SourceControl/Public/ISourceControlOperation.h | SourceControl | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlOperation](API\Developer\SourceControl\ISourceControlOperation), ESPMode::ThreadSafe > FSourceControlOperationRef | [] |
|
FSourceControlPreSubmitDataValidationDelegate | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Delegate called on pre-submit for data validation | SourceControl | typedef TBaseDelegate_FourParams< void, [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr), EDataValidationResult &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & > FSourceControlPreSubmitDataValidationDelegate | [] |
FSourceControlPreSubmitFinalizeDelegate | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Delegate called once the user has confirmed that they want to submit files to source control BUT before the files are actually submitted. It is intended for last minute checks that can only run once there is no chance of the user canceling the actual submit. At this point the only way to prevent the files from being submitted is for this delegate to return errors. | SourceControl | typedef TMulticastDelegate_ThreeParams< void, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & > FSourceControlPreSubmitFinalizeDelegate | [] |
FSourceControlProviderChanged | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Delegate called when the active source control provider is changed | SourceControl | typedef TMulticastDelegate_TwoParams< void, [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) &, [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & > FSourceControlProviderChanged | [] |
FSourceControlProjectDirDelegate | /Engine/Source/Developer/SourceControl/Public/ISourceControlModule.h | Delegate used to specify the project base directory to be used by the source control | SourceControl | typedef TBaseDelegate_NoParams< [FString](API\Runtime\Core\Containers\FString) > FSourceControlProjectDirDelegate | [] |
FSourceControlResultInfo::Append | /Engine/Source/Developer/SourceControl/Public/SourceControlResultInfo.h | Append any messages from anotherFSourceControlResultInfo, ensuring to keep any already accumulated info. | SourceControl | void Append ( const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & InResultInfo ) | [] |
FSourceControlResultInfo::DidConnectionFail | /Engine/Source/Developer/SourceControl/Public/SourceControlResultInfo.h | SourceControl | bool DidConnectionFail() const | [] |
|
EAdditionalErrorContext | /Engine/Source/Developer/SourceControl/Public/SourceControlResultInfo.h | SourceControl | enum EAdditionalErrorContext { None = 0, ConnectionFailed = 1 << 0, ConnectionDropped = 1 << 1, } | [] |
|
FSourceControlResultInfo::OnConnectionDroped | /Engine/Source/Developer/SourceControl/Public/SourceControlResultInfo.h | SourceControl | void OnConnectionDroped() | [] |
|
FSourceControlResultInfo::OnConnectionFailed | /Engine/Source/Developer/SourceControl/Public/SourceControlResultInfo.h | SourceControl | void OnConnectionFailed() | [] |
|
FSourceControlResultInfo | /Engine/Source/Developer/SourceControl/Public/SourceControlResultInfo.h | Accumulated error and info messages for a source control operation. | SourceControl | struct FSourceControlResultInfo | [
{
"type": "TArray<FText>",
"name": "ErrorMessages",
"description": "Potential error message storage"
},
{
"type": "TArray<FText>",
"name": "InfoMessages",
"description": "Info and/or warning message storage"
},
{
"type": "TArray<FString...",
"name": "Tags",
"description": "Additional arbitrary information attached to the command"
}
] |
FSourceControlState::FSourceControlState | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | SourceControl | FSourceControlState() | [] |
|
FSourceControlState | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | USourceControlHelpers::QueryFileState() | SourceControl | struct FSourceControlState | [
{
"type": "bool",
"name": "bCanAdd",
"description": "Determine if this file can be added to source control (i.e. is part of the directory structure currently under source control)"
},
{
"type": "bool",
"name": "bCanCheckIn",
"description": "Determine if this file can be checked in."
},
{
"type": "bool",
"name": "bCanCheckOut",
"description": "Determine if this file can be checked out"
},
{
"type": "bool",
"name": "bCanDelete",
"description": "Determine if source control allows this file to be deleted."
},
{
"type": "bool",
"name": "bCanEdit",
"description": "Determine if source control allows this file to be edited"
},
{
"type": "bool",
"name": "bCanRevert",
"description": "Determine if this file can be reverted, i.e. discard changes and the file will no longer be checked-out."
},
{
"type": "bool",
"name": "bIsAdded",
"description": "Determine if this file is marked for add"
}
] |
FSourceControlStateChanged | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h | Delegate called when the state of an item (or group of items) has changed. | SourceControl | typedef TMulticastDelegate_NoParams< void > FSourceControlStateChanged | [] |
FSourceControlStatePtr | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | SourceControl | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlState](API\Developer\SourceControl\ISourceControlState), ESPMode::ThreadSafe > FSourceControlStatePtr | [] |
|
FSourceControlStateRef | /Engine/Source/Developer/SourceControl/Public/ISourceControlState.h | SourceControl | typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlState](API\Developer\SourceControl\ISourceControlState), ESPMode::ThreadSafe > FSourceControlStateRef | [] |
|
FSync::GetInProgressString | /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h | Get the string to display when this operation is in progress | SourceControl | virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.