FSourceControlState

API > API/Developer > API/Developer/SourceControl

Snapshot of source control state of a file


Name	FSourceControlState
Type	struct
Header File	/Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h
Include Path	#include "SourceControlHelpers.h"

Syntax

USTRUCT (BlueprintType )  
struct FSourceControlState

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FSourceControlState()		SourceControlHelpers.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bCanAdd	bool	Determine if this file can be added to source control (i.e. is part of the directory structure currently under source control)	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bCanCheckIn	bool	Determine if this file can be checked in.	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bCanCheckOut	bool	Determine if this file can be checked out	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bCanDelete	bool	Determine if source control allows this file to be deleted.	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bCanEdit	bool	Determine if source control allows this file to be edited	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bCanRevert	bool	Determine if this file can be reverted, i.e. discard changes and the file will no longer be checked-out.	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsAdded	bool	Determine if this file is marked for add

if already checked in then not considered mid add | SourceControlHelpers.h |

VisibleAnywhere
BlueprintReadOnly
Category="Editor Scripting | Editor Revision Control Helpers"
Meta=(Keywords="Source Control")

bIsCheckedOut	bool	Determine if this file is checked out	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsCheckedOutInOtherBranch	bool	Determine if this file is checked out by someone else in another branch	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsCheckedOutOther	bool	Determine if this file is checked out by someone else	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsConflicted	bool	Determine if this file is in a conflicted state	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsCurrent	bool	Determine if this file is up-to-date with the version in source control	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsDeleted	bool	Determine if this file is marked for delete	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsIgnored	bool	Determine if this file is ignored by source control	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsModified	bool	Determine if this file is modified compared to the version in source control.	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsModifiedInOtherBranch	bool	Determine if this file is modified by someone in another branch	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsSourceControlled	bool	Determine if this file is under source control	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsUnknown	bool	Determine if we know anything about the source control state of this file	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
bIsValid	bool	Indicates whether this source control state has valid information (true) or not (false)	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
CheckedOutOther	FString	Get name of other user who this file already checked out or "" if no other user has it checked out	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
Filename	FString	Get the local filename that this state represents	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")
PreviousUser	FString	The username of the previous user to modify this file	SourceControlHelpers.h	VisibleAnywhere BlueprintReadOnly Category="Editor Scripting \| Editor Revision Control Helpers" Meta=(Keywords="Source Control")

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void SetFromStatus ( const FSourceControlStatePtr& InStatus )		SourceControlHelpers.h

Navigation

Syntax

Constructors

Variables

Public

Functions

Public

See Also