Navigation
API > API/Developer > API/Developer/Localization
| Name | FLocalizationSCC |
| Type | class |
| Header File | /Engine/Source/Developer/Localization/Public/LocalizationSourceControlUtil.h |
| Include Path | #include "LocalizationSourceControlUtil.h" |
Syntax
class FLocalizationSCC
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLocalizationSCC() |
LocalizationSourceControlUtil.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FLocalizationSCC() |
LocalizationSourceControlUtil.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CheckedOutFiles | TSet< FString > | Set of files that were checked-out from SCC via CheckOutFile | LocalizationSourceControlUtil.h | |
| DeferredCheckedOutFiles | TSet< FString > | Set of files that will be checked-out from SCC via CheckOutFile, but had to be deferred due to running in parallel mode | LocalizationSourceControlUtil.h | |
| FilesMutex | UE::FMutex | Mutex protecting CheckedOutFiles and DeferredCheckedOutFiles when ParallelTasksCount > 0 | LocalizationSourceControlUtil.h | |
| ParallelTasksCount | std::atomic< uint16 > | >0 if this we're being used from a parallel tasks block, and need to defer check-out requests | LocalizationSourceControlUtil.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginParallelTasks() |
Start a block of parallel tasks (may be nested); this will defer check-out requests until the final EndParallelTasks is called | LocalizationSourceControlUtil.h | |
| Attempt to check-in every file that is currently tracked as checked-out; this cannot be called during a parallel tasks block | LocalizationSourceControlUtil.h | ||
| Attempt to check-out the given file; if called during a parallel tasks block, the file will be made writable and the check-out request deferred | LocalizationSourceControlUtil.h | ||
bool CleanUp
(
FText& OutError |
Attempt to revert every file that is currently tracked as checked-out; this cannot be called during a parallel tasks block | LocalizationSourceControlUtil.h | |
bool EndParallelTasks
(
FText& OutError |
Stop a block of parallel tasks; this will attempt to perform any check-outs deferred during the block | LocalizationSourceControlUtil.h | |
bool IsReady
(
FText& OutError |
Check whether SCC is ready to be used; this cannot be called during a parallel tasks block | LocalizationSourceControlUtil.h | |
| Attempt to revert the given file; this cannot be called during a parallel tasks block | LocalizationSourceControlUtil.h |