FCreateWorkspace

Operation used to create a new workspace if the source control system supports this functionality.

Unreal Engine C++ API Reference > Developer > SourceControl

Inheritance Hierarchy

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/SourceControlOperations.h
Include #include "SourceControlOperations.h"

Syntax

class FCreateWorkspace : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)  

Remarks

Operation used to create a new workspace if the source control system supports this functionality.

Variables

Type Name Description
TArray< FClient... ClientView  
EType Type  
FString WorkspaceDescription  
FString WorkspaceName  
FString WorkspaceRoot  
FString WorkspaceStream  

Constructors

Type Name Description
  FCreateWorkspace ()  
  FCreateWorkspace ( FStringView WorkspaceName, FStringView WorkspaceRoot ) Constructor

Functions

Type Name Description
void AddNativeClientViewMapping ( FStringView DepotPath, FStringView ClientPath ) Add a new mapping for the client spec in the native format of the current source control provider.
void ClearClientViewMappings () Remove all currently set client-view mappings
const TArray... GetClientView ()  
EType GetType ()  
const FStrin... GetWorkspaceDescription ()  
const FStrin... GetWorkspaceName ()  
const FStrin... GetWorkspaceRoot ()  
const FStrin... GetWorkspaceStream ()  
void SetDescription ( FStringView Desciption ) Set the description to be used by the workspace, if left unset then the default description will be used
void SetStream ( FStringView Stream ) Set the stream to be used by the workspace, if left unset then a classic depot with ClientView will be used
void SetType ( EType InType ) Set the type of workspace to be created.

Overridden from ISourceControlOperation

Type Name Description
FText GetInProgressString () Get the string to display when this operation is in progress
FName GetName () Get the name of this operation, used as a unique identifier

Enums

Type Name Description
Public enum EType  

Typedefs

Name Description
FClientViewMapping  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library