FSourceControlState

Snapshot of source control state of for a file

Windows
MacOS
Linux

References

Module

SourceControl

Header

/Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h

Include

#include "SourceControlHelpers.h"

Syntax

struct FSourceControlState

Remarks

Snapshot of source control state of for a file

Variables

Name Description

Public variable

bool

 

bCanAdd

Determine if this file can be added to source control (i.e. is part of the directory structure currently under source control)

Public variable

bool

 

bCanCheckIn

Determine if this file can be checked in.

Public variable

bool

 

bCanCheckOut

Determine if this file can be checked out

Public variable

bool

 

bCanDelete

Determine if source control allows this file to be deleted.

Public variable

bool

 

bCanEdit

Determine if source control allows this file to be edited

Public variable

bool

 

bCanRevert

Determine if this file can be reverted, i.e. discard changes and the file will no longer be checked-out.

Public variable

bool

 

bIsAdded

Determine if this file is marked for add

if already checked in then not considered mid add

Public variable

bool

 

bIsCheckedOut

Determine if this file is checked out

Public variable

bool

 

bIsCheckedOutOther

Determine if this file is checked out by someone else

Public variable

bool

 

bIsConflicted

Determine if this file is in a conflicted state

Public variable

bool

 

bIsCurrent

Determine if this file is up-to-date with the version in source control

Public variable

bool

 

bIsDeleted

Determine if this file is marked for delete

Public variable

bool

 

bIsIgnored

Determine if this file is ignored by source control

Public variable

bool

 

bIsModified

Determine if this file is modified compared to the version in source control.

Public variable

bool

 

bIsSourceControlled

Determine if this file is under source control

Public variable

bool

 

bIsUnknown

Determine if we know anything about the source control state of this file

Public variable

bool

 

bIsValid

Indicates whether this source control state has valid information (true) or not (false)

Public variable

FString

 

CheckedOutOther

Get name of other user who this file already checked out or "" if no other user has it checked out

Public variable

FString

 

Filename

Get the local filename that this state represents

See Also

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss