ISourceControlState

An abstraction of the state of a file under source control

Unreal Engine C++ API Reference > Developer > SourceControl

Inheritance Hierarchy

References

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

Syntax

class ISourceControlState : public [TSharedFromThis< ISourceControlState, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)  

Remarks

An abstraction of the state of a file under source control

Destructors

Type Name Description
  ~ISourceControlState () Virtual destructor

Functions

Type Name Description
bool CanAdd () Get whether this file can be added to source control (i.e. is part of the directory structure currently under source control)
bool CanCheckIn () Get whether this file can be checked in.
bool CanCheckout () Get whether this file can be checked out
bool CanDelete () Get whether source control allows this file to be deleted.
bool CanEdit () Get whether source control allows this file to be edited
bool CanRevert () Get whether this file can be reverted, i.e. its changes are discarded and the file will no longer be checked-out.
TSharedPtr< ... FindHistoryRevision ( int32 RevisionNumber ) Find an item from the history with the specified revision number.
TSharedPtr< ... FindHistoryRevision ( const FString& InRevision ) Find an item from the history with the specified revision.
TArray< FStr... GetCheckedOutBranches () Get the other branches this file is checked out in
FSourceContr... GetCheckInIdentifier ()  
TSharedPtr< ... GetCurrentRevision () Get the revision that we are currently synced to
FText GetDisplayName () Get a text representation of the state
FText GetDisplayTooltip () Get a tooltip to describe this state
const FStrin... GetFilename () Get the local filename that this state represents
TSharedPtr< ... GetHistoryItem ( int32 HistoryIndex ) Get an item from the history
int32 GetHistorySize () Get the size of the history.
FSlateIcon GetIcon () Gets the icon we should use to display the state in a UI.
bool GetOtherBranchHeadModification ( FString& HeadBranchOut, FString& ActionOut, int32& HeadChangeListOut ) Get head modification information for other branches
FString GetOtherUserBranchCheckedOuts () Get the user info for checkouts on other branches
FResolveInfo GetResolveInfo () Get the file and revision number of the base and remote assets considered in a merge resolve
TOptional< F... GetStatusText () Gets the status message associated with this state, if any.
const FDateT... GetTimeStamp () Get the timestamp of the last update that was made to this state.
TOptional< F... GetWarningText () Gets the warnings messages associated with this state, if any.
bool IsAdded () Get whether this file is marked for add
bool IsCheckedOut () Get whether this file is checked out by the current user
bool IsCheckedOutInOtherBranch ( const FString& CurrentBranch ) Get whether this file is checked out in a different branch, if no branch is specified defaults to FEngineVerion current branch
bool IsCheckedOutOrModifiedInOtherBranch ( const FString& CurrentBranch ) Get whether this file is checked out or modified in a different branch, if no branch is specified defaults to FEngineVerion current branch
bool IsCheckedOutOther ( FString* Who ) Get whether this file is checked out by someone else in the current branch
bool IsConflicted () Get whether this file is in a conflicted state
bool IsCurrent () Get whether this file is up-to-date with the version in source control
bool IsDeleted () Get whether this file is marked for delete
bool IsIgnored () Get whether this file is ignored by source control
bool IsLocal () Get whether this file is local to the current user (ie, has never been pushed to anyone else)
bool IsModified () Get whether this file is modified compared to the version we have from source control
bool IsModifiedInOtherBranch ( const FString& CurrentBranch ) Get whether this file is modified in a different branch, if no branch is specified defaults to FEngineVerion current branch
bool IsSourceControlled () Get whether this file is under source control
bool IsUnknown () Get whether we know anything about this files source control state

Classes

Type Name Description
Public struct FResolveInfo  

Constants

Name Description
INVALID_REVISION  

Deprecated Functions

Type Name Description
TSharedPtr< ... GetBaseRevForMerge () Use GetResolveInfo() and FindHistoryRevision() instead
FName GetIconName () GetIconName has been replaced by GetIcon.
FName GetSmallIconName () GetSmallIconName has been replaced by GetIcon.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library