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