Navigation
API > API/Developer > API/Developer/UncontrolledChangelists
Inheritance Hierarchy
- TSharedFromThis
- FUncontrolledChangelistState
References
| Module | UncontrolledChangelists |
| Header | /Engine/Source/Developer/UncontrolledChangelists/Public/UncontrolledChangelistState.h |
| Include | #include "UncontrolledChangelistState.h" |
Syntax
class FUncontrolledChangelistState : public TSharedFromThis< FUncontrolledChangelistState, ESPMode::ThreadSafe >
Variables
| Type | Name | Description | |
|---|---|---|---|
| FUncontrolledChangelist | Changelist | ||
| TSet< FString > | DeletedOfflineFiles | ||
| FText | Description | ||
| TSet< FSourceControlStateRef > | Files | ||
| TSet< FString > | OfflineFiles | ||
| FDateTime | TimeStamp | The timestamp of the last update |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| An FUncontrolledChangelistState should always reference a given Changelist (with a valid GUID). | |||
FUncontrolledChangelistState
(
const FUncontrolledChangelist& InUncontrolledChangelist |
|||
FUncontrolledChangelistState
(
const FUncontrolledChangelistState& InUncontrolledChangelistState |
Uncontrolled Changelist states are unique and non-copyable, should always be used by reference to preserve cache coherence. | ||
FUncontrolledChangelistState
(
const FUncontrolledChangelist& InUncontrolledChangelist, |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | AddFiles
(
const TArray< FString >& InFilenames, |
Adds files to this Uncontrolled Changelist State. | |
| bool | ContainsFilename
(
const FString& PackageFilename |
Check whether a file exists in the file states or offline files | |
| bool | Returns true if the Uncontrolled Changelists contains either Files or OfflineFiles. | ||
| bool | Deserialize
(
const TSharedRef< FJsonObject > InJsonValue |
Deserialize the state of the Uncontrolled Changelist from a Json Object. | |
| const TSet< FString > & | |||
| const FText & | Get a text representation of the state | ||
| const FText & | Get a text representation of the state | ||
| FText | Get a tooltip to describe this state | ||
| int32 | GetFileCount () |
Get the number of files in the CL. (Includes file states and offline files) | |
| TArray< FString > | GetFilenames () |
Get the filenames in the CL. (Includes file states and offline files) | |
| const TSet< FSourceControlStateRef > & | |||
| FName | GetIconName () |
Get the name of the icon graphic we should use to display the state in a UI. | |
| const TSet< FString > & | |||
| FName | Get the name of the small icon graphic we should use to display the state in a UI. | ||
| const FDateTime & | GetTimeStamp () |
Get the timestamp of the last update that was made to this state. | |
| void | RemoveDuplicates
(
TSet< FString >& InOutAddedAssets |
Removes files present both in the Uncontrolled Changelist and the provided set. | |
| bool | RemoveFiles
(
const TArray< FSourceControlStateRef >& InFileStates |
Removes files from this Uncontrolled Changelist State if present. | |
| void | Serialize
(
TSharedRef< class FJsonObject > OutJsonObject |
Serialize the state of the Uncontrolled Changelist to a Json Object. | |
| void | SetDescription
(
const FText& InDescription |
Sets a new description for this Uncontrolled Changelist | |
| bool | UpdateStatus () |
Updates the status of all files contained in this changelist. |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FUncontrolledChangelistState & | operator=
(
const FUncontrolledChangelistState& InUncontrolledChangelistState |
Enums
| Type | Name | Description | |
|---|---|---|---|
| ECheckFlags |
Constants
| Name | Description |
|---|---|
| DEFAULT_UNCONTROLLED_CHANGELIST_DESCRIPTION | |
| DESCRIPTION_NAME | |
| FILES_NAME | |
| NAME_NAME |